Summary of entries of Classes for recommendationengine.
Classes
CatalogServiceAsyncClient
Service for ingesting catalog information of the customer's website.
CatalogServiceClient
Service for ingesting catalog information of the customer's website.
ListCatalogItemsAsyncPager
A pager for iterating through list_catalog_items
requests.
This class thinly wraps an initial
ListCatalogItemsResponse object, and
provides an __aiter__
method to iterate through its
catalog_items
field.
If there are more pages, the __aiter__
method will make additional
ListCatalogItems
requests and continue to iterate
through the catalog_items
field on the
corresponding responses.
All the usual ListCatalogItemsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListCatalogItemsPager
A pager for iterating through list_catalog_items
requests.
This class thinly wraps an initial
ListCatalogItemsResponse object, and
provides an __iter__
method to iterate through its
catalog_items
field.
If there are more pages, the __iter__
method will make additional
ListCatalogItems
requests and continue to iterate
through the catalog_items
field on the
corresponding responses.
All the usual ListCatalogItemsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
PredictionApiKeyRegistryAsyncClient
Service for registering API keys for use with the predict
method. If you use an API key to request predictions, you must first
register the API key. Otherwise, your prediction request is
rejected. If you use OAuth to authenticate your predict
method
call, you do not need to register an API key. You can register up to
20 API keys per project.
PredictionApiKeyRegistryClient
Service for registering API keys for use with the predict
method. If you use an API key to request predictions, you must first
register the API key. Otherwise, your prediction request is
rejected. If you use OAuth to authenticate your predict
method
call, you do not need to register an API key. You can register up to
20 API keys per project.
ListPredictionApiKeyRegistrationsAsyncPager
A pager for iterating through list_prediction_api_key_registrations
requests.
This class thinly wraps an initial
ListPredictionApiKeyRegistrationsResponse object, and
provides an __aiter__
method to iterate through its
prediction_api_key_registrations
field.
If there are more pages, the __aiter__
method will make additional
ListPredictionApiKeyRegistrations
requests and continue to iterate
through the prediction_api_key_registrations
field on the
corresponding responses.
All the usual ListPredictionApiKeyRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListPredictionApiKeyRegistrationsPager
A pager for iterating through list_prediction_api_key_registrations
requests.
This class thinly wraps an initial
ListPredictionApiKeyRegistrationsResponse object, and
provides an __iter__
method to iterate through its
prediction_api_key_registrations
field.
If there are more pages, the __iter__
method will make additional
ListPredictionApiKeyRegistrations
requests and continue to iterate
through the prediction_api_key_registrations
field on the
corresponding responses.
All the usual ListPredictionApiKeyRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
PredictionServiceAsyncClient
Service for making recommendation prediction.
PredictionServiceClient
Service for making recommendation prediction.
PredictAsyncPager
A pager for iterating through predict
requests.
This class thinly wraps an initial
PredictResponse object, and
provides an __aiter__
method to iterate through its
results
field.
If there are more pages, the __aiter__
method will make additional
Predict
requests and continue to iterate
through the results
field on the
corresponding responses.
All the usual PredictResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
PredictPager
A pager for iterating through predict
requests.
This class thinly wraps an initial
PredictResponse object, and
provides an __iter__
method to iterate through its
results
field.
If there are more pages, the __iter__
method will make additional
Predict
requests and continue to iterate
through the results
field on the
corresponding responses.
All the usual PredictResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
UserEventServiceAsyncClient
Service for ingesting end user actions on the customer website.
UserEventServiceClient
Service for ingesting end user actions on the customer website.
ListUserEventsAsyncPager
A pager for iterating through list_user_events
requests.
This class thinly wraps an initial
ListUserEventsResponse object, and
provides an __aiter__
method to iterate through its
user_events
field.
If there are more pages, the __aiter__
method will make additional
ListUserEvents
requests and continue to iterate
through the user_events
field on the
corresponding responses.
All the usual ListUserEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListUserEventsPager
A pager for iterating through list_user_events
requests.
This class thinly wraps an initial
ListUserEventsResponse object, and
provides an __iter__
method to iterate through its
user_events
field.
If there are more pages, the __iter__
method will make additional
ListUserEvents
requests and continue to iterate
through the user_events
field on the
corresponding responses.
All the usual ListUserEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CatalogInlineSource
The inline source for the input config for ImportCatalogItems method.
CatalogItem
CatalogItem captures all metadata information of items to be recommended.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CategoryHierarchy
Category represents catalog item category hierarchy.
CollectUserEventRequest
Request message for CollectUserEvent method.
CreateCatalogItemRequest
Request message for CreateCatalogItem method.
CreatePredictionApiKeyRegistrationRequest
Request message for the CreatePredictionApiKeyRegistration
method.
DeleteCatalogItemRequest
Request message for DeleteCatalogItem method.
DeletePredictionApiKeyRegistrationRequest
Request message for DeletePredictionApiKeyRegistration
method.
EventDetail
User event details shared by all recommendation types.
FeatureMap
FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.
CategoricalFeaturesEntry
The abstract base class for a message.
FloatList
A list of float features.
NumericalFeaturesEntry
The abstract base class for a message.
StringList
A list of string features.
GcsSource
Google Cloud Storage location for input content. format.
GetCatalogItemRequest
Request message for GetCatalogItem method.
Image
Catalog item thumbnail/detail image.
ImportCatalogItemsRequest
Request message for Import methods.
ImportCatalogItemsResponse
Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
ImportErrorsConfig
Configuration of destination for Import related errors.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportMetadata
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
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.
InputConfig
The input config source.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListCatalogItemsRequest
Request message for ListCatalogItems method.
ListCatalogItemsResponse
Response message for ListCatalogItems method.
ListPredictionApiKeyRegistrationsRequest
Request message for the ListPredictionApiKeyRegistrations
.
ListPredictionApiKeyRegistrationsResponse
Response message for the ListPredictionApiKeyRegistrations
.
ListUserEventsRequest
Request message for ListUserEvents method.
ListUserEventsResponse
Response message for ListUserEvents method.
PredictRequest
Request message for Predict method.
LabelsEntry
The abstract base class for a message.
ParamsEntry
The abstract base class for a message.
PredictResponse
Response message for predict method.
MetadataEntry
The abstract base class for a message.
PredictionResult
PredictionResult represents the recommendation prediction results.
ItemMetadataEntry
The abstract base class for a message.
PredictionApiKeyRegistration
Registered Api Key.
ProductCatalogItem
ProductCatalogItem captures item metadata specific to retail products.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CostsEntry
The abstract base class for a message.
ExactPrice
Exact product price.
PriceRange
Product price range when there are a range of prices for different variations of the same product.
StockState
Item stock state. If this field is unspecified, the item is assumed to be in stock.
ProductDetail
Detailed product information associated with a user event.
ProductEventDetail
ProductEventDetail captures user event information specific to retail products.
PurchaseTransaction
A transaction represents the entire purchase transaction.
CostsEntry
The abstract base class for a message.
TaxesEntry
The abstract base class for a message.
PurgeUserEventsMetadata
Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata 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.
UpdateCatalogItemRequest
Request message for UpdateCatalogItem method.
UserEvent
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
EventSource
User event source.
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.
UserInfo
Information of end users.
WriteUserEventRequest
Request message for WriteUserEvent method.
Modules
pagers
API documentation for recommendationengine_v1beta1.services.catalog_service.pagers
module.
pagers
API documentation for recommendationengine_v1beta1.services.prediction_api_key_registry.pagers
module.
pagers
API documentation for recommendationengine_v1beta1.services.prediction_service.pagers
module.
pagers
API documentation for recommendationengine_v1beta1.services.user_event_service.pagers
module.