feat: [google-cloud-retail] add a user_attributes field in SearchRequest that can be used for personalization (googleapis#13950)

gcf-owl-bot[bot] · web-flow · commit 3eb9d240d80d · 2025-05-28T23:00:37.000+05:00
BEGIN_COMMIT_OVERRIDE feat: add a user_attributes field in SearchRequest that can be used for personalization feat: add a model_scores field in SearchResponse.results to expose model quality signals feat: data_source_id replaces primary_feed_id in MerchantCenterFeedFilter END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. feat: add a model_scores field in SearchResponse.results to expose model quality signals feat: data_source_id replaces primary_feed_id in MerchantCenterFeedFilter PiperOrigin-RevId: 763884353 Source-Link: googleapis/googleapis@6d09280 Source-Link: https://github.com/googleapis/googleapis-gen/commit/61900159032488fc309bf741a7be1dcd6a247383 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJldGFpbC8uT3dsQm90LnlhbWwiLCJoIjoiNjE5MDAxNTkwMzI0ODhmYzMwOWJmNzQxYTdiZTFkY2Q2YTI0NzM4MyJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/__init__.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/__init__.py
@@ -96,6 +96,7 @@
     ColorInfo,
     Condition,
     CustomAttribute,
+    DoubleList,
     FulfillmentInfo,
     Image,
     Interval,
@@ -107,6 +108,7 @@
     Rule,
     SearchSolutionUseCase,
     SolutionType,
+    StringList,
     UserInfo,
 )
 from .types.completion_service import CompleteQueryRequest, CompleteQueryResponse
@@ -344,6 +346,7 @@
     "DeleteModelRequest",
     "DeleteProductRequest",
     "DeleteServingConfigRequest",
+    "DoubleList",
     "EnrollSolutionMetadata",
     "EnrollSolutionRequest",
     "EnrollSolutionResponse",
@@ -465,6 +468,7 @@
     "SetInventoryRequest",
     "SetInventoryResponse",
     "SolutionType",
+    "StringList",
     "Tile",
     "TransformedUserEventsMetadata",
     "TuneModelMetadata",
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/__init__.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/__init__.py
@@ -48,6 +48,7 @@
     ColorInfo,
     Condition,
     CustomAttribute,
+    DoubleList,
     FulfillmentInfo,
     Image,
     Interval,
@@ -59,6 +60,7 @@
     Rule,
     SearchSolutionUseCase,
     SolutionType,
+    StringList,
     UserInfo,
 )
 from .completion_service import CompleteQueryRequest, CompleteQueryResponse
@@ -255,6 +257,7 @@
     "ColorInfo",
     "Condition",
     "CustomAttribute",
+    "DoubleList",
     "FulfillmentInfo",
     "Image",
     "Interval",
@@ -263,6 +266,7 @@
     "PriceInfo",
     "Rating",
     "Rule",
+    "StringList",
     "UserInfo",
     "AttributeConfigLevel",
     "RecommendationsFilteringOption",
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/catalog.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/catalog.py
@@ -831,7 +831,10 @@ class MerchantCenterFeedFilter(proto.Message):
 
     Attributes:
         primary_feed_id (int):
-            Merchant Center primary feed ID.
+            Merchant Center primary feed ID. Deprecated: use
+            data_source_id instead.
+        data_source_id (int):
+            AFM data source ID.
         primary_feed_name (str):
             Merchant Center primary feed name. The name
             is used for the display purposes only.
@@ -841,6 +844,10 @@ class MerchantCenterFeedFilter(proto.Message):
         proto.INT64,
         number=1,
     )
+    data_source_id: int = proto.Field(
+        proto.INT64,
+        number=3,
+    )
     primary_feed_name: str = proto.Field(
         proto.STRING,
         number=2,
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/common.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/common.py
@@ -40,6 +40,8 @@
         "UserInfo",
         "LocalInventory",
         "PinControlMetadata",
+        "StringList",
+        "DoubleList",
     },
 )
 
