Note: The following fields are mutually exclusive: image_query, text_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: image_query, text_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: image_query, text_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
#index_endpoint
defindex_endpoint()->::String
Returns
(::String) — Required. The index endpoint to search.
Format:
projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}
#index_endpoint=
defindex_endpoint=(value)->::String
Parameter
value (::String) — Required. The index endpoint to search.
Format:
projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}
Returns
(::String) — Required. The index endpoint to search.
Format:
projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}
#page_size
defpage_size()->::Integer
Returns
(::Integer) — 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_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — 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.
Returns
(::Integer) — 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
defpage_token()->::String
Returns
(::String) — The continuation token to fetch the next page. If empty, it means it is
fetching the first page.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — The continuation token to fetch the next page. If empty, it means it is
fetching the first page.
Returns
(::String) — The continuation token to fetch the next page. If empty, it means it is
fetching the first page.
#text_query
deftext_query()->::String
Returns
(::String) — A text-only query.
Note: The following fields are mutually exclusive: text_query, image_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text_query=
deftext_query=(value)->::String
Parameter
value (::String) — A text-only query.
Note: The following fields are mutually exclusive: text_query, image_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — A text-only query.
Note: The following fields are mutually exclusive: text_query, image_query. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-SearchIndexEndpointRequest) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest.\n\nRequest message for SearchIndexEndpoint. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #criteria\n\n def criteria() -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::Criteria\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria applied to search results.\n\n### #criteria=\n\n def criteria=(value) -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::Criteria\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria applied to search results. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria applied to search results.\n\n### #exclusion_criteria\n\n def exclusion_criteria() -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::Criteria\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria to exclude from search results. Note that `fetch_matched_annotations` will be ignored.\n\n### #exclusion_criteria=\n\n def exclusion_criteria=(value) -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::Criteria\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria to exclude from search results. Note that `fetch_matched_annotations` will be ignored. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::Criteria](./Google-Cloud-VisionAI-V1-Criteria)\\\u003e) --- Criteria to exclude from search results. Note that `fetch_matched_annotations` will be ignored.\n\n### #image_query\n\n def image_query() -\u003e ::Google::Cloud::VisionAI::V1::ImageQuery\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::ImageQuery](./Google-Cloud-VisionAI-V1-ImageQuery)) --- An image-only query.\n\n\n Note: The following fields are mutually exclusive: `image_query`, `text_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #image_query=\n\n def image_query=(value) -\u003e ::Google::Cloud::VisionAI::V1::ImageQuery\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::ImageQuery](./Google-Cloud-VisionAI-V1-ImageQuery)) --- An image-only query.\n\n\nNote: The following fields are mutually exclusive: `image_query`, `text_query`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::ImageQuery](./Google-Cloud-VisionAI-V1-ImageQuery)) --- An image-only query.\n\n\n Note: The following fields are mutually exclusive: `image_query`, `text_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #index_endpoint\n\n def index_endpoint() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}`\n\n### #index_endpoint=\n\n def index_endpoint=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}` \n**Returns**\n\n- (::String) --- Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}`\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- 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. \n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The continuation token to fetch the next page. If empty, it means it is fetching the first page.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The continuation token to fetch the next page. If empty, it means it is fetching the first page. \n**Returns**\n\n- (::String) --- The continuation token to fetch the next page. If empty, it means it is fetching the first page.\n\n### #text_query\n\n def text_query() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A text-only query.\n\n Note: The following fields are mutually exclusive: `text_query`, `image_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text_query=\n\n def text_query=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A text-only query.\n\n\nNote: The following fields are mutually exclusive: `text_query`, `image_query`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A text-only query.\n\n Note: The following fields are mutually exclusive: `text_query`, `image_query`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
