Class SearchDataObjectsRequest (0.11.0)

SearchDataObjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name Description
vector_search google.cloud.vectorsearch_v1beta.types.VectorSearch
A vector search operation. This field is a member of oneof_ search_type.
semantic_search google.cloud.vectorsearch_v1beta.types.SemanticSearch
A semantic search operation. This field is a member of oneof_ search_type.
text_search google.cloud.vectorsearch_v1beta.types.TextSearch
Optional. A text search operation. This field is a member of oneof_ search_type.
parent str
Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}
page_size int
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.
page_token str
Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.