Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::TextQuery.
A leaf-level text query targeting one or more data fields. When multiple fields are specified, this is equivalent to combining per-field matches with an OR operator (i.e. the query matches if the text is found in any of the listed fields).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#fields
def fields() -> ::Array<::String>
Returns
- (::Array<::String>) — Required. The data fields to search against.
#fields=
def fields=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Required. The data fields to search against.
Returns
- (::Array<::String>) — Required. The data fields to search against.
#match_type
def match_type() -> ::Google::Cloud::VectorSearch::V1::TextQuery::MatchType
Returns
-
(::Google::Cloud::VectorSearch::V1::TextQuery::MatchType) — Optional. The matching strategy to apply for this query. If unset, defaults
to
TEXT.
#match_type=
def match_type=(value) -> ::Google::Cloud::VectorSearch::V1::TextQuery::MatchType
Parameter
-
value (::Google::Cloud::VectorSearch::V1::TextQuery::MatchType) — Optional. The matching strategy to apply for this query. If unset, defaults
to
TEXT.
Returns
-
(::Google::Cloud::VectorSearch::V1::TextQuery::MatchType) — Optional. The matching strategy to apply for this query. If unset, defaults
to
TEXT.
#query_enhancement
def query_enhancement() -> ::Google::Cloud::VectorSearch::V1::QueryEnhancement
Returns
- (::Google::Cloud::VectorSearch::V1::QueryEnhancement) — Optional. The query enhancement settings to apply for this query.
#query_enhancement=
def query_enhancement=(value) -> ::Google::Cloud::VectorSearch::V1::QueryEnhancement
Parameter
- value (::Google::Cloud::VectorSearch::V1::QueryEnhancement) — Optional. The query enhancement settings to apply for this query.
Returns
- (::Google::Cloud::VectorSearch::V1::QueryEnhancement) — Optional. The query enhancement settings to apply for this query.
#text
def text() -> ::String
Returns
- (::String) — Required. The text to search for.
#text=
def text=(value) -> ::String
Parameter
- value (::String) — Required. The text to search for.
Returns
- (::String) — Required. The text to search for.