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

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.MemberwiseClone()

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
`Boolean`

ItemsMissingInCatalog

public RepeatedField<string> ItemsMissingInCatalog { get; }

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

Property Value
Type	Description
`RepeatedField<String>`

Metadata

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

Additional domain specific prediction response metadata.

Property Value
Type	Description
`MapField<String, Value>`

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
`RepeatedField<PredictResponse.Types.PredictionResult>`

Methods

GetEnumerator()

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

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

Returns
Type	Description
`IEnumerator<PredictResponse.Types.PredictionResult>`

Explicit Interface Implementations

IEnumerable.GetEnumerator()

IEnumerator IEnumerable.GetEnumerator()

Returns
Type	Description
`IEnumerator`