Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::TextSearch (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::TextSearch.

Defines a text search operation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_field_names

def data_field_names() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The data field names to search. Required when using the default text search mode.

#data_field_names=

def data_field_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

#filter

def filter() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

#filter=

def filter=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — 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.

#output_fields

def output_fields() -> ::Google::Cloud::VectorSearch::V1::OutputFields
Returns

#output_fields=

def output_fields=(value) -> ::Google::Cloud::VectorSearch::V1::OutputFields
Parameter
Returns

#search_text

def search_text() -> ::String
Returns
  • (::String) — Optional. The query text. Required when using the default text search mode.

#search_text=

def search_text=(value) -> ::String
Parameter
  • value (::String) — 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.

#top_k

def top_k() -> ::Integer
Returns
  • (::Integer) — Optional. The number of results to return.

#top_k=

def top_k=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of results to return.
Returns
  • (::Integer) — Optional. The number of results to return.