Performs a search.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
servingConfig |
Required. The resource name of the servingConfigs.search serving config, such as |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "branch": string, "query": string, "imageQuery": { object ( |
Fields | |
---|---|
branch |
The branch resource name, such as Use |
query |
Raw search query. |
imageQuery |
Raw image query. |
pageSize |
Maximum number of
If this field is negative, an |
pageToken |
A page token received from a previous When paginating, all other parameters provided to |
offset |
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the If this field is negative, an |
dataStoreSpecs[] |
Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. |
filter |
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 Filtering in Vertex AI servingConfigs.search is done by mapping the LHS filter key to a key property defined in the Vertex AI servingConfigs.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 |
canonicalFilter |
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 |
orderBy |
The order in which documents are returned. Documents can be ordered by a field in an For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an |
userInfo |
Information about the end user. Highly recommended for analytics. |
languageCode |
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. |
regionCode |
The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the regionCode provided. |
facetSpecs[] |
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an |
boostSpec |
Boost specification to boost certain documents. For more information on boosting, see Boosting |
params |
Additional search parameters. For public website search only, supported values are:
For available codes see Country Codes
|
queryExpansionSpec |
The query expansion specification that specifies the conditions under which query expansion occurs. |
spellCorrectionSpec |
The spell correction specification that specifies the mode under which spell correction takes effect. |
userPseudoId |
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 This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an |
contentSearchSpec |
A specification for configuring the behavior of content search. |
embeddingSpec |
Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of If |
rankingExpression |
The ranking expression controls the customized ranking on retrieval documents. This overrides
Supported functions:
Function variables:
Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be |
safeSearch |
Whether to turn on safe search. This is only supported for website search. |
userLabels |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
naturalLanguageQueryUnderstandingSpec |
If |
searchAsYouTypeSpec |
servingConfigs.search as you type configuration. Only supported for the |
customFineTuningSpec |
Custom fine tuning configs. If set, it has higher priority than the configs set in |
session |
The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when Multi-turn servingConfigs.search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. |
sessionSpec |
Session specification. Can be used only when |
relevanceThreshold |
The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. |
Response body
If successful, the response body contains an instance of SearchResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the servingConfig
resource:
discoveryengine.servingConfigs.search
For more information, see the IAM documentation.