Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.ml/v1.getVersion
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model.
Using getVersion
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getVersion(args: GetVersionArgs, opts?: InvokeOptions): Promise<GetVersionResult>
function getVersionOutput(args: GetVersionOutputArgs, opts?: InvokeOptions): Output<GetVersionResult>def get_version(model_id: Optional[str] = None,
                project: Optional[str] = None,
                version_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVersionResult
def get_version_output(model_id: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                version_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVersionResult]func LookupVersion(ctx *Context, args *LookupVersionArgs, opts ...InvokeOption) (*LookupVersionResult, error)
func LookupVersionOutput(ctx *Context, args *LookupVersionOutputArgs, opts ...InvokeOption) LookupVersionResultOutput> Note: This function is named LookupVersion in the Go SDK.
public static class GetVersion 
{
    public static Task<GetVersionResult> InvokeAsync(GetVersionArgs args, InvokeOptions? opts = null)
    public static Output<GetVersionResult> Invoke(GetVersionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVersionResult> getVersion(GetVersionArgs args, InvokeOptions options)
public static Output<GetVersionResult> getVersion(GetVersionArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:ml/v1:getVersion
  arguments:
    # arguments dictionaryThe following arguments are supported:
- model_id str
- version_id str
- project str
getVersion Result
The following output properties are available:
- AcceleratorConfig Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Accelerator Config Response 
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- AutoScaling Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Auto Scaling Response 
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- Container
Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Container Spec Response 
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- CreateTime string
- The time the version was created.
- DeploymentUri string
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- Description string
- Optional. The description specified for the version when it was created.
- ErrorMessage string
- The details of a failure or a cancellation.
- Etag string
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- ExplanationConfig Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Explanation Config Response 
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- Framework string
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- IsDefault bool
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- Labels Dictionary<string, string>
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- LastMigration stringModel Id 
- The AI Platform (Unified) ModelID for the last model migration.
- LastMigration stringTime 
- The last time this version was successfully migrated to AI Platform (Unified).
- LastUse stringTime 
- The time the version was last used for prediction.
- MachineType string
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- ManualScaling Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Manual Scaling Response 
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- Name string
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- PackageUris List<string>
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- PredictionClass string
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- PythonVersion string
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- RequestLogging Pulumi.Config Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Request Logging Config Response 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- Routes
Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Route Map Response 
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- RuntimeVersion string
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- ServiceAccount string
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- State string
- The state of a version.
- AcceleratorConfig GoogleCloud Ml V1__Accelerator Config Response 
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- AutoScaling GoogleCloud Ml V1__Auto Scaling Response 
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- Container
GoogleCloud Ml V1__Container Spec Response 
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- CreateTime string
- The time the version was created.
- DeploymentUri string
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- Description string
- Optional. The description specified for the version when it was created.
- ErrorMessage string
- The details of a failure or a cancellation.
- Etag string
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- ExplanationConfig GoogleCloud Ml V1__Explanation Config Response 
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- Framework string
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- IsDefault bool
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- Labels map[string]string
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- LastMigration stringModel Id 
- The AI Platform (Unified) ModelID for the last model migration.
- LastMigration stringTime 
- The last time this version was successfully migrated to AI Platform (Unified).
- LastUse stringTime 
- The time the version was last used for prediction.
- MachineType string
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- ManualScaling GoogleCloud Ml V1__Manual Scaling Response 
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- Name string
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- PackageUris []string
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- PredictionClass string
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- PythonVersion string
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- RequestLogging GoogleConfig Cloud Ml V1__Request Logging Config Response 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- Routes
GoogleCloud Ml V1__Route Map Response 
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- RuntimeVersion string
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- ServiceAccount string
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- State string
- The state of a version.
- acceleratorConfig GoogleCloud Ml V1__Accelerator Config Response 
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- autoScaling GoogleCloud Ml V1__Auto Scaling Response 
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- container
GoogleCloud Ml V1__Container Spec Response 
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- createTime String
- The time the version was created.
- deploymentUri String
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- description String
- Optional. The description specified for the version when it was created.
- errorMessage String
- The details of a failure or a cancellation.
- etag String
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- explanationConfig GoogleCloud Ml V1__Explanation Config Response 
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- framework String
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- isDefault Boolean
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- labels Map<String,String>
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- lastMigration StringModel Id 
- The AI Platform (Unified) ModelID for the last model migration.
- lastMigration StringTime 
- The last time this version was successfully migrated to AI Platform (Unified).
- lastUse StringTime 
- The time the version was last used for prediction.
- machineType String
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- manualScaling GoogleCloud Ml V1__Manual Scaling Response 
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- name String
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- packageUris List<String>
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- predictionClass String
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- pythonVersion String
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- requestLogging GoogleConfig Cloud Ml V1__Request Logging Config Response 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- routes
GoogleCloud Ml V1__Route Map Response 
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- runtimeVersion String
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- serviceAccount String
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- state String
- The state of a version.
- acceleratorConfig GoogleCloud Ml V1__Accelerator Config Response 
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- autoScaling GoogleCloud Ml V1__Auto Scaling Response 
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- container
GoogleCloud Ml V1__Container Spec Response 
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- createTime string
- The time the version was created.
- deploymentUri string
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- description string
- Optional. The description specified for the version when it was created.
- errorMessage string
- The details of a failure or a cancellation.
- etag string
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- explanationConfig GoogleCloud Ml V1__Explanation Config Response 
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- framework string
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- isDefault boolean
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- labels {[key: string]: string}
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- lastMigration stringModel Id 
- The AI Platform (Unified) ModelID for the last model migration.
- lastMigration stringTime 
- The last time this version was successfully migrated to AI Platform (Unified).
- lastUse stringTime 
- The time the version was last used for prediction.
- machineType string
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- manualScaling GoogleCloud Ml V1__Manual Scaling Response 
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- name string
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- packageUris string[]
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- predictionClass string
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- pythonVersion string
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- requestLogging GoogleConfig Cloud Ml V1__Request Logging Config Response 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- routes
GoogleCloud Ml V1__Route Map Response 
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- runtimeVersion string
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- serviceAccount string
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- state string
- The state of a version.
- accelerator_config GoogleCloud Ml V1Accelerator Config Response 
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- auto_scaling GoogleCloud Ml V1Auto Scaling Response 
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- container
GoogleCloud Ml V1Container Spec Response 
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- create_time str
- The time the version was created.
- deployment_uri str
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- description str
- Optional. The description specified for the version when it was created.
- error_message str
- The details of a failure or a cancellation.
- etag str
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- explanation_config GoogleCloud Ml V1Explanation Config Response 
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- framework str
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- is_default bool
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- labels Mapping[str, str]
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- last_migration_ strmodel_ id 
- The AI Platform (Unified) ModelID for the last model migration.
- last_migration_ strtime 
- The last time this version was successfully migrated to AI Platform (Unified).
- last_use_ strtime 
- The time the version was last used for prediction.
- machine_type str
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- manual_scaling GoogleCloud Ml V1Manual Scaling Response 
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- name str
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- package_uris Sequence[str]
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- prediction_class str
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- python_version str
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- request_logging_ Googleconfig Cloud Ml V1Request Logging Config Response 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- routes
GoogleCloud Ml V1Route Map Response 
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- runtime_version str
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- service_account str
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- state str
- The state of a version.
- acceleratorConfig Property Map
- Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the machineTypefield. Learn more about using GPUs for online prediction.
- autoScaling Property Map
- Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
- container Property Map
- Optional. Specifies a custom container to use for serving predictions. If you specify this field, then machineTypeis required. If you specify this field, thendeploymentUriis optional. If you specify this field, then you must not specifyruntimeVersion,packageUris,framework,pythonVersion, orpredictionClass.
- createTime String
- The time the version was created.
- deploymentUri String
- The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the guide to deploying models for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn how to use this field with a custom container.
- description String
- Optional. The description specified for the version when it was created.
- errorMessage String
- The details of a failure or a cancellation.
- etag String
- etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the- etagin the read-modify-write cycle to perform model updates in order to avoid race conditions: An- etagis returned in the response to- GetVersion, and systems are expected to put that etag in the request to- UpdateVersionto ensure that their change will be applied to the model as intended.
- explanationConfig Property Map
- Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
- framework String
- Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW,SCIKIT_LEARN,XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you chooseSCIKIT_LEARNorXGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine or if you're using a custom container.
- isDefault Boolean
- If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
- labels Map<String>
- Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models.
- lastMigration StringModel Id 
- The AI Platform (Unified) ModelID for the last model migration.
- lastMigration StringTime 
- The last time this version was successfully migrated to AI Platform (Unified).
- lastUse StringTime 
- The time the version was last used for prediction.
- machineType String
- Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read Choosing a machine type for online prediction. If this field is not specified and you are using a regional endpoint, then the machine type defaults to n1-standard-2. If this field is not specified and you are using the global endpoint (ml.googleapis.com), then the machine type defaults tomls1-c1-m2.
- manualScaling Property Map
- Manually select the number of nodes to use for serving the model. You should generally use auto_scalingwith an appropriatemin_nodesinstead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
- name String
- The name specified for the version when it was created. The version name must be unique within the model it is created in.
- packageUris List<String>
- Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (seepredictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also setruntimeVersionto 1.4 or greater.
- predictionClass String
- Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUrisfield. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must setruntimeVersionto 1.4 or greater and you must setmachineTypeto a legacy (MLS1) machine type. The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about the Predictor interface and custom prediction routines.
- pythonVersion String
- The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when runtime_versionis set to '1.15' or later. * Python '3.5' is available whenruntime_versionis set to a version from '1.4' to '1.14'. * Python '2.7' is available whenruntime_versionis set to '1.15' or earlier. Read more about the Python versions available for each runtime version.
- requestLogging Property MapConfig 
- Optional. Only specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
- routes Property Map
- Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the containerfield. If you specify thecontainerfield and do not specify this field, it defaults to the following:json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" }See RouteMap for more details about these default values.
- runtimeVersion String
- The AI Platform runtime version to use for this deployment. For more information, see the runtime version list and how to manage runtime versions.
- serviceAccount String
- Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the containerSpecor thepredictionClassfield. Learn more about using a custom service account.
- state String
- The state of a version.
Supporting Types
GoogleCloudMlV1__AcceleratorConfigResponse     
GoogleCloudMlV1__AutoScalingResponse     
- MaxNodes int
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- Metrics
List<Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Metric Spec Response> 
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- MinNodes int
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
- MaxNodes int
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- Metrics
[]GoogleCloud Ml V1__Metric Spec Response 
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- MinNodes int
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
- maxNodes Integer
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- metrics
List<GoogleCloud Ml V1__Metric Spec Response> 
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- minNodes Integer
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
- maxNodes number
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- metrics
GoogleCloud Ml V1__Metric Spec Response[] 
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- minNodes number
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
- max_nodes int
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- metrics
Sequence[GoogleCloud Ml V1Metric Spec Response] 
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- min_nodes int
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
- maxNodes Number
- The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.
- metrics List<Property Map>
- MetricSpec contains the specifications to use to calculate the desired nodes count.
- minNodes Number
- Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least rate*min_nodes* number of hours since last billing cycle, whererateis the cost per node-hour as documented in the pricing guide, even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at leastmin_nodes. You will be charged for the time in which additional nodes are used. Ifmin_nodesis not specified and AutoScaling is used with a legacy (MLS1) machine type,min_nodesdefaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. Ifmin_nodesis not specified and AutoScaling is used with a Compute Engine (N1) machine type,min_nodesdefaults to 1.min_nodesmust be at least 1 for use with a Compute Engine machine type. You can setmin_nodeswhen creating the model version, and you can also updatemin_nodesfor an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects//models//versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json
GoogleCloudMlV1__ContainerPortResponse     
- ContainerPort int
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
- ContainerPort int
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
- containerPort Integer
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
- containerPort number
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
- container_port int
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
- containerPort Number
- Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.
GoogleCloudMlV1__ContainerSpecResponse     
- Args List<string>
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- Command List<string>
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- Env
List<Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Env Var Response> 
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- Image string
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- Ports
List<Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Container Port Response> 
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
- Args []string
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- Command []string
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- Env
[]GoogleCloud Ml V1__Env Var Response 
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- Image string
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- Ports
[]GoogleCloud Ml V1__Container Port Response 
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
- args List<String>
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- command List<String>
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- env
List<GoogleCloud Ml V1__Env Var Response> 
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- image String
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- ports
List<GoogleCloud Ml V1__Container Port Response> 
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
- args string[]
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- command string[]
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- env
GoogleCloud Ml V1__Env Var Response[] 
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- image string
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- ports
GoogleCloud Ml V1__Container Port Response[] 
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
- args Sequence[str]
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- command Sequence[str]
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- env
Sequence[GoogleCloud Ml V1Env Var Response] 
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- image str
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- ports
Sequence[GoogleCloud Ml V1Container Port Response] 
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
- args List<String>
- Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a DockerCMD's "default parameters" form. If you don't specify this field but do specify the command field, then the command from thecommandfield runs without any additional arguments. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. If you don't specify this field and don't specify thecommmandfield, then the container'sENTRYPOINTandCMDdetermine what runs based on their default behavior. See the Docker documentation about howCMDandENTRYPOINTinteract. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to theargsfield of the Kubernetes Containers v1 core API.
- command List<String>
- Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a DockerENTRYPOINT's "exec" form, not its "shell" form. If you do not specify this field, then the container'sENTRYPOINTruns, in conjunction with the args field or the container'sCMD, if either exists. If this field is not specified and the container does not have anENTRYPOINT, then refer to the Docker documentation about howCMDandENTRYPOINTinteract. If you specify this field, then you can also specify theargsfield to provide additional arguments for this command. However, if you specify this field, then the container'sCMDis ignored. See the Kubernetes documentation about how thecommandandargsfields interact with a container'sENTRYPOINTandCMD. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with$$; for example: $$(VARIABLE_NAME) This field corresponds to thecommandfield of the Kubernetes Containers v1 core API.
- env List<Property Map>
- Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2to have the valuefoo bar:json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to theenvfield of the Kubernetes Containers v1 core API.
- image String
- URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry and begin with the hostname {REGION}-docker.pkg.dev, where{REGION}is replaced by the region that matches AI Platform Prediction regional endpoint that you are using. For example, if you are using theus-central1-ml.googleapis.comendpoint, then this URI must begin withus-central1-docker.pkg.dev. To use a custom container, the AI Platform Google-managed service account must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format:service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com{PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read Custom container requirements.
- ports List<Property Map>
- Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value: json [ { "containerPort": 8080 } ]AI Platform Prediction does not use ports other than the first one listed. This field corresponds to theportsfield of the Kubernetes Containers v1 core API.
GoogleCloudMlV1__EnvVarResponse     
- Name string
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- Value string
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
- Name string
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- Value string
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
- name String
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- value String
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
- name string
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- value string
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
- name str
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- value str
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
- name String
- Name of the environment variable. Must be a valid C identifier and must not begin with the prefix AIP_.
- value String
- Value of the environment variable. Defaults to an empty string. In this field, you can reference environment variables set by AI Platform Prediction and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: $$(VARIABLE_NAME)
GoogleCloudMlV1__ExplanationConfigResponse     
- IntegratedGradients Pulumi.Attribution Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Integrated Gradients Attribution Response 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- SampledShapley Pulumi.Attribution Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Sampled Shapley Attribution Response 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- XraiAttribution Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Xrai Attribution Response 
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
- IntegratedGradients GoogleAttribution Cloud Ml V1__Integrated Gradients Attribution Response 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- SampledShapley GoogleAttribution Cloud Ml V1__Sampled Shapley Attribution Response 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- XraiAttribution GoogleCloud Ml V1__Xrai Attribution Response 
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
- integratedGradients GoogleAttribution Cloud Ml V1__Integrated Gradients Attribution Response 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- sampledShapley GoogleAttribution Cloud Ml V1__Sampled Shapley Attribution Response 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- xraiAttribution GoogleCloud Ml V1__Xrai Attribution Response 
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
- integratedGradients GoogleAttribution Cloud Ml V1__Integrated Gradients Attribution Response 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- sampledShapley GoogleAttribution Cloud Ml V1__Sampled Shapley Attribution Response 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- xraiAttribution GoogleCloud Ml V1__Xrai Attribution Response 
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
- integrated_gradients_ Googleattribution Cloud Ml V1Integrated Gradients Attribution Response 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- sampled_shapley_ Googleattribution Cloud Ml V1Sampled Shapley Attribution Response 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- xrai_attribution GoogleCloud Ml V1Xrai Attribution Response 
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
- integratedGradients Property MapAttribution 
- Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
- sampledShapley Property MapAttribution 
- An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
- xraiAttribution Property Map
- Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
GoogleCloudMlV1__IntegratedGradientsAttributionResponse      
- NumIntegral intSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- NumIntegral intSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral IntegerSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral numberSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- num_integral_ intsteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral NumberSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
GoogleCloudMlV1__ManualScalingResponse     
- Nodes int
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
- Nodes int
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
- nodes Integer
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
- nodes number
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
- nodes int
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
- nodes Number
- The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to nodes* number of hours since last billing cycle plus the cost for each prediction performed.
GoogleCloudMlV1__MetricSpecResponse     
GoogleCloudMlV1__RequestLoggingConfigResponse      
- BigqueryTable stringName 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- SamplingPercentage double
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
- BigqueryTable stringName 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- SamplingPercentage float64
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
- bigqueryTable StringName 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- samplingPercentage Double
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
- bigqueryTable stringName 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- samplingPercentage number
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
- bigquery_table_ strname 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- sampling_percentage float
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
- bigqueryTable StringName 
- Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following schema: Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE
- samplingPercentage Number
- Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter 0.1. The sampling window is the lifetime of the model version. Defaults to 0.
GoogleCloudMlV1__RouteMapResponse     
- Health string
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- Predict string
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- Health string
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- Predict string
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- health String
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- predict String
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- health string
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- predict string
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- health str
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- predict str
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- health String
- HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to /bar, then AI Platform Prediction intermittently sends a GET request to the/barpath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID /models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
- predict String
- HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to /foo, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the/foopath on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the "projects/PROJECT_ID/models/" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the "projects/PROJECT_ID/models/MODEL/versions/" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.
GoogleCloudMlV1__SampledShapleyAttributionResponse      
- NumPaths int
- The number of feature permutations to consider when approximating the Shapley values.
- NumPaths int
- The number of feature permutations to consider when approximating the Shapley values.
- numPaths Integer
- The number of feature permutations to consider when approximating the Shapley values.
- numPaths number
- The number of feature permutations to consider when approximating the Shapley values.
- num_paths int
- The number of feature permutations to consider when approximating the Shapley values.
- numPaths Number
- The number of feature permutations to consider when approximating the Shapley values.
GoogleCloudMlV1__XraiAttributionResponse     
- NumIntegral intSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- NumIntegral intSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral IntegerSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral numberSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- num_integral_ intsteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
- numIntegral NumberSteps 
- Number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.