OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_ml1_cli/projects_predict/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

498 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Predict - Cloud Machine Learning Engine v2.0.0+20210317</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Cloud Machine Learning Engine v2.0.0+20210317</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_explain">Explain</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_get-config">Get Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-cancel">Jobs Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-create">Jobs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-get">Jobs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-get-iam-policy">Jobs Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-list">Jobs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-patch">Jobs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-set-iam-policy">Jobs Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_jobs-test-iam-permissions">Jobs Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-create">Locations Studies Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-delete">Locations Studies Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-get">Locations Studies Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-list">Locations Studies List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-add-measurement">Locations Studies Trials Add Measurement</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-check-early-stopping-state">Locations Studies Trials Check Early Stopping State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-complete">Locations Studies Trials Complete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-create">Locations Studies Trials Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-delete">Locations Studies Trials Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-get">Locations Studies Trials Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-list">Locations Studies Trials List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-list-optimal-trials">Locations Studies Trials List Optimal Trials</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-stop">Locations Studies Trials Stop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-studies-trials-suggest">Locations Studies Trials Suggest</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-create">Models Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-delete">Models Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-get">Models Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-get-iam-policy">Models Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-list">Models List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-patch">Models Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-set-iam-policy">Models Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-test-iam-permissions">Models Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-create">Models Versions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-delete">Models Versions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-get">Models Versions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-list">Models Versions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-patch">Models Versions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_models-versions-set-default">Models Versions Set Default</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-cancel">Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-list">Operations List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Predict</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Predict</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/ml1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Performs online prediction on the data in the request. {% dynamic include &#34;/ai-platform/includes/___predict-request&#34; %} </p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>ml1 --scope &lt;scope&gt; projects predict ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. The resource name of a model or a version. Authorization: requires the <code>predict</code> permission on the specified resource.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>GoogleCloudMlV1__PredictRequest:
http-body:
content-type: string
data: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r .http-body content-type=sit</code><ul>
<li>The HTTP Content-Type header value specifying the content type of the body.</li>
</ul>
</li>
<li><code>data=accusam</code><ul>
<li>The HTTP request/response body as raw binary.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_operations-list" class="btn btn-neutral" title="Operations List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_operations-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink