Retail v2 API - Namespace Google.Cloud.Retail.V2 (2.12.0)

Classes

AddCatalogAttributeRequest

Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2.CatalogService.AddCatalogAttribute] method.

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.

AddFulfillmentPlacesRequest

Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.

AddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.

AddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.

AddLocalInventoriesRequest

Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.

AddLocalInventoriesResponse

Response of the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.

AnalyticsService

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

AnalyticsService.AnalyticsServiceBase

Base class for server-side implementations of AnalyticsService

AnalyticsService.AnalyticsServiceClient

Client for AnalyticsService

AnalyticsServiceClient

AnalyticsService client wrapper, for convenient use.

AnalyticsServiceClientBuilder

Builder class for AnalyticsServiceClient to provide simple configuration of credentials, endpoint etc.

AnalyticsServiceClientImpl

AnalyticsService client wrapper implementation, for convenient use.

AnalyticsServiceSettings

Settings for AnalyticsServiceClient instances.

AttributesConfig

Catalog level attribute config.

AttributesConfigName

Resource name for the AttributesConfig resource.

Audience

An intended audience of the [Product][google.cloud.retail.v2.Product] for whom it's sold.

BatchUpdateGenerativeQuestionConfigsRequest

Request for BatchUpdateGenerativeQuestionConfig method.

BatchUpdateGenerativeQuestionConfigsResponse

Aggregated response for UpdateGenerativeQuestionConfig method.

BigQueryOutputResult

A BigQuery output result.

BigQuerySource

BigQuery source import data from.

BranchName

Resource name for the Branch resource.

Catalog

The catalog configuration.

CatalogAttribute

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

CatalogAttribute.Types

Container for nested types declared in the CatalogAttribute message type.

CatalogAttribute.Types.FacetConfig

Possible options for the facet that corresponds to the current attribute config.

CatalogAttribute.Types.FacetConfig.Types

Container for nested types declared in the FacetConfig message type.

CatalogAttribute.Types.FacetConfig.Types.IgnoredFacetValues

[Facet values][google.cloud.retail.v2.SearchResponse.Facet.values] to ignore on [facets][google.cloud.retail.v2.SearchResponse.Facet] during the specified time range for the given [SearchResponse.Facet.key][google.cloud.retail.v2.SearchResponse.Facet.key] attribute.

CatalogAttribute.Types.FacetConfig.Types.MergedFacet

The current facet key (i.e. attribute config) maps into the [merged_facet_key][google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacet.merged_facet_key]. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type).

CatalogAttribute.Types.FacetConfig.Types.MergedFacetValue

Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]. This feature is available only for textual custom attributes.

CatalogAttribute.Types.FacetConfig.Types.RerankConfig

Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).

CatalogName

Resource name for the Catalog resource.

CatalogService

Service for managing catalog configuration.

CatalogService.CatalogServiceBase

Base class for server-side implementations of CatalogService

CatalogService.CatalogServiceClient

Client for CatalogService

CatalogServiceClient

CatalogService client wrapper, for convenient use.

CatalogServiceClientBuilder

Builder class for CatalogServiceClient to provide simple configuration of credentials, endpoint etc.

CatalogServiceClientImpl

CatalogService client wrapper implementation, for convenient use.

CatalogServiceSettings

Settings for CatalogServiceClient instances.

CollectUserEventRequest

Request message for CollectUserEvent method.

ColorInfo

The color information of a [Product][google.cloud.retail.v2.Product].

CompleteQueryRequest

Autocomplete parameters.

CompleteQueryResponse

Response of the autocomplete query.

CompleteQueryResponse.Types

Container for nested types declared in the CompleteQueryResponse message type.

CompleteQueryResponse.Types.AttributeResult

Resource that represents attribute results. The list of suggestions for the attribute.

CompleteQueryResponse.Types.CompletionResult

Resource that represents completion results.

CompleteQueryResponse.Types.RecentSearchResult

Deprecated: Recent search of this user.

CompletionConfig

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

CompletionConfigName

Resource name for the CompletionConfig resource.

CompletionDataInputConfig

The input config source for completion data.

CompletionDetail

Detailed completion information including completion attribution token and clicked completion info.

CompletionService

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

CompletionService.CompletionServiceBase

Base class for server-side implementations of CompletionService

CompletionService.CompletionServiceClient

