Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class SearchIndexEndpointRequest.
Request message for SearchIndexEndpoint.
Generated from protobuf message google.cloud.visionai.v1.SearchIndexEndpointRequest
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ image_query
↳ text_query
string
A text-only query.
↳ index_endpoint
string
Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
↳ criteria
↳ exclusion_criteria
array< 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 200.
↳ page_token
string
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
getImageQuery
An image-only query.
hasImageQuery
setImageQuery
An image-only query.
$this
getTextQuery
A text-only query.
string
hasTextQuery
setTextQuery
A text-only query.
var
string
$this
getIndexEndpoint
Required. The index endpoint to search.
Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
string
setIndexEndpoint
Required. The index endpoint to search.
Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
var
string
$this
getCriteria
Criteria applied to search results.
setCriteria
Criteria applied to search results.
$this
getExclusionCriteria
Criteria to exclude from search results.
Note that fetch_matched_annotations
will be ignored.
setExclusionCriteria
Criteria to exclude from search results.
Note that fetch_matched_annotations
will be ignored.
$this
getPageSize
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 200.
int
setPageSize
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 200.
var
int
$this
getPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
string
setPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
var
string
$this
getQuery
string
