{ "rootUrl": "https://vectorsearch.googleapis.com/", "servicePath": "", "title": "Vector Search API", "name": "vectorsearch", "version_module": true, "endpoints": [ { "endpointUrl": "https://vectorsearch.us.rep.googleapis.com/", "location": "us", "description": "Regional Endpoint" } ], "parameters": { "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "alt": { "type": "string", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response.", "default": "json" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] } }, "batchPath": "batch", "id": "vectorsearch:v1", "ownerDomain": "google.com", "description": "The Vector Search API provides a fully-managed, highly performant, and scalable vector database designed to power next-generation search, recommendation, and generative AI applications. It allows you to store, index, and query your data and its corresponding vector embeddings through a simple, intuitive interface. With Vector Search, you can define custom schemas for your data, insert objects with associated metadata, automatically generate embeddings from your data, and perform fast approximate nearest neighbor (ANN) searches to find semantically similar items at scale.", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "mtlsRootUrl": "https://vectorsearch.mtls.googleapis.com/", "schemas": { "GoogleCloudVectorsearchV1Vector": { "description": "A vector which can be either dense or sparse.", "type": "object", "id": "GoogleCloudVectorsearchV1Vector", "properties": { "sparse": { "description": "A sparse vector.", "$ref": "GoogleCloudVectorsearchV1SparseVector" }, "dense": { "$ref": "GoogleCloudVectorsearchV1DenseVector", "description": "A dense vector." } } }, "GoogleCloudLocationLocation": { "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "type": "object", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" } } }, "GoogleCloudVectorsearchV1AggregateDataObjectsRequest": { "type": "object", "description": "Request message for DataObjectSearchService.AggregateDataObjects.", "properties": { "aggregate": { "type": "string", "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "COUNT" ], "description": "Required. The aggregation method to apply to the query.", "enumDescriptions": [ "Should not be used.", "Count the number of data objects that match the filter." ] }, "filter": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." } }, "id": "GoogleCloudVectorsearchV1AggregateDataObjectsRequest" }, "GoogleCloudVectorsearchV1BatchCreateDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1BatchCreateDataObjectsResponse", "properties": { "dataObjects": { "items": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "readOnly": true, "description": "Output only. DataObjects created.", "type": "array" } }, "description": "Response message for DataObjectService.BatchCreateDataObjects.", "type": "object" }, "GoogleCloudVectorsearchV1ImportDataObjectsRequest": { "type": "object", "description": "Request message for VectorSearchService.ImportDataObjects.", "properties": { "gcsImport": { "description": "The Cloud Storage location of the input content.", "$ref": "GoogleCloudVectorsearchV1ImportDataObjectsRequestGcsImportConfig" } }, "id": "GoogleCloudVectorsearchV1ImportDataObjectsRequest" }, "GoogleCloudVectorsearchV1DenseVectorField": { "properties": { "vertexEmbeddingConfig": { "description": "Optional. Configuration for generating embeddings for the vector field. If not specified, the embedding field must be populated in the DataObject.", "$ref": "GoogleCloudVectorsearchV1VertexEmbeddingConfig" }, "dimensions": { "type": "integer", "description": "Dimensionality of the vector field.", "format": "int32" } }, "type": "object", "description": "Message describing a dense vector field.", "id": "GoogleCloudVectorsearchV1DenseVectorField" }, "GoogleCloudVectorsearchV1SearchDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1SearchDataObjectsResponse", "type": "object", "description": "Response for a search request.", "properties": { "results": { "items": { "$ref": "GoogleCloudVectorsearchV1SearchResult" }, "type": "array", "readOnly": true, "description": "Output only. The list of dataObjects that match the search criteria." }, "nextPageToken": { "type": "string", "description": "Output only. A token to retrieve next page of results. Pass to DataObjectSearchService.SearchDataObjectsRequest.page_token to obtain that page.", "readOnly": true } } }, "GoogleCloudVectorsearchV1DenseVector": { "description": "A dense vector.", "id": "GoogleCloudVectorsearchV1DenseVector", "properties": { "values": { "type": "array", "items": { "format": "float", "type": "number" }, "description": "Required. The values of the vector." } }, "type": "object" }, "GoogleCloudVectorsearchV1QueryDataObjectsRequest": { "type": "object", "properties": { "filter": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1OutputFields" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call." }, "pageSize": { "description": "Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" } }, "description": "Request message for DataObjectSearchService.QueryDataObjects.", "id": "GoogleCloudVectorsearchV1QueryDataObjectsRequest" }, "GoogleCloudVectorsearchV1DeleteDataObjectRequest": { "id": "GoogleCloudVectorsearchV1DeleteDataObjectRequest", "type": "object", "description": "Request message for DataObjectService.DeleteDataObject.", "properties": { "etag": { "description": "Optional. The current etag of the DataObject. If an etag is provided and does not match the current etag of the DataObject, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "name": { "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "type": "string" } } }, "GoogleCloudVectorsearchV1BatchUpdateDataObjectsResponse": { "properties": {}, "id": "GoogleCloudVectorsearchV1BatchUpdateDataObjectsResponse", "type": "object", "description": "Response message for DataObjectService.BatchUpdateDataObjects." }, "GoogleCloudVectorsearchV1ListIndexesResponse": { "properties": { "indexes": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1Index" }, "description": "The list of Index" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "description": "Message for response to listing Indexes", "type": "object", "id": "GoogleCloudVectorsearchV1ListIndexesResponse" }, "GoogleCloudVectorsearchV1DenseScannIndex": { "id": "GoogleCloudVectorsearchV1DenseScannIndex", "description": "Dense ScaNN index configuration.", "properties": { "featureNormType": { "enum": [ "FEATURE_NORM_TYPE_UNSPECIFIED", "NONE", "UNIT_L2_NORM" ], "type": "string", "description": "Optional. Feature norm type.", "enumDescriptions": [ "Unspecified feature norm type.", "No norm applied.", "Unit L2 norm." ] } }, "type": "object" }, "GoogleCloudVectorsearchV1DedicatedInfrastructureAutoscalingSpec": { "properties": { "maxReplicaCount": { "type": "integer", "description": "Optional. The maximum number of replicas. Must be \u003e= `min_replica_count` and \u003c= `1000`. For the v1beta version, if not set or set to `0`, defaults to the greater of `min_replica_count` and `5`. For all other versions, if not set or set to `0`, defaults to the greater of `min_replica_count` and `2`.", "format": "int32" }, "minReplicaCount": { "format": "int32", "description": "Optional. The minimum number of replicas. If not set or set to `0`, defaults to `2`. Must be \u003e= `1` and \u003c= `1000`.", "type": "integer" } }, "type": "object", "description": "Specification for autoscaling.", "id": "GoogleCloudVectorsearchV1DedicatedInfrastructureAutoscalingSpec" }, "GoogleCloudVectorsearchV1ListCollectionsResponse": { "properties": { "collections": { "items": { "$ref": "GoogleCloudVectorsearchV1Collection" }, "type": "array", "description": "The list of Collection" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "type": "object", "description": "Message for response to listing Collections", "id": "GoogleCloudVectorsearchV1ListCollectionsResponse" }, "GoogleCloudVectorsearchV1SearchResult": { "id": "GoogleCloudVectorsearchV1SearchResult", "description": "A single search result.", "type": "object", "properties": { "dataObject": { "description": "Output only. The matching data object.", "$ref": "GoogleCloudVectorsearchV1DataObject", "readOnly": true }, "distance": { "readOnly": true, "description": "Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.", "format": "double", "type": "number" } } }, "GoogleCloudVectorsearchV1ExportDataObjectsRequestGcsExportDestination": { "properties": { "exportUri": { "description": "Required. URI prefix of the Cloud Storage where to export Data Objects. The bucket is required to be in the same region as the collection.", "type": "string" }, "format": { "enum": [ "FORMAT_UNSPECIFIED", "JSONL" ], "type": "string", "enumDescriptions": [ "Unspecified format.", "Exports Data Objects in `JSONL` format." ], "description": "Required. The format of the exported Data Objects." } }, "type": "object", "id": "GoogleCloudVectorsearchV1ExportDataObjectsRequestGcsExportDestination", "description": "Google Cloud Storage configuration for the export." }, "GoogleCloudVectorsearchV1SparseVector": { "description": "A sparse vector.", "properties": { "indices": { "items": { "type": "integer", "format": "int32" }, "description": "Required. The corresponding indices for the values.", "type": "array" }, "values": { "type": "array", "description": "Required. The values of the vector.", "items": { "format": "float", "type": "number" } } }, "id": "GoogleCloudVectorsearchV1SparseVector", "type": "object" }, "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequestCombineResultsOptions": { "description": "Options for combining the results of the batch search operations.", "type": "object", "id": "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequestCombineResultsOptions", "properties": { "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1OutputFields" }, "topK": { "format": "int32", "type": "integer", "description": "Optional. The number of results to return. If not set, a default value will be used." }, "ranker": { "$ref": "GoogleCloudVectorsearchV1Ranker", "description": "Required. The ranker to use for combining the results." } } }, "GoogleCloudVectorsearchV1TextSearch": { "id": "GoogleCloudVectorsearchV1TextSearch", "description": "Defines a text search operation.", "properties": { "searchText": { "description": "Optional. The query text. Required when using the default text search mode.", "type": "string" }, "filter": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. A JSON filter expression, e.g. `{\"genre\": {\"$eq\": \"sci-fi\"}}`, represented as a `google.protobuf.Struct`.", "type": "object" }, "topK": { "description": "Optional. The number of results to return.", "type": "integer", "format": "int32" }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1OutputFields", "description": "Optional. The fields to return in the search results." }, "dataFieldNames": { "description": "Optional. The data field names to search. Required when using the default text search mode.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "GoogleCloudVectorsearchV1AggregateDataObjectsResponse": { "type": "object", "description": "Response message for DataObjectSearchService.AggregateDataObjects.", "id": "GoogleCloudVectorsearchV1AggregateDataObjectsResponse", "properties": { "aggregateResults": { "readOnly": true, "type": "array", "items": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "description": "Output only. The aggregated results of the query." } } }, "GoogleCloudVectorsearchV1SemanticSearch": { "type": "object", "id": "GoogleCloudVectorsearchV1SemanticSearch", "description": "Defines a semantic search operation.", "properties": { "taskType": { "enumDescriptions": [ "Unspecified task type.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the embeddings will be used for question answering.", "Specifies that the embeddings will be used for fact verification.", "Specifies that the embeddings will be used for code retrieval." ], "enum": [ "EMBEDDING_TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "type": "string", "description": "Required. The task type of the query embedding." }, "filter": { "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "searchHint": { "$ref": "GoogleCloudVectorsearchV1SearchHint", "description": "Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to KNN search otherwise." }, "searchField": { "description": "Required. The vector field to search.", "type": "string" }, "searchText": { "description": "Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.", "type": "string" }, "outputFields": { "description": "Optional. The fields to return in the search results.", "$ref": "GoogleCloudVectorsearchV1OutputFields" }, "topK": { "description": "Optional. The number of data objects to return.", "format": "int32", "type": "integer" } } }, "GoogleCloudVectorsearchV1VertexEmbeddingConfig": { "properties": { "taskType": { "enum": [ "EMBEDDING_TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "description": "Required. Required: Task type for the embeddings.", "type": "string", "enumDescriptions": [ "Unspecified task type.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the embeddings will be used for question answering.", "Specifies that the embeddings will be used for fact verification.", "Specifies that the embeddings will be used for code retrieval." ] }, "textTemplate": { "type": "string", "description": "Required. Required: Text template for the input to the model. The template must contain one or more references to fields in the DataObject, e.g.: \"Movie Title: {title} ---- Movie Plot: {plot}\"." }, "modelId": { "type": "string", "description": "Required. Required: ID of the embedding model to use. See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models for the list of supported models." } }, "id": "GoogleCloudVectorsearchV1VertexEmbeddingConfig", "description": "Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.", "type": "object" }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "id": "GoogleLongrunningListOperationsResponse", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations." } } }, "GoogleCloudVectorsearchV1DataObject": { "properties": { "vectors": { "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1Vector" }, "type": "object", "description": "Optional. The vectors of the dataObject." }, "etag": { "type": "string", "description": "Optional. The etag of the dataObject." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp the dataObject was created at." }, "dataObjectId": { "readOnly": true, "type": "string", "description": "Output only. The id of the dataObject." }, "data": { "description": "Optional. The data of the dataObject.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "updateTime": { "type": "string", "description": "Output only. Timestamp the dataObject was last updated.", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Identifier. The fully qualified resource name of the dataObject. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}` The data_object_id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1DataObject", "description": "A dataObject resource in Vector Search." }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", "properties": { "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "response": { "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } }, "type": "object" }, "GoogleCloudVectorsearchV1DedicatedInfrastructure": { "type": "object", "id": "GoogleCloudVectorsearchV1DedicatedInfrastructure", "description": "Represents dedicated infrastructure for the index.", "properties": { "mode": { "description": "Optional. Mode of the dedicated infrastructure.", "enum": [ "MODE_UNSPECIFIED", "STORAGE_OPTIMIZED", "PERFORMANCE_OPTIMIZED" ], "enumDescriptions": [ "Default will use `PERFORMANCE_OPTIMIZED`.", "This is storage optimized variation.", "This is Performance optimized on E2 or equivalent family." ], "type": "string" }, "autoscalingSpec": { "$ref": "GoogleCloudVectorsearchV1DedicatedInfrastructureAutoscalingSpec", "description": "Optional. Autoscaling specification." } } }, "Empty": { "properties": {}, "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object" }, "GoogleCloudVectorsearchV1Collection": { "type": "object", "description": "Message describing Collection object", "id": "GoogleCloudVectorsearchV1Collection", "properties": { "vectorSchema": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1VectorField" }, "description": "Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens." }, "createTime": { "description": "Output only. [Output only] Create time stamp", "type": "string", "readOnly": true, "format": "google-datetime" }, "labels": { "type": "object", "description": "Optional. Labels as key value pairs.", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "Identifier. name of resource" }, "description": { "description": "Optional. User-specified description of the collection", "type": "string" }, "encryptionSpec": { "description": "Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.", "$ref": "GoogleCloudVectorsearchV1EncryptionSpec" }, "updateTime": { "type": "string", "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", "readOnly": true }, "dataSchema": { "type": "object", "description": "Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with [JSON Schema Draft 7](https://json-schema.org/draft-07/schema).", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "displayName": { "description": "Optional. User-specified display name of the collection", "type": "string" } } }, "GoogleCloudVectorsearchV1Search": { "type": "object", "properties": { "semanticSearch": { "description": "A semantic search.", "$ref": "GoogleCloudVectorsearchV1SemanticSearch" }, "vectorSearch": { "$ref": "GoogleCloudVectorsearchV1VectorSearch", "description": "A vector-based search." }, "textSearch": { "description": "A text search operation.", "$ref": "GoogleCloudVectorsearchV1TextSearch" } }, "id": "GoogleCloudVectorsearchV1Search", "description": "A single search request within a batch operation." }, "GoogleCloudVectorsearchV1BatchDeleteDataObjectsRequest": { "properties": { "requests": { "items": { "$ref": "GoogleCloudVectorsearchV1DeleteDataObjectRequest" }, "description": "Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.", "type": "array" } }, "id": "GoogleCloudVectorsearchV1BatchDeleteDataObjectsRequest", "type": "object", "description": "Request message for DataObjectService.BatchDeleteDataObjects." }, "GoogleCloudVectorsearchV1SearchHintKnnHint": { "description": "KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.", "id": "GoogleCloudVectorsearchV1SearchHintKnnHint", "type": "object", "properties": {} }, "GoogleCloudLocationListLocationsResponse": { "id": "GoogleCloudLocationListLocationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "items": { "$ref": "GoogleCloudLocationLocation" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" } }, "type": "object", "description": "The response message for Locations.ListLocations." }, "GoogleCloudVectorsearchV1SearchHintIndexHint": { "description": "Message to specify the index to use for the search.", "id": "GoogleCloudVectorsearchV1SearchHintIndexHint", "type": "object", "properties": { "name": { "description": "Required. The resource name of the index to use for the search. The index must be in the same project, location, and collection. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "type": "string" } } }, "GoogleCloudVectorsearchV1VectorField": { "description": "Message describing a vector field.", "id": "GoogleCloudVectorsearchV1VectorField", "type": "object", "properties": { "denseVector": { "$ref": "GoogleCloudVectorsearchV1DenseVectorField", "description": "Dense vector field." }, "sparseVector": { "description": "Sparse vector field.", "$ref": "GoogleCloudVectorsearchV1SparseVectorField" } } }, "GoogleCloudVectorsearchV1SearchHint": { "properties": { "indexHint": { "description": "Optional. Specifies that the search should use a particular index.", "$ref": "GoogleCloudVectorsearchV1SearchHintIndexHint" }, "knnHint": { "$ref": "GoogleCloudVectorsearchV1SearchHintKnnHint", "description": "Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine." } }, "id": "GoogleCloudVectorsearchV1SearchHint", "type": "object", "description": "Represents a hint to the search index engine." }, "GoogleCloudVectorsearchV1VectorSearch": { "properties": { "searchField": { "type": "string", "description": "Required. The vector field to search." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1OutputFields" }, "topK": { "format": "int32", "type": "integer", "description": "Optional. The number of nearest neighbors to return." }, "vector": { "description": "A dense vector for the query.", "$ref": "GoogleCloudVectorsearchV1DenseVector" }, "sparseVector": { "$ref": "GoogleCloudVectorsearchV1SparseVector", "description": "A sparse vector for the query." }, "distanceMetric": { "description": "Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.", "type": "string", "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ], "enum": [ "DISTANCE_METRIC_UNSPECIFIED", "DOT_PRODUCT", "COSINE_DISTANCE" ] }, "filter": { "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "searchHint": { "description": "Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.", "$ref": "GoogleCloudVectorsearchV1SearchHint" } }, "description": "Defines a search operation using a query vector.", "type": "object", "id": "GoogleCloudVectorsearchV1VectorSearch" }, "GoogleCloudVectorsearchV1ImportDataObjectsRequestGcsImportConfig": { "type": "object", "description": "Google Cloud Storage configuration for the import.", "properties": { "errorUri": { "type": "string", "description": "Required. URI prefix of the Cloud Storage location to write any errors encountered during the import." }, "contentsUri": { "type": "string", "description": "Required. URI prefix of the Cloud Storage DataObjects to import." }, "outputUri": { "type": "string", "description": "Optional. URI prefix of the Cloud Storage location to write DataObject `IDs` and `etags` of DataObjects that were successfully imported. The service will write the successfully imported DataObjects to sharded files under this prefix. If this field is empty, no output will be written." } }, "id": "GoogleCloudVectorsearchV1ImportDataObjectsRequestGcsImportConfig" }, "GoogleCloudVectorsearchV1QueryDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1QueryDataObjectsResponse", "properties": { "nextPageToken": { "readOnly": true, "description": "Output only. A token to retrieve next page of results. Pass to DataObjectSearchService.QueryDataObjectsRequest.page_token to obtain that page.", "type": "string" }, "dataObjects": { "readOnly": true, "description": "Output only. The list of dataObjects that match the query.", "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1DataObject" } } }, "description": "Response message for DataObjectSearchService.QueryDataObjects.", "type": "object" }, "GoogleCloudVectorsearchV1VertexRanker": { "description": "Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.", "id": "GoogleCloudVectorsearchV1VertexRanker", "type": "object", "properties": { "topN": { "type": "integer", "description": "Required. The number of documents to be processed for ranking.", "format": "int32" }, "model": { "description": "Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only `semantic-ranker-fast@latest` is supported.", "type": "string" }, "textRecordSpec": { "$ref": "GoogleCloudVectorsearchV1VertexRankerTextRecordSpec", "description": "The record spec for text search." } } }, "GoogleCloudVectorsearchV1Index": { "type": "object", "id": "GoogleCloudVectorsearchV1Index", "description": "Message describing Index object", "properties": { "displayName": { "type": "string", "description": "Optional. User-specified display name of the index" }, "distanceMetric": { "enum": [ "DISTANCE_METRIC_UNSPECIFIED", "DOT_PRODUCT", "COSINE_DISTANCE" ], "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ], "type": "string", "description": "Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT." }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime", "type": "string" }, "storeFields": { "description": "Optional. The fields to push into the index to enable inline data retrieval.", "items": { "type": "string" }, "type": "array" }, "labels": { "description": "Optional. Labels as key value pairs.", "additionalProperties": { "type": "string" }, "type": "object" }, "dedicatedInfrastructure": { "$ref": "GoogleCloudVectorsearchV1DedicatedInfrastructure", "description": "Optional. Dedicated infrastructure for the index." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. [Output only] Create time stamp" }, "indexField": { "description": "Required. The collection schema field to index.", "type": "string" }, "description": { "description": "Optional. User-specified description of the index", "type": "string" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "filterFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. The fields to push into the index to enable fast ANN inline filtering." }, "denseScann": { "description": "Optional. Dense ScaNN index.", "$ref": "GoogleCloudVectorsearchV1DenseScannIndex" } } }, "GoogleCloudVectorsearchV1ExportDataObjectsRequest": { "properties": { "fieldFilter": { "$ref": "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilter", "description": "Optional. Restricts which top-level Data Object fields appear in each exported JSONL record. If unset, every field is exported (the existing behavior). The primary use case is excluding the per-object `etag` so that the exported records can be imported into a Collection in a different region without optimistic-concurrency conflicts. Allowed field names are `id`, `data`, `vectors`, `etag`." }, "gcsDestination": { "$ref": "GoogleCloudVectorsearchV1ExportDataObjectsRequestGcsExportDestination", "description": "The Cloud Storage location where user wants to export Data Objects." } }, "description": "Request message for VectorSearchService.ExportDataObjects.", "id": "GoogleCloudVectorsearchV1ExportDataObjectsRequest", "type": "object" }, "GoogleCloudVectorsearchV1VertexRankerTextRecordSpec": { "properties": { "contentTemplate": { "type": "string", "description": "Optional. The template used to generate the record's content." }, "titleTemplate": { "description": "Optional. The template used to generate the record's title.", "type": "string" }, "query": { "type": "string", "description": "Required. The query against which the records are ranked and scored." } }, "type": "object", "id": "GoogleCloudVectorsearchV1VertexRankerTextRecordSpec", "description": "The record spec for text search." }, "GoogleCloudVectorsearchV1BatchUpdateDataObjectsRequest": { "description": "Request message for DataObjectService.BatchUpdateDataObjects.", "type": "object", "id": "GoogleCloudVectorsearchV1BatchUpdateDataObjectsRequest", "properties": { "requests": { "type": "array", "description": "Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.", "items": { "$ref": "GoogleCloudVectorsearchV1UpdateDataObjectRequest" } } } }, "GoogleCloudVectorsearchV1CreateDataObjectRequest": { "id": "GoogleCloudVectorsearchV1CreateDataObjectRequest", "properties": { "parent": { "type": "string", "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`" }, "dataObject": { "description": "Required. The DataObject to create.", "$ref": "GoogleCloudVectorsearchV1DataObject" }, "dataObjectId": { "description": "Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.", "type": "string" } }, "description": "Request message for DataObjectService.CreateDataObject.", "type": "object" }, "GoogleCloudVectorsearchV1OutputFields": { "id": "GoogleCloudVectorsearchV1OutputFields", "type": "object", "properties": { "metadataFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. The fields from the DataObject metadata to include in the output." }, "dataFields": { "items": { "type": "string" }, "description": "Optional. The fields from the data fields to include in the output.", "type": "array" }, "vectorFields": { "type": "array", "description": "Optional. The fields from the vector fields to include in the output.", "items": { "type": "string" } } }, "description": "Defines a output fields struct for data in DataObject." }, "GoogleCloudVectorsearchV1Ranker": { "type": "object", "id": "GoogleCloudVectorsearchV1Ranker", "description": "Defines a ranker to combine results from multiple searches.", "properties": { "vertexRanker": { "description": "Optional. Vertex AI ranking.", "$ref": "GoogleCloudVectorsearchV1VertexRanker" }, "rrf": { "description": "Reciprocal Rank Fusion ranking.", "$ref": "GoogleCloudVectorsearchV1ReciprocalRankFusion" } } }, "GoogleCloudVectorsearchV1ReciprocalRankFusion": { "description": "Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.", "properties": { "weights": { "type": "array", "items": { "format": "double", "type": "number" }, "description": "Required. The weights to apply to each search result set during fusion." } }, "id": "GoogleCloudVectorsearchV1ReciprocalRankFusion", "type": "object" }, "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilterFieldList": { "properties": { "fields": { "type": "array", "description": "Required. The list of top-level Data Object JSON field names. Allowed values are `id`, `data`, `vectors`, `etag`.", "items": { "type": "string" } } }, "id": "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilterFieldList", "description": "Wrapper for a repeated string. Wrapping in a message lets the surrounding `oneof` distinguish \"field set to an empty list\" (which is rejected as INVALID_ARGUMENT) from \"field not set\".", "type": "object" }, "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequest", "type": "object", "properties": { "searches": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1Search" }, "description": "Required. A list of search requests to execute in parallel." }, "combine": { "$ref": "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequestCombineResultsOptions", "description": "Optional. Options for combining the results of the batch search operations." } }, "description": "A request to perform a batch of search operations." }, "GoogleCloudVectorsearchV1SearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1SearchDataObjectsRequest", "properties": { "vectorSearch": { "$ref": "GoogleCloudVectorsearchV1VectorSearch", "description": "A vector search operation." }, "textSearch": { "$ref": "GoogleCloudVectorsearchV1TextSearch", "description": "Optional. A text search operation." }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The standard list page size. Only supported for KNN. If not set, up to search_type.top_k results will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "semanticSearch": { "$ref": "GoogleCloudVectorsearchV1SemanticSearch", "description": "A semantic search operation." }, "pageToken": { "type": "string", "description": "Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call." } }, "description": "Request for performing a single search.", "type": "object" }, "GoogleCloudVectorsearchV1BatchCreateDataObjectsRequest": { "description": "Request message for DataObjectService.BatchCreateDataObjects.", "properties": { "requests": { "items": { "$ref": "GoogleCloudVectorsearchV1CreateDataObjectRequest" }, "description": "Required. The request message specifying the resources to create. A maximum of 1000 DataObjects can be created in a batch.", "type": "array" } }, "type": "object", "id": "GoogleCloudVectorsearchV1BatchCreateDataObjectsRequest" }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "id": "GoogleLongrunningCancelOperationRequest", "properties": {} }, "GoogleCloudVectorsearchV1UpdateDataObjectRequest": { "properties": { "updateMask": { "type": "string", "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask.", "format": "google-fieldmask" }, "dataObject": { "description": "Required. The DataObject which replaces the resource on the server.", "$ref": "GoogleCloudVectorsearchV1DataObject" } }, "id": "GoogleCloudVectorsearchV1UpdateDataObjectRequest", "description": "Request message for DataObjectService.UpdateDataObject.", "type": "object" }, "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilter": { "id": "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilter", "properties": { "includedFields": { "description": "Optional. Only these top-level fields will appear in each exported record.", "$ref": "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilterFieldList" }, "excludedFields": { "description": "Optional. Every top-level field except these will appear in each exported record.", "$ref": "GoogleCloudVectorsearchV1ExportDataObjectsRequestFieldFilterFieldList" } }, "type": "object", "description": "Selects which top-level Data Object fields are emitted at export time." }, "GoogleCloudVectorsearchV1BatchSearchDataObjectsResponse": { "description": "A response from a batch search operation.", "properties": { "results": { "items": { "$ref": "GoogleCloudVectorsearchV1SearchDataObjectsResponse" }, "description": "Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.", "readOnly": true, "type": "array" } }, "id": "GoogleCloudVectorsearchV1BatchSearchDataObjectsResponse", "type": "object" }, "GoogleCloudVectorsearchV1SparseVectorField": { "description": "Message describing a sparse vector field.", "id": "GoogleCloudVectorsearchV1SparseVectorField", "properties": {}, "type": "object" }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" } } } }, "GoogleCloudVectorsearchV1EncryptionSpec": { "properties": { "cryptoKeyName": { "description": "Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } }, "id": "GoogleCloudVectorsearchV1EncryptionSpec", "type": "object", "description": "Represents a customer-managed encryption key specification that can be applied to a Vector Search collection." }, "GoogleCloudVectorsearchV1OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "apiVersion": { "type": "string", "readOnly": true, "description": "Output only. API version used to start the operation." }, "target": { "type": "string", "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true } }, "type": "object", "id": "GoogleCloudVectorsearchV1OperationMetadata" } }, "kind": "discovery#restDescription", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/locations", "parameters": { "pageSize": { "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer" }, "extraLocationTypes": { "repeated": true, "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "name": { "type": "string", "required": true, "location": "path", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.list", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "httpMethod": "GET", "id": "vectorsearch.projects.locations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Resource name for the location.", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "GoogleCloudLocationLocation" }, "path": "v1/{+name}", "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "vectorsearch.projects.locations.operations.list", "parameterOrder": [ "name" ] }, "delete": { "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "Empty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "vectorsearch.projects.locations.operations.delete" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "httpMethod": "POST", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "id": "vectorsearch.projects.locations.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "Empty" }, "path": "v1/{+name}:cancel" }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.operations.get", "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } } } } }, "collections": { "resources": { "dataObjects": { "methods": { "aggregate": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudVectorsearchV1AggregateDataObjectsRequest" }, "parameters": { "parent": { "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:aggregate", "response": { "$ref": "GoogleCloudVectorsearchV1AggregateDataObjectsResponse" }, "id": "vectorsearch.projects.locations.collections.dataObjects.aggregate", "parameterOrder": [ "parent" ], "description": "Aggregates data objects.", "path": "v1/{+parent}/dataObjects:aggregate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "search": { "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:search", "response": { "$ref": "GoogleCloudVectorsearchV1SearchDataObjectsResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dataObjects:search", "id": "vectorsearch.projects.locations.collections.dataObjects.search", "parameterOrder": [ "parent" ], "description": "Searches data objects.", "request": { "$ref": "GoogleCloudVectorsearchV1SearchDataObjectsRequest" } }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects", "response": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "description": "Creates a dataObject.", "parameters": { "dataObjectId": { "description": "Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.", "location": "query", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path", "type": "string" } }, "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.dataObjects.create", "request": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "path": "v1/{+parent}/dataObjects", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "batchSearch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchSearch", "response": { "$ref": "GoogleCloudVectorsearchV1BatchSearchDataObjectsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.dataObjects.batchSearch", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudVectorsearchV1BatchSearchDataObjectsRequest" }, "path": "v1/{+parent}/dataObjects:batchSearch", "description": "Batch searches data objects." }, "batchUpdate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.dataObjects.batchUpdate", "description": "Updates dataObjects in a batch.", "path": "v1/{+parent}/dataObjects:batchUpdate", "httpMethod": "POST", "request": { "$ref": "GoogleCloudVectorsearchV1BatchUpdateDataObjectsRequest" }, "parameters": { "parent": { "description": "Required. The resource name of the Collection to update the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`. The parent field in the UpdateDataObjectRequest messages must match this field.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchUpdate", "response": { "$ref": "GoogleCloudVectorsearchV1BatchUpdateDataObjectsResponse" }, "parameterOrder": [ "parent" ] }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "response": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "id": "vectorsearch.projects.locations.collections.dataObjects.patch", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "httpMethod": "PATCH", "parameters": { "name": { "required": true, "type": "string", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "description": "Identifier. The fully qualified resource name of the dataObject. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}` The data_object_id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt)." }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask.", "type": "string", "location": "query" } }, "description": "Updates a dataObject." }, "get": { "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.dataObjects.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "description": "Required. The name of the DataObject resource. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "response": { "$ref": "GoogleCloudVectorsearchV1DataObject" }, "description": "Gets a data object." }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "response": { "$ref": "Empty" }, "id": "vectorsearch.projects.locations.collections.dataObjects.delete", "description": "Deletes a dataObject.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "location": "path", "type": "string", "required": true }, "etag": { "type": "string", "location": "query", "description": "Optional. The current etag of the DataObject. If an etag is provided and does not match the current etag of the DataObject, deletion will be blocked and an ABORTED error will be returned." } } }, "query": { "description": "Queries data objects.", "id": "vectorsearch.projects.locations.collections.dataObjects.query", "path": "v1/{+parent}/dataObjects:query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudVectorsearchV1QueryDataObjectsRequest" }, "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:query", "response": { "$ref": "GoogleCloudVectorsearchV1QueryDataObjectsResponse" } }, "batchCreate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.dataObjects.batchCreate", "description": "Creates a batch of dataObjects.", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection to create the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`. The parent field in the CreateDataObjectRequest messages must match this field." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchCreate", "response": { "$ref": "GoogleCloudVectorsearchV1BatchCreateDataObjectsResponse" }, "request": { "$ref": "GoogleCloudVectorsearchV1BatchCreateDataObjectsRequest" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/dataObjects:batchCreate" }, "batchDelete": { "request": { "$ref": "GoogleCloudVectorsearchV1BatchDeleteDataObjectsRequest" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchDelete", "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dataObjects:batchDelete", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the Collection to delete the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`." } }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchDelete", "description": "Deletes dataObjects in a batch." } } }, "indexes": { "methods": { "patch": { "id": "vectorsearch.projects.locations.collections.indexes.patch", "httpMethod": "PATCH", "parameters": { "requestId": { "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "name": { "type": "string", "description": "Identifier. name of resource", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "location": "path" }, "updateMask": { "type": "string", "description": "Optional. Specifies the fields to be overwritten in the Index resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request with non-empty values will be overwritten. The following fields support update: * `display_name` * `description` * `labels` * `dedicated_infrastructure.autoscaling_spec.min_replica_count` * `dedicated_infrastructure.autoscaling_spec.max_replica_count` If `*` is provided in the `update_mask`, full replacement of mutable fields will be performed.", "format": "google-fieldmask", "location": "query" } }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudVectorsearchV1Index" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Index." }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "response": { "$ref": "GoogleCloudVectorsearchV1Index" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.indexes.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "description": "Required. Name of the resource", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Index.", "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "name": { "required": true, "description": "Required. The resource name of the Index to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" } }, "description": "Deletes a single Index.", "id": "vectorsearch.projects.locations.collections.indexes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "list": { "id": "vectorsearch.projects.locations.collections.indexes.list", "httpMethod": "GET", "path": "v1/{+parent}/indexes", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A token identifying a page of results the server should return." }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "format": "int32" }, "parent": { "required": true, "description": "Required. Parent value for ListIndexesRequest", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filtering results", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "response": { "$ref": "GoogleCloudVectorsearchV1ListIndexesResponse" }, "description": "Lists Indexes in a given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "create": { "id": "vectorsearch.projects.locations.collections.indexes.create", "request": { "$ref": "GoogleCloudVectorsearchV1Index" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection for which to create the Index. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "indexId": { "description": "Required. ID of the Index to create. The id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Index in a given project and location.", "path": "v1/{+parent}/indexes", "httpMethod": "POST" } } } }, "methods": { "importDataObjects": { "description": "Initiates a Long-Running Operation to import DataObjects into a Collection.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+name}:importDataObjects", "id": "vectorsearch.projects.locations.collections.importDataObjects", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the Collection to import DataObjects into. Format: `projects/{project}/locations/{location}/collections/{collection}`." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:importDataObjects", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudVectorsearchV1ImportDataObjectsRequest" } }, "exportDataObjects": { "path": "v1/{+name}:exportDataObjects", "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.exportDataObjects", "description": "Initiates a Long-Running Operation to export DataObjects from a Collection.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection from which we want to export Data Objects. Format: `projects/{project}/locations/{location}/collections/{collection}`." } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudVectorsearchV1ExportDataObjectsRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:exportDataObjects", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string", "description": "Required. Name of the resource", "location": "path" } }, "description": "Gets details of a single Collection.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "response": { "$ref": "GoogleCloudVectorsearchV1Collection" } }, "patch": { "id": "vectorsearch.projects.locations.collections.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates the parameters of a single Collection.", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudVectorsearchV1Collection" }, "parameters": { "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The following fields support update: `display_name`, `description`, `labels`, `data_schema`, `vector_schema`. For `data_schema` and `vector_schema`, fields can only be added, not deleted, but `vertex_embedding_config` in `vector_schema` can be added or removed. Partial updates for `data_schema` and `vector_schema` are also supported by using sub-field paths in `update_mask`, e.g. `data_schema.properties.foo` or `vector_schema.my_vector_field`. If `*` is provided in the update_mask, full replacement will be performed.", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Identifier. name of resource", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/collections", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections", "response": { "$ref": "GoogleCloudVectorsearchV1ListCollectionsResponse" }, "httpMethod": "GET", "id": "vectorsearch.projects.locations.collections.list", "description": "Lists Collections in a given project and location.", "parameters": { "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A token identifying a page of results the server should return." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. Parent value for ListCollectionsRequest", "type": "string", "required": true }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results" } } }, "delete": { "parameters": { "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, any Indexes and DataObjects from this Collection will also be deleted. (Otherwise, the request will only work if the Collection has no Indexes and DataObjects.)" }, "name": { "location": "path", "description": "Required. Name of the resource", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Collection.", "httpMethod": "DELETE", "id": "vectorsearch.projects.locations.collections.delete", "path": "v1/{+name}", "parameterOrder": [ "name" ] }, "create": { "parameters": { "collectionId": { "type": "string", "description": "Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.", "location": "query" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. Value for parent." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/collections", "id": "vectorsearch.projects.locations.collections.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a new Collection in a given project and location.", "httpMethod": "POST", "request": { "$ref": "GoogleCloudVectorsearchV1Collection" }, "parameterOrder": [ "parent" ] } } } } } } } }, "baseUrl": "https://vectorsearch.googleapis.com/", "discoveryVersion": "v1", "basePath": "", "ownerName": "Google", "fullyEncodeReservedExpansion": true, "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Vector Search", "documentationLink": "https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview", "protocol": "rest", "version": "v1", "revision": "20260723" }