pydoc/2.47.0/_modules/apache_beam/ml/gcp/videointelligenceml.html - beam-site - Git at Google



 <!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>apache_beam.ml.gcp.videointelligenceml &mdash; Apache Beam 2.47.0 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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" />
 </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"> Apache Beam


           </a>


               <div class="version">
                 2.47.0
               </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>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.yaml.html">apache_beam.yaml package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pvalue.html">apache_beam.pvalue module</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">Apache Beam</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">Module code</a> &raquo;</li>

       <li>apache_beam.ml.gcp.videointelligenceml</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.ml.gcp.videointelligenceml</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;A connector for sending API requests to the GCP Video Intelligence API.&quot;&quot;&quot;</span>

 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>

 <span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">typehints</span>
 <span class="kn">from</span> <span class="nn">apache_beam.metrics</span> <span class="kn">import</span> <span class="n">Metrics</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">DoFn</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">ParDo</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">PTransform</span>
 <span class="kn">from</span> <span class="nn">cachetools.func</span> <span class="kn">import</span> <span class="n">ttl_cache</span>

 <span class="k">try</span><span class="p">:</span>
   <span class="kn">from</span> <span class="nn">google.cloud</span> <span class="kn">import</span> <span class="n">videointelligence</span>
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
   <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
       <span class="s1">&#39;Google Cloud Video Intelligence not supported for this execution &#39;</span>
       <span class="s1">&#39;environment (could not import google.cloud.videointelligence).&#39;</span><span class="p">)</span>

 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;AnnotateVideo&#39;</span><span class="p">,</span> <span class="s1">&#39;AnnotateVideoWithContext&#39;</span><span class="p">]</span>


 <span class="nd">@ttl_cache</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">3600</span><span class="p">)</span>
 <span class="k">def</span> <span class="nf">get_videointelligence_client</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Returns a Cloud Video Intelligence client.&quot;&quot;&quot;</span>
   <span class="n">_client</span> <span class="o">=</span> <span class="n">videointelligence</span><span class="o">.</span><span class="n">VideoIntelligenceServiceClient</span><span class="p">()</span>
   <span class="k">return</span> <span class="n">_client</span>


 <div class="viewcode-block" id="AnnotateVideo"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.videointelligenceml.html#apache_beam.ml.gcp.videointelligenceml.AnnotateVideo">[docs]</a><span class="k">class</span> <span class="nc">AnnotateVideo</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A ``PTransform`` for annotating video using the GCP Video Intelligence API</span>
 <span class="sd">  ref: https://cloud.google.com/video-intelligence/docs</span>

 <span class="sd">  Sends each element to the GCP Video Intelligence API. Element is a</span>
 <span class="sd">  Union[str, bytes] of either an URI (e.g. a GCS URI) or</span>
 <span class="sd">  bytes base64-encoded video data.</span>
 <span class="sd">  Accepts an `AsDict` side input that maps each video to a video context.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">features</span><span class="p">,</span>
       <span class="n">location_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span>
       <span class="n">context_side_input</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Args:</span>
 <span class="sd">      features: (List[``videointelligence_v1.Feature``]) Required.</span>
 <span class="sd">        The Video Intelligence API features to detect</span>
 <span class="sd">      location_id: (str) Optional.</span>
 <span class="sd">        Cloud region where annotation should take place.</span>
 <span class="sd">        If no region is specified, a region will be determined</span>
 <span class="sd">        based on video file location.</span>
 <span class="sd">      metadata: (Sequence[Tuple[str, str]]) Optional.</span>
 <span class="sd">        Additional metadata that is provided to the method.</span>
 <span class="sd">      timeout: (int) Optional.</span>
 <span class="sd">        The time in seconds to wait for the response from the</span>
 <span class="sd">        Video Intelligence API</span>
 <span class="sd">      context_side_input: (beam.pvalue.AsDict) Optional.</span>
 <span class="sd">        An ``AsDict`` of a PCollection to be passed to the</span>
 <span class="sd">        _VideoAnnotateFn as the video context mapping containing additional</span>
 <span class="sd">        video context and/or feature-specific parameters.</span>
 <span class="sd">        Example usage::</span>

 <span class="sd">          video_contexts =</span>
 <span class="sd">            [(&#39;gs://cloud-samples-data/video/cat.mp4&#39;, Union[dict,</span>
 <span class="sd">            ``videointelligence_v1.VideoContext``]),</span>
 <span class="sd">            (&#39;gs://some-other-video/sample.mp4&#39;, Union[dict,</span>
 <span class="sd">            ``videointelligence_v1.VideoContext``]),]</span>

 <span class="sd">          context_side_input =</span>
 <span class="sd">            (</span>
 <span class="sd">              p</span>
 <span class="sd">              | &quot;Video contexts&quot; &gt;&gt; beam.Create(video_contexts)</span>
 <span class="sd">            )</span>

 <span class="sd">          videointelligenceml.AnnotateVideo(features,</span>
 <span class="sd">            context_side_input=beam.pvalue.AsDict(context_side_input)))</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">features</span> <span class="o">=</span> <span class="n">features</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">location_id</span> <span class="o">=</span> <span class="n">location_id</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">context_side_input</span> <span class="o">=</span> <span class="n">context_side_input</span>

 <div class="viewcode-block" id="AnnotateVideo.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.videointelligenceml.html#apache_beam.ml.gcp.videointelligenceml.AnnotateVideo.expand">[docs]</a>  <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pvalue</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">pvalue</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
         <span class="n">_VideoAnnotateFn</span><span class="p">(</span>
             <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
             <span class="n">location_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location_id</span><span class="p">,</span>
             <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
             <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">),</span>
         <span class="n">context_side_input</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">context_side_input</span><span class="p">)</span></div></div>


 <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_input_types</span><span class="p">(</span>
     <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">videointelligence</span><span class="o">.</span><span class="n">VideoContext</span><span class="p">])</span>
 <span class="k">class</span> <span class="nc">_VideoAnnotateFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A DoFn that sends each input element to the GCP Video Intelligence API</span>
 <span class="sd">  service and outputs an element with the return result of the API</span>
 <span class="sd">  (``google.cloud.videointelligence_v1.AnnotateVideoResponse``).</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">features</span><span class="p">,</span> <span class="n">location_id</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">features</span> <span class="o">=</span> <span class="n">features</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">location_id</span> <span class="o">=</span> <span class="n">location_id</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">counter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">,</span> <span class="s2">&quot;API Calls&quot;</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">start_bundle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">get_videointelligence_client</span><span class="p">()</span>

   <span class="k">def</span> <span class="nf">_annotate_video</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">video_context</span><span class="p">):</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>  <span class="c1"># Is element an URI to a GCS bucket</span>
       <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">annotate_video</span><span class="p">(</span>
           <span class="n">input_uri</span><span class="o">=</span><span class="n">element</span><span class="p">,</span>
           <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
           <span class="n">video_context</span><span class="o">=</span><span class="n">video_context</span><span class="p">,</span>
           <span class="n">location_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location_id</span><span class="p">,</span>
           <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>  <span class="c1"># Is element raw bytes</span>
       <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">annotate_video</span><span class="p">(</span>
           <span class="n">input_content</span><span class="o">=</span><span class="n">element</span><span class="p">,</span>
           <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
           <span class="n">video_context</span><span class="o">=</span><span class="n">video_context</span><span class="p">,</span>
           <span class="n">location_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location_id</span><span class="p">,</span>
           <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">response</span>

   <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">context_side_input</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="k">if</span> <span class="n">context_side_input</span><span class="p">:</span>  <span class="c1"># If we have a side input video context, use that</span>
       <span class="n">video_context</span> <span class="o">=</span> <span class="n">context_side_input</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="n">video_context</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_annotate_video</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">video_context</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span><span class="o">.</span><span class="n">inc</span><span class="p">()</span>
     <span class="k">yield</span> <span class="n">response</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>


 <div class="viewcode-block" id="AnnotateVideoWithContext"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.videointelligenceml.html#apache_beam.ml.gcp.videointelligenceml.AnnotateVideoWithContext">[docs]</a><span class="k">class</span> <span class="nc">AnnotateVideoWithContext</span><span class="p">(</span><span class="n">AnnotateVideo</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A ``PTransform`` for annotating video using the GCP Video Intelligence API</span>
 <span class="sd">  ref: https://cloud.google.com/video-intelligence/docs</span>

 <span class="sd">  Sends each element to the GCP Video Intelligence API.</span>
 <span class="sd">  Element is a tuple of</span>

 <span class="sd">    (Union[str, bytes],</span>
 <span class="sd">    Optional[videointelligence.VideoContext])</span>

 <span class="sd">  where the former is either an URI (e.g. a GCS URI) or</span>
 <span class="sd">  bytes base64-encoded video data</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">features</span><span class="p">,</span> <span class="n">location_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">      Args:</span>
 <span class="sd">        features: (List[``videointelligence_v1.Feature``]) Required.</span>
 <span class="sd">          the Video Intelligence API features to detect</span>
 <span class="sd">        location_id: (str) Optional.</span>
 <span class="sd">          Cloud region where annotation should take place.</span>
 <span class="sd">          If no region is specified, a region will be determined</span>
 <span class="sd">          based on video file location.</span>
 <span class="sd">        metadata: (Sequence[Tuple[str, str]]) Optional.</span>
 <span class="sd">          Additional metadata that is provided to the method.</span>
 <span class="sd">        timeout: (int) Optional.</span>
 <span class="sd">          The time in seconds to wait for the response from the</span>
 <span class="sd">          Video Intelligence API</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="n">features</span><span class="o">=</span><span class="n">features</span><span class="p">,</span>
         <span class="n">location_id</span><span class="o">=</span><span class="n">location_id</span><span class="p">,</span>
         <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
         <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>

 <div class="viewcode-block" id="AnnotateVideoWithContext.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.videointelligenceml.html#apache_beam.ml.gcp.videointelligenceml.AnnotateVideoWithContext.expand">[docs]</a>  <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pvalue</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">pvalue</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
         <span class="n">_VideoAnnotateFnWithContext</span><span class="p">(</span>
             <span class="n">features</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">features</span><span class="p">,</span>
             <span class="n">location_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location_id</span><span class="p">,</span>
             <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
             <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">))</span></div></div>


 <span class="nd">@typehints</span><span class="o">.</span><span class="n">with_input_types</span><span class="p">(</span>
     <span class="n">Tuple</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">videointelligence</span><span class="o">.</span><span class="n">VideoContext</span><span class="p">]])</span>
 <span class="k">class</span> <span class="nc">_VideoAnnotateFnWithContext</span><span class="p">(</span><span class="n">_VideoAnnotateFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A DoFn that unpacks each input tuple to element, video_context variables</span>
 <span class="sd">  and sends these to the GCP Video Intelligence API service and outputs</span>
 <span class="sd">  an element with the return result of the API</span>
 <span class="sd">  (``google.cloud.videointelligence_v1.AnnotateVideoResponse``).</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">features</span><span class="p">,</span> <span class="n">location_id</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span>
     <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
         <span class="n">features</span><span class="o">=</span><span class="n">features</span><span class="p">,</span>
         <span class="n">location_id</span><span class="o">=</span><span class="n">location_id</span><span class="p">,</span>
         <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
         <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="n">element</span><span class="p">,</span> <span class="n">video_context</span> <span class="o">=</span> <span class="n">element</span>  <span class="c1"># Unpack (video, video_context) tuple</span>
     <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_annotate_video</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">video_context</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span><span class="o">.</span><span class="n">inc</span><span class="p">()</span>
     <span class="k">yield</span> <span class="n">response</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>
 </pre></div>

            </div>

           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </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>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>