Class SearchIndexEndpointRequest (0.1.6)

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

Request message for SearchIndexEndpoint.

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
image_query google.cloud.visionai_v1.types.ImageQuery
An image-only query. This field is a member of oneof_ query.
text_query str
A text-only query. This field is a member of oneof_ query.
index_endpoint str
Required. The index endpoint to search. Format: \`projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
criteria MutableSequence[google.cloud.visionai_v1.types.Criteria]
Criteria applied to search results.
exclusion_criteria MutableSequence[google.cloud.visionai_v1.types.Criteria]
Criteria to exclude from search results. Note that fetch_matched_annotations will be ignored.
page_size int
Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick the maximum size, which is 100.
page_token str
The continuation token to fetch the next page. If empty, it means it is fetching the first page.