Google

AI Platform Training & Prediction API

An API to enable creating and using machine learning models.

AI & machine learning#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

An API to enable creating and using machine learning models.

Endpoints 29

projects

  • POSTPerforms explanation on the data in the request/v1/:name:explainPerforms explanation on the data in the request. {% dynamic include "/ai-platform/includes/___explain-request" %}
  • GETGet the service account information associated with your project/v1/:name:getConfigGet the service account information associated with your project. You need this information in order to grant the service account permissions for the Google…
  • POSTPerforms online prediction on the data in the request/v1/:name:predictPerforms online prediction on the data in the request. {% dynamic include "/ai-platform/includes/___predict-request" %}

projects.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETGets the latest state of a long-running operation/v1/:nameGets 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.
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.jobs

  • GETLists the jobs in the project/v1/:parent/jobs?filter=string&pageSize=0&pageToken=stringLists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
  • POSTCreates a training or a batch prediction job./v1/:parent/jobsCreates a training or a batch prediction job.

projects.models.versions

  • DELETEDeletes a model version/v1/:nameDeletes 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…
  • PATCHUpdates the specified Version resource/v1/:name?updateMask=stringUpdates the specified Version resource. Currently the only update-able fields are description, requestLoggingConfig, autoScaling.minNodes, and…
  • GETGets basic information about all the versions of a model/v1/:parent/versions?filter=string&pageSize=0&pageToken=stringGets 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…
  • POSTCreates a new version of a model from a trained TensorFlow model/v1/:parent/versionsCreates 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…
  • POSTDesignates a version to be the default for the model/v1/:name:setDefaultDesignates 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.…

projects.models

  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns 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…
  • GETLists the models in a project/v1/:parent/models?filter=string&pageSize=0&pageToken=stringLists 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…
  • POSTCreates a model which will later contain one or more versions/v1/:parent/modelsCreates 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…

projects.locations

  • GETList all locations that provides at least one type of CMLE capability./v1/:parent/locations?pageSize=0&pageToken=stringList all locations that provides at least one type of CMLE capability.

projects.locations.studies

  • GETLists all the studies in a region for an associated project./v1/:parent/studiesLists all the studies in a region for an associated project.
  • POSTCreates a study./v1/:parent/studies?studyId=stringCreates a study.

projects.locations.studies.trials

  • POSTAdds a measurement of the objective metrics to a trial/v1/:name:addMeasurementAdds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
  • POSTChecks whether a trial should stop or not/v1/:name:checkEarlyStoppingStateChecks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a…
  • POSTMarks a trial as complete./v1/:name:completeMarks a trial as complete.
  • GETLists the trials associated with a study./v1/:parent/trialsLists the trials associated with a study.
  • POSTAdds a user provided trial to a study./v1/:parent/trialsAdds a user provided trial to a study.
  • POSTLists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study/v1/:parent/trials:listOptimalTrialsLists 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…
  • POSTStops a trial./v1/:name:stopStops a trial.
  • POSTAdds one or more trials to a study, with parameter values suggested by AI Platform Vizier/v1/:parent/trials:suggestAdds 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…

API details

Base URL
https://ml.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
29 operations on 22 pathsPOST 17GET 10PATCH 1DELETE 1
Main resources
projects.locations.studies.trials 8projects.models 5projects.models.versions 5projects 3projects.operations 3projects.jobs 2projects.locations.studies 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the AI Platform Training & Prediction API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AI Platform Training & Prediction API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Performs explanation on the data in the request” (POST /v1/:name:explain), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AI Platform Training & Prediction API?

An API to enable creating and using machine learning models. It is listed under AI & machine learning and has 29 endpoints.

Who publishes the AI Platform Training & Prediction API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AI Platform Training & Prediction API?

Requests go to https://ml.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the AI Platform Training & Prediction API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the AI Platform Training & Prediction API have?

29 operations on 22 paths (17 POST, 10 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.studies.trials, projects.models, projects.models.versions, projects.

Is forking the AI Platform Training & Prediction API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.