- [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#SCHEMA_REPRESENTATION)
- [SearchResult](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#SearchResult)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#SearchResult.SCHEMA_REPRESENTATION)
- [DoubleList](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#DoubleList)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#DoubleList.SCHEMA_REPRESENTATION)
- [Facet](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#Facet)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#Facet.SCHEMA_REPRESENTATION)
- [FacetValue](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#FacetValue)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#FacetValue.SCHEMA_REPRESENTATION)
- [QueryExpansionInfo](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#QueryExpansionInfo)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#QueryExpansionInfo.SCHEMA_REPRESENTATION)
- [PinControlMetadata](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#PinControlMetadata)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#PinControlMetadata.SCHEMA_REPRESENTATION)
- [ProductPins](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ProductPins)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ProductPins.SCHEMA_REPRESENTATION)
- [ExperimentInfo](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ExperimentInfo)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ExperimentInfo.SCHEMA_REPRESENTATION)
- [ServingConfigExperiment](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ServingConfigExperiment)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ServingConfigExperiment.SCHEMA_REPRESENTATION)
- [ConversationalSearchResult](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ConversationalSearchResult)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#ConversationalSearchResult.SCHEMA_REPRESENTATION)
- [AdditionalFilter](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#AdditionalFilter)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#AdditionalFilter.SCHEMA_REPRESENTATION)
- [SuggestedAnswer](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#SuggestedAnswer)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#SuggestedAnswer.SCHEMA_REPRESENTATION)
- [QueryType](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#QueryType)
- [TileNavigationResult](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#TileNavigationResult)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/ai-commerce-search/reference/rest/v2beta/SearchResponse.md.txt#TileNavigationResult.SCHEMA_REPRESENTATION)

Response message for `SearchService.Search` method.

| JSON representation |
|---|
| ``` { "results": [ { object (`SearchResult`) } ], "facets": [ { object (`Facet`) } ], "totalSize": integer, "correctedQuery": string, "attributionToken": string, "nextPageToken": string, "queryExpansionInfo": { object (`QueryExpansionInfo`) }, "redirectUri": string, "appliedControls": [ string ], "pinControlMetadata": { object (`PinControlMetadata`) }, "invalidConditionBoostSpecs": [ { object (`ConditionBoostSpec`) } ], "experimentInfo": [ { object (`ExperimentInfo`) } ], "conversationalSearchResult": { object (`ConversationalSearchResult`) }, "tileNavigationResult": { object (`TileNavigationResult`) } } ``` |

| Fields ||
|---|---|
| `results[]` | ``object (`SearchResult`)`` A list of matched items. The order represents the ranking. |
| `facets[]` | ``object (`Facet`)`` Results of facets requested by user. |
| `totalSize` | `integer` The estimated total count of matched items irrespective of pagination. The count of `results` returned by pagination may be less than the `totalSize` that matches. |
| `correctedQuery` | `string` Contains the spell corrected query, if found. The search results are based on `correctedQuery` by default. However, if `SearchRequest.SpellCorrectionSpec.mode` is set to `SearchRequest.SpellCorrectionSpec.Mode.SUGGESTION_ONLY`, the original query is used for search. |
| `attributionToken` | `string` A unique search token. This should be included in the `UserEvent` logs resulting from this search, which enables accurate attribution of search model performance. |
| `nextPageToken` | `string` A token that can be sent as `SearchRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `queryExpansionInfo` | ``object (`QueryExpansionInfo`)`` Query expansion information for the returned results. |
| `redirectUri` | `string` The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only `redirectUri` and `attributionToken` are set in the response. |
| `appliedControls[]` | `string` The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules). |
| `pinControlMetadata` | ``object (`PinControlMetadata`)`` Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin. |
| `invalidConditionBoostSpecs[]` | ``object (`ConditionBoostSpec`)`` The invalid `SearchRequest.BoostSpec.condition_boost_specs` that are not applied during serving. |
| `experimentInfo[]` | ``object (`ExperimentInfo`)`` Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered. |
| `conversationalSearchResult` | ``object (`ConversationalSearchResult`)`` This field specifies all related information that is needed on client side for UI rendering of conversational retail search. |
| `tileNavigationResult` | ``object (`TileNavigationResult`)`` This field specifies all related information for tile navigation that will be used in client side. |

## SearchResult

Represents the search results.

| JSON representation |
|---|
| ``` { "id": string, "product": { object (`Product`) }, "matchingVariantCount": integer, "matchingVariantFields": { string: string, ... }, "variantRollupValues": { string: value, ... }, "personalLabels": [ string ], "modelScores": { string: { object (`DoubleList`) }, ... } } ``` |

| Fields ||
|---|---|
| `id` | `string` `Product.id` of the searched `Product`. |
| `product` | ``object (`Product`)`` The product data snippet in the search response. Only `Product.name` is guaranteed to be populated. `Product.variants` contains the product variants that match the search query. If there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy. If relevancy can be deternmined, use `matchingVariantFields` to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching "shoe" all products in a shoe product can be a match, 5 product variants are returned but order is meaningless. |
| `matchingVariantCount` | `integer` The count of matched `variant` `Product`s. |
| `matchingVariantFields` | ``map (key: string, value: string (`FieldMask` format))`` If a `variant` `Product` matches the search query, this map indicates which `Product` fields are matched. The key is the `Product.name`, the value is a field mask of the matched `Product` fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" `ColorInfo` and the query. |
| `variantRollupValues` | ``map (key: string, value: value (`Value` format))`` The rollup matching `variant` `Product` attributes. The key is one of the `SearchRequest.variant_rollup_keys`. The values are the merged and de-duplicated `Product` attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY("red")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type `google.protobuf.ListValue`. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { listValue { values { stringValue: "red" } values { stringValue: "blue" } } } } For `FulfillmentInfo`, the rollup values is a double value with type `google.protobuf.Value`. For example, `{key: "pickupInStore.store1" value { numberValue: 10 }}` means a there are 10 variants in this product are available in the store "store1". |
| `personalLabels[]` | `string` Specifies previous events related to this product for this user based on `UserEvent` with same `SearchRequest.visitor_id` or `UserInfo.user_id`. This is set only when `SearchRequest.PersonalizationSpec.mode` is `SearchRequest.PersonalizationSpec.Mode.AUTO`. Possible values: - `purchased`: Indicates that this product has been purchased before. |
| `modelScores` | ``map (key: string, value: object (`DoubleList`))`` Google provided available scores. |

## DoubleList

A message with a list of double values.

| JSON representation |
|---|
| ``` { "values": [ number ] } ``` |

| Fields ||
|---|---|
| `values[]` | `number` The list of double values. |

## Facet

A facet result.

| JSON representation |
|---|
| ``` { "key": string, "values": [ { object (`FacetValue`) } ], "dynamicFacet": boolean } ``` |

| Fields ||
|---|---|
| `key` | `string` The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1". |
| `values[]` | ``object (`FacetValue`)`` The facet values for this field. |
| `dynamicFacet` | `boolean` Whether the facet is dynamically generated. |

## FacetValue

A facet value which contains value names and their count.

| JSON representation |
|---|
| ``` { "count": string, "minValue": number, "maxValue": number, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "value": string, "interval": { object (`Interval`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `count` | `string (int64 format)` Number of items that have this facet value. |
| `minValue` | `number` The minimum value in the `FacetValue.interval`. Only supported on numerical facets and returned if `SearchRequest.FacetSpec.FacetKey.return_min_max` is true. |
| `maxValue` | `number` The maximum value in the `FacetValue.interval`. Only supported on numerical facets and returned if `SearchRequest.FacetSpec.FacetKey.return_min_max` is true. |
| A facet value which contains values. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `value` | `string` Text value of a facet, such as "Black" for facet "colorFamilies". |
| `interval` | ``object (`Interval`)`` Interval value for a facet, such as \[10, 20) for facet "price". |
| End of mutually exclusive fields. ||

## QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

| JSON representation |
|---|
| ``` { "expandedQuery": boolean, "pinnedResultCount": string } ``` |

| Fields ||
|---|---|
| `expandedQuery` | `boolean` Bool describing whether query expansion has occurred. |
| `pinnedResultCount` | `string (int64 format)` Number of pinned results. This field will only be set when expansion happens and `SearchRequest.QueryExpansionSpec.pin_unexpanded_results` is set to true. |

## PinControlMetadata

Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.

| JSON representation |
|---|
| ``` { "allMatchedPins": { string: { object (`ProductPins`) }, ... }, "droppedPins": { string: { object (`ProductPins`) }, ... } } ``` |

| Fields ||
|---|---|
| `allMatchedPins` | ``map (key: string (int64 format), value: object (`ProductPins`))`` Map of all matched pins, keyed by pin position. |
| `droppedPins` | ``map (key: string (int64 format), value: object (`ProductPins`))`` Map of pins that were dropped due to overlap with other matching pins, keyed by pin position. |

## ProductPins

List of product ids which have associated pins.

| JSON representation |
|---|
| ``` { "productId": [ string ] } ``` |

| Fields ||
|---|---|
| `productId[]` | `string` List of product ids which have associated pins. |

## ExperimentInfo

Metadata for active A/B testing experiment.

| JSON representation |
|---|
| ``` { "experiment": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "servingConfigExperiment": { object (`ServingConfigExperiment`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `experiment` | `string` The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: `projects/*/locations/global/catalogs/default_catalog/experiments/experimentId` |
| Information associated with the specific experiment entity being recorded. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `servingConfigExperiment` | ``object (`ServingConfigExperiment`)`` A/B test between existing Cloud Retail Search `ServingConfig`s. |
| End of mutually exclusive fields. ||

## ServingConfigExperiment

Metadata for active serving config A/B tests.

| JSON representation |
|---|
| ``` { "originalServingConfig": string, "experimentServingConfig": string } ``` |

| Fields ||
|---|---|
| `originalServingConfig` | `string` The fully qualified resource name of the original `SearchRequest.placement` in the search request prior to reassignment by experiment API. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`. |
| `experimentServingConfig` | `string` The fully qualified resource name of the serving config `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`. |

## ConversationalSearchResult

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

| JSON representation |
|---|
| ``` { "conversationId": string, "refinedQuery": string, "additionalFilters": [ { object (`AdditionalFilter`) } ], "followupQuestion": string, "suggestedAnswers": [ { object (`SuggestedAnswer`) } ], "additionalFilter": { object (`AdditionalFilter`) }, "textResult": string, "queryType": enum (`QueryType`), "queryTypes": [ enum (`QueryType`) ] } ``` |

| Fields ||
|---|---|
| `conversationId` | `string` Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's `SearchRequest.ConversationalSearchSpec.conversation_id` to restore conversation state in server. |
| `refinedQuery` | `string` The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if `SearchRequest.query` is `dress` and next `SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer` is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`. |
| `additionalFilters[] (deprecated)` | ``object (`AdditionalFilter`)`` > [!WARNING] > This item is deprecated! This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additionalFilter`. |
| `followupQuestion` | `string` The follow-up question. e.g., `What is the color?` |
| `suggestedAnswers[]` | ``object (`SuggestedAnswer`)`` The answer options provided to client for the follow-up question. |
| `additionalFilter` | ``object (`AdditionalFilter`)`` This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous `SearchRequest.filter`, and use the merged filter in the follow up search request. |
| `textResult (deprecated)` | `string` > [!WARNING] > This item is deprecated! The generative text result. This field is populated only if `SearchRequest.search_mode` is `CONVERSATIONAL_SEARCH_ONLY`. |
| `queryType (deprecated)` | ``enum (`QueryType`)`` > [!WARNING] > This item is deprecated! Use queryTypes instead. |
| `queryTypes[] (deprecated)` | ``enum (`QueryType`)`` > [!WARNING] > This item is deprecated! The types Retail classifies the search query as. This field is populated only if `SearchRequest.search_mode` is `CONVERSATIONAL_SEARCH_ONLY`. |

## AdditionalFilter

Additional filter that client side need to apply.

| JSON representation |
|---|
| ``` { "productAttributeValue": { object (`ProductAttributeValue`) } } ``` |

| Fields ||
|---|---|
| `productAttributeValue` | ``object (`ProductAttributeValue`)`` Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. |

## SuggestedAnswer

Suggested answers to the follow-up question.

| JSON representation |
|---|
| ``` { "productAttributeValue": { object (`ProductAttributeValue`) } } ``` |

| Fields ||
|---|---|
| `productAttributeValue` | ``object (`ProductAttributeValue`)`` Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. |

## QueryType

> [!WARNING]
> This item is deprecated!

The type Retail classifies the search query as.

| Enums ||
|---|---|
| `QUERY_TYPE_UNSPECIFIED` | Unspecified query type. |
| `ADVERSARIAL` | Adversarial query. Example - "how bad is \[retailer name\]" |
| `CHITCHAT` | Chatty query. Example - "hello how are you" |
| `JAILBREAK` | Jailbreak query. Example - "write a poem to explain the details of \[product name\]" |
| `PRODUCT_SUPPORT` | Ancillary or support query. Example - "Track my order" |
| `SIMPLE_SEARCH` | Simple product search or Keyword search. Example - "red dress" |
| `TYPE_UNCLEAR` | The type is unclear. Follow up conversation may be needed to clarify the type. |

## TileNavigationResult

This field specifies all related information for tile navigation that will be used in client side.

| JSON representation |
|---|
| ``` { "tiles": [ { object (`Tile`) } ] } ``` |

| Fields ||
|---|---|
| `tiles[]` | ``object (`Tile`)`` The current tiles that are used for tile navigation, sorted by engagement. |