Client for CompletionService

CompletionServiceClient

CompletionService client wrapper, for convenient use.

CompletionServiceClientBuilder

Builder class for CompletionServiceClient to provide simple configuration of credentials, endpoint etc.

CompletionServiceClientImpl

CompletionService client wrapper implementation, for convenient use.

CompletionServiceSettings

Settings for CompletionServiceClient instances.

Condition

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

Condition.Types

Container for nested types declared in the Condition message type.

Condition.Types.QueryTerm

Query terms that we want to match on.

Condition.Types.TimeRange

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

Control

Configures dynamic metadata that can be linked to a [ServingConfig][google.cloud.retail.v2.ServingConfig] and affect search or recommendation results at serving time.

ControlName

Resource name for the Control resource.

ControlService

Service for modifying Control.

ControlService.ControlServiceBase

Base class for server-side implementations of ControlService

ControlService.ControlServiceClient

Client for ControlService

ControlServiceClient

ControlService client wrapper, for convenient use.

ControlServiceClientBuilder

Builder class for ControlServiceClient to provide simple configuration of credentials, endpoint etc.

ControlServiceClientImpl

ControlService client wrapper implementation, for convenient use.

ControlServiceSettings

Settings for ControlServiceClient instances.

CreateControlRequest

Request for CreateControl method.

CreateModelMetadata

Metadata associated with a create operation.

CreateModelRequest

Request for creating a model.

CreateProductRequest

Request message for [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] method.

CreateServingConfigRequest

Request for CreateServingConfig method.

CustomAttribute

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2.Product].

DeleteControlRequest

Request for DeleteControl method.

DeleteModelRequest

Request for deleting a model.

DeleteProductRequest

Request message for [ProductService.DeleteProduct][google.cloud.retail.v2.ProductService.DeleteProduct] method.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

ExperimentInfo

Metadata for active A/B testing [Experiment][].

ExperimentInfo.Types

Container for nested types declared in the ExperimentInfo message type.

ExperimentInfo.Types.ServingConfigExperiment

Metadata for active serving config A/B tests.

ExperimentName

Resource name for the Experiment resource.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

ExportAnalyticsMetricsResponse

Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

ExportErrorsConfig

Configuration of destination for Export related errors.

ExportMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

FulfillmentInfo

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

GcsOutputResult

A Gcs output result.

GcsSource

Google Cloud Storage location for input content.

GenerativeQuestionConfig

Configuration for a single generated question.

GenerativeQuestionService

Service for managing LLM generated questions in search serving.

GenerativeQuestionService.GenerativeQuestionServiceBase

Base class for server-side implementations of GenerativeQuestionService

GenerativeQuestionService.GenerativeQuestionServiceClient

Client for GenerativeQuestionService

GenerativeQuestionServiceClient

GenerativeQuestionService client wrapper, for convenient use.

GenerativeQuestionServiceClientBuilder

Builder class for GenerativeQuestionServiceClient to provide simple configuration of credentials, endpoint etc.

GenerativeQuestionServiceClientImpl

GenerativeQuestionService client wrapper implementation, for convenient use.

GenerativeQuestionServiceSettings

Settings for GenerativeQuestionServiceClient instances.

GenerativeQuestionsFeatureConfig

Configuration for overall generative question feature state.

GetAttributesConfigRequest

Request for [CatalogService.GetAttributesConfig][google.cloud.retail.v2.CatalogService.GetAttributesConfig] method.

GetCompletionConfigRequest

Request for [CatalogService.GetCompletionConfig][google.cloud.retail.v2.CatalogService.GetCompletionConfig] method.

GetControlRequest

Request for GetControl method.

GetDefaultBranchRequest

Request message to show which branch is currently the default branch.

GetDefaultBranchResponse

Response message of [CatalogService.GetDefaultBranch][google.cloud.retail.v2.CatalogService.GetDefaultBranch].

GetGenerativeQuestionsFeatureConfigRequest

Request for GetGenerativeQuestionsFeatureConfig method.

GetModelRequest

Request for getting a model.

GetProductRequest

Request message for [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] method.

GetServingConfigRequest

Request for GetServingConfig method.

Image

[Product][google.cloud.retail.v2.Product] image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

ImportCompletionDataResponse

Response of the [ImportCompletionDataRequest][google.cloud.retail.v2.ImportCompletionDataRequest]. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

