From a77f0ea03ab1d5a2cb976bb2bff3739c15026558 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 19 Aug 2021 20:34:27 +0000 Subject: [PATCH] docs: Keep the API doc up-to-date (#80) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 391605108 Source-Link: https://github.com/googleapis/googleapis/commit/62d50355dff115d1b566a77bbcd6ae087fb470c0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d3293d946e020fd3047df60ffd9fd6b08f393889 --- .../services/catalog_service/async_client.py | 12 +- .../services/catalog_service/client.py | 12 +- .../catalog_service/transports/grpc.py | 12 +- .../transports/grpc_asyncio.py | 12 +- .../completion_service/async_client.py | 33 ++-- .../services/completion_service/client.py | 33 ++-- .../completion_service/transports/grpc.py | 33 ++-- .../transports/grpc_asyncio.py | 33 ++-- .../services/product_service/async_client.py | 18 +- .../services/product_service/client.py | 18 +- .../product_service/transports/grpc.py | 18 +- .../transports/grpc_asyncio.py | 18 +- .../services/search_service/async_client.py | 16 +- .../services/search_service/client.py | 16 +- .../search_service/transports/grpc.py | 16 +- .../search_service/transports/grpc_asyncio.py | 16 +- .../retail_v2/types/completion_service.py | 21 ++- google/cloud/retail_v2/types/import_config.py | 2 +- google/cloud/retail_v2/types/product.py | 14 +- .../cloud/retail_v2/types/search_service.py | 175 +++++++++++------- google/cloud/retail_v2/types/user_event.py | 18 +- 21 files changed, 307 insertions(+), 239 deletions(-) diff --git a/google/cloud/retail_v2/services/catalog_service/async_client.py b/google/cloud/retail_v2/services/catalog_service/async_client.py index 65f2c54b..38888836 100644 --- a/google/cloud/retail_v2/services/catalog_service/async_client.py +++ b/google/cloud/retail_v2/services/catalog_service/async_client.py @@ -394,9 +394,9 @@ async def set_default_branch( branch {newBranch}. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.SetDefaultBranchRequest`): @@ -465,9 +465,9 @@ async def get_default_branch( method under a specified parent catalog. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.GetDefaultBranchRequest`): diff --git a/google/cloud/retail_v2/services/catalog_service/client.py b/google/cloud/retail_v2/services/catalog_service/client.py index d9a7dbb5..52b27a38 100644 --- a/google/cloud/retail_v2/services/catalog_service/client.py +++ b/google/cloud/retail_v2/services/catalog_service/client.py @@ -597,9 +597,9 @@ def set_default_branch( branch {newBranch}. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.SetDefaultBranchRequest): @@ -668,9 +668,9 @@ def get_default_branch( method under a specified parent catalog. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.GetDefaultBranchRequest): diff --git a/google/cloud/retail_v2/services/catalog_service/transports/grpc.py b/google/cloud/retail_v2/services/catalog_service/transports/grpc.py index f4f37675..44645f41 100644 --- a/google/cloud/retail_v2/services/catalog_service/transports/grpc.py +++ b/google/cloud/retail_v2/services/catalog_service/transports/grpc.py @@ -325,9 +325,9 @@ def set_default_branch( branch {newBranch}. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SetDefaultBranchRequest], @@ -361,9 +361,9 @@ def get_default_branch( method under a specified parent catalog. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.GetDefaultBranchRequest], diff --git a/google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py b/google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py index c4661cfe..57ab116a 100644 --- a/google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py +++ b/google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py @@ -333,9 +333,9 @@ def set_default_branch( branch {newBranch}. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SetDefaultBranchRequest], @@ -369,9 +369,9 @@ def get_default_branch( method under a specified parent catalog. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.GetDefaultBranchRequest], diff --git a/google/cloud/retail_v2/services/completion_service/async_client.py b/google/cloud/retail_v2/services/completion_service/async_client.py index 669460f9..afef37ef 100644 --- a/google/cloud/retail_v2/services/completion_service/async_client.py +++ b/google/cloud/retail_v2/services/completion_service/async_client.py @@ -37,10 +37,11 @@ class CompletionServiceAsyncClient: """Auto-completion service for retail. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. """ _client: CompletionServiceClient @@ -176,12 +177,12 @@ async def complete_query( timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> completion_service.CompleteQueryResponse: - r"""Completes the specified prefix with keyword - suggestions. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + r"""Completes the specified prefix with keyword suggestions. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.CompleteQueryRequest`): @@ -228,12 +229,14 @@ async def import_completion_data( metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of processed completion dataset. - Request processing may be synchronous. Partial updating - is not supported. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + Request processing may be synchronous. Partial updating is not + supported. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.ImportCompletionDataRequest`): diff --git a/google/cloud/retail_v2/services/completion_service/client.py b/google/cloud/retail_v2/services/completion_service/client.py index 80dcbd85..056a16e7 100644 --- a/google/cloud/retail_v2/services/completion_service/client.py +++ b/google/cloud/retail_v2/services/completion_service/client.py @@ -76,10 +76,11 @@ def get_transport_class( class CompletionServiceClient(metaclass=CompletionServiceClientMeta): """Auto-completion service for retail. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. """ @staticmethod @@ -367,12 +368,12 @@ def complete_query( timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> completion_service.CompleteQueryResponse: - r"""Completes the specified prefix with keyword - suggestions. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + r"""Completes the specified prefix with keyword suggestions. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.CompleteQueryRequest): @@ -420,12 +421,14 @@ def import_completion_data( metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: r"""Bulk import of processed completion dataset. - Request processing may be synchronous. Partial updating - is not supported. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + Request processing may be synchronous. Partial updating is not + supported. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.ImportCompletionDataRequest): diff --git a/google/cloud/retail_v2/services/completion_service/transports/grpc.py b/google/cloud/retail_v2/services/completion_service/transports/grpc.py index 9b87675b..e6f3a9ec 100644 --- a/google/cloud/retail_v2/services/completion_service/transports/grpc.py +++ b/google/cloud/retail_v2/services/completion_service/transports/grpc.py @@ -35,10 +35,11 @@ class CompletionServiceGrpcTransport(CompletionServiceTransport): """gRPC backend transport for CompletionService. Auto-completion service for retail. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -256,12 +257,12 @@ def complete_query( ]: r"""Return a callable for the complete query method over gRPC. - Completes the specified prefix with keyword - suggestions. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + Completes the specified prefix with keyword suggestions. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.CompleteQueryRequest], @@ -290,12 +291,14 @@ def import_completion_data( r"""Return a callable for the import completion data method over gRPC. Bulk import of processed completion dataset. - Request processing may be synchronous. Partial updating - is not supported. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + Request processing may be synchronous. Partial updating is not + supported. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.ImportCompletionDataRequest], diff --git a/google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py b/google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py index 768f8d2a..f20c73fe 100644 --- a/google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py +++ b/google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py @@ -37,10 +37,11 @@ class CompletionServiceGrpcAsyncIOTransport(CompletionServiceTransport): """gRPC AsyncIO backend transport for CompletionService. Auto-completion service for retail. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -261,12 +262,12 @@ def complete_query( ]: r"""Return a callable for the complete query method over gRPC. - Completes the specified prefix with keyword - suggestions. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + Completes the specified prefix with keyword suggestions. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.CompleteQueryRequest], @@ -295,12 +296,14 @@ def import_completion_data( r"""Return a callable for the import completion data method over gRPC. Bulk import of processed completion dataset. - Request processing may be synchronous. Partial updating - is not supported. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + Request processing may be synchronous. Partial updating is not + supported. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.ImportCompletionDataRequest], diff --git a/google/cloud/retail_v2/services/product_service/async_client.py b/google/cloud/retail_v2/services/product_service/async_client.py index aec45efc..dfb74841 100644 --- a/google/cloud/retail_v2/services/product_service/async_client.py +++ b/google/cloud/retail_v2/services/product_service/async_client.py @@ -764,9 +764,9 @@ async def set_inventory( [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.SetInventoryRequest`): @@ -919,9 +919,9 @@ async def add_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.AddFulfillmentPlacesRequest`): @@ -1024,9 +1024,9 @@ async def remove_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest`): diff --git a/google/cloud/retail_v2/services/product_service/client.py b/google/cloud/retail_v2/services/product_service/client.py index 44619e70..3edf319b 100644 --- a/google/cloud/retail_v2/services/product_service/client.py +++ b/google/cloud/retail_v2/services/product_service/client.py @@ -974,9 +974,9 @@ def set_inventory( [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.SetInventoryRequest): @@ -1129,9 +1129,9 @@ def add_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.AddFulfillmentPlacesRequest): @@ -1234,9 +1234,9 @@ def remove_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest): diff --git a/google/cloud/retail_v2/services/product_service/transports/grpc.py b/google/cloud/retail_v2/services/product_service/transports/grpc.py index 8599fc3f..f2792df5 100644 --- a/google/cloud/retail_v2/services/product_service/transports/grpc.py +++ b/google/cloud/retail_v2/services/product_service/transports/grpc.py @@ -463,9 +463,9 @@ def set_inventory( [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SetInventoryRequest], @@ -508,9 +508,9 @@ def add_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.AddFulfillmentPlacesRequest], @@ -553,9 +553,9 @@ def remove_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.RemoveFulfillmentPlacesRequest], diff --git a/google/cloud/retail_v2/services/product_service/transports/grpc_asyncio.py b/google/cloud/retail_v2/services/product_service/transports/grpc_asyncio.py index 5ef2127f..a06268db 100644 --- a/google/cloud/retail_v2/services/product_service/transports/grpc_asyncio.py +++ b/google/cloud/retail_v2/services/product_service/transports/grpc_asyncio.py @@ -477,9 +477,9 @@ def set_inventory( [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SetInventoryRequest], @@ -523,9 +523,9 @@ def add_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.AddFulfillmentPlacesRequest], @@ -569,9 +569,9 @@ def remove_fulfillment_places( [ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. This feature is only available for users who have Retail Search - enabled. Contact Retail Support - (retail-search-support@google.com) if you are interested in - using Retail Search. + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.RemoveFulfillmentPlacesRequest], diff --git a/google/cloud/retail_v2/services/search_service/async_client.py b/google/cloud/retail_v2/services/search_service/async_client.py index 0d29b142..093b856b 100644 --- a/google/cloud/retail_v2/services/search_service/async_client.py +++ b/google/cloud/retail_v2/services/search_service/async_client.py @@ -35,10 +35,11 @@ class SearchServiceAsyncClient: """Service for search. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. """ _client: SearchServiceClient @@ -177,10 +178,11 @@ async def search( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.SearchAsyncPager: r"""Performs a search. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (:class:`google.cloud.retail_v2.types.SearchRequest`): diff --git a/google/cloud/retail_v2/services/search_service/client.py b/google/cloud/retail_v2/services/search_service/client.py index deb8f6c8..177b7ee4 100644 --- a/google/cloud/retail_v2/services/search_service/client.py +++ b/google/cloud/retail_v2/services/search_service/client.py @@ -70,10 +70,11 @@ def get_transport_class(cls, label: str = None,) -> Type[SearchServiceTransport] class SearchServiceClient(metaclass=SearchServiceClientMeta): """Service for search. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. """ @staticmethod @@ -384,10 +385,11 @@ def search( metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.SearchPager: r"""Performs a search. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Args: request (google.cloud.retail_v2.types.SearchRequest): diff --git a/google/cloud/retail_v2/services/search_service/transports/grpc.py b/google/cloud/retail_v2/services/search_service/transports/grpc.py index ab60cf74..c02af97c 100644 --- a/google/cloud/retail_v2/services/search_service/transports/grpc.py +++ b/google/cloud/retail_v2/services/search_service/transports/grpc.py @@ -32,10 +32,11 @@ class SearchServiceGrpcTransport(SearchServiceTransport): """gRPC backend transport for SearchService. Service for search. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -236,10 +237,11 @@ def search( r"""Return a callable for the search method over gRPC. Performs a search. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SearchRequest], diff --git a/google/cloud/retail_v2/services/search_service/transports/grpc_asyncio.py b/google/cloud/retail_v2/services/search_service/transports/grpc_asyncio.py index 81d4e709..e0e2721d 100644 --- a/google/cloud/retail_v2/services/search_service/transports/grpc_asyncio.py +++ b/google/cloud/retail_v2/services/search_service/transports/grpc_asyncio.py @@ -34,10 +34,11 @@ class SearchServiceGrpcAsyncIOTransport(SearchServiceTransport): """gRPC AsyncIO backend transport for SearchService. Service for search. + This feature is only available for users who have Retail Search - enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using Retail - Search. + enabled. Please submit a form + `here `__ to contact cloud sales + if you are interested in using Retail Search. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -241,10 +242,11 @@ def search( r"""Return a callable for the search method over gRPC. Performs a search. - This feature is only available for users who have Retail - Search enabled. Contact Retail Support (retail-search- - support@google.com) if you are interested in using - Retail Search. + + This feature is only available for users who have Retail Search + enabled. Please submit a form + `here `__ to contact cloud + sales if you are interested in using Retail Search. Returns: Callable[[~.SearchRequest], diff --git a/google/cloud/retail_v2/types/completion_service.py b/google/cloud/retail_v2/types/completion_service.py index a28dac47..3ea97969 100644 --- a/google/cloud/retail_v2/types/completion_service.py +++ b/google/cloud/retail_v2/types/completion_service.py @@ -82,13 +82,16 @@ class CompleteQueryRequest(proto.Message): - user-data - - cloud-retail This option is not automatically enabled. - Before using cloud-retail, contact - retail-search-support@google.com first. + - cloud-retail This option requires additional + allowlisting. Before using cloud-retail, contact Cloud + Retail support team first. max_suggestions (int): - Completion max suggestions. - The maximum allowed max suggestions is 20. The - default value is 20. + Completion max suggestions. If left unset or set to 0, then + will fallback to the configured value + [CompletionConfig.max_suggestions][]. + + The maximum allowed max suggestions is 20. If it is set + higher, it will be capped by 20. """ catalog = proto.Field(proto.STRING, number=1,) @@ -113,9 +116,9 @@ class CompleteQueryResponse(proto.Message): resulting from this completion, which enables accurate attribution of complete model performance. recent_search_results (Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.RecentSearchResult]): - Matched recent searches of this user. This field is a - restricted feature. Contact Retail Support - (retail-search-support@google.com) if you are interested in + Matched recent searches of this user. The maximum number of + recent searches is 10. This field is a restricted feature. + Contact Retail Search support team if you are interested in enabling it. This feature is only available when diff --git a/google/cloud/retail_v2/types/import_config.py b/google/cloud/retail_v2/types/import_config.py index d56995db..0e4e64f0 100644 --- a/google/cloud/retail_v2/types/import_config.py +++ b/google/cloud/retail_v2/types/import_config.py @@ -356,7 +356,7 @@ class CompletionDataInputConfig(proto.Message): Attributes: big_query_source (google.cloud.retail_v2.types.BigQuerySource): Required. BigQuery input source. - Add the IAM permission “BigQuery Data Viewer” + Add the IAM permission "BigQuery Data Viewer" for cloud-retail-customer-data- access@system.gserviceaccount.com before using this feature otherwise an error is thrown. diff --git a/google/cloud/retail_v2/types/product.py b/google/cloud/retail_v2/types/product.py index 50d5416a..dd2a65f3 100644 --- a/google/cloud/retail_v2/types/product.py +++ b/google/cloud/retail_v2/types/product.py @@ -249,13 +249,9 @@ class Product(proto.Message): This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: - - Max entries count: 200 by default; 100 for - [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. + - Max entries count: 200. - The key must be a UTF-8 encoded string with a length limit of 128 characters. - - Max indexable entries count: 200 by default; 40 for - [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. - - Max searchable entries count: 30. - For indexable attribute, the key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9\_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. @@ -368,7 +364,7 @@ class Product(proto.Message): The material of the product. For example, "leather", "wooden". - A maximum of 5 values are allowed. Each value must be a + A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -476,8 +472,12 @@ class Product(proto.Message): - [name][google.cloud.retail.v2.Product.name] - [color_info][google.cloud.retail.v2.Product.color_info] - Maximum number of paths is 20. Otherwise, an + Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. + + Note: Returning more fields in + [SearchResponse][google.cloud.retail.v2.SearchResponse] may + increase response payload size and serving latency. variants (Sequence[google.cloud.retail_v2.types.Product]): Output only. Product variants grouped together on primary product which share similar product attributes. It's diff --git a/google/cloud/retail_v2/types/search_service.py b/google/cloud/retail_v2/types/search_service.py index f9ff1abe..a164cfdf 100644 --- a/google/cloud/retail_v2/types/search_service.py +++ b/google/cloud/retail_v2/types/search_service.py @@ -94,7 +94,8 @@ class SearchRequest(proto.Message): The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is - case-sensitive. + case-sensitive. See more details at this `user + guide `__. If this field is unrecognizable, an INVALID_ARGUMENT is returned. @@ -116,7 +117,8 @@ class SearchRequest(proto.Message): ordered by a field in an [Product][google.cloud.retail.v2.Product] object. Leave it unset if ordered by relevance. OrderBy expression is - case-sensitive. + case-sensitive. See more details at this `user + guide `__. If this field is unrecognizable, an INVALID_ARGUMENT is returned. @@ -131,16 +133,17 @@ class SearchRequest(proto.Message): facets. Notice that only textual facets can be dynamically generated. This feature requires additional allowlisting. - Contact Retail Support (retail-search- - support@google.com) if you are interested in - using dynamic facet feature. + Contact Retail Search support team if you are + interested in using dynamic facet feature. boost_spec (google.cloud.retail_v2.types.SearchRequest.BoostSpec): - Boost specification to boost certain - products. + Boost specification to boost certain products. See more + details at this `user + guide `__. query_expansion_spec (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec): - The query expansion specification that - specifies the conditions under which query - expansion will occur. + The query expansion specification that specifies the + conditions under which query expansion will occur. See more + details at this `user + guide `__. variant_rollup_keys (Sequence[str]): The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] @@ -154,9 +157,9 @@ class SearchRequest(proto.Message): lead to extra query latency. Maximum number of keys is 10. For - [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info], - a fulfillment type and a fulfillment ID must be provided in - the format of "fulfillmentType.filfillmentId". E.g., in + [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo], a + fulfillment type and a fulfillment ID must be provided in + the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. @@ -169,31 +172,51 @@ class SearchRequest(proto.Message): - attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2.Product.attributes] map. - - pickupInStore.id, where id is any [FulfillmentInfo.ids][] - for type [FulfillmentInfo.Type.PICKUP_IN_STORE][]. - - shipToStore.id, where id is any [FulfillmentInfo.ids][] - for type [FulfillmentInfo.Type.SHIP_TO_STORE][]. + - pickupInStore.id, where id is any + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "pickup-in-store". + - shipToStore.id, where id is any + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "ship-to-store". - sameDayDelivery.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.SAME_DAY_DELIVERY][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "same-day-delivery". - nextDayDelivery.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "next-day-delivery". - customFulfillment1.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.CUSTOM_TYPE_1][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "custom-type-1". - customFulfillment2.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.CUSTOM_TYPE_2][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "custom-type-2". - customFulfillment3.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.CUSTOM_TYPE_3][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "custom-type-3". - customFulfillment4.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.CUSTOM_TYPE_4][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "custom-type-4". - customFulfillment5.id, where id is any - [FulfillmentInfo.ids][] for type - [FulfillmentInfo.Type.CUSTOM_TYPE_5][]. + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + for + [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] + "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. @@ -294,37 +317,37 @@ class FacetKey(proto.Message): [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query] is not specified: - Textual facet keys: - - - brands - - categories - - genders - - ageGroups - - availability - - colorFamilies - - colors - - sizes - - materials - - patterns - - conditions - - attributes.key - - pickupInStore - - shipToStore - - sameDayDelivery - - nextDayDelivery - - customFulfillment1 - - customFulfillment2 - - customFulfillment3 - - customFulfillment4 - - customFulfillment5 - - Numeric facet keys: - - - price - - discount - - rating - - ratingCount - - attributes.key + - textual_field = + + - "brands" + - "categories" + - "genders" + - "ageGroups" + - "availability" + - "colorFamilies" + - "colors" + - "sizes" + - "materials" + - "patterns" + - "conditions" + - "attributes.key" + - "pickupInStore" + - "shipToStore" + - "sameDayDelivery" + - "nextDayDelivery" + - "customFulfillment1" + - "customFulfillment2" + - "customFulfillment3" + - "customFulfillment4" + - "customFulfillment5" + + - numerical_field = + + - "price" + - "discount" + - "rating" + - "ratingCount" + - "attributes.key". intervals (Sequence[google.cloud.retail_v2.types.Interval]): Set only if values should be bucketized into intervals. Must be set for facets with numerical @@ -389,7 +412,8 @@ class FacetKey(proto.Message): order `__; numerical intervals are sorted in the order given by [FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals]; - [FulfillmentInfo.ids][] are sorted in the order given by + [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] + are sorted in the order given by [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values]. query (str): The query that is used to compute facet for the given facet @@ -477,12 +501,9 @@ class ConditionBoostSpec(proto.Message): Examples: - To boost products with product ID "product_1" or - "product_2", and color "Red" or "Blue": - :: - - (id: ANY("product_1", "product_2")) - AND - (colorFamilies: ANY("Red", "Blue")) + "product_2", and color "Red" or "Blue": *(id: + ANY("product_1", "product_2"))* *AND* *(colorFamilies: + ANY("Red", "Blue"))* boost (float): Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. @@ -522,6 +543,11 @@ class QueryExpansionSpec(proto.Message): The condition under which query expansion should occur. 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. """ class Condition(proto.Enum): @@ -535,6 +561,7 @@ class Condition(proto.Enum): condition = proto.Field( proto.ENUM, number=1, enum="SearchRequest.QueryExpansionSpec.Condition", ) + pin_unexpanded_results = proto.Field(proto.BOOL, number=2,) placement = proto.Field(proto.STRING, number=1,) branch = proto.Field(proto.STRING, number=2,) @@ -674,9 +701,9 @@ class SearchResult(proto.Message): } For - [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info], + [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo], the rollup values is a double value with type - [google.protobuf.Value][google.protobuf.Value]. For example: + [google.protobuf.Value][google.protobuf.Value]. For example, ``{key: "pickupInStore.store1" value { number_value: 10 }}`` means a there are 10 variants in this product are available in the store "store1". @@ -737,9 +764,15 @@ class QueryExpansionInfo(proto.Message): expanded_query (bool): Bool describing whether query expansion has occurred. + pinned_result_count (int): + Number of pinned results. This field will only be set when + expansion happens and + [SearchRequest.query_expansion_spec.pin_unexpanded_results][] + is set to true. """ expanded_query = proto.Field(proto.BOOL, number=1,) + pinned_result_count = proto.Field(proto.INT64, number=2,) @property def raw_page(self): diff --git a/google/cloud/retail_v2/types/user_event.py b/google/cloud/retail_v2/types/user_event.py index 377d99ab..1c934780 100644 --- a/google/cloud/retail_v2/types/user_event.py +++ b/google/cloud/retail_v2/types/user_event.py @@ -305,9 +305,21 @@ class ProductDetail(proto.Message): Required. [Product][google.cloud.retail.v2.Product] information. - Only [Product.id][google.cloud.retail.v2.Product.id] field - is used when ingesting an event, all other product fields - are ignored as we will look them up from the catalog. + Required field(s): + + - [Product.id][google.cloud.retail.v2.Product.id] + + Optional override field(s): + + - [Product.price_info][google.cloud.retail.v2.Product.price_info] + + If any supported optional fields are provided, we will treat + them as a full override when looking up product information + from the catalog. Thus, it is important to ensure that the + overriding fields are accurate and complete. + + All other product fields are ignored and instead populated + via catalog lookup after event ingestion. quantity (google.protobuf.wrappers_pb2.Int32Value): Quantity of the product associated with the user event.