- JSON representation
- SearchResult
- Facet
- FacetValue
- QueryExpansionInfo
- ExperimentInfo
- ServingConfigExperiment
Response message for SearchService.Search
method.
JSON representation |
---|
{ "results": [ { object ( |
Fields | |
---|---|
results[] |
A list of matched items. The order represents the ranking. |
facets[] |
Results of facets requested by user. |
totalSize |
The estimated total count of matched items irrespective of pagination. The count of |
correctedQuery |
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on correctedQuery. Otherwise the original query is used for search. |
attributionToken |
A unique search token. This should be included in the |
nextPageToken |
A token that can be sent as |
queryExpansionInfo |
Query expansion information for the returned results. |
redirectUri |
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only |
appliedControls[] |
The fully qualified resource name of applied controls. |
invalidConditionBoostSpecs[] |
The invalid |
experimentInfo[] |
Metadata related to A/B testing [Experiment][] associated with this response. Only exists when an experiment is triggered. |
SearchResult
Represents the search results.
JSON representation |
---|
{
"id": string,
"product": {
object ( |
Fields | |
---|---|
id |
|
product |
The product data snippet in the search response. Only
If relevancy can be deternmined, use |
matchingVariantCount |
|
matchingVariantFields |
If a For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" |
variantRollupValues |
The rollup matching For textual and numerical attributes, the rollup values is a list of string or double values with type
For |
personalLabels[] |
Specifies previous events related to this product for this user based on This is set only when Possible values:
|
Facet
A facet result.
JSON representation |
---|
{
"key": string,
"values": [
{
object ( |
Fields | |
---|---|
key |
The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1". |
values[] |
The facet values for this field. |
dynamicFacet |
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, // Union field |
Fields | |
---|---|
count |
Number of items that have this facet value. |
minValue |
The minimum value in the |
maxValue |
The maximum value in the |
Union field facet_value . A facet value which contains values. facet_value can be only one of the following: |
|
value |
Text value of a facet, such as "Black" for facet "colorFamilies". |
interval |
Interval value for a facet, such as [10, 20) for facet "price". |
QueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
JSON representation |
---|
{ "expandedQuery": boolean, "pinnedResultCount": string } |
Fields | |
---|---|
expandedQuery |
Bool describing whether query expansion has occurred. |
pinnedResultCount |
Number of pinned results. This field will only be set when expansion happens and |
ExperimentInfo
Metadata for active A/B testing [Experiment][].
JSON representation |
---|
{ "experiment": string, // Union field |
Fields | |
---|---|
experiment |
The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: |
Union field experiment_metadata . Information associated with the specific experiment entity being recorded. experiment_metadata can be only one of the following: |
|
servingConfigExperiment |
A/B test between existing Cloud Retail Search |
ServingConfigExperiment
Metadata for active serving config A/B tests.
JSON representation |
---|
{ "originalServingConfig": string, "experimentServingConfig": string } |
Fields | |
---|---|
originalServingConfig |
The fully qualified resource name of the original |
experimentServingConfig |
The fully qualified resource name of the serving config [Experiment.VariantArm.serving_config_id][] responsible for generating the search response. For example: |