Recommendations AI v1beta1 API - Class PredictResponse (2.0.0-beta05)

public sealed class PredictResponse : IMessage<PredictResponse>, IEquatable<PredictResponse>, IDeepCloneable<PredictResponse>, IBufferMessage, IMessage, IPageResponse<PredictResponse.Types.PredictionResult>, IEnumerable<PredictResponse.Types.PredictionResult>, IEnumerable

Reference documentation and code samples for the Recommendations AI v1beta1 API class PredictResponse.

Response message for predict method.

Inheritance

object > PredictResponse

Implements

IMessage PredictResponse, IEquatable PredictResponse, IDeepCloneable PredictResponse, IBufferMessage, IMessage, IPageResponse PredictResponse Types PredictionResult, IEnumerable PredictResponse Types PredictionResult, IEnumerable

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

PredictResponse()

public PredictResponse()

PredictResponse(PredictResponse)

public PredictResponse(PredictResponse other)

Parameter
Name	Description
`other`	`PredictResponse`

Properties

DryRun

public bool DryRun { get; set; }

True if the dryRun property was set in the request.

Property Value
Type	Description
`bool`

ItemsMissingInCatalog

public RepeatedField<string> ItemsMissingInCatalog { get; }

IDs of items in the request that were missing from the catalog.

Property Value
Type	Description
`RepeatedFieldstring`

Metadata

public MapField<string, Value> Metadata { get; }

Additional domain specific prediction response metadata.

Property Value
Type	Description
`MapFieldstringValue`

NextPageToken

public string NextPageToken { get; set; }

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

Property Value
Type	Description
`string`

RecommendationToken

public string RecommendationToken { get; set; }

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.

Property Value
Type	Description
`string`

Results

public RepeatedField<PredictResponse.Types.PredictionResult> Results { get; }

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

Property Value
Type	Description
`RepeatedFieldPredictResponseTypesPredictionResult`

Methods

GetEnumerator()

public IEnumerator<PredictResponse.Types.PredictionResult> GetEnumerator()

Returns an enumerator that iterates through the resources in this response.

Returns
Type	Description
`IEnumeratorPredictResponseTypesPredictionResult`