ImportErrorsConfig

Configuration of destination for Import related errors.

ImportMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

ImportProductsRequest

Request message for Import methods.

ImportProductsRequest.Types

Container for nested types declared in the ImportProductsRequest message type.

ImportProductsResponse

Response of the [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsResponse

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Interval

A floating point interval.

ListCatalogsRequest

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] method.

ListCatalogsResponse

Response for [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] method.

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListGenerativeQuestionConfigsRequest

Request for ListQuestions method.

ListGenerativeQuestionConfigsResponse

Response for ListQuestions method.

ListModelsRequest

Request for listing models associated with a resource.

ListModelsResponse

Response to a ListModelRequest.

ListProductsRequest

Request message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.

ListProductsResponse

Response message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

LocalInventory

The inventory information at a place (e.g. a store) identified by a place ID.

Model

Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2.Model]. A [Model][google.cloud.retail.v2.Model] can be associated with a [ServingConfig][google.cloud.retail.v2.ServingConfig] and then queried through the Predict API.

Model.Types

Container for nested types declared in the Model message type.

Model.Types.FrequentlyBoughtTogetherFeaturesConfig

Additional configs for the frequently-bought-together model type.

Model.Types.ModelFeaturesConfig

Additional model features config.

Model.Types.ServingConfigList

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

ModelName

Resource name for the Model resource.

ModelService

Service for performing CRUD operations on models. Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page).

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ModelService.ModelServiceBase

Base class for server-side implementations of ModelService

ModelService.ModelServiceClient

Client for ModelService

ModelServiceClient

ModelService client wrapper, for convenient use.

ModelServiceClientBuilder

Builder class for ModelServiceClient to provide simple configuration of credentials, endpoint etc.

ModelServiceClientImpl

ModelService client wrapper implementation, for convenient use.

ModelServiceSettings

Settings for ModelServiceClient instances.

OutputConfig

The output configuration setting.

OutputConfig.Types

Container for nested types declared in the OutputConfig message type.

OutputConfig.Types.BigQueryDestination

The BigQuery output destination configuration.

OutputConfig.Types.GcsDestination

The Google Cloud Storage output destination configuration.

OutputResult

Output result that stores the information about where the exported data is stored.

PauseModelRequest

Request for pausing training of a model.

PredictRequest

Request message for Predict method.

PredictResponse

Response message for predict method.

PredictResponse.Types

Container for nested types declared in the PredictResponse message type.

PredictResponse.Types.PredictionResult

PredictionResult represents the recommendation prediction results.

PredictionService

Service for making recommendation prediction.

PredictionService.PredictionServiceBase

Base class for server-side implementations of PredictionService

PredictionService.PredictionServiceClient

Client for PredictionService

PredictionServiceClient

PredictionService client wrapper, for convenient use.

PredictionServiceClientBuilder

Builder class for PredictionServiceClient to provide simple configuration of credentials, endpoint etc.

PredictionServiceClientImpl

PredictionService client wrapper implementation, for convenient use.

PredictionServiceSettings

Settings for PredictionServiceClient instances.

PriceInfo

The price information of a [Product][google.cloud.retail.v2.Product].

PriceInfo.Types

Container for nested types declared in the PriceInfo message type.

PriceInfo.Types.PriceRange

The price range of all [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product] having the same [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id].

Product

Product captures all metadata information of items to be recommended or searched.

Product.Types

Container for nested types declared in the Product message type.

ProductAttributeInterval

Product attribute name and numeric interval.

ProductAttributeValue

Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have name=color and value=red, this means that the color is red.

ProductDetail

Detailed product information associated with a user event.

ProductInlineSource

The inline source for the input config for ImportProducts method.

ProductInputConfig

The input config source for products.

ProductLevelConfig

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

ProductName

Resource name for the Product resource.

ProductService

Service for ingesting [Product][google.cloud.retail.v2.Product] information of the customer's website.

ProductService.ProductServiceBase

Base class for server-side implementations of ProductService

ProductService.ProductServiceClient

Client for ProductService

ProductServiceClient

ProductService client wrapper, for convenient use.

ProductServiceClientBuilder

Builder class for ProductServiceClient to provide simple configuration of credentials, endpoint etc.

ProductServiceClientImpl

ProductService client wrapper implementation, for convenient use.

