1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="ml_v1.html">AI Platform Training & Prediction API</a> . <a href="ml_v1.projects.html">projects</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="ml_v1.projects.jobs.html">jobs()</a></code> 79</p> 80<p class="firstline">Returns the jobs Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="ml_v1.projects.locations.html">locations()</a></code> 84</p> 85<p class="firstline">Returns the locations Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="ml_v1.projects.models.html">models()</a></code> 89</p> 90<p class="firstline">Returns the models Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="ml_v1.projects.operations.html">operations()</a></code> 94</p> 95<p class="firstline">Returns the operations Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="#close">close()</a></code></p> 99<p class="firstline">Close httplib2 connections.</p> 100<p class="toc_element"> 101 <code><a href="#explain">explain(name, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Performs explanation on the data in the request. {% dynamic include "/ai-platform/includes/___explain-request" %} </p> 103<p class="toc_element"> 104 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> 105<p class="firstline">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.</p> 106<p class="toc_element"> 107 <code><a href="#predict">predict(name, body=None, x__xgafv=None)</a></code></p> 108<p class="firstline">Performs online prediction on the data in the request. {% dynamic include "/ai-platform/includes/___predict-request" %} </p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="close">close()</code> 112 <pre>Close httplib2 connections.</pre> 113</div> 114 115<div class="method"> 116 <code class="details" id="explain">explain(name, body=None, x__xgafv=None)</code> 117 <pre>Performs explanation on the data in the request. {% dynamic include "/ai-platform/includes/___explain-request" %} 118 119Args: 120 name: string, Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource. (required) 121 body: object, The request body. 122 The object takes the form of: 123 124{ # Request for explanations to be issued against a trained model. 125 "httpBody": { # 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. # Required. The explanation request body. 126 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 127 "data": "A String", # The HTTP request/response body as raw binary. 128 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 129 { 130 "a_key": "", # Properties of the object. Contains field @type with type URL. 131 }, 132 ], 133 }, 134} 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # 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. 145 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 146 "data": "A String", # The HTTP request/response body as raw binary. 147 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 148 { 149 "a_key": "", # Properties of the object. Contains field @type with type URL. 150 }, 151 ], 152}</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> 157 <pre>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. 158 159Args: 160 name: string, Required. The project name. (required) 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # Returns service account information associated with a project. 170 "config": { 171 "tpuServiceAccount": "A String", # The service account Cloud ML uses to run on TPU node. 172 }, 173 "serviceAccount": "A String", # The service account Cloud ML uses to access resources in the project. 174 "serviceAccountProject": "A String", # The project number for `service_account`. 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="predict">predict(name, body=None, x__xgafv=None)</code> 180 <pre>Performs online prediction on the data in the request. {% dynamic include "/ai-platform/includes/___predict-request" %} 181 182Args: 183 name: string, Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource. (required) 184 body: object, The request body. 185 The object takes the form of: 186 187{ # Request for predictions to be issued against a trained model. 188 "httpBody": { # 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. # Required. The prediction request body. Refer to the [request body details section](#request-body-details) for more information on how to structure your request. 189 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 190 "data": "A String", # The HTTP request/response body as raw binary. 191 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 192 { 193 "a_key": "", # Properties of the object. Contains field @type with type URL. 194 }, 195 ], 196 }, 197} 198 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # 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. 208 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 209 "data": "A String", # The HTTP request/response body as raw binary. 210 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 211 { 212 "a_key": "", # Properties of the object. Contains field @type with type URL. 213 }, 214 ], 215}</pre> 216</div> 217 218</body></html>