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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ image_query |
ImageQuery
An image-only 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 |
array<Criteria>
Criteria applied to search results. |
↳ exclusion_criteria |
array<Criteria>
Criteria to exclude from search results. Note that |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
ImageQuery|null |
|
hasImageQuery
setImageQuery
An image-only query.
| Parameter | |
|---|---|
| Name | Description |
var |
ImageQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTextQuery
A text-only query.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTextQuery
setTextQuery
A text-only query.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIndexEndpoint
Required. The index endpoint to search.
Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
| Returns | |
|---|---|
| Type | Description |
string |
|
setIndexEndpoint
Required. The index endpoint to search.
Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCriteria
Criteria applied to search results.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCriteria
Criteria applied to search results.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Criteria>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExclusionCriteria
Criteria to exclude from search results.
Note that fetch_matched_annotations will be ignored.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setExclusionCriteria
Criteria to exclude from search results.
Note that fetch_matched_annotations will be ignored.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Criteria>
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
| Returns | |
|---|---|
| Type | Description |
string |
|