Summary of entries of Classes for google-cloud-vectorsearch.
Classes
DataObjectSearchServiceAsyncClient
Service for searching data objects.
DataObjectSearchServiceClient
Service for searching data objects.
QueryDataObjectsAsyncPager
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.
QueryDataObjectsPager
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.
SearchDataObjectsAsyncPager
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.
SearchDataObjectsPager
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.
DataObjectServiceAsyncClient
Service for creating and managing data objects.
DataObjectServiceClient
Service for creating and managing data objects.
VectorSearchServiceAsyncClient
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.
VectorSearchServiceClient
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.
ListCollectionsAsyncPager
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.
ListCollectionsPager
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.
ListIndexesAsyncPager
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.
ListIndexesPager
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.
AggregateDataObjectsRequest
Request message for DataObjectSearchService.AggregateDataObjects.
AggregateDataObjectsResponse
Response message for DataObjectSearchService.AggregateDataObjects.
AggregationMethod
Aggregation methods.
BatchCreateDataObjectsRequest
Request message for DataObjectService.BatchCreateDataObjects.
BatchCreateDataObjectsResponse
Response message for DataObjectService.BatchCreateDataObjects.
BatchDeleteDataObjectsRequest
Request message for DataObjectService.BatchDeleteDataObjects.
BatchSearchDataObjectsRequest
A request to perform a batch of search operations.
CombineResultsOptions
Options for combining the results of the batch search operations.
BatchSearchDataObjectsResponse
A response from a batch search operation.
BatchUpdateDataObjectsRequest
Request message for DataObjectService.BatchUpdateDataObjects.
BatchUpdateDataObjectsResponse
Response message for DataObjectService.BatchUpdateDataObjects.
Collection
Message describing Collection object
LabelsEntry
The abstract base class for a message.
VectorSchemaEntry
The abstract base class for a message.
CreateCollectionRequest
Message for creating a Collection
CreateDataObjectRequest
Request message for DataObjectService.CreateDataObject.
CreateIndexRequest
Message for creating an Index.
DataObject
A dataObject resource in Vector Search.
VectorsEntry
The abstract base class for a message.
DeleteCollectionRequest
Message for deleting a Collection
DeleteDataObjectRequest
Request message for DataObjectService.DeleteDataObject.
DeleteIndexRequest
Message for deleting an Index.
DenseVector
A dense vector.
DenseVectorField
Message describing a dense vector field.
DistanceMetric
Distance metric for vector search.
EmbeddingTaskType
Represents the task the embeddings will be used for.
GetCollectionRequest
Message for getting a Collection
GetDataObjectRequest
Request message for DataObjectService.GetDataObject.
GetIndexRequest
Message for getting an Index
ImportDataObjectsMetadata
Metadata for [DataObjectService.ImportDataObjects][].
ImportDataObjectsRequest
Request message for [DataObjectService.ImportDataObjects][].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GcsImportConfig
Google Cloud Storage configuration for the import.
ImportDataObjectsResponse
Response for [DataObjectService.ImportDataObjects][].
Index
Message describing Index object
LabelsEntry
The abstract base class for a message.
ListCollectionsRequest
Message for requesting list of Collections
ListCollectionsResponse
Message for response to listing Collections
ListIndexesRequest
Message for requesting list of Indexes
ListIndexesResponse
Message for response to listing Indexes
OperationMetadata
Represents the metadata of the long-running operation.
OutputFields
Defines a output fields struct for data in DataObject.
QueryDataObjectsRequest
Request message for DataObjectSearchService.QueryDataObjects.
QueryDataObjectsResponse
Response message for DataObjectSearchService.QueryDataObjects.
Ranker
Defines a ranker to combine results from multiple searches.
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
ReciprocalRankFusion
Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.
Search
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
SearchDataObjectsRequest
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
SearchDataObjectsResponse
Response for a search request.
SearchHint
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
IndexHint
Message to specify the index to use for the search.
SearchResponseMetadata
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
IndexInfo
Message that indicates the index used for the search.
SearchResult
A single search result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SemanticSearch
Defines a semantic search operation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SparseVector
A sparse vector.
SparseVectorField
Message describing a sparse vector field.
TextSearch
Defines a text search operation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateCollectionRequest
Message for updating a Collection
UpdateDataObjectRequest
Request message for DataObjectService.UpdateDataObject.
Vector
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
VectorField
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
VectorSearch
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
VertexEmbeddingConfig
Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.
VertexRanker
Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.
Modules
pagers
API documentation for vectorsearch_v1beta.services.data_object_search_service.pagers module.
pagers
API documentation for vectorsearch_v1beta.services.vector_search_service.pagers module.