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

- [ ] Regenerate this pull request now.

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

END_COMMIT_OVERRIDE



feat: add a model_scores field in SearchResponse.results to expose model
quality signals

PiperOrigin-RevId: 775377248

Source-Link:
googleapis/googleapis@d2835e8

Source-Link:
https://github.com/googleapis/googleapis-gen/commit/e2be1360a4ca8dd17d1a24e39a4e95abfef52b46
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJldGFpbC8uT3dsQm90LnlhbWwiLCJoIjoiZTJiZTEzNjBhNGNhOGRkMTdkMWEyNGUzOWE0ZTk1YWJmZWY1MmI0NiJ9

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-retail/google/cloud/retail/__init__.py

@@ -102,6 +102,7 @@
     ColorInfo,
     Condition,
     CustomAttribute,
+    DoubleList,
     FulfillmentInfo,
     Image,
     Interval,
@@ -113,6 +114,7 @@
     Rule,
     SearchSolutionUseCase,
     SolutionType,
+    StringList,
     UserInfo,
 )
 from google.cloud.retail_v2.types.completion_service import (
@@ -299,6 +301,7 @@
     "ColorInfo",
     "Condition",
     "CustomAttribute",
+    "DoubleList",
     "FulfillmentInfo",
     "Image",
     "Interval",
@@ -307,6 +310,7 @@
     "PriceInfo",
     "Rating",
     "Rule",
+    "StringList",
     "UserInfo",
     "AttributeConfigLevel",
     "RecommendationsFilteringOption",

packages/google-cloud-retail/google/cloud/retail/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.2.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-retail/google/cloud/retail_v2/__init__.py

@@ -75,6 +75,7 @@
     ColorInfo,
     Condition,
     CustomAttribute,
+    DoubleList,
     FulfillmentInfo,
     Image,
     Interval,
@@ -86,6 +87,7 @@
     Rule,
     SearchSolutionUseCase,
     SolutionType,
+    StringList,
     UserInfo,
 )
 from .types.completion_service import CompleteQueryRequest, CompleteQueryResponse
@@ -273,6 +275,7 @@
     "DeleteModelRequest",
     "DeleteProductRequest",
     "DeleteServingConfigRequest",
+    "DoubleList",
     "ExperimentInfo",
     "ExportAnalyticsMetricsRequest",
     "ExportAnalyticsMetricsResponse",
@@ -369,6 +372,7 @@
     "SetInventoryRequest",
     "SetInventoryResponse",
     "SolutionType",
+    "StringList",
     "Tile",
     "TuneModelMetadata",
     "TuneModelRequest",

packages/google-cloud-retail/google/cloud/retail_v2/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.2.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-retail/google/cloud/retail_v2/types/__init__.py

@@ -41,6 +41,7 @@
     ColorInfo,
     Condition,
     CustomAttribute,
+    DoubleList,
     FulfillmentInfo,
     Image,
     Interval,
@@ -52,6 +53,7 @@
     Rule,
     SearchSolutionUseCase,
     SolutionType,
+    StringList,
     UserInfo,
 )
 from .completion_service import CompleteQueryRequest, CompleteQueryResponse
@@ -205,6 +207,7 @@
     "ColorInfo",
     "Condition",
     "CustomAttribute",
+    "DoubleList",
     "FulfillmentInfo",
     "Image",
     "Interval",
@@ -213,6 +216,7 @@
     "PriceInfo",
     "Rating",
     "Rule",
+    "StringList",
     "UserInfo",
     "AttributeConfigLevel",
     "RecommendationsFilteringOption",

packages/google-cloud-retail/google/cloud/retail_v2/types/common.py

@@ -40,6 +40,8 @@
         "UserInfo",
         "LocalInventory",
         "PinControlMetadata",
+        "StringList",
+        "DoubleList",
     },
 )
 
@@ -1490,4 +1492,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))

packages/google-cloud-retail/google/cloud/retail_v2/types/search_service.py

@@ -440,6 +440,17 @@ class SearchRequest(proto.Message):
             local inventory with the matching product's
             [LocalInventory.place_id][google.cloud.retail.v2.LocalInventory.place_id]
             for revenue optimization.
+        user_attributes (MutableMapping[str, google.cloud.retail_v2.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 SearchMode(proto.Enum):
@@ -912,10 +923,11 @@ class QueryExpansionSpec(proto.Message):
                 Default to
                 [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
             pin_unexpanded_results (bool):
-                Whether to pin unexpanded results. If this
-                field is set to true, unexpanded products are
-                always at the top of the search results,
-                followed by the expanded results.
+                Whether to pin unexpanded results. The
+                default value is false. If this field is set to
+                true, unexpanded products are always at the top
+                of the search results, followed by the expanded
+                results.
         """
 
         class Condition(proto.Enum):
@@ -1276,6 +1288,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):
@@ -1447,6 +1465,8 @@ class SearchResult(proto.Message):
 
                 -  ``purchased``: Indicates that this product has been
                    purchased before.
+            model_scores (MutableMapping[str, google.cloud.retail_v2.types.DoubleList]):
+                Google provided available scores.
         """
 
         id: str = proto.Field(
@@ -1480,6 +1500,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.

packages/google-cloud-retail/google/cloud/retail_v2/types/user_event.py

@@ -78,7 +78,7 @@ class UserEvent(proto.Message):
             length limit of 128 bytes. A session is an aggregation of an
             end user behavior in a time span.
 
-            A general guideline to populate the sesion_id:
+            A general guideline to populate the session_id:
 
             1. If user has no activity for 30 min, a new session_id
                should be assigned.

packages/google-cloud-retail/google/cloud/retail_v2alpha/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.2.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-retail/google/cloud/retail_v2beta/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.2.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}