ProductServiceSettings

Settings for ProductServiceClient instances.

Promotion

Promotion information.

PurchaseTransaction

A transaction represents the entire purchase transaction.

PurgeMetadata

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

PurgeProductsMetadata

Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.

PurgeProductsRequest

Request message for PurgeProducts method.

PurgeProductsResponse

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Rating

The rating of a [Product][google.cloud.retail.v2.Product].

RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

RejoinUserEventsRequest

Request message for RejoinUserEvents method.

RejoinUserEventsRequest.Types

Container for nested types declared in the RejoinUserEventsRequest message type.

RejoinUserEventsResponse

Response message for RejoinUserEvents method.

RemoveCatalogAttributeRequest

Request for [CatalogService.RemoveCatalogAttribute][google.cloud.retail.v2.CatalogService.RemoveCatalogAttribute] method.

RemoveControlRequest

Request for RemoveControl method.

RemoveFulfillmentPlacesMetadata

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces] method.

RemoveFulfillmentPlacesRequest

Request message for [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces] method.

RemoveFulfillmentPlacesResponse

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces] method.

RemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] method.

RemoveLocalInventoriesRequest

Request message for [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] method.

RemoveLocalInventoriesResponse

Response of the [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] method.

ReplaceCatalogAttributeRequest

Request for [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2.CatalogService.ReplaceCatalogAttribute] method.

ResumeModelRequest

Request for resuming training of a model.

Rule

A rule is a condition-action pair

A condition defines when a rule is to be triggered.
An action specifies what occurs on that trigger. Currently rules only work for [controls][google.cloud.retail.v2.Control] with [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].

Rule.Types

Container for nested types declared in the Rule message type.

Rule.Types.BoostAction

A boost action to apply to results matching condition specified above.

Rule.Types.DoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

Rule.Types.FilterAction

Rule Condition:
- No [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] provided is a global match.
- 1 or more [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] provided are combined with OR operator.
Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
Action Result: Filters the returned objects to be ONLY those that passed the filter.

Rule.Types.ForceReturnFacetAction

Force returns an attribute/facet in the request around a certain position or above.

Rule Condition: Must specify non-empty [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] (for search only) or [Condition.page_categories][google.cloud.retail.v2.Condition.page_categories] (for browse only), but can't specify both.
Action Inputs: attribute name, position
Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

Example: Suppose the query is "shoes", the [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] is "shoes", the [ForceReturnFacetAction.FacetPositionAdjustment.attribute_name][google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment.attribute_name] is "size" and the [ForceReturnFacetAction.FacetPositionAdjustment.position][google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment.position] is 8.

Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.

Rule.Types.ForceReturnFacetAction.Types

Container for nested types declared in the ForceReturnFacetAction message type.

Rule.Types.ForceReturnFacetAction.Types.FacetPositionAdjustment

Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.

Rule.Types.IgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

Rule.Types.OnewaySynonymsAction

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".

Rule.Types.RedirectAction

Redirects a shopper to a specific page.

Rule Condition: Must specify [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms].
Action Input: Request Query
Action Result: Redirects shopper to provided uri.

Rule.Types.RemoveFacetAction

Removes an attribute/facet in the request if is present.

Rule Condition: Must specify non-empty [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] (for search only) or [Condition.page_categories][google.cloud.retail.v2.Condition.page_categories] (for browse only), but can't specify both.
Action Input: attribute name
Action Result: Will remove the attribute (as a facet) from the request if it is present.

Example: Suppose the query is "shoes", the [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).

Rule.Types.ReplacementAction

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".

Rule.Types.TwowaySynonymsAction

Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes":

"sneakers" will use a synonym of "shoes".
"shoes" will use a synonym of "sneakers".

SearchRequest

Request message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.

SearchRequest.Types

Container for nested types declared in the SearchRequest message type.

SearchRequest.Types.BoostSpec

Boost specification to boost certain items.

SearchRequest.Types.BoostSpec.Types

Container for nested types declared in the BoostSpec message type.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec

Boost applies to products which match a condition.

SearchRequest.Types.ConversationalSearchSpec

This field specifies all conversational related parameters addition to traditional retail search.

SearchRequest.Types.ConversationalSearchSpec.Types

Container for nested types declared in the ConversationalSearchSpec message type.

