Package Classes (0.11.5)

Service for searching data objects.

Service for searching data objects.

A pager for iterating through query_data_objects requests.

This class thinly wraps an initial QueryDataObjectsResponse object, and provides an __aiter__ method to iterate through its data_objects field.

If there are more pages, the __aiter__ method will make additional QueryDataObjects requests and continue to iterate through the data_objects field on the corresponding responses.

All the usual QueryDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through query_data_objects requests.

This class thinly wraps an initial QueryDataObjectsResponse object, and provides an __iter__ method to iterate through its data_objects field.

If there are more pages, the __iter__ method will make additional QueryDataObjects requests and continue to iterate through the data_objects field on the corresponding responses.

All the usual QueryDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_data_objects requests.

This class thinly wraps an initial SearchDataObjectsResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchDataObjects requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_data_objects requests.

This class thinly wraps an initial SearchDataObjectsResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchDataObjects requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service for creating and managing data objects.

Service for creating and managing data objects.

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __aiter__ method to iterate through its collections field.

If there are more pages, the __aiter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __iter__ method to iterate through its collections field.

If there are more pages, the __iter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __aiter__ method to iterate through its indexes field.

If there are more pages, the __aiter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __iter__ method to iterate through its indexes field.

If there are more pages, the __iter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message for DataObjectSearchService.AggregateDataObjects.

Response message for DataObjectSearchService.AggregateDataObjects.

Aggregation methods.

Request message for DataObjectService.BatchCreateDataObjects.

Response message for DataObjectService.BatchCreateDataObjects.

Request message for DataObjectService.BatchDeleteDataObjects.

A request to perform a batch of search operations.

Options for combining the results of the batch search operations.

A response from a batch search operation.

Request message for DataObjectService.BatchUpdateDataObjects.

Response message for DataObjectService.BatchUpdateDataObjects.

Message describing Collection object

The abstract base class for a message.

The abstract base class for a message.

Message for creating a Collection

Request message for DataObjectService.CreateDataObject.

Message for creating an Index.

A dataObject resource in Vector Search.

The abstract base class for a message.

Represents dedicated infrastructure for the index.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specification for autoscaling.

Mode of the dedicated infrastructure.

Message for deleting a Collection

Request message for DataObjectService.DeleteDataObject.

Message for deleting an Index.

Dense ScaNN index configuration.

Feature norm type for ScaNN index.

A dense vector.

Message describing a dense vector field.

Distance metric for vector search.

Represents the task the embeddings will be used for.

Represents a customer-managed encryption key specification that can be applied to a Vector Search collection.

Metadata for the ExportDataObjects LRO.

Request message for VectorSearchService.ExportDataObjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Selects which top-level Data Object fields are emitted at export time.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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".

Google Cloud Storage configuration for the export.

Options for the format of the exported Data Objects.

Response for the ExportDataObjects LRO.

Message for getting a Collection

Request message for DataObjectService.GetDataObject.

Message for getting an Index

Metadata for VectorSearchService.ImportDataObjects.

Request message for VectorSearchService.ImportDataObjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Google Cloud Storage configuration for the import.

Response for VectorSearchService.ImportDataObjects.

Message describing Index object

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Message for requesting list of Collections

Message for response to listing Collections

Message for requesting list of Indexes

Message for response to listing Indexes

Represents the metadata of the long-running operation.

Defines a output fields struct for data in DataObject.

Request message for DataObjectSearchService.QueryDataObjects.

Response message for DataObjectSearchService.QueryDataObjects.

Defines a ranker to combine results from multiple searches.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.

A single search request within a batch operation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for performing a single search.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response for a search request.

Represents a hint to the search index engine.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message to specify the index to use for the search.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Parameters for dense ScaNN.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.

A single search result.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines a semantic search operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A sparse vector.

Message describing a sparse vector field.

Defines a text search operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for updating a Collection

Request message for DataObjectService.UpdateDataObject.

Message for updating an Index.

A vector which can be either dense or sparse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message describing a vector field.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines a search operation using a query vector.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.

Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The record spec for text search.

Service for searching data objects.

Service for searching data objects.

A pager for iterating through query_data_objects requests.

This class thinly wraps an initial QueryDataObjectsResponse object, and provides an __aiter__ method to iterate through its data_objects field.

If there are more pages, the __aiter__ method will make additional QueryDataObjects requests and continue to iterate through the data_objects field on the corresponding responses.

All the usual QueryDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through query_data_objects requests.

This class thinly wraps an initial QueryDataObjectsResponse object, and provides an __iter__ method to iterate through its data_objects field.

