This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

Method: projects.locations.dataStores.servingConfigs.search

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
IAM Permissions
Try it!

Performs a search.

HTTP request

POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`servingConfig`	`string` Required. The resource name of the servingConfigs.search serving config, such as `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.

servingConfig

string

Required. The resource name of the servingConfigs.search serving config, such as 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.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "branch": string, "query": string, "imageQuery": { object (`ImageQuery`) }, "pageSize": integer, "pageToken": string, "offset": integer, "filter": string, "orderBy": string, "userInfo": { object (`UserInfo`) }, "facetSpecs": [ { object (`FacetSpec`) } ], "boostSpec": { object (`BoostSpec`) }, "params": { string: value, ... }, "queryExpansionSpec": { object (`QueryExpansionSpec`) }, "spellCorrectionSpec": { object (`SpellCorrectionSpec`) }, "userPseudoId": string, "contentSearchSpec": { object (`ContentSearchSpec`) }, "embeddingSpec": { object (`EmbeddingSpec`) }, "rankingExpression": string, "safeSearch": boolean, "userLabels": { string: string, ... } }

{
  "branch": string,
  "query": string,
  "imageQuery": {
    object (ImageQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "offset": integer,
  "filter": string,
  "orderBy": string,
  "userInfo": {
    object (UserInfo)
  },
  "facetSpecs": [
    {
      object (FacetSpec)
    }
  ],
  "boostSpec": {
    object (BoostSpec)
  },
  "params": {
    string: value,
    ...
  },
  "queryExpansionSpec": {
    object (QueryExpansionSpec)
  },
  "spellCorrectionSpec": {
    object (SpellCorrectionSpec)
  },
  "userPseudoId": string,
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "embeddingSpec": {
    object (EmbeddingSpec)
  },
  "rankingExpression": string,
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  }
}

Fields
`branch`	`string` 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`	`string` Raw search query.
`imageQuery`	`object (ImageQuery)` Raw image query.
`pageSize`	`integer` Maximum number of `Document`s to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
`pageToken`	`string` 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`	`integer` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the `Document`s deemed by the API as relevant) in search results. This field is only considered if `pageToken` is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
`filter`	`string` 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.
`orderBy`	`string` 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. `orderBy` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
`userInfo`	`object (UserInfo)` Information about the end user. Highly recommended for analytics. `UserInfo.user_agent` is used to deduce `deviceType` for analytics.
`facetSpecs[]`	`object (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.
`boostSpec`	`object (BoostSpec)` Boost specification to boost certain documents.
`params`	`map (key: string, value: value (Value format))` 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. `searchType`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
`queryExpansionSpec`	`object (QueryExpansionSpec)` The query expansion specification that specifies the conditions under which query expansion occurs.
`spellCorrectionSpec`	`object (SpellCorrectionSpec)` The spell correction specification that specifies the mode under which spell correction takes effect.
`userPseudoId`	`string` 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.
`contentSearchSpec`	`object (ContentSearchSpec)` A specification for configuring the behavior of content search.
`embeddingSpec`	`object (EmbeddingSpec)` Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document embedding that is provided in [SearchRequest.embedding_spec.embedding_vectors.field_path][]. If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].
`rankingExpression`	`string` 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 "+". * rankingExpression = 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)`.
`safeSearch`	`boolean` Whether to turn on safe search. This is only supported for website search.
`userLabels`	`map (key: string, value: string)` 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 for more details.

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.