Interface PredictResponse.PredictionResultOrBuilder (0.52.0)

public static interface PredictResponse.PredictionResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsItemMetadata(String key)

public abstract boolean containsItemMetadata(String key)

Additional item metadata / annotations.

Possible values:

  • catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getId()

public abstract String getId()

ID of the recommended catalog item

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public abstract ByteString getIdBytes()

ID of the recommended catalog item

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getItemMetadata() (deprecated)

public abstract Map<String,Value> getItemMetadata()

Use #getItemMetadataMap() instead.

Returns
Type Description
Map<String,Value>

getItemMetadataCount()

public abstract int getItemMetadataCount()

Additional item metadata / annotations.

Possible values:

  • catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type Description
int

getItemMetadataMap()

public abstract Map<String,Value> getItemMetadataMap()

Additional item metadata / annotations.

Possible values:

  • catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type Description
Map<String,Value>

getItemMetadataOrDefault(String key, Value defaultValue)

public abstract Value getItemMetadataOrDefault(String key, Value defaultValue)

Additional item metadata / annotations.

Possible values:

  • catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getItemMetadataOrThrow(String key)

public abstract Value getItemMetadataOrThrow(String key)

Additional item metadata / annotations.

Possible values:

  • catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name Description
key String
Returns
Type Description
Value