SearchRequest.Types.ConversationalSearchSpec.Types.UserAnswer

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

SearchRequest.Types.ConversationalSearchSpec.Types.UserAnswer.Types

Container for nested types declared in the UserAnswer message type.

SearchRequest.Types.ConversationalSearchSpec.Types.UserAnswer.Types.SelectedAnswer

This field specifies the selected answers during the conversational search.

SearchRequest.Types.DynamicFacetSpec

The specifications of dynamically generated facets.

SearchRequest.Types.DynamicFacetSpec.Types

Container for nested types declared in the DynamicFacetSpec message type.

SearchRequest.Types.FacetSpec

A facet specification to perform faceted search.

SearchRequest.Types.FacetSpec.Types

Container for nested types declared in the FacetSpec message type.

SearchRequest.Types.FacetSpec.Types.FacetKey

Specifies how a facet is computed.

SearchRequest.Types.PersonalizationSpec

The specification for personalization.

SearchRequest.Types.PersonalizationSpec.Types

Container for nested types declared in the PersonalizationSpec message type.

SearchRequest.Types.QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

SearchRequest.Types.QueryExpansionSpec.Types

Container for nested types declared in the QueryExpansionSpec message type.

SearchRequest.Types.SpellCorrectionSpec

The specification for query spell correction.

SearchRequest.Types.SpellCorrectionSpec.Types

Container for nested types declared in the SpellCorrectionSpec message type.

SearchRequest.Types.TileNavigationSpec

This field specifies tile navigation related parameters.

SearchResponse

Response message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.

SearchResponse.Types

Container for nested types declared in the SearchResponse message type.

SearchResponse.Types.ConversationalSearchResult

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

SearchResponse.Types.ConversationalSearchResult.Types

Container for nested types declared in the ConversationalSearchResult message type.

SearchResponse.Types.ConversationalSearchResult.Types.AdditionalFilter

Additional filter that client side need to apply.

SearchResponse.Types.ConversationalSearchResult.Types.SuggestedAnswer

Suggested answers to the follow-up question.

A facet result.

Container for nested types declared in the Facet message type.

A facet value which contains value names and their count.

SearchResponse.Types.QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResponse.Types.SearchResult

Represents the search results.

SearchResponse.Types.TileNavigationResult

This field specifies all related information for tile navigation that will be used in client side.

SearchService

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchService.SearchServiceBase

Base class for server-side implementations of SearchService

SearchService.SearchServiceClient

Client for SearchService

SearchServiceClient

SearchService client wrapper, for convenient use.

SearchServiceClientBuilder

Builder class for SearchServiceClient to provide simple configuration of credentials, endpoint etc.

SearchServiceClientImpl

SearchService client wrapper implementation, for convenient use.

SearchServiceSettings

Settings for SearchServiceClient instances.

ServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

ServingConfig.Types

Container for nested types declared in the ServingConfig message type.

ServingConfigName

Resource name for the ServingConfig resource.

ServingConfigService

Service for modifying ServingConfig.

ServingConfigService.ServingConfigServiceBase

Base class for server-side implementations of ServingConfigService

ServingConfigService.ServingConfigServiceClient

Client for ServingConfigService

ServingConfigServiceClient

ServingConfigService client wrapper, for convenient use.

ServingConfigServiceClientBuilder

Builder class for ServingConfigServiceClient to provide simple configuration of credentials, endpoint etc.

ServingConfigServiceClientImpl

ServingConfigService client wrapper implementation, for convenient use.

ServingConfigServiceSettings

Settings for ServingConfigServiceClient instances.

SetDefaultBranchRequest

Request message to set a specified branch as new default_branch.

SetInventoryMetadata

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory] method.

SetInventoryRequest

Request message for [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory] method.

SetInventoryResponse

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory] method.

Tile

This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.

TuneModelMetadata

Metadata associated with a tune operation.

TuneModelRequest

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

TuneModelResponse

Response associated with a tune operation.

UpdateAttributesConfigRequest

Request for [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2.CatalogService.UpdateAttributesConfig] method.

UpdateCatalogRequest

Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2.CatalogService.UpdateCatalog] method.

UpdateCompletionConfigRequest

Request for [CatalogService.UpdateCompletionConfig][google.cloud.retail.v2.CatalogService.UpdateCompletionConfig] method.

UpdateControlRequest

