{ "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "ownerName": "Google", "revision": "20260930", "servicePath": "", "resources": { "projects": { "resources": { "locations": { "resources": { "collections": { "resources": { "dataObjects": { "methods": { "create": { "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "description": "Creates a dataObject.", "path": "v1beta/{+parent}/dataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path" }, "dataObjectId": { "location": "query", "type": "string", "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])?`." } }, "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "parameterOrder": [ "parent" ], "id": "vectorsearch.projects.locations.collections.dataObjects.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects", "httpMethod": "POST" }, "aggregate": { "response": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse" }, "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path" } }, "request": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest" }, "description": "Aggregates data objects.", "id": "vectorsearch.projects.locations.collections.dataObjects.aggregate", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/dataObjects:aggregate", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:aggregate", "parameterOrder": [ "parent" ] }, "batchUpdate": { "description": "Updates dataObjects in a batch.", "path": "v1beta/{+parent}/dataObjects:batchUpdate", "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse" }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchUpdate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "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 } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchUpdate", "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "id": "vectorsearch.projects.locations.collections.dataObjects.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets a data object.", "path": "v1beta/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the DataObject resource. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`" } }, "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "batchDelete": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchDelete", "id": "vectorsearch.projects.locations.collections.dataObjects.batchDelete", "description": "Deletes dataObjects in a batch.", "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the Collection to delete the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "response": { "$ref": "Empty" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:batchDelete" }, "search": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`" } }, "parameterOrder": [ "parent" ], "description": "Searches data objects.", "path": "v1beta/{+parent}/dataObjects:search", "id": "vectorsearch.projects.locations.collections.dataObjects.search", "request": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest" }, "response": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" } }, "delete": { "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "path": "v1beta/{+name}", "description": "Deletes a dataObject.", "parameters": { "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." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "required": true, "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.dataObjects.delete" }, "batchSearch": { "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest" }, "parameterOrder": [ "parent" ], "description": "Batch searches data objects.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.dataObjects.batchSearch", "path": "v1beta/{+parent}/dataObjects:batchSearch", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchSearch" }, "query": { "response": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse" }, "parameterOrder": [ "parent" ], "description": "Queries data objects.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.dataObjects.query", "request": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest" }, "parameters": { "parent": { "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path" } }, "path": "v1beta/{+parent}/dataObjects:query", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:query", "httpMethod": "POST" }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "id": "vectorsearch.projects.locations.collections.dataObjects.patch", "httpMethod": "PATCH", "parameters": { "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", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true }, "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.", "path": "v1beta/{+name}", "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "batchCreate": { "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse" }, "description": "Creates a batch of dataObjects.", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest" }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchCreate", "parameters": { "parent": { "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.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$" } }, "path": "v1beta/{+parent}/dataObjects:batchCreate", "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] } } }, "indexes": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "description": "Gets details of a single Index.", "parameters": { "name": { "location": "path", "description": "Required. Name of the resource", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$" } }, "id": "vectorsearch.projects.locations.collections.indexes.get", "response": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "path": "v1beta/{+name}" }, "create": { "id": "vectorsearch.projects.locations.collections.indexes.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/indexes", "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the Collection for which to create the Index. Format: `projects/{project}/locations/{location}/collections/{collection}`" }, "indexId": { "location": "query", "type": "string", "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)." } }, "parameterOrder": [ "parent" ], "description": "Creates a new Index in a given project and location.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "vectorsearch.projects.locations.collections.indexes.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "parameters": { "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results" }, "parent": { "required": true, "description": "Required. Parent value for ListIndexesRequest", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "location": "path" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" } }, "path": "v1beta/{+parent}/indexes", "description": "Lists Indexes in a given project and location.", "response": { "$ref": "GoogleCloudVectorsearchV1betaListIndexesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the Index to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "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)." } }, "path": "v1beta/{+name}", "id": "vectorsearch.projects.locations.collections.indexes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a single Index." }, "patch": { "parameters": { "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)." }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "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." }, "name": { "description": "Identifier. name of resource", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$" } }, "httpMethod": "PATCH", "path": "v1beta/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Index.", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "id": "vectorsearch.projects.locations.collections.indexes.patch" } } } }, "methods": { "patch": { "path": "v1beta/{+name}", "parameters": { "name": { "description": "Identifier. name of resource", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" }, "updateMask": { "type": "string", "location": "query", "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": { "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)." } }, "description": "Updates the parameters of a single Collection.", "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "id": "vectorsearch.projects.locations.collections.patch" }, "list": { "parameters": { "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" }, "filter": { "description": "Optional. Filtering results", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "parent": { "description": "Required. Parent value for ListCollectionsRequest", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "description": "Lists Collections in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "vectorsearch.projects.locations.collections.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaListCollectionsResponse" }, "path": "v1beta/{+parent}/collections" }, "importDataObjects": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the Collection to import DataObjects into. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}:importDataObjects", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:importDataObjects", "id": "vectorsearch.projects.locations.collections.importDataObjects", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest" }, "description": "Initiates a Long-Running Operation to import DataObjects into a Collection." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.collections.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path" }, "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)." }, "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.)" } }, "description": "Deletes a single Collection." }, "exportDataObjects": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}:exportDataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Initiates a Long-Running Operation to export DataObjects from a Collection.", "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.exportDataObjects", "request": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:exportDataObjects", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "description": "Required. The resource name of the Collection from which we want to export Data Objects. Format: `projects/{project}/locations/{location}/collections/{collection}`." } } }, "get": { "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets details of a single Collection.", "id": "vectorsearch.projects.locations.collections.get", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaCollection" } }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a new Collection in a given project and location.", "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "parameters": { "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", "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" }, "parent": { "required": true, "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta/{+parent}/collections", "id": "vectorsearch.projects.locations.collections.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections" } } }, "operations": { "methods": { "list": { "parameters": { "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "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": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "vectorsearch.projects.locations.operations.list", "path": "v1beta/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "get": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "id": "vectorsearch.projects.locations.operations.get", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "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.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "vectorsearch.projects.locations.operations.delete", "httpMethod": "DELETE", "path": "v1beta/{+name}", "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`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true } } }, "cancel": { "response": { "$ref": "Empty" }, "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "id": "vectorsearch.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "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", "path": "v1beta/{+name}:cancel", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled." } } } } } }, "methods": { "list": { "parameterOrder": [ "name" ], "path": "v1beta/{+name}/locations", "flatPath": "v1beta/projects/{projectsId}/locations", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32", "location": "query" }, "filter": { "location": "query", "type": "string", "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)." }, "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "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" } }, "httpMethod": "GET", "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.", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "id": "vectorsearch.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudLocationLocation" }, "description": "Gets information about a location.", "path": "v1beta/{+name}", "id": "vectorsearch.projects.locations.get", "parameters": { "name": { "type": "string", "required": true, "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" } } } } } }, "baseUrl": "https://vectorsearch.googleapis.com/", "ownerDomain": "google.com", "basePath": "", "rootUrl": "https://vectorsearch.googleapis.com/", "protocol": "rest", "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." } } } }, "fullyEncodeReservedExpansion": true, "batchPath": "batch", "mtlsRootUrl": "https://vectorsearch.mtls.googleapis.com/", "endpoints": [ { "location": "us", "description": "Regional Endpoint", "endpointUrl": "https://vectorsearch.us.rep.googleapis.com/" } ], "id": "vectorsearch:v1beta", "kind": "discovery#restDescription", "canonicalName": "Vector Search", "documentationLink": "https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview", "title": "Vector Search API", "name": "vectorsearch", "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.", "discoveryVersion": "v1", "schemas": { "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse", "properties": { "results": { "readOnly": true, "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.", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" }, "type": "array" } }, "type": "object", "description": "A response from a batch search operation." }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination": { "type": "object", "description": "Google Cloud Storage configuration for the export.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination", "properties": { "format": { "enumDeprecated": [ false, true, false ], "enum": [ "FORMAT_UNSPECIFIED", "JSON", "JSONL" ], "description": "Required. The format of the exported Data Objects.", "enumDescriptions": [ "Unspecified format.", "Deprecated: Exports Data Objects in `JSON` format. Use `JSONL` instead.", "Exports Data Objects in `JSONL` format." ], "type": "string" }, "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" } } }, "GoogleCloudVectorsearchV1betaSparseVector": { "type": "object", "description": "A sparse vector.", "properties": { "values": { "description": "Required. The values of the vector.", "type": "array", "items": { "type": "number", "format": "float" } }, "indices": { "type": "array", "description": "Required. The corresponding indices for the values.", "items": { "type": "integer", "format": "int32" } } }, "id": "GoogleCloudVectorsearchV1betaSparseVector" }, "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest", "type": "object", "properties": { "requests": { "items": { "$ref": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest" }, "type": "array", "description": "Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch." } }, "description": "Request message for DataObjectService.BatchDeleteDataObjects." }, "GoogleCloudVectorsearchV1betaOutputFields": { "type": "object", "id": "GoogleCloudVectorsearchV1betaOutputFields", "properties": { "dataFields": { "type": "array", "description": "Optional. The fields from the data fields to include in the output.", "items": { "type": "string" } }, "metadataFields": { "type": "array", "description": "Optional. The fields from the DataObject metadata to include in the output.", "items": { "type": "string" } }, "vectorFields": { "items": { "type": "string" }, "type": "array", "description": "Optional. The fields from the vector fields to include in the output." } }, "description": "Defines a output fields struct for data in DataObject." }, "GoogleCloudVectorsearchV1betaSparseVectorField": { "description": "Message describing a sparse vector field.", "type": "object", "properties": {}, "id": "GoogleCloudVectorsearchV1betaSparseVectorField" }, "GoogleCloudVectorsearchV1betaCollection": { "properties": { "vectorSchema": { "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1betaVectorField" }, "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.", "type": "object" }, "displayName": { "description": "Optional. User-specified display name of the collection", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. [Output only] Create time stamp", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime", "type": "string" }, "description": { "description": "Optional. User-specified description of the collection", "type": "string" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "dataSchema": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "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)." }, "encryptionSpec": { "$ref": "GoogleCloudVectorsearchV1betaEncryptionSpec", "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." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs." }, "schema": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "deprecated": true, "type": "object", "description": "Optional. Deprecated: JSON Schema for data. Please use data_schema instead." } }, "id": "GoogleCloudVectorsearchV1betaCollection", "type": "object", "description": "Message describing Collection object" }, "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse": { "properties": { "dataObjects": { "type": "array", "readOnly": true, "description": "Output only. The list of dataObjects that match the query.", "items": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } }, "nextPageToken": { "description": "Output only. A token to retrieve next page of results. Pass to DataObjectSearchService.QueryDataObjectsRequest.page_token to obtain that page.", "readOnly": true, "type": "string" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse", "description": "Response message for DataObjectSearchService.QueryDataObjects." }, "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse": { "properties": {}, "description": "Response message for DataObjectService.BatchUpdateDataObjects.", "type": "object", "id": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse" }, "GoogleCloudVectorsearchV1betaReciprocalRankFusion": { "properties": { "weights": { "description": "Required. The weights to apply to each search result set during fusion.", "type": "array", "items": { "format": "double", "type": "number" } } }, "id": "GoogleCloudVectorsearchV1betaReciprocalRankFusion", "description": "Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.", "type": "object" }, "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig": { "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" }, "taskType": { "description": "Optional. Optional: Task type for the embeddings. Required for text-only embedding models, see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/embeddings/task-types Not needed for multi modal embedding models, see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/embeddings/get-multimodal-embeddings#specify-task-instructions", "type": "string", "enum": [ "EMBEDDING_TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "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": "Optional. 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}\". Required when using the text-only path." } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig", "description": "Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API." }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest", "properties": { "aggregate": { "type": "string", "enumDescriptions": [ "Should not be used.", "Count the number of data objects that match the filter." ], "description": "Required. The aggregation method to apply to the query.", "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "COUNT" ] }, "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" } } }, "description": "Request message for DataObjectSearchService.AggregateDataObjects.", "type": "object" }, "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" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions": { "properties": { "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. Mask specifying which fields to return." }, "topK": { "description": "Optional. The number of results to return. If not set, a default value will be used.", "format": "int32", "type": "integer" }, "ranker": { "description": "Required. The ranker to use for combining the results.", "$ref": "GoogleCloudVectorsearchV1betaRanker" } }, "description": "Options for combining the results of the batch search operations.", "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResult": { "type": "object", "properties": { "distance": { "readOnly": true, "format": "double", "description": "Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.", "type": "number" }, "searchResultMetadata": { "description": "Output only. Quality signals for this result. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is `true`.", "$ref": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadata", "readOnly": true }, "dataObject": { "description": "Output only. The matching data object.", "$ref": "GoogleCloudVectorsearchV1betaDataObject", "readOnly": true } }, "description": "A single search result.", "id": "GoogleCloudVectorsearchV1betaSearchResult" }, "GoogleCloudVectorsearchV1betaVectorField": { "id": "GoogleCloudVectorsearchV1betaVectorField", "type": "object", "description": "Message describing a vector field.", "properties": { "sparseVector": { "description": "Sparse vector field.", "$ref": "GoogleCloudVectorsearchV1betaSparseVectorField" }, "denseVector": { "$ref": "GoogleCloudVectorsearchV1betaDenseVectorField", "description": "Dense vector field." } } }, "GoogleCloudLocationLocation": { "id": "GoogleCloudLocationLocation", "properties": { "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } }, "description": "A resource that represents a Google Cloud location.", "type": "object" }, "GoogleCloudVectorsearchV1betaSearch": { "description": "A single search request within a batch operation.", "type": "object", "properties": { "vectorSearch": { "description": "A vector-based search.", "$ref": "GoogleCloudVectorsearchV1betaVectorSearch" }, "semanticSearch": { "description": "A semantic search.", "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch" }, "textSearch": { "description": "A text search operation.", "$ref": "GoogleCloudVectorsearchV1betaTextSearch" } }, "id": "GoogleCloudVectorsearchV1betaSearch" }, "GoogleCloudVectorsearchV1betaIndex": { "properties": { "storeFields": { "type": "array", "description": "Optional. The fields to push into the index to enable inline data retrieval.", "items": { "type": "string" } }, "indexField": { "description": "Required. The collection schema field to index.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. [Output only] Create time stamp" }, "updateTime": { "type": "string", "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs.", "type": "object" }, "filterFields": { "items": { "type": "string" }, "description": "Optional. The fields to push into the index to enable fast ANN inline filtering.", "type": "array" }, "denseScann": { "$ref": "GoogleCloudVectorsearchV1betaDenseScannIndex", "description": "Optional. Dense ScaNN index." }, "distanceMetric": { "description": "Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.", "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" }, "dedicatedInfrastructure": { "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure", "description": "Optional. Dedicated infrastructure for the index." }, "description": { "description": "Optional. User-specified description of the index", "type": "string" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "displayName": { "description": "Optional. User-specified display name of the index", "type": "string" } }, "description": "Message describing Index object", "id": "GoogleCloudVectorsearchV1betaIndex", "type": "object" }, "GoogleCloudVectorsearchV1betaUnaryQuery": { "properties": { "op": { "enumDescriptions": [ "Default value. This value is unused.", "Negates the sub-query." ], "description": "Required. The unary operator to apply.", "enum": [ "OPERATOR_UNSPECIFIED", "NOT" ], "type": "string" }, "subQuery": { "$ref": "GoogleCloudVectorsearchV1betaStructuredQuery", "description": "Required. The sub-query the operator is applied to." } }, "description": "A query that applies a unary operator to a sub-query.", "id": "GoogleCloudVectorsearchV1betaUnaryQuery", "type": "object" }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "id": "GoogleCloudLocationListLocationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array", "description": "A list of locations that matches the specified filter in the request." } } }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList": { "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\".", "properties": { "fields": { "description": "Required. The list of top-level Data Object JSON field names. Allowed values are `id`, `data`, `vectors`, `etag`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudVectorsearchV1betaDenseVector": { "properties": { "values": { "description": "Required. The values of the vector.", "items": { "type": "number", "format": "float" }, "type": "array" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaDenseVector", "description": "A dense vector." }, "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataVertexRankerResult": { "id": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataVertexRankerResult", "type": "object", "properties": { "score": { "format": "double", "description": "Output only. The score of this data object after Vertex re-ranking.", "type": "number", "readOnly": true }, "rank": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The rank of this data object after Vertex re-ranking." } }, "description": "The rank and score assigned by the Vertex re-ranker." }, "GoogleCloudVectorsearchV1betaListCollectionsResponse": { "description": "Message for response to listing Collections", "type": "object", "id": "GoogleCloudVectorsearchV1betaListCollectionsResponse", "properties": { "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "collections": { "description": "The list of Collection", "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaCollection" } } } }, "GoogleCloudVectorsearchV1betaStructuredQuery": { "properties": { "combine": { "$ref": "GoogleCloudVectorsearchV1betaCombinedQuery", "description": "Optional. A query that combines multiple sub-queries with a boolean operator." }, "unary": { "description": "Optional. A query that applies a unary operator to a sub-query.", "$ref": "GoogleCloudVectorsearchV1betaUnaryQuery" }, "boost": { "format": "float", "type": "number", "description": "Optional. Optional multiplier applied to this query node's contribution to the final relevance score. Must be non-negative; if unset or 0, defaults to 1.0. Values greater than 1.0 increase its influence on ranking, values between 0.0 and 1.0 decrease it." }, "text": { "$ref": "GoogleCloudVectorsearchV1betaTextQuery", "description": "Optional. A leaf-level text query." } }, "id": "GoogleCloudVectorsearchV1betaStructuredQuery", "type": "object", "description": "A structured query for text search. Allows expressing field-targeted text queries combined via boolean operators, with optional per-node boosting." }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestBatchSearchMetadataOptions": { "properties": { "searchSignalsEnabled": { "description": "Optional. If `true`, per-result quality signals are returned in SearchResult.search_result_metadata.", "type": "boolean" } }, "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestBatchSearchMetadataOptions", "description": "Options controlling which metadata is included in the search results.", "type": "object" }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig": { "description": "Google Cloud Storage configuration for the import.", "properties": { "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." }, "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" } }, "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig", "type": "object" }, "GoogleCloudVectorsearchV1betaEncryptionSpec": { "type": "object", "description": "Represents a customer-managed encryption key specification that can be applied to a Vector Search collection.", "id": "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" } } }, "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadata": { "description": "Quality signals describing how this result was retrieved, combined and re-ranked. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is `true`.", "id": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadata", "type": "object", "properties": { "searchDistances": { "description": "Output only. The per-search distances for this data object, one entry per batch search that returned it.", "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataSearchDistance" }, "readOnly": true }, "rrfRankerResult": { "$ref": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataRrfRankerResult", "description": "Output only. The RRF combination signals for this data object. Only set when the request combines results using RRF.", "readOnly": true }, "vertexRankerResult": { "$ref": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataVertexRankerResult", "readOnly": true, "description": "Output only. The Vertex re-ranking signals for this data object. Only set when the request re-ranks results using the Vertex ranker." } } }, "GoogleCloudVectorsearchV1betaListIndexesResponse": { "description": "Message for response to listing Indexes", "properties": { "indexes": { "description": "The list of Index", "items": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "id": "GoogleCloudVectorsearchV1betaListIndexesResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructure": { "type": "object", "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure", "description": "Represents dedicated infrastructure for the index.", "properties": { "autoscalingSpec": { "description": "Optional. Autoscaling specification.", "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec" }, "mode": { "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", "description": "Optional. Mode of the dedicated infrastructure." } } }, "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest": { "id": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest", "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" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest", "type": "object", "properties": { "requests": { "items": { "$ref": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest" }, "description": "Required. The request message specifying the resources to create. A maximum of 1000 DataObjects can be created in a batch.", "type": "array" } }, "description": "Request message for DataObjectService.BatchCreateDataObjects." }, "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest": { "description": "Request for performing a single search.", "properties": { "semanticSearch": { "description": "A semantic search operation.", "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.", "type": "string" }, "pageSize": { "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.", "format": "int32" }, "textSearch": { "description": "Optional. A text search operation.", "$ref": "GoogleCloudVectorsearchV1betaTextSearch" }, "vectorSearch": { "$ref": "GoogleCloudVectorsearchV1betaVectorSearch", "description": "A vector search operation." } }, "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest", "type": "object" }, "GoogleLongrunningCancelOperationRequest": { "type": "object", "properties": {}, "id": "GoogleLongrunningCancelOperationRequest", "description": "The request message for Operations.CancelOperation." }, "GoogleCloudVectorsearchV1betaRanker": { "id": "GoogleCloudVectorsearchV1betaRanker", "description": "Defines a ranker to combine results from multiple searches.", "properties": { "rrf": { "$ref": "GoogleCloudVectorsearchV1betaReciprocalRankFusion", "description": "Reciprocal Rank Fusion ranking." }, "vertexRanker": { "description": "Optional. Vertex AI ranking.", "$ref": "GoogleCloudVectorsearchV1betaVertexRanker" } }, "type": "object" }, "Empty": { "properties": {}, "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", "id": "Empty" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest", "type": "object", "description": "A request to perform a batch of search operations.", "properties": { "combine": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions", "description": "Optional. Options for combining the results of the batch search operations." }, "searches": { "description": "Required. A list of search requests to execute in parallel.", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearch" }, "type": "array" }, "metadataOptions": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestBatchSearchMetadataOptions", "description": "Optional. Options controlling which metadata is included in the search results." } } }, "GoogleCloudVectorsearchV1betaQueryEnhancement": { "description": "Query enhancement settings. When enabled, expands the search terms with stemming, synonyms, and spelling corrections, and removes stop words.", "type": "object", "properties": { "languageCode": { "description": "Optional. The IETF BCP 47 language tag, such as \"en-US\", for query enhancement. If unset, the language is detected automatically. See .", "type": "string" }, "enabled": { "description": "Optional. Whether query enhancement is enabled.", "type": "boolean" } }, "id": "GoogleCloudVectorsearchV1betaQueryEnhancement" }, "GoogleCloudVectorsearchV1betaTextQuery": { "description": "A leaf-level text query targeting one or more data fields. When multiple fields are specified, this is equivalent to combining per-field matches with an OR operator (i.e. the query matches if the text is found in any of the listed fields).", "id": "GoogleCloudVectorsearchV1betaTextQuery", "properties": { "text": { "description": "Required. The text to search for.", "type": "string" }, "queryEnhancement": { "$ref": "GoogleCloudVectorsearchV1betaQueryEnhancement", "description": "Optional. The query enhancement settings to apply for this query." }, "fields": { "items": { "type": "string" }, "description": "Required. The data fields to search against.", "type": "array" }, "matchType": { "type": "string", "description": "Optional. The matching strategy to apply for this query. If unset, defaults to `STANDARD`.", "enumDescriptions": [ "Defaults to `STANDARD`.", "Treats `text` as individual search terms combined with an implicit AND: every term must appear in the field, in any order and any position. Case-insensitive.", "Matches only when the entire field value is exactly equal to `text`." ], "enum": [ "MATCH_TYPE_UNSPECIFIED", "TEXT", "EXACT" ] } }, "type": "object" }, "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest": { "description": "Request message for DataObjectSearchService.QueryDataObjects.", "type": "object", "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest", "properties": { "pageSize": { "type": "integer", "description": "Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32" }, "filter": { "type": "object", "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." } }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.", "type": "string" }, "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. Mask specifying which fields to return." } } }, "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest": { "type": "object", "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.", "type": "string", "format": "google-fieldmask" } }, "id": "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest", "description": "Request message for DataObjectService.UpdateDataObject." }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest", "type": "object", "description": "Request message for VectorSearchService.ImportDataObjects.", "properties": { "gcsImport": { "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig", "description": "The Cloud Storage location of the input content." } } }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest", "type": "object", "description": "Request message for VectorSearchService.ExportDataObjects.", "properties": { "gcsDestination": { "description": "The Cloud Storage location where user wants to export Data Objects.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination" }, "fieldFilter": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter", "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`." } } }, "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse": { "description": "Response for a search request.", "type": "object", "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse", "properties": { "searchResponseMetadata": { "readOnly": true, "description": "Output only. Metadata about the search execution.", "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadata" }, "nextPageToken": { "description": "Output only. A token to retrieve next page of results. Pass to DataObjectSearchService.SearchDataObjectsRequest.page_token to obtain that page.", "readOnly": true, "type": "string" }, "results": { "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchResult" }, "description": "Output only. The list of dataObjects that match the search criteria.", "readOnly": true, "type": "array" } } }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse", "properties": { "aggregateResults": { "description": "Output only. The aggregated results of the query.", "items": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "readOnly": true, "type": "array" } }, "description": "Response message for DataObjectSearchService.AggregateDataObjects.", "type": "object" }, "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" }, "error": { "$ref": "GoogleRpcStatus", "description": "The error result of the operation in case of failure or cancellation." }, "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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." } }, "id": "GoogleLongrunningOperation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "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", "id": "GoogleRpcStatus", "properties": { "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" }, "details": { "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } } }, "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataRrfRankerResult": { "properties": { "rank": { "format": "int32", "description": "Output only. The rank of this data object after RRF combination.", "type": "integer", "readOnly": true }, "score": { "description": "Output only. The score of this data object after RRF combination.", "readOnly": true, "type": "number", "format": "double" } }, "type": "object", "description": "The rank and score assigned by the Reciprocal Rank Fusion ranker when combining the results of the batch searches.", "id": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataRrfRankerResult" }, "GoogleCloudVectorsearchV1betaDenseVectorField": { "description": "Message describing a dense vector field.", "properties": { "dimensions": { "format": "int32", "description": "Dimensionality of the vector field.", "type": "integer" }, "vertexEmbeddingConfig": { "$ref": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig", "description": "Optional. Configuration for generating embeddings for the vector field. If not specified, the embedding field must be populated in the DataObject." } }, "id": "GoogleCloudVectorsearchV1betaDenseVectorField", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResponseMetadata": { "type": "object", "description": "Metadata about the search execution.", "properties": { "warnings": { "type": "array", "description": "Output only. Warnings or non-fatal errors that occurred during execution.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true }, "usedIndex": { "description": "Indicates that the search used a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo" }, "usedKnn": { "description": "Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.", "readOnly": true, "type": "boolean" } }, "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadata" }, "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo": { "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo", "properties": { "name": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the index used for the search. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`" } }, "description": "Message that indicates the index used for the search.", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHintIndexHint": { "description": "Message to specify the index to use for the search.", "id": "GoogleCloudVectorsearchV1betaSearchHintIndexHint", "type": "object", "properties": { "denseScannParams": { "description": "Optional. Dense ScaNN parameters.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams" }, "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" } } }, "GoogleCloudVectorsearchV1betaSearchHint": { "id": "GoogleCloudVectorsearchV1betaSearchHint", "description": "Represents a hint to the search index engine.", "type": "object", "properties": { "useKnn": { "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.", "deprecated": true }, "knnHint": { "$ref": "GoogleCloudVectorsearchV1betaSearchHintKnnHint", "description": "Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine." }, "indexHint": { "description": "Optional. Specifies that the search should use a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint" }, "useIndex": { "deprecated": true, "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint", "description": "Optional. Deprecated: Use `index_hint` instead. Specifies that the search should use a particular index." } } }, "GoogleCloudVectorsearchV1betaTextSearch": { "id": "GoogleCloudVectorsearchV1betaTextSearch", "description": "Defines a text search operation.", "properties": { "dataFieldNames": { "type": "array", "description": "Optional. The data field names to search. Required when using the default text search mode.", "items": { "type": "string" } }, "outputFields": { "description": "Optional. The fields to return in the search results.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "structuredQuery": { "description": "Optional. Structured query definition. When set, `search_text` and `data_field_names` must be left empty; otherwise the request will be rejected with an `INVALID_ARGUMENT` error. Conversely, when `structured_query` is unset, both `search_text` and `data_field_names` are required.", "$ref": "GoogleCloudVectorsearchV1betaStructuredQuery" }, "searchText": { "description": "Optional. The query text. Required when using the default text search mode.", "type": "string" }, "topK": { "type": "integer", "description": "Optional. The number of results to return.", "format": "int32" }, "filter": { "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`.", "type": "object" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataSearchDistance": { "description": "The rank and distance of this data object within a single search of the batch.", "properties": { "distance": { "description": "Output only. The similarity distance of this data object for the search.", "readOnly": true, "type": "number", "format": "double" }, "rank": { "readOnly": true, "format": "int32", "description": "Output only. The order of this data object in the search's result list, starting at 1 for the top (best-ranked) result.", "type": "integer" }, "searchIndex": { "type": "integer", "readOnly": true, "description": "Output only. The index of the search in the BatchSearchDataObjectsRequest.searches this distance corresponds to.", "format": "int32" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaSearchResultSearchResultMetadataSearchDistance" }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter": { "description": "Selects which top-level Data Object fields are emitted at export time.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilter", "type": "object", "properties": { "excludedFields": { "description": "Optional. Every top-level field except these will appear in each exported record.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList" }, "includedFields": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestFieldFilterFieldList", "description": "Optional. Only these top-level fields will appear in each exported record." } } }, "GoogleCloudVectorsearchV1betaVector": { "id": "GoogleCloudVectorsearchV1betaVector", "description": "A vector which can be either dense or sparse.", "properties": { "sparse": { "$ref": "GoogleCloudVectorsearchV1betaSparseVector", "description": "A sparse vector." }, "values": { "items": { "type": "number", "format": "float" }, "deprecated": true, "type": "array", "description": "Deprecated: Use `dense` or `sparse` instead." }, "dense": { "description": "A dense vector.", "$ref": "GoogleCloudVectorsearchV1betaDenseVector" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse", "description": "Response message for DataObjectService.BatchCreateDataObjects.", "properties": { "dataObjects": { "readOnly": true, "items": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "description": "Output only. DataObjects created.", "type": "array" } }, "type": "object" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec": { "description": "Specification for autoscaling.", "type": "object", "properties": { "minReplicaCount": { "format": "int32", "type": "integer", "description": "Optional. The minimum number of replicas. If not set or set to `0`, defaults to `2`. Must be \u003e= `1` and \u003c= `1000`." }, "maxReplicaCount": { "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`.", "type": "integer" } }, "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec" }, "GoogleCloudVectorsearchV1betaDenseScannIndex": { "description": "Dense ScaNN index configuration.", "properties": { "featureNormType": { "type": "string", "description": "Optional. Feature norm type.", "enum": [ "FEATURE_NORM_TYPE_UNSPECIFIED", "NONE", "UNIT_L2_NORM" ], "enumDescriptions": [ "Unspecified feature norm type.", "No norm applied.", "Unit L2 norm." ] } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaDenseScannIndex" }, "GoogleCloudVectorsearchV1betaSemanticSearch": { "properties": { "outputFields": { "$ref": "GoogleCloudVectorsearchV1betaOutputFields", "description": "Optional. The fields to return in the search results." }, "searchText": { "type": "string", "description": "Optional. The query text, which is used to generate an embedding according to the embedding model specified in the collection config. Required when using the text search mode." }, "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." }, "topK": { "description": "Optional. The number of data objects to return.", "type": "integer", "format": "int32" }, "taskType": { "type": "string", "enum": [ "EMBEDDING_TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "description": "Optional. The task type of the query embedding. Must be specified for text-only embedding models, see Not needed for multi modal embedding models, see ", "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." ] }, "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." } }, "type": "object", "description": "Defines a semantic search operation.", "id": "GoogleCloudVectorsearchV1betaSemanticSearch" }, "GoogleLongrunningListOperationsResponse": { "properties": { "unreachable": { "type": "array", "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" } }, "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" } } }, "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHintKnnHint": { "id": "GoogleCloudVectorsearchV1betaSearchHintKnnHint", "properties": {}, "type": "object", "description": "KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine." }, "GoogleCloudVectorsearchV1betaCreateDataObjectRequest": { "description": "Request message for DataObjectService.CreateDataObject.", "type": "object", "id": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest", "properties": { "dataObject": { "description": "Required. The DataObject to create.", "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "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" } } }, "GoogleCloudVectorsearchV1betaDataObject": { "properties": { "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" }, "data": { "type": "object", "description": "Optional. The data of the dataObject.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "etag": { "type": "string", "description": "Optional. The etag of the dataObject." }, "createTime": { "readOnly": true, "description": "Output only. Timestamp the dataObject was created at.", "type": "string", "format": "google-datetime" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp the dataObject was last updated." }, "dataObjectId": { "type": "string", "description": "Output only. The id of the dataObject.", "readOnly": true }, "vectors": { "description": "Optional. The vectors of the dataObject.", "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1betaVector" }, "type": "object" } }, "description": "A dataObject resource in Vector Search.", "id": "GoogleCloudVectorsearchV1betaDataObject", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams": { "description": "Parameters for dense ScaNN.", "type": "object", "properties": { "initialCandidateCount": { "description": "Optional. The number of initial candidates. Must be a positive integer (\u003e 0). Not supported for `STORAGE_OPTIMIZED` indexes. Cannot be set together with `target_recall`.", "type": "integer", "format": "int32" }, "targetRecall": { "format": "double", "type": "number", "description": "Optional. The target recall for the search. Must be a double in the range [0, 1]. While the search aims to achieve this level of recall, it is not guaranteed." }, "searchLeavesPct": { "format": "int32", "type": "integer", "description": "Optional. Dense ANN param overrides to control recall and latency. The percentage of leaves to search, in the range [0, 100]. Not supported for `STORAGE_OPTIMIZED` indexes. Cannot be set together with `target_recall`." } }, "id": "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams" }, "GoogleCloudVectorsearchV1betaCombinedQuery": { "properties": { "subQueries": { "type": "array", "description": "Required. The sub-queries to be combined.", "items": { "$ref": "GoogleCloudVectorsearchV1betaStructuredQuery" } }, "op": { "enum": [ "OPERATOR_UNSPECIFIED", "AND", "OR" ], "enumDescriptions": [ "Default value. This value is unused.", "All sub-queries must match.", "At least one sub-query must match." ], "type": "string", "description": "Required. The boolean operator used to combine the sub-queries." } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaCombinedQuery", "description": "A query that combines multiple sub-queries with a boolean operator." }, "GoogleCloudVectorsearchV1betaOperationMetadata": { "properties": { "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "requestedCancellation": { "readOnly": true, "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`." }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudVectorsearchV1betaOperationMetadata", "type": "object" }, "GoogleCloudVectorsearchV1betaVertexRanker": { "properties": { "topN": { "description": "Required. The number of documents to be processed for ranking.", "type": "integer", "format": "int32" }, "textRecordSpec": { "$ref": "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec", "description": "The record spec for text search." }, "model": { "type": "string", "description": "Required. The model used for ranking documents. The list of available models is described in . Currently, only `semantic-ranker-fast@latest` is supported." } }, "type": "object", "description": "Defines a ranker using the Vertex AI ranking service. See for details.", "id": "GoogleCloudVectorsearchV1betaVertexRanker" }, "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec": { "properties": { "titleTemplate": { "type": "string", "description": "Optional. The template used to generate the record's title." }, "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" } }, "type": "object", "id": "GoogleCloudVectorsearchV1betaVertexRankerTextRecordSpec", "description": "The record spec for text search." }, "GoogleCloudVectorsearchV1betaVectorSearch": { "description": "Defines a search operation using a query vector.", "id": "GoogleCloudVectorsearchV1betaVectorSearch", "type": "object", "properties": { "vector": { "$ref": "GoogleCloudVectorsearchV1betaDenseVector", "description": "A dense vector for the query." }, "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" }, "topK": { "format": "int32", "description": "Optional. The number of nearest neighbors to return.", "type": "integer" }, "sparseVector": { "description": "A sparse vector for the query.", "$ref": "GoogleCloudVectorsearchV1betaSparseVector" }, "searchField": { "type": "string", "description": "Required. The vector field to search." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "distanceMetric": { "description": "Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.", "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" }, "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 the default KNN search otherwise." } } } }, "parameters": { "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "description": "V1 error format.", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "alt": { "description": "Data format for response.", "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" ], "type": "string", "location": "query", "default": "json" }, "quotaUser": { "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.", "type": "string" }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" } }, "version_module": true, "version": "v1beta" }