{ "version_module": true, "parameters": { "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response.", "type": "string", "default": "json", "enum": [ "json", "media", "proto" ] }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "$.xgafv": { "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "key": { "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." } }, "rootUrl": "https://vectorsearch.googleapis.com/", "documentationLink": "https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview", "version": "v1beta", "ownerName": "Google", "mtlsRootUrl": "https://vectorsearch.mtls.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "vectorsearch.projects.locations.operations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "Empty" }, "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`.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "vectorsearch.projects.locations.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } } }, "cancel": { "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "path": "v1beta/{+name}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "Empty" } }, "list": { "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "vectorsearch.projects.locations.operations.list", "parameters": { "name": { "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "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." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta/{+name}/operations", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } }, "collections": { "methods": { "list": { "path": "v1beta/{+parent}/collections", "description": "Lists Collections in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaListCollectionsResponse" }, "id": "vectorsearch.projects.locations.collections.list", "parameters": { "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. Parent value for ListCollectionsRequest", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "filter": { "description": "Optional. Filtering results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "importDataObjects": { "description": "Initiates a Long-Running Operation to import DataObjects into a Collection.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:importDataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest" }, "path": "v1beta/{+name}:importDataObjects", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "description": "Required. The resource name of the Collection to import DataObjects into. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", "type": "string" } }, "id": "vectorsearch.projects.locations.collections.importDataObjects", "httpMethod": "POST", "parameterOrder": [ "name" ] }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The following fields support update: `display_name`, `description`, `labels`, `data_schema`, `vector_schema`. For `data_schema` and `vector_schema`, fields can only be added, not deleted, but `vertex_embedding_config` in `vector_schema` can be added or removed. Partial updates for `data_schema` and `vector_schema` are also supported by using sub-field paths in `update_mask`, e.g. `data_schema.properties.foo` or `vector_schema.my_vector_field`. If `*` is provided in the update_mask, full replacement will be performed.", "location": "query" }, "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)." }, "name": { "location": "path", "description": "Identifier. name of resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates the parameters of a single Collection.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "path": "v1beta/{+name}" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Collection.", "path": "v1beta/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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)." }, "name": { "location": "path", "description": "Required. Name of the resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Collection in a given project and location.", "path": "v1beta/{+parent}/collections", "request": { "$ref": "GoogleCloudVectorsearchV1betaCollection" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "requestId": { "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).", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. Value for parent.", "type": "string" }, "collectionId": { "type": "string", "description": "Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.", "location": "query" } }, "id": "vectorsearch.projects.locations.collections.create" }, "exportDataObjects": { "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.exportDataObjects", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Collection from which we want to export Data Objects. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}:exportDataObjects", "request": { "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:exportDataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a Long-Running Operation to export DataObjects from a Collection." }, "get": { "parameters": { "name": { "type": "string", "description": "Required. Name of the resource", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Collection.", "path": "v1beta/{+name}", "response": { "$ref": "GoogleCloudVectorsearchV1betaCollection" } } }, "resources": { "dataObjects": { "methods": { "aggregate": { "request": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:aggregate", "description": "Aggregates data objects.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:aggregate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse" }, "id": "vectorsearch.projects.locations.collections.dataObjects.aggregate", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "httpMethod": "POST" }, "batchCreate": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.dataObjects.batchCreate", "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a batch of dataObjects.", "path": "v1beta/{+parent}/dataObjects:batchCreate", "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest" } }, "patch": { "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "path": "v1beta/{+name}", "description": "Updates a dataObject.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "id": "vectorsearch.projects.locations.collections.dataObjects.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).", "location": "path", "type": "string", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask." } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH" }, "batchUpdate": { "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:batchUpdate", "description": "Updates dataObjects in a batch.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchUpdate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.dataObjects.batchUpdate", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Collection to update the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`. The parent field in the UpdateDataObjectRequest messages must match this field." } } }, "search": { "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.dataObjects.search", "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Searches data objects.", "path": "v1beta/{+parent}/dataObjects:search", "request": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest" }, "response": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" } }, "create": { "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "description": "Creates a dataObject.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "path": "v1beta/{+parent}/dataObjects", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "dataObjectId": { "type": "string", "location": "query", "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])?`." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Collection to create the DataObject in. Format: `projects/{project}/locations/{location}/collections/{collection}`", "type": "string" } }, "id": "vectorsearch.projects.locations.collections.dataObjects.create" }, "batchSearch": { "response": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:batchSearch", "description": "Batch searches data objects.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchSearch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.dataObjects.batchSearch", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the Collection for which to search. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path" } } }, "delete": { "path": "v1beta/{+name}", "description": "Deletes a dataObject.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "id": "vectorsearch.projects.locations.collections.dataObjects.delete", "parameters": { "etag": { "type": "string", "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.", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE" }, "batchDelete": { "response": { "$ref": "Empty" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest" }, "path": "v1beta/{+parent}/dataObjects:batchDelete", "description": "Deletes dataObjects in a batch.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:batchDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.dataObjects.batchDelete", "parameters": { "parent": { "description": "Required. The resource name of the Collection to delete the DataObjects in. Format: `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true } } }, "query": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "description": "Required. The resource name of the Collection for which to query. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path", "type": "string" } }, "id": "vectorsearch.projects.locations.collections.dataObjects.query", "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects:query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Queries data objects.", "path": "v1beta/{+parent}/dataObjects:query", "request": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest" }, "response": { "$ref": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse" } }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "vectorsearch.projects.locations.collections.dataObjects.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataObjects/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the DataObject resource. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`", "type": "string" } }, "response": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataObjects/{dataObjectsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a data object." } } }, "indexes": { "methods": { "get": { "response": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "description": "Gets details of a single Index.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. Name of the resource", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.collections.indexes.get" }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "path": "v1beta/{+parent}/indexes", "description": "Creates a new Index in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "vectorsearch.projects.locations.collections.indexes.create", "parameters": { "requestId": { "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).", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "description": "Required. The resource name of the Collection for which to create the Index. Format: `projects/{project}/locations/{location}/collections/{collection}`", "location": "path", "type": "string" }, "indexId": { "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])?`.", "location": "query" } } }, "patch": { "id": "vectorsearch.projects.locations.collections.indexes.patch", "parameters": { "updateMask": { "description": "Optional. Specifies the fields to be overwritten in the Index resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request with non-empty values will be overwritten. The following fields support update: * `display_name` * `description` * `labels` * `dedicated_infrastructure.autoscaling_spec.min_replica_count` * `dedicated_infrastructure.autoscaling_spec.max_replica_count` If `*` is provided in the `update_mask`, full replacement of mutable fields will be performed.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "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).", "location": "query" }, "name": { "location": "path", "description": "Identifier. name of resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "path": "v1beta/{+name}", "request": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "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.", "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "vectorsearch.projects.locations.collections.indexes.delete", "parameters": { "name": { "description": "Required. The resource name of the Index to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/indexes/[^/]+$", "required": true }, "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" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta/{+name}", "description": "Deletes a single Index.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes/{indexesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "vectorsearch.projects.locations.collections.indexes.list", "parameters": { "parent": { "location": "path", "description": "Required. Parent value for ListIndexesRequest", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Hint for how to order the results" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "filter": { "type": "string", "description": "Optional. Filtering results", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "v1beta/{+parent}/indexes", "description": "Lists Indexes in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/indexes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudVectorsearchV1betaListIndexesResponse" } } } } } } }, "methods": { "get": { "parameters": { "name": { "description": "Resource name for the location.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "id": "vectorsearch.projects.locations.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "path": "v1beta/{+name}", "response": { "$ref": "GoogleCloudLocationLocation" } }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}/locations", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "parameters": { "name": { "type": "string", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } }, "id": "vectorsearch.projects.locations.list", "httpMethod": "GET", "parameterOrder": [ "name" ] } } } } } }, "protocol": "rest", "ownerDomain": "google.com", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "id": "vectorsearch:v1beta", "canonicalName": "Vector Search", "revision": "20260430", "discoveryVersion": "v1", "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.", "name": "vectorsearch", "schemas": { "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig": { "id": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig", "type": "object", "description": "Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.", "properties": { "textTemplate": { "type": "string", "description": "Required. Required: Text template for the input to the model. The template must contain one or more references to fields in the DataObject, e.g.: \"Movie Title: {title} ---- Movie Plot: {plot}\"." }, "modelId": { "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": "Required. Required: Task type for the embeddings.", "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." ], "type": "string" } } }, "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams": { "properties": { "searchLeavesPct": { "type": "integer", "format": "int32", "description": "Optional. Dense ANN param overrides to control recall and latency. The percentage of leaves to search, in the range [0, 100]." }, "initialCandidateCount": { "type": "integer", "format": "int32", "description": "Optional. The number of initial candidates. Must be a positive integer (\u003e 0)." } }, "description": "Parameters for dense ScaNN.", "id": "GoogleCloudVectorsearchV1betaSearchHintIndexHintDenseScannParams", "type": "object" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions", "type": "object", "properties": { "topK": { "type": "integer", "format": "int32", "description": "Optional. The number of results to return. If not set, a default value will be used." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "ranker": { "description": "Required. The ranker to use for combining the results.", "$ref": "GoogleCloudVectorsearchV1betaRanker" } }, "description": "Options for combining the results of the batch search operations." }, "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": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "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).", "id": "GoogleRpcStatus", "type": "object" }, "GoogleCloudVectorsearchV1betaListCollectionsResponse": { "properties": { "collections": { "description": "The list of Collection", "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaCollection" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Unordered list. Locations that could not be reached." } }, "description": "Message for response to listing Collections", "id": "GoogleCloudVectorsearchV1betaListCollectionsResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaVectorSearch": { "id": "GoogleCloudVectorsearchV1betaVectorSearch", "type": "object", "properties": { "distanceMetric": { "type": "string", "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ], "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" ] }, "searchHint": { "description": "Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.", "$ref": "GoogleCloudVectorsearchV1betaSearchHint" }, "vector": { "description": "A dense vector for the query.", "$ref": "GoogleCloudVectorsearchV1betaDenseVector" }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "topK": { "type": "integer", "format": "int32", "description": "Optional. The number of nearest neighbors to return." }, "searchField": { "description": "Required. The vector field to search.", "type": "string" }, "sparseVector": { "description": "A sparse vector for the query.", "$ref": "GoogleCloudVectorsearchV1betaSparseVector" }, "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." } }, "description": "Defines a search operation using a query vector." }, "GoogleCloudVectorsearchV1betaIndex": { "id": "GoogleCloudVectorsearchV1betaIndex", "type": "object", "description": "Message describing Index object", "properties": { "distanceMetric": { "type": "string", "enumDescriptions": [ "Default value, distance metric is not specified.", "Dot product distance metric.", "Cosine distance metric." ], "description": "Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.", "enum": [ "DISTANCE_METRIC_UNSPECIFIED", "DOT_PRODUCT", "COSINE_DISTANCE" ] }, "labels": { "description": "Optional. Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. [Output only] Create time stamp", "readOnly": true }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "storeFields": { "description": "Optional. The fields to push into the index to enable inline data retrieval.", "type": "array", "items": { "type": "string" } }, "indexField": { "type": "string", "description": "Required. The collection schema field to index." }, "name": { "type": "string", "description": "Identifier. name of resource" }, "displayName": { "type": "string", "description": "Optional. User-specified display name of the index" }, "description": { "type": "string", "description": "Optional. User-specified description of the index" }, "filterFields": { "description": "Optional. The fields to push into the index to enable fast ANN inline filtering.", "type": "array", "items": { "type": "string" } }, "dedicatedInfrastructure": { "description": "Optional. Dedicated infrastructure for the index.", "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure" }, "denseScann": { "description": "Optional. Dense ScaNN index.", "$ref": "GoogleCloudVectorsearchV1betaDenseScannIndex" } } }, "GoogleCloudVectorsearchV1betaRanker": { "properties": { "rrf": { "description": "Reciprocal Rank Fusion ranking.", "$ref": "GoogleCloudVectorsearchV1betaReciprocalRankFusion" } }, "description": "Defines a ranker to combine results from multiple searches.", "id": "GoogleCloudVectorsearchV1betaRanker", "type": "object" }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest": { "properties": { "filter": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "aggregate": { "type": "string", "description": "Required. The aggregation method to apply to the query.", "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "COUNT" ], "enumDescriptions": [ "Should not be used.", "Count the number of data objects that match the filter." ] } }, "description": "Request message for DataObjectSearchService.AggregateDataObjects.", "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHintIndexHint": { "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" } }, "description": "Message to specify the index to use for the search." }, "GoogleCloudVectorsearchV1betaCollection": { "properties": { "schema": { "description": "Optional. Deprecated: JSON Schema for data. Please use data_schema instead.", "deprecated": true, "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "name": { "description": "Identifier. name of resource", "type": "string" }, "displayName": { "type": "string", "description": "Optional. User-specified display name of the collection" }, "description": { "description": "Optional. User-specified description of the collection", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. [Output only] Update time stamp", "readOnly": true }, "createTime": { "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs." }, "dataSchema": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with [JSON Schema Draft 7](https://json-schema.org/draft-07/schema)." }, "encryptionSpec": { "description": "Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.", "$ref": "GoogleCloudVectorsearchV1betaEncryptionSpec" }, "vectorSchema": { "type": "object", "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." } }, "description": "Message describing Collection object", "id": "GoogleCloudVectorsearchV1betaCollection", "type": "object" }, "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest": { "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest" }, "description": "Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch." } }, "description": "Request message for DataObjectService.BatchUpdateDataObjects.", "id": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaVectorField": { "id": "GoogleCloudVectorsearchV1betaVectorField", "type": "object", "properties": { "denseVector": { "description": "Dense vector field.", "$ref": "GoogleCloudVectorsearchV1betaDenseVectorField" }, "sparseVector": { "description": "Sparse vector field.", "$ref": "GoogleCloudVectorsearchV1betaSparseVectorField" } }, "description": "Message describing a vector field." }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequest": { "description": "Request message for VectorSearchService.ExportDataObjects.", "properties": { "gcsDestination": { "description": "The Cloud Storage location where user wants to export Data Objects.", "$ref": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination" } }, "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse", "type": "object", "properties": { "searchResponseMetadata": { "description": "Output only. Metadata about the search execution.", "readOnly": true, "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadata" }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchResult" }, "description": "Output only. The list of dataObjects that match the search criteria.", "readOnly": true }, "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" } }, "description": "Response for a search request." }, "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse": { "description": "Response message for DataObjectSearchService.AggregateDataObjects.", "properties": { "aggregateResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "description": "Output only. The aggregated results of the query.", "readOnly": true } }, "id": "GoogleCloudVectorsearchV1betaAggregateDataObjectsResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchHint": { "properties": { "useIndex": { "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint", "description": "Optional. Deprecated: Use `index_hint` instead. Specifies that the search should use a particular index.", "deprecated": true }, "knnHint": { "description": "Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintKnnHint" }, "indexHint": { "description": "Optional. Specifies that the search should use a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchHintIndexHint" }, "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 } }, "description": "Represents a hint to the search index engine.", "id": "GoogleCloudVectorsearchV1betaSearchHint", "type": "object" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec": { "description": "Specification for autoscaling.", "properties": { "minReplicaCount": { "type": "integer", "format": "int32", "description": "Optional. The minimum number of replicas. If not set or set to `0`, defaults to `2`. Must be \u003e= `1` and \u003c= `1000`." }, "maxReplicaCount": { "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", "format": "int32" } }, "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec", "type": "object" }, "GoogleCloudVectorsearchV1betaDedicatedInfrastructure": { "id": "GoogleCloudVectorsearchV1betaDedicatedInfrastructure", "type": "object", "description": "Represents dedicated infrastructure for the index.", "properties": { "mode": { "description": "Optional. Mode of the dedicated infrastructure.", "enum": [ "MODE_UNSPECIFIED", "STORAGE_OPTIMIZED", "PERFORMANCE_OPTIMIZED" ], "enumDescriptions": [ "Default will use `PERFORMANCE_OPTIMIZED`.", "This is storage optimized variation.", "This is Performance optimized on E2 or equivalent family." ], "type": "string" }, "autoscalingSpec": { "description": "Optional. Autoscaling specification.", "$ref": "GoogleCloudVectorsearchV1betaDedicatedInfrastructureAutoscalingSpec" } } }, "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse": { "properties": { "dataObjects": { "description": "Output only. The list of dataObjects that match the query.", "readOnly": true, "type": "array", "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" } }, "description": "Response message for DataObjectSearchService.QueryDataObjects.", "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaDenseScannIndex": { "id": "GoogleCloudVectorsearchV1betaDenseScannIndex", "type": "object", "properties": { "featureNormType": { "type": "string", "enumDescriptions": [ "Unspecified feature norm type.", "No norm applied.", "Unit L2 norm." ], "description": "Optional. Feature norm type.", "enum": [ "FEATURE_NORM_TYPE_UNSPECIFIED", "NONE", "UNIT_L2_NORM" ] } }, "description": "Dense ScaNN index configuration." }, "GoogleCloudVectorsearchV1betaOperationMetadata": { "properties": { "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "requestedCancellation": { "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudVectorsearchV1betaOperationMetadata", "type": "object" }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequest", "type": "object", "description": "A request to perform a batch of search operations.", "properties": { "searches": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearch" }, "description": "Required. A list of search requests to execute in parallel." }, "combine": { "description": "Optional. Options for combining the results of the batch search operations.", "$ref": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsRequestCombineResultsOptions" } } }, "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaQueryDataObjectsRequest", "type": "object", "description": "Request message for DataObjectSearchService.QueryDataObjects.", "properties": { "pageToken": { "description": "Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.", "type": "string" }, "filter": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. A JSON filter expression, e.g. {\"genre\": {\"$eq\": \"sci-fi\"}}, represented as a google.protobuf.Struct." }, "outputFields": { "description": "Optional. Mask specifying which fields to return.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000." } } }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig": { "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig", "type": "object", "description": "Google Cloud Storage configuration for the import.", "properties": { "contentsUri": { "type": "string", "description": "Required. URI prefix of the Cloud Storage DataObjects to import." }, "errorUri": { "type": "string", "description": "Required. URI prefix of the Cloud Storage location to write any errors encountered during the import." }, "outputUri": { "type": "string", "description": "Optional. URI prefix of the Cloud Storage location to write DataObject `IDs` and `etags` of DataObjects that were successfully imported. The service will write the successfully imported DataObjects to sharded files under this prefix. If this field is empty, no output will be written." } } }, "GoogleCloudLocationLocation": { "id": "GoogleCloudLocationLocation", "type": "object", "description": "A resource that represents a Google Cloud location.", "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." } } }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest": { "description": "Request message for DataObjectService.BatchCreateDataObjects.", "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest" }, "description": "Required. The request message specifying the resources to create. A maximum of 1000 DataObjects can be created in a batch." } }, "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaSparseVectorField": { "id": "GoogleCloudVectorsearchV1betaSparseVectorField", "type": "object", "description": "Message describing a sparse vector field.", "properties": {} }, "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaBatchDeleteDataObjectsRequest", "type": "object", "description": "Request message for DataObjectService.BatchDeleteDataObjects.", "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest" }, "description": "Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch." } } }, "GoogleCloudVectorsearchV1betaSparseVector": { "id": "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", "items": { "type": "integer", "format": "int32" }, "description": "Required. The corresponding indices for the values." } } }, "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse": { "properties": { "results": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaSearchDataObjectsResponse" }, "description": "Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.", "readOnly": true } }, "description": "A response from a batch search operation.", "id": "GoogleCloudVectorsearchV1betaBatchSearchDataObjectsResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaSemanticSearch": { "description": "Defines a semantic search operation.", "properties": { "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" } }, "searchField": { "type": "string", "description": "Required. The vector field to search." }, "topK": { "type": "integer", "format": "int32", "description": "Optional. The number of data objects to return." }, "searchText": { "description": "Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.", "type": "string" }, "outputFields": { "description": "Optional. The fields to return in the search results.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "searchHint": { "description": "Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to KNN search otherwise.", "$ref": "GoogleCloudVectorsearchV1betaSearchHint" }, "taskType": { "type": "string", "enumDescriptions": [ "Unspecified task type.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the embeddings will be used for question answering.", "Specifies that the embeddings will be used for fact verification.", "Specifies that the embeddings will be used for code retrieval." ], "description": "Required. The task type of the query embedding.", "enum": [ "EMBEDDING_TASK_TYPE_UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ] } }, "id": "GoogleCloudVectorsearchV1betaSemanticSearch", "type": "object" }, "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest": { "properties": { "dataObject": { "description": "Required. The DataObject which replaces the resource on the server.", "$ref": "GoogleCloudVectorsearchV1betaDataObject" }, "updateMask": { "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask.", "type": "string", "format": "google-fieldmask" } }, "description": "Request message for DataObjectService.UpdateDataObject.", "id": "GoogleCloudVectorsearchV1betaUpdateDataObjectRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResponseMetadata": { "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadata", "type": "object", "properties": { "usedKnn": { "type": "boolean", "description": "Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.", "readOnly": true }, "usedIndex": { "description": "Indicates that the search used a particular index.", "$ref": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo" }, "warnings": { "description": "Output only. Warnings or non-fatal errors that occurred during execution.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "Metadata about the search execution." }, "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaSearchDataObjectsRequest", "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The standard list page size. Only supported for KNN. If not set, up to search_type.top_k results will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "semanticSearch": { "description": "A semantic search operation.", "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch" }, "vectorSearch": { "description": "A vector search operation.", "$ref": "GoogleCloudVectorsearchV1betaVectorSearch" }, "textSearch": { "description": "Optional. A text search operation.", "$ref": "GoogleCloudVectorsearchV1betaTextSearch" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.", "type": "string" } }, "description": "Request for performing a single search." }, "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaBatchUpdateDataObjectsResponse", "type": "object", "description": "Response message for DataObjectService.BatchUpdateDataObjects.", "properties": {} }, "GoogleCloudVectorsearchV1betaDenseVectorField": { "properties": { "dimensions": { "description": "Dimensionality of the vector field.", "type": "integer", "format": "int32" }, "vertexEmbeddingConfig": { "description": "Optional. Configuration for generating embeddings for the vector field. If not specified, the embedding field must be populated in the DataObject.", "$ref": "GoogleCloudVectorsearchV1betaVertexEmbeddingConfig" } }, "description": "Message describing a dense vector field.", "id": "GoogleCloudVectorsearchV1betaDenseVectorField", "type": "object" }, "GoogleCloudVectorsearchV1betaEncryptionSpec": { "id": "GoogleCloudVectorsearchV1betaEncryptionSpec", "type": "object", "description": "Represents a customer-managed encryption key specification that can be applied to a Vector Search collection.", "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" } } }, "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination": { "properties": { "format": { "enumDeprecated": [ false, true, false ], "enum": [ "FORMAT_UNSPECIFIED", "JSON", "JSONL" ], "enumDescriptions": [ "Unspecified format.", "Deprecated: Exports Data Objects in `JSON` format. Use `JSONL` instead.", "Exports Data Objects in `JSONL` format." ], "description": "Required. The format of the exported Data Objects.", "type": "string" }, "exportUri": { "type": "string", "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." } }, "description": "Google Cloud Storage configuration for the export.", "id": "GoogleCloudVectorsearchV1betaExportDataObjectsRequestGcsExportDestination", "type": "object" }, "GoogleCloudVectorsearchV1betaTextSearch": { "id": "GoogleCloudVectorsearchV1betaTextSearch", "type": "object", "description": "Defines a text search operation.", "properties": { "searchText": { "type": "string", "description": "Required. The query text." }, "outputFields": { "description": "Optional. The fields to return in the search results.", "$ref": "GoogleCloudVectorsearchV1betaOutputFields" }, "dataFieldNames": { "description": "Required. The data field names to search.", "type": "array", "items": { "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": { "type": "integer", "format": "int32", "description": "Optional. The number of results to return." } } }, "GoogleCloudVectorsearchV1betaImportDataObjectsRequest": { "id": "GoogleCloudVectorsearchV1betaImportDataObjectsRequest", "type": "object", "description": "Request message for VectorSearchService.ImportDataObjects.", "properties": { "gcsImport": { "description": "The Cloud Storage location of the input content.", "$ref": "GoogleCloudVectorsearchV1betaImportDataObjectsRequestGcsImportConfig" } } }, "GoogleCloudVectorsearchV1betaReciprocalRankFusion": { "description": "Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.", "properties": { "weights": { "description": "Required. The weights to apply to each search result set during fusion.", "type": "array", "items": { "type": "number", "format": "double" } } }, "id": "GoogleCloudVectorsearchV1betaReciprocalRankFusion", "type": "object" }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "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" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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." }, "done": { "type": "boolean", "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." } } }, "GoogleCloudLocationListLocationsResponse": { "id": "GoogleCloudLocationListLocationsResponse", "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "GoogleCloudLocationLocation" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "description": "The response message for Locations.ListLocations." }, "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse": { "id": "GoogleCloudVectorsearchV1betaBatchCreateDataObjectsResponse", "type": "object", "description": "Response message for DataObjectService.BatchCreateDataObjects.", "properties": { "dataObjects": { "description": "Output only. DataObjects created.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaDataObject" } } } }, "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest": { "id": "GoogleCloudVectorsearchV1betaDeleteDataObjectRequest", "type": "object", "description": "Request message for DataObjectService.DeleteDataObject.", "properties": { "name": { "type": "string", "description": "Required. The name of the DataObject resource to be deleted. Format: `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`" }, "etag": { "type": "string", "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." } } }, "GoogleCloudVectorsearchV1betaListIndexesResponse": { "properties": { "indexes": { "type": "array", "items": { "$ref": "GoogleCloudVectorsearchV1betaIndex" }, "description": "The list of Index" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "description": "Message for response to listing Indexes", "id": "GoogleCloudVectorsearchV1betaListIndexesResponse", "type": "object" }, "GoogleCloudVectorsearchV1betaDenseVector": { "description": "A dense vector.", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "Required. The values of the vector." } }, "id": "GoogleCloudVectorsearchV1betaDenseVector", "type": "object" }, "GoogleCloudVectorsearchV1betaSearchResult": { "id": "GoogleCloudVectorsearchV1betaSearchResult", "type": "object", "description": "A single search result.", "properties": { "dataObject": { "$ref": "GoogleCloudVectorsearchV1betaDataObject", "description": "Output only. The matching data object.", "readOnly": true }, "distance": { "description": "Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.", "readOnly": true, "type": "number", "format": "double" } } }, "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo": { "id": "GoogleCloudVectorsearchV1betaSearchResponseMetadataIndexInfo", "type": "object", "description": "Message that indicates the index used for the search.", "properties": { "name": { "type": "string", "description": "Output only. The resource name of the index used for the search. Format: `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`", "readOnly": true } } }, "GoogleCloudVectorsearchV1betaSearchHintKnnHint": { "description": "KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.", "properties": {}, "id": "GoogleCloudVectorsearchV1betaSearchHintKnnHint", "type": "object" }, "GoogleCloudVectorsearchV1betaCreateDataObjectRequest": { "id": "GoogleCloudVectorsearchV1betaCreateDataObjectRequest", "type": "object", "properties": { "dataObjectId": { "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])?`." }, "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" } }, "description": "Request message for DataObjectService.CreateDataObject." }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "id": "GoogleLongrunningCancelOperationRequest", "type": "object" }, "GoogleCloudVectorsearchV1betaOutputFields": { "description": "Defines a output fields struct for data in DataObject.", "properties": { "metadataFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. The fields from the DataObject metadata to include in the output." }, "vectorFields": { "description": "Optional. The fields from the vector fields to include in the output.", "type": "array", "items": { "type": "string" } }, "dataFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. The fields from the data fields to include in the output." } }, "id": "GoogleCloudVectorsearchV1betaOutputFields", "type": "object" }, "GoogleCloudVectorsearchV1betaDataObject": { "description": "A dataObject resource in Vector Search.", "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", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. The data of the dataObject." }, "dataObjectId": { "description": "Output only. The id of the dataObject.", "readOnly": true, "type": "string" }, "etag": { "description": "Optional. The etag of the dataObject.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp the dataObject was created at.", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp the dataObject was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "vectors": { "description": "Optional. The vectors of the dataObject.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudVectorsearchV1betaVector" } } }, "id": "GoogleCloudVectorsearchV1betaDataObject", "type": "object" }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "id": "Empty", "type": "object" }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "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.", "type": "array", "items": { "type": "string" } } }, "description": "The response message for Operations.ListOperations." }, "GoogleCloudVectorsearchV1betaVector": { "description": "A vector which can be either dense or sparse.", "properties": { "sparse": { "description": "A sparse vector.", "$ref": "GoogleCloudVectorsearchV1betaSparseVector" }, "dense": { "description": "A dense vector.", "$ref": "GoogleCloudVectorsearchV1betaDenseVector" }, "values": { "description": "Deprecated: Use `dense` or `sparse` instead.", "deprecated": true, "type": "array", "items": { "type": "number", "format": "float" } } }, "id": "GoogleCloudVectorsearchV1betaVector", "type": "object" }, "GoogleCloudVectorsearchV1betaSearch": { "id": "GoogleCloudVectorsearchV1betaSearch", "type": "object", "properties": { "semanticSearch": { "description": "A semantic search.", "$ref": "GoogleCloudVectorsearchV1betaSemanticSearch" }, "textSearch": { "description": "A text search operation.", "$ref": "GoogleCloudVectorsearchV1betaTextSearch" }, "vectorSearch": { "description": "A vector-based search.", "$ref": "GoogleCloudVectorsearchV1betaVectorSearch" } }, "description": "A single search request within a batch operation." } }, "servicePath": "", "baseUrl": "https://vectorsearch.googleapis.com/", "basePath": "", "endpoints": [ { "location": "us", "description": "Regional Endpoint", "endpointUrl": "https://vectorsearch.us.rep.googleapis.com/" } ], "title": "Vector Search API", "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." } } } }, "batchPath": "batch" }