mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
392 lines
20 KiB
HTML
392 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-datalabeling1_beta1-cli/projects_datasets-import-data/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Datasets Import Data - Data Labeling v5.0.4+20240207</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Datasets Import Data";
|
|
var mkdocs_page_input_path = "projects_datasets-import-data.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-datalabeling1_beta1-cli/projects_datasets-import-data/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</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-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Data Labeling v5.0.4+20240207
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_annotation-spec-sets-create/">Annotation Spec Sets Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_annotation-spec-sets-delete/">Annotation Spec Sets Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_annotation-spec-sets-get/">Annotation Spec Sets Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_annotation-spec-sets-list/">Annotation Spec Sets List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-data-items-get/">Datasets Annotated Datasets Data Items Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-data-items-list/">Datasets Annotated Datasets Data Items List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-delete/">Datasets Annotated Datasets Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-examples-get/">Datasets Annotated Datasets Examples Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-examples-list/">Datasets Annotated Datasets Examples List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-delete/">Datasets Annotated Datasets Feedback Threads Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-feedback-messages-create/">Datasets Annotated Datasets Feedback Threads Feedback Messages Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-feedback-messages-delete/">Datasets Annotated Datasets Feedback Threads Feedback Messages Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-feedback-messages-get/">Datasets Annotated Datasets Feedback Threads Feedback Messages Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-feedback-messages-list/">Datasets Annotated Datasets Feedback Threads Feedback Messages List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-get/">Datasets Annotated Datasets Feedback Threads Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-feedback-threads-list/">Datasets Annotated Datasets Feedback Threads List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-get/">Datasets Annotated Datasets Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-annotated-datasets-list/">Datasets Annotated Datasets List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-create/">Datasets Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-data-items-get/">Datasets Data Items Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-data-items-list/">Datasets Data Items List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-delete/">Datasets Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-evaluations-example-comparisons-search/">Datasets Evaluations Example Comparisons Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-evaluations-get/">Datasets Evaluations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-export-data/">Datasets Export Data</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-get/">Datasets Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-image-label/">Datasets Image Label</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Datasets Import Data</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-list/">Datasets List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-text-label/">Datasets Text Label</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_datasets-video-label/">Datasets Video Label</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-create/">Evaluation Jobs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-delete/">Evaluation Jobs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-get/">Evaluation Jobs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-list/">Evaluation Jobs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-patch/">Evaluation Jobs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-pause/">Evaluation Jobs Pause</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluation-jobs-resume/">Evaluation Jobs Resume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_evaluations-search/">Evaluations Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instructions-create/">Instructions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instructions-delete/">Instructions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instructions-get/">Instructions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instructions-list/">Instructions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-cancel/">Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-delete/">Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-list/">Operations List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Data Labeling v5.0.4+20240207</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=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Datasets Import Data</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datalabeling1_beta1-cli/edit/master/docs/projects_datasets-import-data.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.</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>datalabeling1-beta1 --scope <scope> projects datasets-import-data ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}</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>GoogleCloudDatalabelingV1beta1ImportDataRequest:
|
|
input-config:
|
|
annotation-type: string
|
|
bigquery-source:
|
|
input-uri: string
|
|
classification-metadata:
|
|
is-multi-label: boolean
|
|
data-type: string
|
|
gcs-source:
|
|
input-uri: string
|
|
mime-type: string
|
|
text-metadata:
|
|
language-code: string
|
|
user-email-address: 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 .input-config annotation-type=stet</code><ul>
|
|
<li>Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>bigquery-source input-uri=kasd</code></p>
|
|
<ul>
|
|
<li>Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the <a href="/ml-engine/docs/continuous-evaluation/create-job#table-schema">correct schema</a>. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" <a href="/ml-engine/docs/continuous-evaluation/create-job#table-schema">Learn more</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..classification-metadata is-multi-label=true</code></p>
|
|
<ul>
|
|
<li>Whether the classification task is multi-label or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. data-type=et</code></p>
|
|
<ul>
|
|
<li>Required. Data type must be specifed when user tries to import data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gcs-source input-uri=et</code><ul>
|
|
<li>Required. The input URI of source file. This must be a Cloud Storage path (<code>gs://...</code>).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>mime-type=vero</code></p>
|
|
<ul>
|
|
<li>Required. The format of the source file. Only "text/csv" is supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..text-metadata language-code=erat</code></p>
|
|
<ul>
|
|
<li>The language of this text, as a <a href="https://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>. Default value is en-US.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... user-email-address=sed</code></p>
|
|
<ul>
|
|
<li>Email of the user who started the import task and should be notified by email. If empty no notification will be sent.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_datasets-image-label/" class="btn btn-neutral float-left" title="Datasets Image Label"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_datasets-list/" class="btn btn-neutral float-right" title="Datasets List">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datalabeling1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_datasets-image-label/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_datasets-list/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|