Class: Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

Request message for SearchIndexEndpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#criteria ⇒ ::Array<::Google::Cloud::VisionAI::V1::Criteria>

Returns Criteria applied to search results.

Returns:



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#exclusion_criteria ⇒ ::Array<::Google::Cloud::VisionAI::V1::Criteria>

Returns Criteria to exclude from search results. Note that fetch_matched_annotations will be ignored.

Returns:



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#image_query ⇒ ::Google::Cloud::VisionAI::V1::ImageQuery

Returns An image-only query.

Returns:



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#index_endpoint ⇒ ::String

Returns 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}



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_query ⇒ ::String

Returns A text-only query.

Returns:

  • (::String) —

    A text-only query.



2683
2684
2685
2686
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2683

class SearchIndexEndpointRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end