Request for UpdateControl method.

UpdateGenerativeQuestionConfigRequest

Request for UpdateGenerativeQuestionConfig method.

UpdateGenerativeQuestionsFeatureConfigRequest

Request for UpdateGenerativeQuestionsFeatureConfig method.

UpdateModelRequest

Request for updating an existing model.

UpdateProductRequest

Request message for [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UserEvent

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

UserEventInlineSource

The inline source for the input config for ImportUserEvents method.

UserEventInputConfig

The input config source for user events.

UserEventService

Service for ingesting end user actions on the customer website.

UserEventService.UserEventServiceBase

Base class for server-side implementations of UserEventService

UserEventService.UserEventServiceClient

Client for UserEventService

UserEventServiceClient

UserEventService client wrapper, for convenient use.

UserEventServiceClientBuilder

Builder class for UserEventServiceClient to provide simple configuration of credentials, endpoint etc.

UserEventServiceClientImpl

UserEventService client wrapper implementation, for convenient use.

UserEventServiceSettings

Settings for UserEventServiceClient instances.

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

Enums

AttributeConfigLevel

At which level we offer configuration for attributes.

AttributesConfigName.ResourceNameType

The possible contents of AttributesConfigName.

BigQuerySource.PartitionOneofCase

Enum of possible cases for the "partition" oneof.

BranchName.ResourceNameType

The possible contents of BranchName.

CatalogAttribute.Types.AttributeType

The type of an attribute.

CatalogAttribute.Types.DynamicFacetableOption

The status of the dynamic facetable option of a catalog attribute.

CatalogAttribute.Types.ExactSearchableOption

The status of the exact-searchable option of a catalog attribute.

CatalogAttribute.Types.IndexableOption

The status of the indexable option of a catalog attribute.

CatalogAttribute.Types.RetrievableOption

The status of the retrievable option of a catalog attribute.

CatalogAttribute.Types.SearchableOption

The status of the searchable option of a catalog attribute.

CatalogName.ResourceNameType

The possible contents of CatalogName.

CollectUserEventRequest.ConversionRuleOneofCase

Enum of possible cases for the "conversion_rule" oneof.

CompletionConfigName.ResourceNameType

The possible contents of CompletionConfigName.

CompletionDataInputConfig.SourceOneofCase

Enum of possible cases for the "source" oneof.

Control.ControlOneofCase

Enum of possible cases for the "control" oneof.

ControlName.ResourceNameType

The possible contents of ControlName.

ExperimentInfo.ExperimentMetadataOneofCase

Enum of possible cases for the "experiment_metadata" oneof.

ExperimentName.ResourceNameType

The possible contents of ExperimentName.

ExportErrorsConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

ImportErrorsConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

ImportProductsRequest.Types.ReconciliationMode

Indicates how imported products are reconciled with the existing products created or imported before.

Interval.MaxOneofCase

Enum of possible cases for the "max" oneof.

Interval.MinOneofCase

Enum of possible cases for the "min" oneof.

Model.Types.ContextProductsType

Use single or multiple context products for recommendations.

Model.Types.DataState

Describes whether this model have sufficient training data to be continuously trained.

Model.Types.ModelFeaturesConfig.TypeDedicatedConfigOneofCase

Enum of possible cases for the "type_dedicated_config" oneof.

Model.Types.PeriodicTuningState

Describes whether periodic tuning is enabled for this model or not. Periodic tuning is scheduled at most every three months. You can start a tuning process manually by using the TuneModel method, which starts a tuning process immediately and resets the quarterly schedule. Enabling or disabling periodic tuning does not affect any current tuning processes.

Model.Types.ServingState

The serving state of the model.

Model.Types.TrainingState

The training state of the model.

ModelName.ResourceNameType

The possible contents of ModelName.

OutputConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

Product.ExpirationOneofCase

Enum of possible cases for the "expiration" oneof.

Product.Types.Availability

Product availability. If this field is unspecified, the product is assumed to be in stock.

Product.Types.Type

The type of this product.

ProductInputConfig.SourceOneofCase

Enum of possible cases for the "source" oneof.

ProductName.ResourceNameType

The possible contents of ProductName.

RecommendationsFilteringOption

If filtering for recommendations is enabled.

RejoinUserEventsRequest.Types.UserEventRejoinScope

The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.