# Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::PredictSchemata (v1.44.0)

1.43.0 (latest) 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.1 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.1 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::PredictSchemata.

Contains the schemata used in Model's predictions and explanations via
[PredictionService.Predict](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictionService-Client#Google__Cloud__AIPlatform__V1__PredictionService__Client_predict_instance_ "Google::Cloud::AIPlatform::V1::PredictionService::Client#predict (method)"),
[PredictionService.Explain](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictionService-Client#Google__Cloud__AIPlatform__V1__PredictionService__Client_explain_instance_ "Google::Cloud::AIPlatform::V1::PredictionService::Client#explain (method)")
and [BatchPredictionJob](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob "Google::Cloud::AIPlatform::V1::BatchPredictionJob (class)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #instance_schema_uri

    def instance_schema_uri() -> ::String

**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#instances (method)"), [ExplainRequest.instances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#instances (method)") and [BatchPredictionJob.input_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_input_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#input_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.

### #instance_schema_uri=

    def instance_schema_uri=(value) -> ::String

**Parameter**

- **value** (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#instances (method)"), [ExplainRequest.instances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#instances (method)") and [BatchPredictionJob.input_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_input_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#input_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.
**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#instances (method)"), [ExplainRequest.instances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_instances_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#instances (method)") and [BatchPredictionJob.input_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_input_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#input_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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

    def parameters_schema_uri() -> ::String

**Returns**

- (::String) --- Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via [PredictRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#parameters (method)"), [ExplainRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#parameters (method)") and [BatchPredictionJob.model_parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_model_parameters_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#model_parameters (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.

### #parameters_schema_uri=

    def parameters_schema_uri=(value) -> ::String

**Parameter**

- **value** (::String) --- Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via [PredictRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#parameters (method)"), [ExplainRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#parameters (method)") and [BatchPredictionJob.model_parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_model_parameters_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#model_parameters (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.
**Returns**

- (::String) --- Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via [PredictRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictRequest#Google__Cloud__AIPlatform__V1__PredictRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::PredictRequest#parameters (method)"), [ExplainRequest.parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainRequest#Google__Cloud__AIPlatform__V1__ExplainRequest_parameters_instance_ "Google::Cloud::AIPlatform::V1::ExplainRequest#parameters (method)") and [BatchPredictionJob.model_parameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_model_parameters_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#model_parameters (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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

    def prediction_schema_uri() -> ::String

**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictResponse#Google__Cloud__AIPlatform__V1__PredictResponse_predictions_instance_ "Google::Cloud::AIPlatform::V1::PredictResponse#predictions (method)"), [ExplainResponse.explanations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainResponse#Google__Cloud__AIPlatform__V1__ExplainResponse_explanations_instance_ "Google::Cloud::AIPlatform::V1::ExplainResponse#explanations (method)"), and [BatchPredictionJob.output_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_output_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.

### #prediction_schema_uri=

    def prediction_schema_uri=(value) -> ::String

**Parameter**

- **value** (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictResponse#Google__Cloud__AIPlatform__V1__PredictResponse_predictions_instance_ "Google::Cloud::AIPlatform::V1::PredictResponse#predictions (method)"), [ExplainResponse.explanations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainResponse#Google__Cloud__AIPlatform__V1__ExplainResponse_explanations_instance_ "Google::Cloud::AIPlatform::V1::ExplainResponse#explanations (method)"), and [BatchPredictionJob.output_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_output_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.
**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-PredictResponse#Google__Cloud__AIPlatform__V1__PredictResponse_predictions_instance_ "Google::Cloud::AIPlatform::V1::PredictResponse#predictions (method)"), [ExplainResponse.explanations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-ExplainResponse#Google__Cloud__AIPlatform__V1__ExplainResponse_explanations_instance_ "Google::Cloud::AIPlatform::V1::ExplainResponse#explanations (method)"), and [BatchPredictionJob.output_config](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-BatchPredictionJob#Google__Cloud__AIPlatform__V1__BatchPredictionJob_output_config_instance_ "Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config (method)"). The schema is defined as an OpenAPI 3.0.2 [Schema
  Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.