com.google.cloud.vertexai.api

Interface PredictResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PredictResponse, PredictResponse.Builder

public interface PredictResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDeployedModelId() ID of the Endpoint's DeployedModel that served this prediction.
com.google.protobuf.ByteString	getDeployedModelIdBytes() ID of the Endpoint's DeployedModel that served this prediction.
com.google.protobuf.Value	getMetadata() Output only.
com.google.protobuf.ValueOrBuilder	getMetadataOrBuilder() Output only.
String	getModel() Output only.
com.google.protobuf.ByteString	getModelBytes() Output only.
String	getModelDisplayName() Output only.
com.google.protobuf.ByteString	getModelDisplayNameBytes() Output only.
String	getModelVersionId() Output only.
com.google.protobuf.ByteString	getModelVersionIdBytes() Output only.
com.google.protobuf.Value	getPredictions(int index) The predictions that are the output of the predictions call.
int	getPredictionsCount() The predictions that are the output of the predictions call.
List<com.google.protobuf.Value>	getPredictionsList() The predictions that are the output of the predictions call.
com.google.protobuf.ValueOrBuilder	getPredictionsOrBuilder(int index) The predictions that are the output of the predictions call.
List<? extends com.google.protobuf.ValueOrBuilder>	getPredictionsOrBuilderList() The predictions that are the output of the predictions call.
boolean	hasMetadata() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPredictionsList

List<com.google.protobuf.Value> getPredictionsList()

 The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
 

repeated .google.protobuf.Value predictions = 1;

getPredictions

com.google.protobuf.Value getPredictions(int index)

 The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
 

repeated .google.protobuf.Value predictions = 1;

getPredictionsCount

int getPredictionsCount()

 The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
 

repeated .google.protobuf.Value predictions = 1;

getPredictionsOrBuilderList

List<? extends com.google.protobuf.ValueOrBuilder> getPredictionsOrBuilderList()

 The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
 

repeated .google.protobuf.Value predictions = 1;

getPredictionsOrBuilder

com.google.protobuf.ValueOrBuilder getPredictionsOrBuilder(int index)

 The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
 

repeated .google.protobuf.Value predictions = 1;

getDeployedModelId

String getDeployedModelId()

 ID of the Endpoint's DeployedModel that served this prediction.
 

string deployed_model_id = 2;

Returns:

The deployedModelId.

getDeployedModelIdBytes

com.google.protobuf.ByteString getDeployedModelIdBytes()

 ID of the Endpoint's DeployedModel that served this prediction.
 

string deployed_model_id = 2;

Returns:

The bytes for deployedModelId.

getModel

String getModel()

 Output only. The resource name of the Model which is deployed as the
 DeployedModel that this prediction hits.
 

string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The model.

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 Output only. The resource name of the Model which is deployed as the
 DeployedModel that this prediction hits.
 

string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The bytes for model.

getModelVersionId

String getModelVersionId()

 Output only. The version ID of the Model which is deployed as the
 DeployedModel that this prediction hits.
 

string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The modelVersionId.

getModelVersionIdBytes

com.google.protobuf.ByteString getModelVersionIdBytes()

 Output only. The version ID of the Model which is deployed as the
 DeployedModel that this prediction hits.
 

string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for modelVersionId.

getModelDisplayName

String getModelDisplayName()

 Output only. The [display
 name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
 deployed as the DeployedModel that this prediction hits.
 

string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The modelDisplayName.

getModelDisplayNameBytes

com.google.protobuf.ByteString getModelDisplayNameBytes()

 Output only. The [display
 name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
 deployed as the DeployedModel that this prediction hits.
 

string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for modelDisplayName.

hasMetadata

boolean hasMetadata()

 Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
 

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the metadata field is set.

getMetadata

com.google.protobuf.Value getMetadata()

 Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
 

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The metadata.

getMetadataOrBuilder

com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()

 Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
 

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];