Class: Google::Cloud::VectorSearch::V1::SemanticSearch

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

Overview

Defines a semantic search operation.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::Google::Protobuf::Struct

Returns Optional. A JSON filter expression, e.g. {"genre": \{"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

Returns:

  • (::Google::Protobuf::Struct) —

    Optional. A JSON filter expression, e.g. {"genre": \{"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#output_fields ⇒ ::Google::Cloud::VectorSearch::V1::OutputFields

Returns Optional. The fields to return in the search results.

Returns:



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#search_field ⇒ ::String

Returns Required. The vector field to search.

Returns:

  • (::String) —

    Required. The vector field to search.



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#search_hint ⇒ ::Google::Cloud::VectorSearch::V1::SearchHint

Returns Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to KNN search otherwise.

Returns:



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#search_text ⇒ ::String

Returns Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.

Returns:

  • (::String) —

    Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#task_type ⇒ ::Google::Cloud::VectorSearch::V1::EmbeddingTaskType

Returns Required. The task type of the query embedding.

Returns:



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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

#top_k ⇒ ::Integer

Returns Optional. The number of data objects to return.

Returns:

  • (::Integer) —

    Optional. The number of data objects to return.



160
161
162
163
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 160

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