View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams (google_api_discovery_engine v0.7.0)
Search parameters.
Attributes
-
boostSpec
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec.t
, default:nil
) - Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting -
filter
(type:String.t
, default:nil
) - The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, anINVALID_ARGUMENT
is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter -
maxReturnResults
(type:integer()
, default:nil
) - Number of search results to return. The default value is 10. -
orderBy
(type:String.t
, default:nil
) - The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance.order_by
expression is case-sensitive. For more information on ordering, see Ordering If this field is unrecognizable, anINVALID_ARGUMENT
is returned.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams{ boostSpec: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec.t() | nil, filter: String.t() | nil, maxReturnResults: integer() | nil, orderBy: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.