Skip to content

Commit 5354fae

Browse files
feat(retail): update the API
#### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.$ref - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.id - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.type - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.type The following keys were changed: - schemas.GoogleCloudRetailV2alphaProduct.properties.retrievableFields.description #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.$ref - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.id - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.type - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.type The following keys were changed: - schemas.GoogleCloudRetailV2betaProduct.properties.retrievableFields.description #### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.$ref - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfig.properties.llmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.id - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.description - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.properties.llmEmbeddingVersion.type - schemas.GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig.type The following keys were changed: - schemas.GoogleCloudRetailV2Product.properties.retrievableFields.description
1 parent fccb1b2 commit 5354fae

File tree

6 files changed

+93
-9
lines changed

6 files changed

+93
-9
lines changed

discovery/retail-v2.json

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2246,7 +2246,7 @@
22462246
}
22472247
}
22482248
},
2249-
"revision": "20240920",
2249+
"revision": "20241003",
22502250
"rootUrl": "https://retail.googleapis.com/",
22512251
"schemas": {
22522252
"GoogleApiHttpBody": {
@@ -4349,7 +4349,7 @@
43494349
},
43504350
"retrievableFields": {
43514351
"deprecated": true,
4352-
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
4352+
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
43534353
"format": "google-fieldmask",
43544354
"type": "string"
43554355
},
@@ -6697,6 +6697,21 @@
66976697
"frequentlyBoughtTogetherConfig": {
66986698
"$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig",
66996699
"description": "Additional configs for frequently-bought-together models."
6700+
},
6701+
"llmEmbeddingConfig": {
6702+
"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
6703+
"description": "Optional. LLM embedding config to use for this model."
6704+
}
6705+
},
6706+
"type": "object"
6707+
},
6708+
"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": {
6709+
"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.",
6710+
"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
6711+
"properties": {
6712+
"llmEmbeddingVersion": {
6713+
"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.",
6714+
"type": "string"
67006715
}
67016716
},
67026717
"type": "object"

discovery/retail-v2alpha.json

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2767,7 +2767,7 @@
27672767
}
27682768
}
27692769
},
2770-
"revision": "20240920",
2770+
"revision": "20241003",
27712771
"rootUrl": "https://retail.googleapis.com/",
27722772
"schemas": {
27732773
"GoogleApiHttpBody": {
@@ -5705,6 +5705,21 @@
57055705
"frequentlyBoughtTogetherConfig": {
57065706
"$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig",
57075707
"description": "Additional configs for frequently-bought-together models."
5708+
},
5709+
"llmEmbeddingConfig": {
5710+
"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
5711+
"description": "Optional. LLM embedding config to use for this model."
5712+
}
5713+
},
5714+
"type": "object"
5715+
},
5716+
"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": {
5717+
"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.",
5718+
"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
5719+
"properties": {
5720+
"llmEmbeddingVersion": {
5721+
"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.",
5722+
"type": "string"
57085723
}
57095724
},
57105725
"type": "object"
@@ -6172,7 +6187,7 @@
61726187
},
61736188
"retrievableFields": {
61746189
"deprecated": true,
6175-
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
6190+
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
61766191
"format": "google-fieldmask",
61776192
"type": "string"
61786193
},

discovery/retail-v2beta.json

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2391,7 +2391,7 @@
23912391
}
23922392
}
23932393
},
2394-
"revision": "20240920",
2394+
"revision": "20241003",
23952395
"rootUrl": "https://retail.googleapis.com/",
23962396
"schemas": {
23972397
"GoogleApiHttpBody": {
@@ -3662,6 +3662,21 @@
36623662
"frequentlyBoughtTogetherConfig": {
36633663
"$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig",
36643664
"description": "Additional configs for frequently-bought-together models."
3665+
},
3666+
"llmEmbeddingConfig": {
3667+
"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
3668+
"description": "Optional. LLM embedding config to use for this model."
3669+
}
3670+
},
3671+
"type": "object"
3672+
},
3673+
"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": {
3674+
"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.",
3675+
"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig",
3676+
"properties": {
3677+
"llmEmbeddingVersion": {
3678+
"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.",
3679+
"type": "string"
36653680
}
36663681
},
36673682
"type": "object"
@@ -6150,7 +6165,7 @@
61506165
},
61516166
"retrievableFields": {
61526167
"deprecated": true,
6153-
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
6168+
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
61546169
"format": "google-fieldmask",
61556170
"type": "string"
61566171
},

src/apis/retail/v2.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,6 +690,19 @@ export namespace retail_v2 {
690690
* Additional configs for frequently-bought-together models.
691691
*/
692692
frequentlyBoughtTogetherConfig?: Schema$GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig;
693+
/**
694+
* Optional. LLM embedding config to use for this model.
695+
*/
696+
llmEmbeddingConfig?: Schema$GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig;
697+
}
698+
/**
699+
* Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.
700+
*/
701+
export interface Schema$GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig {
702+
/**
703+
* Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.
704+
*/
705+
llmEmbeddingVersion?: string | null;
693706
}
694707
/**
695708
* The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.
@@ -2582,7 +2595,7 @@ export namespace retail_v2 {
25822595
*/
25832596
rating?: Schema$GoogleCloudRetailV2Rating;
25842597
/**
2585-
* Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
2598+
* Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
25862599
*/
25872600
retrievableFields?: string | null;
25882601
/**

src/apis/retail/v2alpha.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1778,6 +1778,19 @@ export namespace retail_v2alpha {
17781778
* Additional configs for frequently-bought-together models.
17791779
*/
17801780
frequentlyBoughtTogetherConfig?: Schema$GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig;
1781+
/**
1782+
* Optional. LLM embedding config to use for this model.
1783+
*/
1784+
llmEmbeddingConfig?: Schema$GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig;
1785+
}
1786+
/**
1787+
* Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.
1788+
*/
1789+
export interface Schema$GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig {
1790+
/**
1791+
* Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.
1792+
*/
1793+
llmEmbeddingVersion?: string | null;
17811794
}
17821795
/**
17831796
* The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.
@@ -2111,7 +2124,7 @@ export namespace retail_v2alpha {
21112124
*/
21122125
rating?: Schema$GoogleCloudRetailV2alphaRating;
21132126
/**
2114-
* Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
2127+
* Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
21152128
*/
21162129
retrievableFields?: string | null;
21172130
/**

0 commit comments

Comments
 (0)