@@ -1554,4 +1556,32 @@ class ProductPins(proto.Message):
     )
 
 
+class StringList(proto.Message):
+    r"""A list of string values.
+
+    Attributes:
+        values (MutableSequence[str]):
+            String values.
+    """
+
+    values: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=1,
+    )
+
+
+class DoubleList(proto.Message):
+    r"""A message with a list of double values.
+
+    Attributes:
+        values (MutableSequence[float]):
+            The list of double values.
+    """
+
+    values: MutableSequence[float] = proto.RepeatedField(
+        proto.DOUBLE,
+        number=1,
+    )
+
+
 __all__ = tuple(sorted(__protobuf__.manifest))
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/conversational_search_service.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/conversational_search_service.py
@@ -329,6 +329,9 @@ class FollowupQuestion(proto.Message):
 
         class SuggestedAnswer(proto.Message):
             r"""Suggested answers to the follow-up question.
+            If it's numerical attribute, only ProductAttributeInterval will
+            be set. If it's textual attribute, only productAttributeValue
+            will be set.
 
             Attributes:
                 product_attribute_value (google.cloud.retail_v2alpha.types.ProductAttributeValue):
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/merchant_center_account_link.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/merchant_center_account_link.py
@@ -115,7 +115,10 @@ class MerchantCenterFeedFilter(proto.Message):
 
         Attributes:
             primary_feed_id (int):
-                Merchant Center primary feed ID.
+                Merchant Center primary feed ID. Deprecated: use
+                data_source_id instead.
+            data_source_id (int):
+                AFM data source ID.
             primary_feed_name (str):
                 Merchant Center primary feed name. The name
                 is used for the display purposes only.
@@ -125,6 +128,10 @@ class MerchantCenterFeedFilter(proto.Message):
             proto.INT64,
             number=1,
         )
+        data_source_id: int = proto.Field(
+            proto.INT64,
+            number=3,
+        )
         primary_feed_name: str = proto.Field(
             proto.STRING,
             number=2,
diff --git a/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/search_service.py b/packages/google-cloud-retail/google/cloud/retail_v2alpha/types/search_service.py
@@ -453,6 +453,17 @@ class SearchRequest(proto.Message):
             local inventory with the matching product's
             [LocalInventory.place_id][google.cloud.retail.v2alpha.LocalInventory.place_id]
             for revenue optimization.
+        user_attributes (MutableMapping[str, google.cloud.retail_v2alpha.types.StringList]):
+            Optional. The user attributes that could be used for
+            personalization of search results.
+
+            -  Populate at most 100 key-value pairs per query.
+            -  Only supports string keys and repeated string values.
+            -  Duplcate keys are not allowed within a single query.
+
+            Example: user_attributes: [ { key: "pets" value { values:
+            "dog" values: "cat" } }, { key: "state" value { values: "CA"
+            } } ]
     """
 
     class RelevanceThreshold(proto.Enum):
@@ -1319,6 +1330,12 @@ class TileNavigationSpec(proto.Message):
         proto.STRING,
         number=46,
     )
+    user_attributes: MutableMapping[str, common.StringList] = proto.MapField(
+        proto.STRING,
+        proto.MESSAGE,
+        number=47,
+        message=common.StringList,
+    )
 
 
 class SearchResponse(proto.Message):
@@ -1492,6 +1509,8 @@ class SearchResult(proto.Message):
 
                 -  ``purchased``: Indicates that this product has been
                    purchased before.
+            model_scores (MutableMapping[str, google.cloud.retail_v2alpha.types.DoubleList]):
+                Google provided available scores.
         """
 
         id: str = proto.Field(
@@ -1525,6 +1544,12 @@ class SearchResult(proto.Message):
             proto.STRING,
             number=7,
         )
+        model_scores: MutableMapping[str, common.DoubleList] = proto.MapField(
+            proto.STRING,
+            proto.MESSAGE,
+            number=8,
+            message=common.DoubleList,
+        )
 
     class Facet(proto.Message):
         r"""A facet result.
