Class PredictResponse (0.10.14)

PredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Response message for predict method.

Attributes

Name Description
results MutableSequence[google.cloud.recommendationengine_v1beta1.types.PredictResponse.PredictionResult]
A list of recommended items. The order represents the ranking (from the most relevant item to the least).
recommendation_token str
A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
items_missing_in_catalog MutableSequence[str]
IDs of items in the request that were missing from the catalog.
dry_run bool
True if the dryRun property was set in the request.
metadata MutableMapping[str, google.protobuf.struct_pb2.Value]
Additional domain specific prediction response metadata.
next_page_token str
If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

Classes

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

PredictionResult

PredictionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

PredictionResult represents the recommendation prediction results.