AI Platform Training & Prediction API (ml:v1)

2025-06-06

46 new methods | New API

Additions

    Methods
  • ml.projects.predict

      Path : v1/{+name}:predict

      Flat Path : v1/projects/{projectsId}:predict

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource.

          Pattern : ^projects/.*$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Performs online prediction on the data in the request. {% dynamic include "/ai-platform/includes/___predict-request" %}

  • ml.projects.explain

      Path : v1/{+name}:explain

      Flat Path : v1/projects/{projectsId}:explain

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource.

          Pattern : ^projects/.*$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Performs explanation on the data in the request. {% dynamic include "/ai-platform/includes/___explain-request" %}

  • ml.projects.getConfig

      Path : v1/{+name}:getConfig

      Flat Path : v1/projects/{projectsId}:getConfig

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The project name.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Get the service account information associated with your project. You need this information in order to grant the service account permissions for the Google Cloud Storage location where you put your model training code for training the model with Google Cloud Machine Learning.

  • ml.projects.jobs.create

      Path : v1/{+parent}/jobs

      Flat Path : v1/projects/{projectsId}/jobs

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The project name.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a training or a batch prediction job.

  • ml.projects.jobs.list

      Path : v1/{+parent}/jobs

      Flat Path : v1/projects/{projectsId}/jobs

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the project for which to list jobs.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list --filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.

          Location : query

          Type : string

        pageToken

          Description : Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

          Location : query

          Type : string

        pageSize

          Description : Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

          Location : query

          Type : integer

          Format : int32

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

  • ml.projects.jobs.get

  • ml.projects.jobs.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/jobs/{jobsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the job to cancel.

          Pattern : ^projects/[^/]+/jobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Cancels a running job.

  • ml.projects.jobs.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/jobs/{jobsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. The job name.

          Pattern : ^projects/[^/]+/jobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. Specifies the path, relative to `Job`, of the field to update. To adopt etag mechanism, include `etag` field in the mask, and include the `etag` value in your job resource. For example, to change the labels of a job, the `update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If `etag` matches the one on the server, the labels of the job will be replaced with the given ones, and the server end `etag` will be recalculated. Currently the only supported update masks are `labels` and `etag`.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates a specific job resource. Currently the only supported fields to update are `labels`.

  • ml.projects.jobs.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/jobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • ml.projects.jobs.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy

      HTTP Method : GET

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/jobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

        options.requestedPolicyVersion

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location : query

          Type : integer

          Format : int32

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • ml.projects.jobs.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/jobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • ml.projects.locations.get

  • ml.projects.locations.list

      Path : v1/{+parent}/locations

      Flat Path : v1/projects/{projectsId}/locations

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageToken

          Description : Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

          Location : query

          Type : string

        pageSize

          Description : Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

          Location : query

          Type : integer

          Format : int32

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : List all locations that provides at least one type of CMLE capability.

  • ml.projects.locations.operations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • ml.projects.locations.operations.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • ml.projects.locations.studies.create

      Path : v1/{+parent}/studies

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location}

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        studyId

          Description : Required. The ID to use for the study, which will become the final component of the study's resource name.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a study.

  • ml.projects.locations.studies.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The study name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets a study.

  • ml.projects.locations.studies.list

      Path : v1/{+parent}/studies

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location}

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists all the studies in a region for an associated project.

  • ml.projects.locations.studies.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The study name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a study.

  • ml.projects.locations.studies.trials.suggest

      Path : v1/{+parent}/trials:suggest

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The name of the study that the trial belongs to.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

  • ml.projects.locations.studies.trials.create

      Path : v1/{+parent}/trials

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The name of the study that the trial belongs to.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Adds a user provided trial to a study.

  • ml.projects.locations.studies.trials.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The trial name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets a trial.

  • ml.projects.locations.studies.trials.list

      Path : v1/{+parent}/trials

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the study that the trial belongs to.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists the trials associated with a study.

  • ml.projects.locations.studies.trials.addMeasurement

      Path : v1/{+name}:addMeasurement

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addMeasurement

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The trial name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.

  • ml.projects.locations.studies.trials.complete

      Path : v1/{+name}:complete

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The trial name.metat

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Marks a trial as complete.

  • ml.projects.locations.studies.trials.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The trial name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a trial.

  • ml.projects.locations.studies.trials.checkEarlyStoppingState

      Path : v1/{+name}:checkEarlyStoppingState

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkEarlyStoppingState

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The trial name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

  • ml.projects.locations.studies.trials.stop

      Path : v1/{+name}:stop

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The trial name.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Stops a trial.

  • ml.projects.locations.studies.trials.listOptimalTrials

      Path : v1/{+parent}/trials:listOptimalTrials

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The name of the study that the pareto-optimal trial belongs to.

          Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

  • ml.projects.operations.list

      Path : v1/{+name}/operations

      Flat Path : v1/projects/{projectsId}/operations

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation's parent resource.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • ml.projects.operations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • ml.projects.operations.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • ml.projects.models.create

      Path : v1/{+parent}/models

      Flat Path : v1/projects/{projectsId}/models

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The project name.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create.

  • ml.projects.models.list

      Path : v1/{+parent}/models

      Flat Path : v1/projects/{projectsId}/models

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the project whose models are to be listed.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. Specifies the subset of models to retrieve.

          Location : query

          Type : string

        pageToken

          Description : Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

          Location : query

          Type : string

        pageSize

          Description : Optional. The number of models to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

          Location : query

          Type : integer

          Format : int32

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}.

  • ml.projects.models.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the model.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed).

  • ml.projects.models.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the model.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete.

  • ml.projects.models.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. The project name.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. Specifies the path, relative to `Model`, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the `update_mask` parameter would be specified as `description`, `default_version.name`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo", "defaultVersion": { "name":"version_1" } } Currently the supported update masks are `description` and `default_version.name`.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`.

  • ml.projects.models.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/models/{modelsId}:setIamPolicy

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • ml.projects.models.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/models/{modelsId}:getIamPolicy

      HTTP Method : GET

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

        options.requestedPolicyVersion

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location : query

          Type : integer

          Format : int32

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • ml.projects.models.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/models/{modelsId}:testIamPermissions

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • ml.projects.models.versions.create

      Path : v1/{+parent}/versions

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The name of the model.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault.

  • ml.projects.models.versions.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. The name of the model.

          Pattern : ^projects/[^/]+/models/[^/]+/versions/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction).

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`.

  • ml.projects.models.versions.list

      Path : v1/{+parent}/versions

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the model for which to list the version.

          Pattern : ^projects/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. Specifies the subset of versions to retrieve.

          Location : query

          Type : string

        pageToken

          Description : Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call.

          Location : query

          Type : string

        pageSize

          Description : Optional. The number of versions to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100.

          Location : query

          Type : integer

          Format : int32

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}.

  • ml.projects.models.versions.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the version.

          Pattern : ^projects/[^/]+/models/[^/]+/versions/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : 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.

  • ml.projects.models.versions.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list.

          Pattern : ^projects/[^/]+/models/[^/]+/versions/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version.

  • ml.projects.models.versions.setDefault

      Path : v1/{+name}:setDefault

      Flat Path : v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list.

          Pattern : ^projects/[^/]+/models/[^/]+/versions/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method.