{ "discoveryVersion": "v1", "batchPath": "batch", "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.", "documentationLink": "https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview", "protocol": "rest", "endpoints": [ { "endpointUrl": "https://vectorsearch.us.rep.googleapis.com/", "location": "us", "description": "Regional Endpoint" } ], "baseUrl": "https://vectorsearch.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "path": "v1beta/{+name}", "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.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "vectorsearch.projects.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta/{+name}/operations", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation's parent resource." }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "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" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "id": "vectorsearch.projects.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "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`.", "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "required": true, "location": "path" } }, "path": "v1beta/{+name}:cancel", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" } }, "delete": { "id": "vectorsearch.projects.locations.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ] } } }, "collections": { "methods": { "list": { "description": "Lists Collections in a given project and location.", "httpMethod": "GET", "parameters": { "filter": { "description": "Optional. Filtering results", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "type": "integer", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. Parent value for ListCollectionsRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results the server should return." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" } }, "path": "v1beta/{+parent}/collections", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections", "parameterOrder": [ "parent" ], "id": "vectorsearch.projects.locations.collections.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaListCollectionsResponse" } }, "patch": { "id": "vectorsearch.projects.locations.collections.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}", "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Identifier. name of resource", "required": true, "location": "path" }, "updateMask": { "location": "query", "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." }, "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": "Updates the parameters of a single Collection.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" } }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "parameterOrder": [ "name" ], "description": "Deletes a single Collection.", "path": "v1beta/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string" }, "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 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)." }, "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.)" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "vectorsearch.projects.locations.collections.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "importDataObjects": { "id": "vectorsearch.projects.locations.collections.importDataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Initiates a Long-Running Operation to import DataObjects into a Collection.", "path": "v1beta/{+name}:importDataObjects", "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection to import DataObjects into. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "required": true, "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:importDataObjects", "request": { "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest" }, "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "parameterOrder": [ "name" ], "description": "Gets details of a single Collection.", "path": "v1beta/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. Name of the resource", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "id": "vectorsearch.projects.locations.collections.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a new Collection in a given project and location.", "path": "v1beta/{+parent}/collections", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Value for parent.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "collectionId": { "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", "type": "string" }, "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 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)." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections", "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "parameterOrder": [ "parent" ], "id": "vectorsearch.projects.locations.collections.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "exportDataObjects": { "description": "Initiates a Long-Running Operation to export DataObjects from a Collection.", "path": "v1beta/{+name}:exportDataObjects", "httpMethod": "POST", "parameters": { "name": { "type": "string", "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}`.", "required": true, "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:exportDataObjects", "request": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest" }, "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.exportDataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } }, "resources": { "dataObjects": { "methods": { "batchCreate": { "id": "vectorsearch.projects.locations.collections.dataObjects.batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse" }, "path": "v1beta/{+parent}/dataObjects:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "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.", "location": "path", "required": true } }, "description": "Creates a batch of dataObjects.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchCreate", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest" } }, "batchDelete": { "response": { "$ref": "Empty" }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchDelete", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest" }, "parameterOrder": [ "parent" ], "description": "Deletes dataObjects in a batch.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the Collection to delete the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "path": "v1beta/{+parent}/dataObjects:batchDelete" }, "batchSearch": { "id": "vectorsearch.projects.locations.collections.dataObjects.batchSearch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse" }, "description": "Batch searches data objects.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`" } }, "path": "v1beta/{+parent}/dataObjects:batchSearch", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchSearch", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest" }, "parameterOrder": [ "parent" ] }, "patch": { "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "id": "vectorsearch.projects.locations.collections.dataObjects.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "path": "v1beta/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask." }, "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).", "location": "path", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" } }, "description": "Updates a dataObject." }, "search": { "response": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" }, "id": "vectorsearch.projects.locations.collections.dataObjects.search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:search", "request": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:search", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "required": true, "location": "path" } }, "description": "Searches data objects." }, "create": { "id": "vectorsearch.projects.locations.collections.dataObjects.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`" }, "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" } }, "path": "v1beta/{+parent}/dataObjects", "description": "Creates a dataObject.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects", "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "get": { "path": "v1beta/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the DataObject resource. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`" } }, "description": "Gets a data object.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "id": "vectorsearch.projects.locations.collections.dataObjects.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "aggregate": { "id": "vectorsearch.projects.locations.collections.dataObjects.aggregate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse" }, "description": "Aggregates data objects.", "path": "v1beta/{+parent}/dataObjects:aggregate", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:aggregate", "request": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest" }, "parameterOrder": [ "parent" ] }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "type": "string" }, "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." } }, "path": "v1beta/{+name}", "description": "Deletes a dataObject.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "id": "vectorsearch.projects.locations.collections.dataObjects.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" } }, "query": { "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", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string" } }, "path": "v1beta/{+parent}/dataObjects:query", "description": "Queries data objects.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:query", "request": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest" }, "id": "vectorsearch.projects.locations.collections.dataObjects.query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse" } }, "batchUpdate": { "path": "v1beta/{+parent}/dataObjects:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "location": "path", "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." } }, "description": "Updates dataObjects in a batch.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchUpdate", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest" }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchUpdate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse" } } } }, "indexes": { "methods": { "get": { "description": "Gets details of a single Index.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. Name of the resource" } }, "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.indexes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaIndex" } }, "create": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "parameterOrder": [ "parent" ], "description": "Creates a new Index in a given project and location.", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the Collection for which to create the Index. Format: `projects/{project}/locations/{location}/collections/{collection}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string" }, "indexId": { "type": "string", "location": "query", "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])?`." }, "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)." } }, "path": "v1beta/{+parent}/indexes", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "vectorsearch.projects.locations.collections.indexes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "parameterOrder": [ "name" ], "description": "Deletes a single Index.", "path": "v1beta/{+name}", "httpMethod": "DELETE", "parameters": { "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" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Index to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "vectorsearch.projects.locations.collections.indexes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists Indexes in a given project and location.", "path": "v1beta/{+parent}/indexes", "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" }, "filter": { "description": "Optional. Filtering results", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "description": "Required. Parent value for ListIndexesRequest", "location": "path", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "parameterOrder": [ "parent" ], "id": "vectorsearch.projects.locations.collections.indexes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaListIndexesResponse" } }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "vectorsearch.projects.locations.collections.indexes.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "path": "v1beta/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "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", "type": "string", "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).", "type": "string", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "type": "string", "description": "Identifier. name of resource", "location": "path", "required": true } }, "description": "Updates the parameters of a single Index." } } } } } }, "methods": { "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.", "path": "v1beta/{+name}/locations", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default." }, "filter": { "type": "string", "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)." }, "name": { "required": true, "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string", "pattern": "^projects/[^/]+$" }, "extraLocationTypes": { "type": "string", "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudLocationListLocationsResponse" } }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1beta/{+name}", "description": "Gets information about a location.", "response": { "$ref": "GoogleCloudLocationLocation" }, "id": "vectorsearch.projects.locations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "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." } } } }, "version": "v1beta", "revision": "20260618", "ownerName": "Google", "name": "vectorsearch", "rootUrl": "https://vectorsearch.googleapis.com/", "schemas": { "GoogleRpcStatus": { "properties": { "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "message": { "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.", "type": "string" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } }, "type": "object", "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)." }, "GoogleCloudVectorsearchV1betaSearchResult": { "id": "GoogleCloudVectorsearchV1betaSearchResult", "description": "A single search result.", "properties": { "dataObject": { "description": "Output only. The matching data object.", "readOnly": true, "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "distance": { "type": "number", "description": "Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.", "readOnly": true, "format": "double" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaListIndexesResponse": { "id": "GoogleCloudVectorsearchV1betaListIndexesResponse", "description": "Message for response to listing Indexes", "properties": { "indexes": { "type": "array", "description": "The list of Index", "items": { "$ref": "GoogleCloudVectorsearchV1betaIndex" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest": { "properties": { "dataObject": { "$ref": "GoogleCloudVectorsearchV1betaDataObject", "description": "Required. The DataObject which replaces the resource on the server." }, "updateMask": { "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask.", "format": "google-fieldmask", "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest", "description": "Request message for DataObjectService.UpdateDataObject." }, "GoogleCloudVectorsearchV1betaSearchResponseMetadata": { "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadata", "description": "Metadata about the search execution.", "properties": { "usedIndex": { "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo", "description": "Indicates that the search used a particular index." }, "usedKnn": { "description": "Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.", "readOnly": true, "type": "boolean" }, "warnings": { "type": "array", "description": "Output only. Warnings or non-fatal errors that occurred during execution.", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object" }, "GoogleCloudVectorsearchV1betaEncryptionSpec": { "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" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaEncryptionSpec", "description": "Represents a customer-managed encryption key specification that can be applied to a Vector Search collection." }, "GoogleCloudVectorsearchV1betaVector": { "description": "A vector which can be either dense or sparse.", "id": "GoogleCloudVectorsearchV1betaVector", "type": "object", "properties": { "sparse": { "description": "A sparse vector.", "$ref": "GoogleCloudVectorsearchV1betaSparseVector" }, "dense": { "$ref": "GoogleCloudVectorsearchV1betaDenseVector", "description": "A dense vector." }, "values": { "deprecated": true, "type": "array", "description": "Deprecated: Use `dense` or `sparse` instead.", "items": { "type": "number", "format": "float" } } } }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig": { "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig", "description": "Google Cloud Storage configuration for the import.", "properties": { "outputUri": { "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.", "type": "string" }, "contentsUri": { "description": "Required. URI prefix of the Cloud Storage DataObjects to import.", "type": "string" }, "errorUri": { "description": "Required. URI prefix of the Cloud Storage location to write any errors encountered during the import.", "type": "string" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaSparseVector": { "description": "A sparse vector.", "id": "GoogleCloudVectorsearchV1betaSparseVector", "type": "object", "properties": { "values": { "description": "Required. The values of the vector.", "items": { "format": "float", "type": "number" }, "type": "array" }, "indices": { "type": "array", "description": "Required. The corresponding indices for the values.", "items": { "type": "integer", "format": "int32" } } } }, "GoogleCloudVectorsearchV1betaDataObject": { "properties": { "data": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. The data of the dataObject." }, "vectors": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1betaVector" }, "description": "Optional. The vectors of the dataObject." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp the dataObject was created at.", "readOnly": true, "type": "string" }, "dataObjectId": { "description": "Output only. The id of the dataObject.", "readOnly": true, "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp the dataObject was last updated.", "readOnly": true }, "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).", "type": "string", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, "etag": { "description": "Optional. The etag of the dataObject.", "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaDataObject", "description": "A dataObject resource in Vector Search." }, "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams": { "type": "object", "properties": { "searchLeavesPct": { "type": "integer", "description": "Optional. Dense ANN param overrides to control recall and latency. The percentage of leaves to search, in the range [0, 100].", "format": "int32" }, "initialCandidateCount": { "type": "integer", "description": "Optional. The number of initial candidates. Must be a positive integer (\u003e 0).", "format": "int32" } }, "description": "Parameters for dense ScaNN.", "id": "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams" }, "GoogleCloudVectorsearchV1betaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudVectorsearchV1betaOperationMetadata", "type": "object", "properties": { "target": { "type": "string", "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true }, "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "apiVersion": { "type": "string", "description": "Output only. API version used to start the operation.", "readOnly": true }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" }, "verb": { "type": "string", "description": "Output only. Name of the verb executed by the operation.", "readOnly": true }, "requestedCancellation": { "type": "boolean", "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`.", "readOnly": true } } }, "GoogleCloudVectorsearchV1betaSearchHintIndexHint": { "type": "object", "properties": { "denseScannParams": { "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams", "description": "Optional. Dense ScaNN parameters." }, "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" } }, "description": "Message to specify the index to use for the search.", "id": "GoogleCloudVectorsearchV1betaSearchHintIndexHint" }, "GoogleCloudVectorsearchV1betaSparseVectorField": { "id": "GoogleCloudVectorsearchV1betaSparseVectorField", "description": "Message describing a sparse vector field.", "properties": {}, "type": "object" }, "GoogleCloudLocationLocation": { "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } } }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest": { "type": "object", "properties": { "filter": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "aggregate": { "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." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "COUNT" ], "type": "string" } }, "description": "Request message for DataObjectSearchService.AggregateDataObjects.", "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest" }, "GoogleLongrunningOperation": { "properties": { "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" }, "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": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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." }, "response": { "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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } }, "type": "object", "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call." }, "GoogleCloudVectorsearchV1betaVertexRanker": { "properties": { "topN": { "format": "int32", "description": "Required. The number of documents to be processed for ranking.", "type": "integer" }, "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": { "description": "The record spec for text search.", "$ref": "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaVertexRanker", "description": "Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details." }, "GoogleCloudVectorsearchV1betaVectorSearch": { "properties": { "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": "GoogleCloudVectorsearchV1betaSearchHint" }, "searchField": { "description": "Required. The vector field to search.", "type": "string" }, "filter": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. Mask specifying which fields to return." }, "distanceMetric": { "type": "string", "enum": [ "DISTANCE_METRIC_UNSPECIFIED", "DOT_PRODUCT", "COSINE_DISTANCE" ], "description": "Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.", "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ] }, "vector": { "$ref": "GoogleCloudVectorsearchV1betaDenseVector", "description": "A dense vector for the query." }, "sparseVector": { "description": "A sparse vector for the query.", "$ref": "GoogleCloudVectorsearchV1betaSparseVector" }, "topK": { "format": "int32", "description": "Optional. The number of nearest neighbors to return.", "type": "integer" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaVectorSearch", "description": "Defines a search operation using a query vector." }, "GoogleCloudVectorsearchV1betaSearchHintKnnHint": { "properties": {}, "type": "object", "id": "GoogleCloudVectorsearchV1betaSearchHintKnnHint", "description": "KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine." }, "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse", "description": "Response for a search request.", "properties": { "searchResponseMetadata": { "description": "Output only. Metadata about the search execution.", "readOnly": true, "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadata" }, "results": { "type": "array", "description": "Output only. The list of dataObjects that match the search criteria.", "readOnly": true, "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchResult" } }, "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 } }, "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHint": { "id": "GoogleCloudVectorsearchV1betaSearchHint", "description": "Represents a hint to the search index engine.", "properties": { "useKnn": { "deprecated": true, "type": "boolean", "description": "Optional. Deprecated: Use `knn_hint` instead. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine." }, "knnHint": { "description": "Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintKnnHint" }, "useIndex": { "deprecated": true, "description": "Optional. Deprecated: Use `index_hint` instead. Specifies that the search should use a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint" }, "indexHint": { "description": "Optional. Specifies that the search should use a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaSemanticSearch": { "id": "GoogleCloudVectorsearchV1betaSemanticSearch", "description": "Defines a semantic search operation.", "properties": { "taskType": { "description": "Required. The task type of the query embedding.", "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" }, "topK": { "description": "Optional. The number of data objects to return.", "format": "int32", "type": "integer" }, "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" }, "searchHint": { "$ref": "GoogleCloudVectorsearchV1betaSearchHint", "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" }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. The fields to return in the search results." }, "filter": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." } }, "type": "object" }, "GoogleCloudVectorsearchV1betaListCollectionsResponse": { "description": "Message for response to listing Collections", "id": "GoogleCloudVectorsearchV1betaListCollectionsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "collections": { "description": "The list of Collection", "items": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "type": "array" }, "unreachable": { "type": "array", "description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" } } } }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse": { "description": "Response message for DataObjectService.BatchCreateDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse", "type": "object", "properties": { "dataObjects": { "description": "Output only. DataObjects created.", "readOnly": true, "items": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "type": "array" } } }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse": { "description": "Response message for DataObjectService.BatchUpdateDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse", "type": "object", "properties": {} }, "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest", "description": "Request for performing a single search.", "properties": { "vectorSearch": { "description": "A vector search operation.", "$ref": "GoogleCloudVectorsearchV1betaVectorSearch" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.", "type": "string" }, "textSearch": { "$ref": "GoogleCloudVectorsearchV1betaTextSearch", "description": "Optional. A text search operation." }, "semanticSearch": { "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch", "description": "A semantic search operation." }, "pageSize": { "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.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleLongrunningListOperationsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" } }, "unreachable": { "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.", "items": { "type": "string" }, "type": "array" } }, "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse" }, "GoogleCloudVectorsearchV1betaIndex": { "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. [Output only] Update time stamp", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. User-specified display name of the index", "type": "string" }, "description": { "description": "Optional. User-specified description of the index", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs." }, "denseScann": { "description": "Optional. Dense ScaNN index.", "$ref": "GoogleCloudVectorsearchV1betaDenseScannIndex" }, "filterFields": { "type": "array", "description": "Optional. The fields to push into the index to enable fast ANN inline filtering.", "items": { "type": "string" } }, "dedicatedInfrastructure": { "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure", "description": "Optional. Dedicated infrastructure for the index." }, "distanceMetric": { "type": "string", "description": "Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.", "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ], "enum": [ "DISTANCE_METRIC_UNSPECIFIED", "DOT_PRODUCT", "COSINE_DISTANCE" ] }, "createTime": { "format": "google-datetime", "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string" }, "storeFields": { "description": "Optional. The fields to push into the index to enable inline data retrieval.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "indexField": { "description": "Required. The collection schema field to index.", "type": "string" } }, "description": "Message describing Index object", "id": "GoogleCloudVectorsearchV1betaIndex" }, "GoogleCloudVectorsearchV1betaCollection": { "id": "GoogleCloudVectorsearchV1betaCollection", "description": "Message describing Collection object", "properties": { "updateTime": { "type": "string", "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime" }, "displayName": { "description": "Optional. User-specified display name of the collection", "type": "string" }, "description": { "description": "Optional. User-specified description of the collection", "type": "string" }, "labels": { "description": "Optional. Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "format": "google-datetime", "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string" }, "dataSchema": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the 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)." }, "schema": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "deprecated": true, "type": "object", "description": "Optional. Deprecated: JSON Schema for data. Please use data_schema instead." }, "vectorSchema": { "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1betaVectorField" }, "type": "object", "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." }, "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": "GoogleCloudVectorsearchV1betaEncryptionSpec" }, "name": { "description": "Identifier. name of resource", "type": "string" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo": { "properties": { "name": { "description": "Output only. The resource name of the index used for the search. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "readOnly": true, "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo", "description": "Message that indicates the index used for the search." }, "GoogleCloudVectorsearchV1betaCreateDataObjectRequest": { "properties": { "parent": { "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`", "type": "string" }, "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" }, "dataObject": { "description": "Required. The DataObject to create.", "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest", "description": "Request message for DataObjectService.CreateDataObject." }, "GoogleCloudVectorsearchV1betaDenseScannIndex": { "type": "object", "properties": { "featureNormType": { "description": "Optional. Feature norm type.", "enumDescriptions": [ "Unspecified feature norm type.", "No norm applied.", "Unit L2 norm." ], "enum": [ "FEATURE_NORM_TYPE_UNSPECIFIED", "NONE", "UNIT_L2_NORM" ], "type": "string" } }, "description": "Dense ScaNN index configuration.", "id": "GoogleCloudVectorsearchV1betaDenseScannIndex" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec": { "type": "object", "properties": { "maxReplicaCount": { "type": "integer", "format": "int32", "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`." }, "minReplicaCount": { "type": "integer", "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`." } }, "description": "Specification for autoscaling.", "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec" }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse": { "type": "object", "properties": { "aggregateResults": { "type": "array", "description": "Output only. The aggregated results of the query.", "readOnly": true, "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "description": "Response message for DataObjectSearchService.AggregateDataObjects.", "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructure": { "type": "object", "properties": { "mode": { "description": "Optional. Mode of the dedicated infrastructure.", "enumDescriptions": [ "Default will use `PERFORMANCE_OPTIMIZED`.", "This is storage optimized variation.", "This is Performance optimized on E2 or equivalent family." ], "enum": [ "MODE_UNSPECIFIED", "STORAGE_OPTIMIZED", "PERFORMANCE_OPTIMIZED" ], "type": "string" }, "autoscalingSpec": { "description": "Optional. Autoscaling specification.", "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec" } }, "description": "Represents dedicated infrastructure for the index.", "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest": { "properties": { "searches": { "type": "array", "description": "Required. A list of search requests to execute in parallel.", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearch" } }, "combine": { "description": "Optional. Options for combining the results of the batch search operations.", "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest", "description": "A request to perform a batch of search operations." }, "GoogleCloudVectorsearchV1betaTextSearch": { "description": "Defines a text search operation.", "id": "GoogleCloudVectorsearchV1betaTextSearch", "type": "object", "properties": { "topK": { "type": "integer", "description": "Optional. The number of results to return.", "format": "int32" }, "dataFieldNames": { "type": "array", "description": "Optional. The data field names to search. Required when using the default text search mode.", "items": { "type": "string" } }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. The fields to return in the search results." }, "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" }, "searchText": { "description": "Optional. The query text. Required when using the default text search mode.", "type": "string" } } }, "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest": { "properties": { "filter": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. Mask specifying which fields to return." }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.", "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest", "description": "Request message for DataObjectSearchService.QueryDataObjects." }, "GoogleCloudVectorsearchV1betaRanker": { "description": "Defines a ranker to combine results from multiple searches.", "id": "GoogleCloudVectorsearchV1betaRanker", "type": "object", "properties": { "rrf": { "$ref": "GoogleCloudVectorsearchV1betaReciprocalRankFusion", "description": "Reciprocal Rank Fusion ranking." }, "vertexRanker": { "$ref": "GoogleCloudVectorsearchV1betaVertexRanker", "description": "Optional. Vertex AI ranking." } } }, "GoogleCloudVectorsearchV1betaSearch": { "id": "GoogleCloudVectorsearchV1betaSearch", "description": "A single search request within a batch operation.", "properties": { "vectorSearch": { "$ref": "GoogleCloudVectorsearchV1betaVectorSearch", "description": "A vector-based search." }, "textSearch": { "description": "A text search operation.", "$ref": "GoogleCloudVectorsearchV1betaTextSearch" }, "semanticSearch": { "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch", "description": "A semantic search." } }, "type": "object" }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest": { "description": "Request message for DataObjectService.BatchCreateDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest", "type": "object", "properties": { "requests": { "type": "array", "description": "Required. The request message specifying the resources to create. A maximum of 1000 DataObjects can be created in a batch.", "items": { "$ref": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest" } } } }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination": { "type": "object", "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": { "type": "string", "enumDescriptions": [ "Unspecified format.", "Deprecated: Exports Data Objects in `JSON` format. Use `JSONL` instead.", "Exports Data Objects in `JSONL` format." ], "enumDeprecated": [ false, true, false ], "enum": [ "FORMAT_UNSPECIFIED", "JSON", "JSONL" ], "description": "Required. The format of the exported Data Objects." } }, "description": "Google Cloud Storage configuration for the export.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination" }, "GoogleCloudVectorsearchV1betaDenseVectorField": { "properties": { "dimensions": { "format": "int32", "description": "Dimensionality of the vector field.", "type": "integer" }, "vertexEmbeddingConfig": { "description": "Optional. Configuration for generating embeddings for the vector field. If not specified, the embedding field must be populated in the DataObject.", "$ref": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaDenseVectorField", "description": "Message describing a dense vector field." }, "GoogleCloudVectorsearchV1betaVectorField": { "type": "object", "properties": { "denseVector": { "description": "Dense vector field.", "$ref": "GoogleCloudVectorsearchV1betaDenseVectorField" }, "sparseVector": { "description": "Sparse vector field.", "$ref": "GoogleCloudVectorsearchV1betaSparseVectorField" } }, "description": "Message describing a vector field.", "id": "GoogleCloudVectorsearchV1betaVectorField" }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", "type": "object", "properties": {} }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse", "description": "A response from a batch search operation.", "properties": { "results": { "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, "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" }, "type": "array" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequest": { "description": "Request message for VectorSearchService.ImportDataObjects.", "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest", "type": "object", "properties": { "gcsImport": { "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig", "description": "The Cloud Storage location of the input content." } } }, "GoogleCloudVectorsearchV1betaDenseVector": { "type": "object", "properties": { "values": { "type": "array", "description": "Required. The values of the vector.", "items": { "format": "float", "type": "number" } } }, "description": "A dense vector.", "id": "GoogleCloudVectorsearchV1betaDenseVector" }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequest": { "type": "object", "properties": { "gcsDestination": { "description": "The Cloud Storage location where user wants to export Data Objects.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination" }, "fieldFilter": { "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`.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter" } }, "description": "Request message for VectorSearchService.ExportDataObjects.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest" }, "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest": { "type": "object", "properties": { "requests": { "description": "Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.", "items": { "$ref": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest" }, "type": "array" } }, "description": "Request message for DataObjectService.BatchDeleteDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest" }, "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec": { "properties": { "query": { "description": "Required. The query against which the records are ranked and scored.", "type": "string" }, "contentTemplate": { "description": "Optional. The template used to generate the record's content.", "type": "string" }, "titleTemplate": { "description": "Optional. The template used to generate the record's title.", "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec", "description": "The record spec for text search." }, "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); }", "id": "Empty", "type": "object", "properties": {} }, "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig": { "type": "object", "properties": { "modelId": { "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.", "type": "string" }, "textTemplate": { "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}\".", "type": "string" }, "taskType": { "description": "Required. Required: Task type for the embeddings.", "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": "Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.", "id": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig" }, "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest": { "type": "object", "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": "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest" } } }, "description": "Request message for DataObjectService.BatchUpdateDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest" }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter": { "description": "Selects which top-level Data Object fields are emitted at export time.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter", "type": "object", "properties": { "includedFields": { "description": "Optional. Only these top-level fields will appear in each exported record.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList" }, "excludedFields": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList", "description": "Optional. Every top-level field except these will appear in each exported record." } } }, "GoogleCloudVectorsearchV1betaReciprocalRankFusion": { "description": "Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.", "id": "GoogleCloudVectorsearchV1betaReciprocalRankFusion", "type": "object", "properties": { "weights": { "type": "array", "description": "Required. The weights to apply to each search result set during fusion.", "items": { "format": "double", "type": "number" } } } }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList": { "properties": { "fields": { "description": "Required. The list of top-level Data Object JSON field names. Allowed values are `id`, `data`, `vectors`, `etag`.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList", "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\"." }, "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse": { "properties": { "dataObjects": { "type": "array", "description": "Output only. The list of dataObjects that match the query.", "readOnly": true, "items": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "nextPageToken": { "type": "string", "description": "Output only. A token to retrieve next page of results. Pass to DataObjectSearchService.QueryDataObjectsRequest.page_token to obtain that page.", "readOnly": true } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse", "description": "Response message for DataObjectSearchService.QueryDataObjects." }, "GoogleCloudVectorsearchV1betaOutputFields": { "type": "object", "properties": { "dataFields": { "description": "Optional. The fields from the data fields to include in the output.", "items": { "type": "string" }, "type": "array" }, "metadataFields": { "type": "array", "description": "Optional. The fields from the DataObject metadata to include in the output.", "items": { "type": "string" } }, "vectorFields": { "description": "Optional. The fields from the vector fields to include in the output.", "items": { "type": "string" }, "type": "array" } }, "description": "Defines a output fields struct for data in DataObject.", "id": "GoogleCloudVectorsearchV1betaOutputFields" }, "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest": { "type": "object", "properties": { "name": { "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "type": "string" }, "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" } }, "description": "Request message for DataObjectService.DeleteDataObject.", "id": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions", "description": "Options for combining the results of the batch search operations.", "properties": { "ranker": { "$ref": "GoogleCloudVectorsearchV1betaRanker", "description": "Required. The ranker to use for combining the results." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "topK": { "type": "integer", "format": "int32", "description": "Optional. The number of results to return. If not set, a default value will be used." } }, "type": "object" } }, "parameters": { "callback": { "description": "JSONP", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "location": "query", "description": "Data format for response.", "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "enum": [ "json", "media", "proto" ] }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "quotaUser": { "type": "string", "location": "query", "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." }, "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", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" } }, "kind": "discovery#restDescription", "ownerDomain": "google.com", "canonicalName": "Vector Search", "basePath": "", "mtlsRootUrl": "https://vectorsearch.mtls.googleapis.com/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "version_module": true, "id": "vectorsearch:v1beta", "title": "Vector Search API" }