Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PredictSchemata.
Contains the schemata used in Model's predictions and explanations via PredictionService.Predict , PredictionService.Explain and BatchPredictionJob .
Generated from protobuf message google.cloud.aiplatform.v1.PredictSchemata
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ instance_schema_uri
string
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances , ExplainRequest.instances and BatchPredictionJob.input_config . The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
↳ parameters_schema_uri
string
Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters , ExplainRequest.parameters and BatchPredictionJob.model_parameters . The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
↳ prediction_schema_uri
string
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions , ExplainResponse.explanations , and BatchPredictionJob.output_config . The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
getInstanceSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances , ExplainRequest.instances and BatchPredictionJob.input_config .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string
setInstanceSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances , ExplainRequest.instances and BatchPredictionJob.input_config .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
var
string
$this
getParametersSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters , ExplainRequest.parameters and BatchPredictionJob.model_parameters .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string
setParametersSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters , ExplainRequest.parameters and BatchPredictionJob.model_parameters .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
var
string
$this
getPredictionSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions , ExplainResponse.explanations , and BatchPredictionJob.output_config .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string
setPredictionSchemaUri
Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions , ExplainResponse.explanations , and BatchPredictionJob.output_config .
The schema is defined as an OpenAPI 3.0.2 Schema Object . AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
var
string
$this
