This Recommendations AI documentation references the Recommendations console. We recommend switching to the Retail console and using the Retail documentation, which documents Recommendations AI, the Retail console, and Retail Search.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Retail API

Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.

Service: retail.googleapis.com

The Service name retail.googleapis.com is needed to create RPC client stubs.

google.cloud.location.Locations

Methods
GetLocation Gets information about a location.
ListLocations Lists information about the supported locations for this service.

google.cloud.retail.v2.CatalogService

Methods
GetDefaultBranch Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
ListCatalogs Lists all the Catalogs associated with the project.
SetDefaultBranch Set a specified branch id as default branch.
UpdateCatalog Updates the Catalogs.

google.cloud.retail.v2.CompletionService

Methods
CompleteQuery Completes the specified prefix with keyword suggestions.
ImportCompletionData Bulk import of processed completion dataset.

google.cloud.retail.v2.PredictionService

Methods
Predict Makes a recommendation prediction.

google.cloud.retail.v2.ProductService

Methods
AddFulfillmentPlaces Incrementally adds place IDs to Product.fulfillment_info.place_ids.
AddLocalInventories Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field.
CreateProduct Creates a Product.
DeleteProduct Deletes a Product.
GetProduct Gets a Product.
ImportProducts Bulk import of multiple Products.
ListProducts Gets a list of Products.
RemoveFulfillmentPlaces Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
RemoveLocalInventories Remove local inventory information for a Product at a list of places at a removal timestamp.
SetInventory Updates inventory information for a Product while respecting the last update timestamps of each inventory field.
UpdateProduct Updates a Product.

google.cloud.retail.v2.SearchService

Methods
Search Performs a search.

google.cloud.retail.v2.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of User events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
RejoinUserEvents Starts a user event rejoin operation with latest product catalog.
WriteUserEvent Writes a single user event.

google.cloud.retail.v2alpha.CatalogService

Methods
AddCatalogAttribute Adds the specified CatalogAttribute to the AttributesConfig.
GetAttributesConfig Gets an AttributesConfig.
GetCompletionConfig Gets a CompletionConfig.
GetDefaultBranch Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
ListCatalogs Lists all the Catalogs associated with the project.
RemoveCatalogAttribute Removes the specified CatalogAttribute from the AttributesConfig.
ReplaceCatalogAttribute Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.
SetDefaultBranch Set a specified branch id as default branch.
UpdateAttributesConfig Updates the AttributesConfig.
UpdateCatalog Updates the Catalogs.
UpdateCompletionConfig Updates the CompletionConfigs.

google.cloud.retail.v2alpha.CompletionService

Methods
CompleteQuery Completes the specified prefix with keyword suggestions.
ImportCompletionData Bulk import of processed completion dataset.

google.cloud.retail.v2alpha.ControlService

Methods
CreateControl Creates a Control.
DeleteControl Deletes a Control.
GetControl Gets a Control.
ListControls Lists all Controls linked to this catalog.
UpdateControl Updates a Control.

google.cloud.retail.v2alpha.PredictionService

Methods
Predict Makes a recommendation prediction.

google.cloud.retail.v2alpha.ProductService

Methods
AddFulfillmentPlaces Incrementally adds place IDs to Product.fulfillment_info.place_ids.
AddLocalInventories Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field.
CreateProduct Creates a Product.
DeleteProduct Deletes a Product.
GetProduct Gets a Product.
ImportProducts Bulk import of multiple Products.
ListProducts Gets a list of Products.
PurgeProducts Permanently deletes all selected Products under a branch.
RemoveFulfillmentPlaces Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
RemoveLocalInventories Remove local inventory information for a Product at a list of places at a removal timestamp.
SetInventory Updates inventory information for a Product while respecting the last update timestamps of each inventory field.
UpdateProduct Updates a Product.

google.cloud.retail.v2alpha.SearchService

Methods
Search Performs a search.

google.cloud.retail.v2alpha.ServingConfigService

Methods
AddControl Enables a Control on the specified ServingConfig.
CreateServingConfig Creates a ServingConfig.
DeleteServingConfig Deletes a ServingConfig.
GetServingConfig Gets a ServingConfig.
ListServingConfigs Lists all ServingConfigs linked to this catalog.
RemoveControl Disables a Control on the specified ServingConfig.
UpdateServingConfig Updates a ServingConfig.

google.cloud.retail.v2alpha.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of User events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
RejoinUserEvents Starts a user event rejoin operation with latest product catalog.
WriteUserEvent Writes a single user event.

google.cloud.retail.v2beta.CatalogService

Methods
AddCatalogAttribute Adds the specified CatalogAttribute to the AttributesConfig.
GetAttributesConfig Gets an AttributesConfig.
GetCompletionConfig Gets a CompletionConfig.
GetDefaultBranch Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
ListCatalogs Lists all the Catalogs associated with the project.
RemoveCatalogAttribute Removes the specified CatalogAttribute from the AttributesConfig.
ReplaceCatalogAttribute Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.
SetDefaultBranch Set a specified branch id as default branch.
UpdateAttributesConfig Updates the AttributesConfig.
UpdateCatalog Updates the Catalogs.
UpdateCompletionConfig Updates the CompletionConfigs.

google.cloud.retail.v2beta.CompletionService

Methods
CompleteQuery Completes the specified prefix with keyword suggestions.
ImportCompletionData Bulk import of processed completion dataset.

google.cloud.retail.v2beta.ControlService

Methods
CreateControl Creates a Control.
DeleteControl Deletes a Control.
GetControl Gets a Control.
ListControls Lists all Controls linked to this catalog.
UpdateControl Updates a Control.

google.cloud.retail.v2beta.PredictionService

Methods
Predict Makes a recommendation prediction.

google.cloud.retail.v2beta.ProductService

Methods
AddFulfillmentPlaces Incrementally adds place IDs to Product.fulfillment_info.place_ids.
AddLocalInventories Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field.
CreateProduct Creates a Product.
DeleteProduct Deletes a Product.
GetProduct Gets a Product.
ImportProducts Bulk import of multiple Products.
ListProducts Gets a list of Products.
RemoveFulfillmentPlaces Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
RemoveLocalInventories Remove local inventory information for a Product at a list of places at a removal timestamp.
SetInventory Updates inventory information for a Product while respecting the last update timestamps of each inventory field.
UpdateProduct Updates a Product.

google.cloud.retail.v2beta.SearchService

Methods
Search Performs a search.

google.cloud.retail.v2beta.ServingConfigService

Methods
AddControl Enables a Control on the specified ServingConfig.
CreateServingConfig Creates a ServingConfig.
DeleteServingConfig Deletes a ServingConfig.
GetServingConfig Gets a ServingConfig.
ListServingConfigs Lists all ServingConfigs linked to this catalog.
RemoveControl Disables a Control on the specified ServingConfig.
UpdateServingConfig Updates a ServingConfig.

google.cloud.retail.v2beta.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of User events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
RejoinUserEvents Starts a user event rejoin operation with latest product catalog.
WriteUserEvent Writes a single user event.

google.longrunning.Operations

Methods
GetOperation Gets the latest state of a long-running operation.
ListOperations Lists operations that match the specified filter in the request.