Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / ml_v1.projects.html
blob: 8ba8c7479b4c5b435d53c48b7d0655d0c2f603cf [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="ml_v1.html">Cloud Machine Learning Engine</a> . <a href="ml_v1.projects.html">projects</a></h1>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]98 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]99<p class="firstline">Get the service account information associated with your project. You need</p>
100<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]101 <code><a href="#predict">predict(name, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]102<p class="firstline">Performs prediction on the data in the request.</p>
103<h3>Method Details</h3>
104<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]105 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106 <pre>Get the service account information associated with your project. You need
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107this information in order to grant the service account permissions for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]108the Google Cloud Storage location where you put your model training code
109for training the model with Google Cloud Machine Learning.
110
111Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 name: string, Required. The project name. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
117
118Returns:
119 An object of the form:
120
121 { # Returns service account information associated with a project.
122 "serviceAccountProject": "A String", # The project number for `service_account`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "config": {
124 "tpuServiceAccount": "A String", # The service account Cloud ML uses to run on TPU node.
125 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]126 "serviceAccount": "A String", # The service account Cloud ML uses to access resources in the project.
127 }</pre>
128</div>
129
130<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]131 <code class="details" id="predict">predict(name, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]132 <pre>Performs prediction on the data in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133AI Platform implements a custom `predict` verb on top of an HTTP POST
134method. <p>For details of the request and response format, see the **guide
135to the [predict request format](/ml-engine/docs/v1/predict-request)**.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]136
137Args:
138 name: string, Required. The resource name of a model or a version.
139
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140Authorization: requires the `predict` permission on the specified resource. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]141 body: object, The request body. (required)
142 The object takes the form of:
143
144{ # Request for predictions to be issued against a trained model.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]145 "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for #
146 # Required. The prediction request body.
147 # payload formats that can't be represented as JSON, such as raw binary or
148 # an HTML page.
149 #
150 #
151 # This message can be used both in streaming and non-streaming API methods in
152 # the request as well as the response.
153 #
154 # It can be used as a top-level request field, which is convenient if one
155 # wants to extract parameters from either the URL or HTTP template into the
156 # request fields and also want access to the raw HTTP body.
157 #
158 # Example:
159 #
160 # message GetResourceRequest {
161 # // A unique request id.
162 # string request_id = 1;
163 #
164 # // The raw HTTP body is bound to this field.
165 # google.api.HttpBody http_body = 2;
166 # }
167 #
168 # service ResourceService {
169 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 # rpc UpdateResource(google.api.HttpBody) returns
171 # (google.protobuf.Empty);
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]172 # }
173 #
174 # Example with streaming methods:
175 #
176 # service CaldavService {
177 # rpc GetCalendar(stream google.api.HttpBody)
178 # returns (stream google.api.HttpBody);
179 # rpc UpdateCalendar(stream google.api.HttpBody)
180 # returns (stream google.api.HttpBody);
181 # }
182 #
183 # Use of this type only changes how the request and response bodies are
184 # handled, all other features will continue to work unchanged.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]185 "extensions": [ # Application specific response metadata. Must be set in the first response
186 # for streaming APIs.
187 {
188 "a_key": "", # Properties of the object. Contains field @type with type URL.
189 },
190 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
192 "data": "A String", # The HTTP request/response body as raw binary.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]193 },
194 }
195
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
204 { # Message that represents an arbitrary HTTP body. It should only be used for
205 # payload formats that can't be represented as JSON, such as raw binary or
206 # an HTML page.
207 #
208 #
209 # This message can be used both in streaming and non-streaming API methods in
210 # the request as well as the response.
211 #
212 # It can be used as a top-level request field, which is convenient if one
213 # wants to extract parameters from either the URL or HTTP template into the
214 # request fields and also want access to the raw HTTP body.
215 #
216 # Example:
217 #
218 # message GetResourceRequest {
219 # // A unique request id.
220 # string request_id = 1;
221 #
222 # // The raw HTTP body is bound to this field.
223 # google.api.HttpBody http_body = 2;
224 # }
225 #
226 # service ResourceService {
227 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 # rpc UpdateResource(google.api.HttpBody) returns
229 # (google.protobuf.Empty);
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]230 # }
231 #
232 # Example with streaming methods:
233 #
234 # service CaldavService {
235 # rpc GetCalendar(stream google.api.HttpBody)
236 # returns (stream google.api.HttpBody);
237 # rpc UpdateCalendar(stream google.api.HttpBody)
238 # returns (stream google.api.HttpBody);
239 # }
240 #
241 # Use of this type only changes how the request and response bodies are
242 # handled, all other features will continue to work unchanged.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]243 "extensions": [ # Application specific response metadata. Must be set in the first response
244 # for streaming APIs.
245 {
246 "a_key": "", # Properties of the object. Contains field @type with type URL.
247 },
248 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
250 "data": "A String", # The HTTP request/response body as raw binary.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]251 }</pre>
252</div>
253
254</body></html>