blob: f7a8cb92247ec2a25fc9ac2cd337395ebe4c71f8 [file] [log] [blame]
<!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>Google Cloud Vision Operators &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="PythonOperator" href="../python.html" />
<link rel="prev" title="Google Cloud Video Intelligence Operators" href="video.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.5
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">How-to Guides</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../set-config.html">Setting Configuration Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../initialize-database.html">Initializing a Database Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Using Operators</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../bash.html">BashOperator</a></li>
<li class="toctree-l3"><a class="reference internal" href="../dingding.html">Dingding Operators</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Google Cloud Operators</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="bigtable.html">Google Cloud Bigtable Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="cloud_build.html">Google Cloud Build Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="compute.html">Google Compute Engine Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="function.html">Google Cloud Functions Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="gcs.html">Google Cloud Storage Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="natural_language.html">Google Cloud Natural Language Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="spanner.html">Google Cloud Spanner Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="speech.html">Google Cloud Text to Speech Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="speech.html#google-cloud-speech-to-text-operators">Google Cloud Speech to Text Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="sql.html">Google Cloud Sql Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="transfer.html">Google Cloud Transfer Service Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="translate.html">Google Cloud Translate Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="translate-speech.html">Google Cloud Speech Translate Operators</a></li>
<li class="toctree-l4"><a class="reference internal" href="video.html">Google Cloud Video Intelligence Operators</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">Google Cloud Vision Operators</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../python.html">PythonOperator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../connection/index.html">Managing Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../secure-connections.html">Securing Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../secure-connections.html#rotating-encryption-keys">Rotating encryption keys</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../write-logs.html">Writing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../executor/use-celery.html">Celery Executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../executor/use-dask.html">Dask Executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../executor/use-mesos.html">Scaling Out with Mesos (community contributed)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../run-behind-proxy.html">Running Airflow behind a reverse proxy</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../run-with-systemd.html">Running Airflow with systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../run-with-upstart.html">Running Airflow with upstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../use-test-config.html">Using the Test Mode Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../check-health.html">Checking Airflow Health Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../define_extra_link.html">Define an operator extra link</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tracking-user-activity.html">Tracking User Activity</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../cli.html">Command Line Interface Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api.html">REST API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../macros.html">Macros reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../privacy_notice.html">Privacy Notice</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Airflow</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="../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">How-to Guides</a> &raquo;</li>
<li><a href="../index.html">Using Operators</a> &raquo;</li>
<li><a href="index.html">Google Cloud Operators</a> &raquo;</li>
<li>Google Cloud Vision Operators</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/howto/operator/gcp/vision.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<blockquote>
<div></div></blockquote>
<div class="section" id="google-cloud-vision-operators">
<h1>Google Cloud Vision Operators<a class="headerlink" href="#google-cloud-vision-operators" title="Permalink to this headline"></a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#cloudvisionaddproducttoproductsetoperator" id="id61">CloudVisionAddProductToProductSetOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionannotateimageoperator" id="id62">CloudVisionAnnotateImageOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductcreateoperator" id="id63">CloudVisionProductCreateOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductdeleteoperator" id="id64">CloudVisionProductDeleteOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductgetoperator" id="id65">CloudVisionProductGetOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductsetcreateoperator" id="id66">CloudVisionProductSetCreateOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductsetdeleteoperator" id="id67">CloudVisionProductSetDeleteOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductsetgetoperator" id="id68">CloudVisionProductSetGetOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductsetupdateoperator" id="id69">CloudVisionProductSetUpdateOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionproductupdateoperator" id="id70">CloudVisionProductUpdateOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionreferenceimagecreateoperator" id="id71">CloudVisionReferenceImageCreateOperator</a></p></li>
<li><p><a class="reference internal" href="#cloudvisionremoveproductfromproductsetoperator" id="id72">CloudVisionRemoveProductFromProductSetOperator</a></p></li>
</ul>
</div>
<div class="section" id="cloudvisionaddproducttoproductsetoperator">
<span id="howto-operator-cloudvisionaddproducttoproductsetoperator"></span><h2><a class="toc-backref" href="#id61">CloudVisionAddProductToProductSetOperator</a><a class="headerlink" href="#cloudvisionaddproducttoproductsetoperator" title="Permalink to this headline"></a></h2>
<p>Creates a new <code class="code docutils literal notranslate"><span class="pre">ReferenceImage</span></code> resource.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionAddProductToProductSetOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionAddProductToProductSetOperator</span></code></a></p>
<div class="section" id="arguments">
<h3>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="using-the-operator">
<h3>Using the operator<a class="headerlink" href="#using-the-operator" title="Permalink to this headline"></a></h3>
<p>We are using the <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Product" title="(in google-cloud)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Product</span></code></a>,
<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.ProductSet" title="(in google-cloud)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProductSet</span></code></a> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">ProductSet</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">Product</span>
</pre></div>
</div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> and <code class="docutils literal notranslate"><span class="pre">product_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">add_product_to_product_set</span> <span class="o">=</span> <span class="n">CloudVisionAddProductToProductSetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_set_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;add_product_to_product_set&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">add_product_to_product_set_2</span> <span class="o">=</span> <span class="n">CloudVisionAddProductToProductSetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;add_product_to_product_set_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="templating">
<h3>Templating<a class="headerlink" href="#templating" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;location&quot;</span><span class="p">,</span> <span class="s2">&quot;product_set_id&quot;</span><span class="p">,</span> <span class="s2">&quot;product_id&quot;</span><span class="p">,</span> <span class="s2">&quot;project_id&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="more-information">
<h3>More information<a class="headerlink" href="#more-information" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.add_product_to_product_set">Google Cloud Vision Add Product To Product Set documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionannotateimageoperator">
<span id="howto-operator-cloudvisionannotateimageoperator"></span><h2><a class="toc-backref" href="#id62">CloudVisionAnnotateImageOperator</a><a class="headerlink" href="#cloudvisionannotateimageoperator" title="Permalink to this headline"></a></h2>
<p>Run image detection and annotation for an image.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionAnnotateImageOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionAnnotateImageOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionAnnotateImageOperator</span></code></a></p>
<div class="section" id="id1">
<h3>Arguments<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_ANNOTATE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_ANNOTATE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image2.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id2">
<h3>Using the operator<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="xref py py-class docutils literal notranslate"><span class="pre">enums</span></code> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision</span> <span class="kn">import</span> <span class="n">enums</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">annotate_image</span> <span class="o">=</span> <span class="n">CloudVisionAnnotateImageOperator</span><span class="p">(</span>
<span class="n">request</span><span class="o">=</span><span class="n">annotate_image_request</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;annotate_image&#39;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The result can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">annotate_image_result</span> <span class="o">=</span> <span class="n">BashOperator</span><span class="p">(</span>
<span class="n">bash_command</span><span class="o">=</span><span class="s2">&quot;echo {{ task_instance.xcom_pull(&#39;annotate_image&#39;)&quot;</span>
<span class="s2">&quot;[&#39;logoAnnotations&#39;][0][&#39;description&#39;] }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;annotate_image_result&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id3">
<h3>Templating<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;request&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id4">
<h3>More information<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ImageAnnotatorClient.annotate_image">Google Cloud Vision Annotate Image documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductcreateoperator">
<span id="howto-operator-cloudvisionproductcreateoperator"></span><h2><a class="toc-backref" href="#id63">CloudVisionProductCreateOperator</a><a class="headerlink" href="#cloudvisionproductcreateoperator" title="Permalink to this headline"></a></h2>
<p>Creates and returns a new product resource.</p>
<p>Possible errors regarding the <code class="code docutils literal notranslate"><span class="pre">Product</span></code> object provided:</p>
<ul class="simple">
<li><p>Returns INVALID_ARGUMENT if <cite>display_name</cite> is missing or longer than 4096 characters.</p></li>
<li><p>Returns INVALID_ARGUMENT if <cite>description</cite> is longer than 4096 characters.</p></li>
<li><p>Returns INVALID_ARGUMENT if <cite>product_category</cite> is missing or invalid.</p></li>
</ul>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductCreateOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductCreateOperator</span></code></a></p>
<div class="section" id="id5">
<h3>Arguments<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id6">
<h3>Using the operator<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="docutils literal notranslate"><span class="pre">Product</span></code> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">Product</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product</span> <span class="o">=</span> <span class="n">Product</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product 1&#39;</span><span class="p">,</span> <span class="n">product_category</span><span class="o">=</span><span class="s1">&#39;toys&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">product_id</span></code> argument can be omitted (it will be generated by the API):</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_create</span> <span class="o">=</span> <span class="n">CloudVisionProductCreateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product</span><span class="o">=</span><span class="n">product</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_create&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Or it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_create_2</span> <span class="o">=</span> <span class="n">CloudVisionProductCreateOperator</span><span class="p">(</span>
<span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product</span><span class="o">=</span><span class="n">product</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_create_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id7">
<h3>Templating<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id8">
<h3>More information<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.create_product">Google Cloud Vision Product create documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductdeleteoperator">
<span id="howto-operator-cloudvisionproductdeleteoperator"></span><h2><a class="toc-backref" href="#id64">CloudVisionProductDeleteOperator</a><a class="headerlink" href="#cloudvisionproductdeleteoperator" title="Permalink to this headline"></a></h2>
<p>Permanently deletes a product and its reference images.</p>
<p>Metadata of the product and all its images will be deleted right away, but search queries
against <code class="code docutils literal notranslate"><span class="pre">ProductSets</span></code> containing the product may still work until all related
caches are refreshed.</p>
<p>Possible errors:</p>
<ul class="simple">
<li><p>Returns NOT_FOUND if the product does not exist.</p></li>
</ul>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductDeleteOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductDeleteOperator</span></code></a></p>
<div class="section" id="id9">
<h3>Arguments<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id10">
<h3>Using the operator<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<p>If <code class="docutils literal notranslate"><span class="pre">product_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_delete</span> <span class="o">=</span> <span class="n">CloudVisionProductDeleteOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_delete&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_delete_2</span> <span class="o">=</span> <span class="n">CloudVisionProductDeleteOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span> <span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_delete_2&#39;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id11">
<h3>Templating<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id12">
<h3>More information<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.delete_product">Google Cloud Vision Product delete documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductgetoperator">
<span id="howto-operator-cloudvisionproductgetoperator"></span><h2><a class="toc-backref" href="#id65">CloudVisionProductGetOperator</a><a class="headerlink" href="#cloudvisionproductgetoperator" title="Permalink to this headline"></a></h2>
<p>Gets information associated with a <code class="code docutils literal notranslate"><span class="pre">Product</span></code>.</p>
<p>Possible errors:</p>
<ul class="simple">
<li><p>Returns NOT_FOUND if the <cite>Product</cite> does not exist.</p></li>
</ul>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductGetOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductGetOperator</span></code></a></p>
<div class="section" id="id13">
<h3>Arguments<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id14">
<h3>Using the operator<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<p>If <code class="docutils literal notranslate"><span class="pre">product_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_get</span> <span class="o">=</span> <span class="n">CloudVisionProductGetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_get&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_get_2</span> <span class="o">=</span> <span class="n">CloudVisionProductGetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span> <span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_get_2&#39;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id15">
<h3>Templating<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id16">
<h3>More information<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.get_product">Google Cloud Vision Product get documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductsetcreateoperator">
<span id="howto-operator-cloudvisionproductsetcreateoperator"></span><h2><a class="toc-backref" href="#id66">CloudVisionProductSetCreateOperator</a><a class="headerlink" href="#cloudvisionproductsetcreateoperator" title="Permalink to this headline"></a></h2>
<p>Creates a new <code class="code docutils literal notranslate"><span class="pre">ProductSet</span></code> resource.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetCreateOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductSetCreateOperator</span></code></a></p>
<div class="section" id="id17">
<h3>Arguments<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id18">
<h3>Using the operator<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="docutils literal notranslate"><span class="pre">ProductSet</span></code> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">ProductSet</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set</span> <span class="o">=</span> <span class="n">ProductSet</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product Set&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> argument can be omitted (it will be generated by the API):</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_create</span> <span class="o">=</span> <span class="n">CloudVisionProductSetCreateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set</span><span class="o">=</span><span class="n">product_set</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_create&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Or it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_create_2</span> <span class="o">=</span> <span class="n">CloudVisionProductSetCreateOperator</span><span class="p">(</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set</span><span class="o">=</span><span class="n">product_set</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_create_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id19">
<h3>Templating<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;location&quot;</span><span class="p">,</span> <span class="s2">&quot;project_id&quot;</span><span class="p">,</span> <span class="s2">&quot;product_set_id&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id20">
<h3>More information<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.create_product_set">Google Cloud Vision ProductSet create documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductsetdeleteoperator">
<span id="howto-operator-cloudvisionproductsetdeleteoperator"></span><h2><a class="toc-backref" href="#id67">CloudVisionProductSetDeleteOperator</a><a class="headerlink" href="#cloudvisionproductsetdeleteoperator" title="Permalink to this headline"></a></h2>
<p>Permanently deletes a <code class="code docutils literal notranslate"><span class="pre">ProductSet</span></code>. <code class="code docutils literal notranslate"><span class="pre">Products</span></code> and <code class="code docutils literal notranslate"><span class="pre">ReferenceImages</span></code> in
the <code class="code docutils literal notranslate"><span class="pre">ProductSet</span></code> are not deleted. The actual image files are not deleted from
Google Cloud Storage.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetDeleteOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductSetDeleteOperator</span></code></a></p>
<div class="section" id="id21">
<h3>Arguments<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id22">
<h3>Using the operator<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h3>
<p>If <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_delete</span> <span class="o">=</span> <span class="n">CloudVisionProductSetDeleteOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_set_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_delete&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_delete_2</span> <span class="o">=</span> <span class="n">CloudVisionProductSetDeleteOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span> <span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_delete_2&#39;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id23">
<h3>Templating<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id24">
<h3>More information<a class="headerlink" href="#id24" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.delete_product_set">Google Cloud Vision ProductSet delete documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductsetgetoperator">
<span id="howto-operator-cloudvisionproductsetgetoperator"></span><h2><a class="toc-backref" href="#id68">CloudVisionProductSetGetOperator</a><a class="headerlink" href="#cloudvisionproductsetgetoperator" title="Permalink to this headline"></a></h2>
<p>Gets information associated with a <code class="code docutils literal notranslate"><span class="pre">ProductSet</span></code>.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetGetOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductSetGetOperator</span></code></a></p>
<div class="section" id="id25">
<h3>Arguments<a class="headerlink" href="#id25" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id26">
<h3>Using the operator<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h3>
<p>If <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_get</span> <span class="o">=</span> <span class="n">CloudVisionProductSetGetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_set_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_get&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_get_2</span> <span class="o">=</span> <span class="n">CloudVisionProductSetGetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span> <span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_get_2&#39;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id27">
<h3>Templating<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id28">
<h3>More information<a class="headerlink" href="#id28" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.get_product_set">Google Cloud Vision ProductSet get documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductsetupdateoperator">
<span id="howto-operator-cloudvisionproductsetupdateoperator"></span><h2><a class="toc-backref" href="#id69">CloudVisionProductSetUpdateOperator</a><a class="headerlink" href="#cloudvisionproductsetupdateoperator" title="Permalink to this headline"></a></h2>
<p>Makes changes to a <code class="code docutils literal notranslate"><span class="pre">ProductSet</span></code> resource. Only <code class="code docutils literal notranslate"><span class="pre">display_name</span></code> can be updated
currently.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To locate the <cite>ProductSet</cite> resource, its <cite>name</cite> in the form
<code class="docutils literal notranslate"><span class="pre">projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID</span></code> is necessary.</p>
</div>
<p>You can provide the <cite>name</cite> directly as an attribute of the <cite>product_set</cite> object.
However, you can leave it blank and provide <cite>location</cite> and <cite>product_set_id</cite> instead (and
optionally <cite>project_id</cite> - if not present, the connection default will be used) and the
<cite>name</cite> will be created by the operator itself.</p>
<p>This mechanism exists for your convenience, to allow leaving the <cite>project_id</cite> empty and
having Airflow use the connection default <cite>project_id</cite>.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductSetUpdateOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductSetUpdateOperator</span></code></a></p>
<div class="section" id="id29">
<h3>Arguments<a class="headerlink" href="#id29" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id30">
<h3>Using the operator<a class="headerlink" href="#id30" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="docutils literal notranslate"><span class="pre">ProductSet</span></code> object from the Google Cloud Vision library:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">ProductSet</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set</span> <span class="o">=</span> <span class="n">ProductSet</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product Set&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>Initialization of the task:</p>
<p>If <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_update</span> <span class="o">=</span> <span class="n">CloudVisionProductSetUpdateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_set_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">product_set</span><span class="o">=</span><span class="n">ProductSet</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product Set 2&#39;</span><span class="p">),</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_update&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_set_update_2</span> <span class="o">=</span> <span class="n">CloudVisionProductSetUpdateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span>
<span class="n">product_set</span><span class="o">=</span><span class="n">ProductSet</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product Set 2&#39;</span><span class="p">),</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_set_update_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id31">
<h3>Templating<a class="headerlink" href="#id31" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id32">
<h3>More information<a class="headerlink" href="#id32" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.update_product_set">Google Cloud Vision ProductSet update documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionproductupdateoperator">
<span id="howto-operator-cloudvisionproductupdateoperator"></span><h2><a class="toc-backref" href="#id70">CloudVisionProductUpdateOperator</a><a class="headerlink" href="#cloudvisionproductupdateoperator" title="Permalink to this headline"></a></h2>
<p>Makes changes to a <code class="code docutils literal notranslate"><span class="pre">Product</span></code> resource. Only the <code class="code docutils literal notranslate"><span class="pre">display_name</span></code>,
<code class="code docutils literal notranslate"><span class="pre">description</span></code>, and <code class="code docutils literal notranslate"><span class="pre">labels</span></code> fields can be updated right now.
If labels are updated, the change will not be reflected in queries until the next index
time.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To locate the <cite>Product</cite> resource, its <cite>name</cite> in the form
<code class="docutils literal notranslate"><span class="pre">projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID</span></code> is necessary.</p>
</div>
<p>You can provide the <cite>name</cite> directly as an attribute of the <cite>product</cite> object. However, you
can leave it blank and provide <cite>location</cite> and <cite>product_id</cite> instead (and optionally
<cite>project_id</cite> - if not present, the connection default will be used) and the <cite>name</cite> will
be created by the operator itself.</p>
<p>This mechanism exists for your convenience, to allow leaving the <cite>project_id</cite> empty and
having Airflow use the connection default <cite>project_id</cite>.</p>
<p>Possible errors:</p>
<ul class="simple">
<li><p>Returns NOT_FOUND if the <cite>Product</cite> does not exist.</p></li>
<li><p>Returns INVALID_ARGUMENT if <cite>display_name</cite> is present in <cite>update_mask</cite> but is missing
from the request or longer than 4096 characters.</p></li>
<li><p>Returns INVALID_ARGUMENT if <cite>description</cite> is present in <cite>update_mask</cite> but is longer than
4096 characters.</p></li>
<li><p>Returns INVALID_ARGUMENT if <cite>product_category</cite> is present in <cite>update_mask</cite>.</p></li>
</ul>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionProductUpdateOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionProductUpdateOperator</span></code></a></p>
<div class="section" id="id33">
<h3>Arguments<a class="headerlink" href="#id33" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id34">
<h3>Using the operator<a class="headerlink" href="#id34" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="docutils literal notranslate"><span class="pre">Product</span></code> object from the Google Cloud Vision library:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">Product</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product</span> <span class="o">=</span> <span class="n">Product</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product 1&#39;</span><span class="p">,</span> <span class="n">product_category</span><span class="o">=</span><span class="s1">&#39;toys&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">product_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_update</span> <span class="o">=</span> <span class="n">CloudVisionProductUpdateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">product</span><span class="o">=</span><span class="n">Product</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product 2&#39;</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;My updated description&#39;</span><span class="p">),</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_update&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">product_update_2</span> <span class="o">=</span> <span class="n">CloudVisionProductUpdateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span>
<span class="n">product</span><span class="o">=</span><span class="n">Product</span><span class="p">(</span><span class="n">display_name</span><span class="o">=</span><span class="s1">&#39;My Product 2&#39;</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;My updated description&#39;</span><span class="p">),</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;product_update_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id35">
<h3>Templating<a class="headerlink" href="#id35" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;product_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id36">
<h3>More information<a class="headerlink" href="#id36" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.update_product">Google Cloud Vision Product update documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionreferenceimagecreateoperator">
<span id="howto-operator-cloudvisionreferenceimagecreateoperator"></span><h2><a class="toc-backref" href="#id71">CloudVisionReferenceImageCreateOperator</a><a class="headerlink" href="#cloudvisionreferenceimagecreateoperator" title="Permalink to this headline"></a></h2>
<p>Creates a new <code class="code docutils literal notranslate"><span class="pre">ReferenceImage</span></code> resource.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionReferenceImageCreateOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionReferenceImageCreateOperator</span></code></a></p>
<div class="section" id="id37">
<h3>Arguments<a class="headerlink" href="#id37" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_REFERENCE_IMAGE_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_REFERENCE_IMAGE_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;reference_image_explicit_id&#39;</span><span class="p">)</span>
<span class="n">GCP_VISION_REFERENCE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_REFERENCE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image1.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id38">
<h3>Using the operator<a class="headerlink" href="#id38" title="Permalink to this headline"></a></h3>
<p>We are using the <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.ReferenceImage" title="(in google-cloud)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReferenceImage</span></code></a> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">ReferenceImage</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">reference_image</span> <span class="o">=</span> <span class="n">ReferenceImage</span><span class="p">(</span><span class="n">uri</span><span class="o">=</span><span class="n">GCP_VISION_REFERENCE_IMAGE_URL</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> argument can be omitted (it will be generated by the API):</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">reference_image_create</span> <span class="o">=</span> <span class="n">CloudVisionReferenceImageCreateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">reference_image</span><span class="o">=</span><span class="n">reference_image</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">reference_image_id</span><span class="o">=</span><span class="n">GCP_VISION_REFERENCE_IMAGE_ID</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;reference_image_create&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Or it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">reference_image_create_2</span> <span class="o">=</span> <span class="n">CloudVisionReferenceImageCreateOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">reference_image</span><span class="o">=</span><span class="n">reference_image</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span>
<span class="n">reference_image_id</span><span class="o">=</span><span class="n">GCP_VISION_REFERENCE_IMAGE_ID</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;reference_image_create_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id39">
<h3>Templating<a class="headerlink" href="#id39" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">&quot;location&quot;</span><span class="p">,</span>
<span class="s2">&quot;reference_image&quot;</span><span class="p">,</span>
<span class="s2">&quot;product_id&quot;</span><span class="p">,</span>
<span class="s2">&quot;reference_image_id&quot;</span><span class="p">,</span>
<span class="s2">&quot;project_id&quot;</span><span class="p">,</span>
<span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id40">
<h3>More information<a class="headerlink" href="#id40" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.create_reference_image">Google Cloud Vision ReferenceImage create documentation</a>.</p>
</div>
</div>
<div class="section" id="cloudvisionremoveproductfromproductsetoperator">
<span id="howto-operator-cloudvisionremoveproductfromproductsetoperator"></span><h2><a class="toc-backref" href="#id72">CloudVisionRemoveProductFromProductSetOperator</a><a class="headerlink" href="#cloudvisionremoveproductfromproductsetoperator" title="Permalink to this headline"></a></h2>
<p>Creates a new <code class="code docutils literal notranslate"><span class="pre">ReferenceImage</span></code> resource.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionRemoveProductFromProductSetOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionRemoveProductFromProductSetOperator</span></code></a></p>
<div class="section" id="id41">
<h3>Arguments<a class="headerlink" href="#id41" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_LOCATION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_LOCATION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west1&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_PRODUCT_SET_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_PRODUCT_SET_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;product_set_explicit_id&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id42">
<h3>Using the operator<a class="headerlink" href="#id42" title="Permalink to this headline"></a></h3>
<p>We are using the <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Product" title="(in google-cloud)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Product</span></code></a>,
<a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.ProductSet" title="(in google-cloud)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProductSet</span></code></a> and <code class="docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">ProductSet</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.cloud.vision_v1.types</span> <span class="kn">import</span> <span class="n">Product</span>
</pre></div>
</div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">product_set_id</span></code> and <code class="docutils literal notranslate"><span class="pre">product_id</span></code> was generated by the API it can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">remove_product_from_product_set</span> <span class="o">=</span> <span class="n">CloudVisionRemoveProductFromProductSetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_set_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;product_create&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;remove_product_from_product_set&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>Otherwise it can be specified explicitly:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">remove_product_from_product_set_2</span> <span class="o">=</span> <span class="n">CloudVisionRemoveProductFromProductSetOperator</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="n">GCP_VISION_LOCATION</span><span class="p">,</span>
<span class="n">product_set_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_SET_ID</span><span class="p">,</span>
<span class="n">product_id</span><span class="o">=</span><span class="n">GCP_VISION_PRODUCT_ID</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;remove_product_from_product_set_2&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id43">
<h3>Templating<a class="headerlink" href="#id43" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;location&quot;</span><span class="p">,</span> <span class="s2">&quot;product_set_id&quot;</span><span class="p">,</span> <span class="s2">&quot;product_id&quot;</span><span class="p">,</span> <span class="s2">&quot;project_id&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id44">
<h3>More information<a class="headerlink" href="#id44" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ProductSearchClient.remove_product_from_product_set">Google Cloud Vision Remove Product From Product Set documentation</a>.</p>
<div class="section" id="cloudvisiondetecttextoperator">
<span id="howto-operator-cloudvisiondetecttextoperator"></span><h4>CloudVisionDetectTextOperator<a class="headerlink" href="#cloudvisiondetecttextoperator" title="Permalink to this headline"></a></h4>
<p>Run text detection for an image.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectTextOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionDetectTextOperator</span></code></a></p>
</div>
</div>
<div class="section" id="id45">
<h3>Arguments<a class="headerlink" href="#id45" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_ANNOTATE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_ANNOTATE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image2.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id46">
<h3>Using the operator<a class="headerlink" href="#id46" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="xref py py-class docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_text</span> <span class="o">=</span> <span class="n">CloudVisionDetectTextOperator</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">DETECT_IMAGE</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_text&quot;</span><span class="p">,</span>
<span class="n">language_hints</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span>
<span class="n">web_detection_params</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;include_geo_results&#39;</span><span class="p">:</span> <span class="bp">True</span><span class="p">},</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The result can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_text_result</span> <span class="o">=</span> <span class="n">BashOperator</span><span class="p">(</span>
<span class="n">bash_command</span><span class="o">=</span><span class="s2">&quot;echo {{ task_instance.xcom_pull(&#39;detect_text&#39;)[&#39;textAnnotations&#39;][0] }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_text_result&quot;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id47">
<h3>Templating<a class="headerlink" href="#id47" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;image&quot;</span><span class="p">,</span> <span class="s2">&quot;max_results&quot;</span><span class="p">,</span> <span class="s2">&quot;timeout&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id48">
<h3>More information<a class="headerlink" href="#id48" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ImageAnnotatorClient.text_detection">Google Cloud Vision Text Detection documentation</a>.</p>
<div class="section" id="cloudvisiondetectdocumenttextoperator">
<span id="howto-operator-cloudvisiondetectdocumenttextoperator"></span><h4>CloudVisionDetectDocumentTextOperator<a class="headerlink" href="#cloudvisiondetectdocumenttextoperator" title="Permalink to this headline"></a></h4>
<p>Run document text detection for an image.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectDocumentTextOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionDetectDocumentTextOperator</span></code></a></p>
</div>
</div>
<div class="section" id="id49">
<h3>Arguments<a class="headerlink" href="#id49" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_ANNOTATE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_ANNOTATE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image2.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id50">
<h3>Using the operator<a class="headerlink" href="#id50" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="xref py py-class docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">document_detect_text</span> <span class="o">=</span> <span class="n">CloudVisionDetectDocumentTextOperator</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">DETECT_IMAGE</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;document_detect_text&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The result can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">document_detect_text_result</span> <span class="o">=</span> <span class="n">BashOperator</span><span class="p">(</span>
<span class="n">bash_command</span><span class="o">=</span><span class="s2">&quot;echo {{ task_instance.xcom_pull(&#39;document_detect_text&#39;)[&#39;textAnnotations&#39;][0] }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;document_detect_text_result&quot;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id51">
<h3>Templating<a class="headerlink" href="#id51" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;image&quot;</span><span class="p">,</span> <span class="s2">&quot;max_results&quot;</span><span class="p">,</span> <span class="s2">&quot;timeout&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id52">
<h3>More information<a class="headerlink" href="#id52" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ImageAnnotatorClient.document_text_detection">Google Cloud Vision Document Text Detection documentation</a>.</p>
<div class="section" id="cloudvisiondetectimagelabelsoperator">
<span id="howto-operator-cloudvisiondetectimagelabelsoperator"></span><h4>CloudVisionDetectImageLabelsOperator<a class="headerlink" href="#cloudvisiondetectimagelabelsoperator" title="Permalink to this headline"></a></h4>
<p>Run image label detection for an image.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageLabelsOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionDetectImageLabelsOperator</span></code></a></p>
</div>
</div>
<div class="section" id="id53">
<h3>Arguments<a class="headerlink" href="#id53" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_ANNOTATE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_ANNOTATE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image2.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id54">
<h3>Using the operator<a class="headerlink" href="#id54" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="xref py py-class docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_labels</span> <span class="o">=</span> <span class="n">CloudVisionDetectImageLabelsOperator</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">DETECT_IMAGE</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_labels&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The result can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_labels_result</span> <span class="o">=</span> <span class="n">BashOperator</span><span class="p">(</span>
<span class="n">bash_command</span><span class="o">=</span><span class="s2">&quot;echo {{ task_instance.xcom_pull(&#39;detect_labels&#39;)[&#39;labelAnnotations&#39;][0] }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_labels_result&quot;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id55">
<h3>Templating<a class="headerlink" href="#id55" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;image&quot;</span><span class="p">,</span> <span class="s2">&quot;max_results&quot;</span><span class="p">,</span> <span class="s2">&quot;timeout&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id56">
<h3>More information<a class="headerlink" href="#id56" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ImageAnnotatorClient.label_detection">Google Cloud Vision Label Detection documentation</a>.</p>
<div class="section" id="cloudvisiondetectimagesafesearchoperator">
<span id="howto-operator-cloudvisiondetectimagesafesearchoperator"></span><h4>CloudVisionDetectImageSafeSearchOperator<a class="headerlink" href="#cloudvisiondetectimagesafesearchoperator" title="Permalink to this headline"></a></h4>
<p>Run image label detection for an image.</p>
<p>For parameter definition, take a look at
<a class="reference internal" href="../../../_api/airflow/contrib/operators/gcp_vision_operator/index.html#airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator" title="airflow.contrib.operators.gcp_vision_operator.CloudVisionDetectImageSafeSearchOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudVisionDetectImageSafeSearchOperator</span></code></a></p>
</div>
</div>
<div class="section" id="id57">
<h3>Arguments<a class="headerlink" href="#id57" title="Permalink to this headline"></a></h3>
<p>Some arguments in the example DAG are taken from the OS environment variables:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_VISION_ANNOTATE_IMAGE_URL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_VISION_ANNOTATE_IMAGE_URL&#39;</span><span class="p">,</span> <span class="s1">&#39;gs://bucket/image2.jpg&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id58">
<h3>Using the operator<a class="headerlink" href="#id58" title="Permalink to this headline"></a></h3>
<p>We are using the <code class="xref py py-class docutils literal notranslate"><span class="pre">Retry</span></code> objects from
Google libraries:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
</pre></div>
</div>
</div>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_safe_search</span> <span class="o">=</span> <span class="n">CloudVisionDetectImageSafeSearchOperator</span><span class="p">(</span>
<span class="n">image</span><span class="o">=</span><span class="n">DETECT_IMAGE</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">maximum</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_safe_search&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The result can be extracted from XCOM:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_vision.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_vision.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">detect_safe_search_result</span> <span class="o">=</span> <span class="n">BashOperator</span><span class="p">(</span>
<span class="n">bash_command</span><span class="o">=</span><span class="s2">&quot;echo {{ task_instance.xcom_pull(&#39;detect_safe_search&#39;) }}&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;detect_safe_search_result&quot;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id59">
<h3>Templating<a class="headerlink" href="#id59" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;image&quot;</span><span class="p">,</span> <span class="s2">&quot;max_results&quot;</span><span class="p">,</span> <span class="s2">&quot;timeout&quot;</span><span class="p">,</span> <span class="s2">&quot;gcp_conn_id&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id60">
<h3>More information<a class="headerlink" href="#id60" title="Permalink to this headline"></a></h3>
<p>See <a class="reference external" href="https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/api.html#google.cloud.vision_v1.ImageAnnotatorClient.safe_search_detection">Google Cloud Vision Safe Search Detection documentation</a>.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../python.html" class="btn btn-neutral float-right" title="PythonOperator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="video.html" class="btn btn-neutral float-left" title="Google Cloud Video Intelligence Operators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="../../../privacy_notice.html">Privacy Policy</a>
for more details.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
var nodes = document.documentElement.childNodes;
var i = -1;
var node;
do {
i++;
node = nodes[i]
} while(node.nodeType !== Node.ELEMENT_NODE);
node.appendChild(ga);
})();
</script>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>