Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::StructuredQuery.
A structured query for text search. Allows expressing field-targeted text queries combined via boolean operators, with optional per-node boosting.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#boost
def boost() -> ::Float- (::Float) — Optional. Optional multiplier applied to this query node's contribution to the final relevance score. Must be non-negative; if unset or 0, defaults to 1.0. Values greater than 1.0 increase its influence on ranking, values between 0.0 and 1.0 decrease it.
#boost=
def boost=(value) -> ::Float- value (::Float) — Optional. Optional multiplier applied to this query node's contribution to the final relevance score. Must be non-negative; if unset or 0, defaults to 1.0. Values greater than 1.0 increase its influence on ranking, values between 0.0 and 1.0 decrease it.
- (::Float) — Optional. Optional multiplier applied to this query node's contribution to the final relevance score. Must be non-negative; if unset or 0, defaults to 1.0. Values greater than 1.0 increase its influence on ranking, values between 0.0 and 1.0 decrease it.
#combine
def combine() -> ::Google::Cloud::VectorSearch::V1::CombinedQuery-
(::Google::Cloud::VectorSearch::V1::CombinedQuery) — Optional. A query that combines multiple sub-queries with a boolean
operator.
Note: The following fields are mutually exclusive:
combine,text,unary. If a field in that set is populated, all other fields in the set will automatically be cleared.
#combine=
def combine=(value) -> ::Google::Cloud::VectorSearch::V1::CombinedQuery-
value (::Google::Cloud::VectorSearch::V1::CombinedQuery) — Optional. A query that combines multiple sub-queries with a boolean
operator.
Note: The following fields are mutually exclusive:
combine,text,unary. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::VectorSearch::V1::CombinedQuery) — Optional. A query that combines multiple sub-queries with a boolean
operator.
Note: The following fields are mutually exclusive:
combine,text,unary. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text
def text() -> ::Google::Cloud::VectorSearch::V1::TextQuery-
(::Google::Cloud::VectorSearch::V1::TextQuery) — Optional. A leaf-level text query.
Note: The following fields are mutually exclusive:
text,unary,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text=
def text=(value) -> ::Google::Cloud::VectorSearch::V1::TextQuery-
value (::Google::Cloud::VectorSearch::V1::TextQuery) — Optional. A leaf-level text query.
Note: The following fields are mutually exclusive:
text,unary,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::VectorSearch::V1::TextQuery) — Optional. A leaf-level text query.
Note: The following fields are mutually exclusive:
text,unary,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.
#unary
def unary() -> ::Google::Cloud::VectorSearch::V1::UnaryQuery-
(::Google::Cloud::VectorSearch::V1::UnaryQuery) — Optional. A query that applies a unary operator to a sub-query.
Note: The following fields are mutually exclusive:
unary,text,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.
#unary=
def unary=(value) -> ::Google::Cloud::VectorSearch::V1::UnaryQuery-
value (::Google::Cloud::VectorSearch::V1::UnaryQuery) — Optional. A query that applies a unary operator to a sub-query.
Note: The following fields are mutually exclusive:
unary,text,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::VectorSearch::V1::UnaryQuery) — Optional. A query that applies a unary operator to a sub-query.
Note: The following fields are mutually exclusive:
unary,text,combine. If a field in that set is populated, all other fields in the set will automatically be cleared.