SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for SearchService.Search method.
Attributes |
|
---|---|
Name | Description |
serving_config |
str
Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config ,
or
projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config .
This field is used to identify the serving configuration
name, set of models used to make the search.
|
branch |
str
The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0 .
Use default_branch as the branch ID or leave this field
empty, to search documents under the default branch.
|
query |
str
Raw search query. |
image_query |
google.cloud.discoveryengine_v1beta.types.SearchRequest.ImageQuery
Raw image query. |
page_size |
int
Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. - Websites with basic indexing: Default 10 , Maximum
25 .
- Websites with advanced indexing: Default 25 , Maximum
50 .
- Other: Default 50 , Maximum 100 .
If this field is negative, an INVALID_ARGUMENT is
returned.
|
page_token |
str
A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
offset |
int
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an INVALID_ARGUMENT is
returned.
|
data_store_specs |
MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.DataStoreSpec]
A list of data store specs to apply on a search call. |
filter |
str
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. If this field is unrecognizable, an INVALID_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 customer 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 __
|
canonical_filter |
str
The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. |
order_by |
str
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, an INVALID_ARGUMENT is
returned.
|
user_info |
google.cloud.discoveryengine_v1beta.types.UserInfo
Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.
|
facet_specs |
MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.FacetSpec]
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
|
boost_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec
Boost specification to boost certain documents. For more information on boosting, see Boosting __
|
params |
MutableMapping[str, google.protobuf.struct_pb2.Value]
Additional search parameters. For public website search only, supported values are: - user_country_code : string. Default empty. If set to
non-empty, results are restricted or boosted based on the
location provided. Example: user_country_code: "au"
For available codes see `Country
Codes |
query_expansion_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.QueryExpansionSpec
The query expansion specification that specifies the conditions under which query expansion occurs. |
spell_correction_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.SpellCorrectionSpec
The spell correction specification that specifies the mode under which spell correction takes effect. |
user_pseudo_id |
str
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as unknown_visitor .
This should be the same identifier as
UserEvent.user_pseudo_id
and
CompleteQueryRequest.user_pseudo_id
The field must be a UTF-8 encoded string with a length limit
of 128 characters. Otherwise, an INVALID_ARGUMENT error
is returned.
|
content_search_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec
A specification for configuring the behavior of content search. |
embedding_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.EmbeddingSpec
Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. |
ranking_expression |
str
The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by "+". - ranking_expression = function, { " + ", function }; Supported functions: - double \* relevance_score - double \* dotProduct(embedding_field_path) Function variables: relevance_score : pre-defined keywords,
used for measure relevance between query and document.
embedding_field_path : the document embedding field
used with query embedding vector. dotProduct :
embedding function between embedding_field_path and query
embedding vector.
Example ranking expression: If document has an embedding
field doc_embedding, the ranking expression could be
0.5 * relevance_score + 0.3 * dotProduct(doc_embedding) .
|
safe_search |
bool
Whether to turn on safe search. This is only supported for website search. |
user_labels |
MutableMapping[str, str]
The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See `Google Cloud Document |
Classes
BoostSpec
BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Boost specification to boost certain documents.
ContentSearchSpec
ContentSearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A specification for configuring the behavior of content search.
DataStoreSpec
DataStoreSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A struct to define data stores to filter on in a search call.
EmbeddingSpec
EmbeddingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The specification that uses customized query embedding vector to do semantic document retrieval.
FacetSpec
FacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A facet specification to perform faceted search.
ImageQuery
ImageQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specifies the image query input.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ParamsEntry
ParamsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |