Class: Google::Cloud::VectorSearch::V1::TextSearch

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 text search operation.

Instance Attribute Summary collapse

Instance Attribute Details

#data_field_names ⇒ ::Array<::String>

Returns Optional. The data field names to search. Required when using the default text search mode.

Returns:

  • (::Array<::String>) —

    Optional. The data field names to search. Required when using the default text search mode.



183
184
185
186
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 183

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

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



183
184
185
186
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 183

class TextSearch
  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:



183
184
185
186
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 183

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

#search_text ⇒ ::String

Returns Optional. The query text. Required when using the default text search mode.

Returns:

  • (::String) —

    Optional. The query text. Required when using the default text search mode.



183
184
185
186
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 183

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

#top_k ⇒ ::Integer

Returns Optional. The number of results to return.

Returns:

  • (::Integer) —

    Optional. The number of results to return.



183
184
185
186
 
# File 'proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb', line 183

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