diff --git a/packages/google-cloud-retail/scripts/fixup_retail_v2alpha_keywords.py b/packages/google-cloud-retail/scripts/fixup_retail_v2alpha_keywords.py
@@ -98,7 +98,7 @@ class retailCallTransformer(cst.CSTTransformer):
         'remove_local_inventories': ('product', 'place_ids', 'remove_time', 'allow_missing', ),
         'replace_catalog_attribute': ('attributes_config', 'catalog_attribute', 'update_mask', ),
         'resume_model': ('name', ),
-        'search': ('placement', 'visitor_id', 'branch', 'query', 'user_info', 'page_size', 'page_token', 'offset', 'filter', 'canonical_filter', 'order_by', 'facet_specs', 'dynamic_facet_spec', 'boost_spec', 'query_expansion_spec', 'relevance_threshold', 'variant_rollup_keys', 'page_categories', 'search_mode', 'personalization_spec', 'labels', 'spell_correction_spec', 'entity', 'conversational_search_spec', 'tile_navigation_spec', 'language_code', 'region_code', 'place_id', ),
+        'search': ('placement', 'visitor_id', 'branch', 'query', 'user_info', 'page_size', 'page_token', 'offset', 'filter', 'canonical_filter', 'order_by', 'facet_specs', 'dynamic_facet_spec', 'boost_spec', 'query_expansion_spec', 'relevance_threshold', 'variant_rollup_keys', 'page_categories', 'search_mode', 'personalization_spec', 'labels', 'spell_correction_spec', 'entity', 'conversational_search_spec', 'tile_navigation_spec', 'language_code', 'region_code', 'place_id', 'user_attributes', ),
         'set_default_branch': ('catalog', 'branch_id', 'note', 'force', ),
         'set_inventory': ('inventory', 'set_mask', 'set_time', 'allow_missing', ),
         'tune_model': ('name', ),
diff --git a/packages/google-cloud-retail/tests/unit/gapic/retail_v2alpha/test_catalog_service.py b/packages/google-cloud-retail/tests/unit/gapic/retail_v2alpha/test_catalog_service.py
@@ -8085,6 +8085,7 @@ def test_update_catalog_rest_call_success(request_type):
                     "feeds": [
                         {
                             "primary_feed_id": 1571,
+                            "data_source_id": 1462,
                             "primary_feed_name": "primary_feed_name_value",
                         }
                     ],
diff --git a/packages/google-cloud-retail/tests/unit/gapic/retail_v2alpha/test_merchant_center_account_link_service.py b/packages/google-cloud-retail/tests/unit/gapic/retail_v2alpha/test_merchant_center_account_link_service.py
@@ -3376,7 +3376,11 @@ def test_create_merchant_center_account_link_rest_call_success(request_type):
         "feed_label": "feed_label_value",
         "language_code": "language_code_value",
         "feed_filters": [
-            {"primary_feed_id": 1571, "primary_feed_name": "primary_feed_name_value"}
+            {
+                "primary_feed_id": 1571,
+                "data_source_id": 1462,
+                "primary_feed_name": "primary_feed_name_value",
+            }
         ],
         "state": 1,
         "project_id": "project_id_value",

Original file line number	Diff line number	Diff line change
`@@ -8085,6 +8085,7 @@ def test_update_catalog_rest_call_success(request_type):`
`8085`	`8085`	`"feeds": [`
`8086`	`8086`	`{`
`8087`	`8087`	`"primary_feed_id": 1571,`
	`8088`	`+ "data_source_id": 1462,`
`8088`	`8089`	`"primary_feed_name": "primary_feed_name_value",`
`8089`	`8090`	`}`
`8090`	`8091`	`],`