Vision AI V1 API - Class Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest (v1.2.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest.

Request message for SearchIndexEndpoint.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#criteria

def criteria() -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Returns

#criteria=

def criteria=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Parameter
Returns

#exclusion_criteria

def exclusion_criteria() -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Returns

#exclusion_criteria=

def exclusion_criteria=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Parameter
Returns

#image_query

def image_query() -> ::Google::Cloud::VisionAI::V1::ImageQuery
Returns
  • (::Google::Cloud::VisionAI::V1::ImageQuery) — An image-only query.

    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.

#image_query=

def image_query=(value) -> ::Google::Cloud::VisionAI::V1::ImageQuery
Parameter
  • value (::Google::Cloud::VisionAI::V1::ImageQuery) — An image-only query.

    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.

Returns
  • (::Google::Cloud::VisionAI::V1::ImageQuery) — An image-only query.

    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

def index_endpoint() -> ::String
Returns
  • (::String) — Required. The index endpoint to search. Format: projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}

#index_endpoint=

def index_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

def page_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=

def page_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

def page_token() -> ::String
Returns
  • (::String) — The continuation token to fetch the next page. If empty, it means it is fetching the first page.

#page_token=

def page_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

def text_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=

def text_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.