# AI Platform Training & Prediction API . projects

## Instance Methods

Returns the jobs Resource.

Returns the locations Resource.

Returns the models Resource.

Returns the operations Resource.

Performs explanation on the data in the request.

Get the service account information associated with your project. You need

Performs online prediction on the data in the request.

### Method Details

`explain(name, body=None, x__xgafv=None)`

    Performs explanation on the data in the request.

    <div>{% dynamic include "/ai-platform/includes/___explain-request" %}</div>

    Args:
      name: string, Required. The resource name of a model or a version.

    Authorization: requires the `predict` permission on the specified resource. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request for explanations to be issued against a trained model.
        "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for # Required.
            # The explanation request body.
            # payload formats that can't be represented as JSON, such as raw binary or
            # an HTML page.
            #
            #
            # This message can be used both in streaming and non-streaming API methods in
            # the request as well as the response.
            #
            # It can be used as a top-level request field, which is convenient if one
            # wants to extract parameters from either the URL or HTTP template into the
            # request fields and also want access to the raw HTTP body.
            #
            # Example:
            #
            #     message GetResourceRequest {
            #       // A unique request id.
            #       string request_id = 1;
            #
            #       // The raw HTTP body is bound to this field.
            #       google.api.HttpBody http_body = 2;
            #     }
            #
            #     service ResourceService {
            #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
            #       rpc UpdateResource(google.api.HttpBody) returns
            #       (google.protobuf.Empty);
            #     }
            #
            # Example with streaming methods:
            #
            #     service CaldavService {
            #       rpc GetCalendar(stream google.api.HttpBody)
            #         returns (stream google.api.HttpBody);
            #       rpc UpdateCalendar(stream google.api.HttpBody)
            #         returns (stream google.api.HttpBody);
            #     }
            #
            # Use of this type only changes how the request and response bodies are
            # handled, all other features will continue to work unchanged.
          "extensions": [ # Application specific response metadata. Must be set in the first response
              # for streaming APIs.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
          "data": "A String", # The HTTP request/response body as raw binary.
        },
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message that represents an arbitrary HTTP body. It should only be used for
          # payload formats that can't be represented as JSON, such as raw binary or
          # an HTML page.
          #
          #
          # This message can be used both in streaming and non-streaming API methods in
          # the request as well as the response.
          #
          # It can be used as a top-level request field, which is convenient if one
          # wants to extract parameters from either the URL or HTTP template into the
          # request fields and also want access to the raw HTTP body.
          #
          # Example:
          #
          #     message GetResourceRequest {
          #       // A unique request id.
          #       string request_id = 1;
          #
          #       // The raw HTTP body is bound to this field.
          #       google.api.HttpBody http_body = 2;
          #     }
          #
          #     service ResourceService {
          #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
          #       rpc UpdateResource(google.api.HttpBody) returns
          #       (google.protobuf.Empty);
          #     }
          #
          # Example with streaming methods:
          #
          #     service CaldavService {
          #       rpc GetCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #       rpc UpdateCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #     }
          #
          # Use of this type only changes how the request and response bodies are
          # handled, all other features will continue to work unchanged.
        "extensions": [ # Application specific response metadata. Must be set in the first response
            # for streaming APIs.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
        "data": "A String", # The HTTP request/response body as raw binary.
      }

`getConfig(name, x__xgafv=None)`

    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.

    Args:
      name: string, Required. The project name. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Returns service account information associated with a project.
        "serviceAccount": "A String", # The service account Cloud ML uses to access resources in the project.
        "config": {
          "tpuServiceAccount": "A String", # The service account Cloud ML uses to run on TPU node.
        },
        "serviceAccountProject": "A String", # The project number for `service_account`.
      }

`predict(name, body=None, x__xgafv=None)`

    Performs online prediction on the data in the request.

    <div>{% dynamic include "/ai-platform/includes/___predict-request" %}</div>

    Args:
      name: string, Required. The resource name of a model or a version.

    Authorization: requires the `predict` permission on the specified resource. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request for predictions to be issued against a trained model.
        "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for #
            # Required. The prediction request body. Refer to the [request body details
            # section](#request-body-details) for more information on how to structure
            # your request.
            # payload formats that can't be represented as JSON, such as raw binary or
            # an HTML page.
            #
            #
            # This message can be used both in streaming and non-streaming API methods in
            # the request as well as the response.
            #
            # It can be used as a top-level request field, which is convenient if one
            # wants to extract parameters from either the URL or HTTP template into the
            # request fields and also want access to the raw HTTP body.
            #
            # Example:
            #
            #     message GetResourceRequest {
            #       // A unique request id.
            #       string request_id = 1;
            #
            #       // The raw HTTP body is bound to this field.
            #       google.api.HttpBody http_body = 2;
            #     }
            #
            #     service ResourceService {
            #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
            #       rpc UpdateResource(google.api.HttpBody) returns
            #       (google.protobuf.Empty);
            #     }
            #
            # Example with streaming methods:
            #
            #     service CaldavService {
            #       rpc GetCalendar(stream google.api.HttpBody)
            #         returns (stream google.api.HttpBody);
            #       rpc UpdateCalendar(stream google.api.HttpBody)
            #         returns (stream google.api.HttpBody);
            #     }
            #
            # Use of this type only changes how the request and response bodies are
            # handled, all other features will continue to work unchanged.
          "extensions": [ # Application specific response metadata. Must be set in the first response
              # for streaming APIs.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
          "data": "A String", # The HTTP request/response body as raw binary.
        },
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message that represents an arbitrary HTTP body. It should only be used for
          # payload formats that can't be represented as JSON, such as raw binary or
          # an HTML page.
          #
          #
          # This message can be used both in streaming and non-streaming API methods in
          # the request as well as the response.
          #
          # It can be used as a top-level request field, which is convenient if one
          # wants to extract parameters from either the URL or HTTP template into the
          # request fields and also want access to the raw HTTP body.
          #
          # Example:
          #
          #     message GetResourceRequest {
          #       // A unique request id.
          #       string request_id = 1;
          #
          #       // The raw HTTP body is bound to this field.
          #       google.api.HttpBody http_body = 2;
          #     }
          #
          #     service ResourceService {
          #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
          #       rpc UpdateResource(google.api.HttpBody) returns
          #       (google.protobuf.Empty);
          #     }
          #
          # Example with streaming methods:
          #
          #     service CaldavService {
          #       rpc GetCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #       rpc UpdateCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #     }
          #
          # Use of this type only changes how the request and response bodies are
          # handled, all other features will continue to work unchanged.
        "extensions": [ # Application specific response metadata. Must be set in the first response
            # for streaming APIs.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
        "data": "A String", # The HTTP request/response body as raw binary.
      }