If there are more pages, the __iter__ method will make additional QueryDataObjects requests and continue to iterate through the data_objects field on the corresponding responses.

All the usual QueryDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_data_objects requests.

This class thinly wraps an initial SearchDataObjectsResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchDataObjects requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_data_objects requests.

This class thinly wraps an initial SearchDataObjectsResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchDataObjects requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchDataObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service for creating and managing data objects.

Service for creating and managing data objects.

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __aiter__ method to iterate through its collections field.

If there are more pages, the __aiter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __iter__ method to iterate through its collections field.

If there are more pages, the __iter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __aiter__ method to iterate through its indexes field.

If there are more pages, the __aiter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __iter__ method to iterate through its indexes field.

If there are more pages, the __iter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message for DataObjectSearchService.AggregateDataObjects.

Response message for DataObjectSearchService.AggregateDataObjects.

Aggregation methods.

Request message for DataObjectService.BatchCreateDataObjects.

Response message for DataObjectService.BatchCreateDataObjects.

Request message for DataObjectService.BatchDeleteDataObjects.

A request to perform a batch of search operations.

Options controlling which metadata is included in the search results.

Options for combining the results of the batch search operations.

A response from a batch search operation.

Request message for DataObjectService.BatchUpdateDataObjects.

Response message for DataObjectService.BatchUpdateDataObjects.

Message describing Collection object

The abstract base class for a message.

The abstract base class for a message.

A query that combines multiple sub-queries with a boolean operator.

Boolean operators used to combine sub-queries.

Message for creating a Collection

Request message for DataObjectService.CreateDataObject.

Message for creating an Index.

A dataObject resource in Vector Search.

The abstract base class for a message.

Represents dedicated infrastructure for the index.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specification for autoscaling.

Mode of the dedicated infrastructure.

Message for deleting a Collection

Request message for DataObjectService.DeleteDataObject.

Message for deleting an Index.

Dense ScaNN index configuration.

Feature norm type for ScaNN index.

A dense vector.

Message describing a dense vector field.

Distance metric for vector search.

Represents the task the embeddings will be used for.

Represents a customer-managed encryption key specification that can be applied to a Vector Search collection.

Metadata for the ExportDataObjects LRO.

Request message for VectorSearchService.ExportDataObjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Selects which top-level Data Object fields are emitted at export time.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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".

Google Cloud Storage configuration for the export.

Options for the format of the exported Data Objects.

Response for the ExportDataObjects LRO.

Message for getting a Collection

Request message for DataObjectService.GetDataObject.

Message for getting an Index

Metadata for VectorSearchService.ImportDataObjects.

Request message for VectorSearchService.ImportDataObjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Google Cloud Storage configuration for the import.

Response for VectorSearchService.ImportDataObjects.

Message describing Index object

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Message for requesting list of Collections

Message for response to listing Collections

Message for requesting list of Indexes

Message for response to listing Indexes

Represents the metadata of the long-running operation.

Defines a output fields struct for data in DataObject.

Request message for DataObjectSearchService.QueryDataObjects.

Response message for DataObjectSearchService.QueryDataObjects.

Query enhancement settings. When enabled, expands the search terms with stemming, synonyms, and spelling corrections, and removes stop words.

Defines a ranker to combine results from multiple searches.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.

A single search request within a batch operation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for performing a single search.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response for a search request.

Represents a hint to the search index engine.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message to specify the index to use for the search.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Parameters for dense ScaNN.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.

Metadata about the search execution.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message that indicates the index used for the search.

A single search result.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Quality signals describing how this result was retrieved, combined and re-ranked. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is true.

The rank and score assigned by the Reciprocal Rank Fusion ranker when combining the results of the batch searches.

The rank and distance of this data object within a single search of the batch.

The rank and score assigned by the Vertex re-ranker.

Defines a semantic search operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A sparse vector.

Message describing a sparse vector field.

A structured query for text search. Allows expressing field-targeted text queries combined via boolean operators, with optional per-node boosting.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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).

The matching strategy to apply when comparing text against the content of fields.

Defines a text search operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A query that applies a unary operator to a sub-query.

Unary operators applicable to a sub-query.

Message for updating a Collection

Request message for DataObjectService.UpdateDataObject.

Message for updating an Index.

A vector which can be either dense or sparse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message describing a vector field.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines a search operation using a query vector.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.

Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The record spec for text search.

API documentation for vectorsearch_v1.services.data_object_search_service.pagers module.

API documentation for vectorsearch_v1.services.vector_search_service.pagers module.

API documentation for vectorsearch_v1beta.services.data_object_search_service.pagers module.

API documentation for vectorsearch_v1beta.services.vector_search_service.pagers module.