Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / pydoc / 2.38.0 / _modules / apache_beam / ml / gcp / recommendations_ai.html
blob: f6cbd5cbf59959b1351672fd469d21062f8e4aef [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>apache_beam.ml.gcp.recommendations_ai &mdash; Apache Beam 2.38.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.38.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.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>
</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.recommendations_ai</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.recommendations_ai</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 Recommendations AI</span>
<span class="sd">API (https://cloud.google.com/recommendations).</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Sequence</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">google.api_core.retry</span> <span class="kn">import</span> <span class="n">Retry</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">pvalue</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.options.pipeline_options</span> <span class="kn">import</span> <span class="n">GoogleCloudOptions</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">apache_beam.transforms.util</span> <span class="kn">import</span> <span class="n">GroupIntoBatches</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="c1"># pylint: disable=wrong-import-order, wrong-import-position, ungrouped-imports</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">recommendationengine</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 Recommendation AI not supported for this execution &#39;</span>
<span class="s1">&#39;environment (could not import google.cloud.recommendationengine).&#39;</span><span class="p">)</span>
<span class="c1"># pylint: enable=wrong-import-order, wrong-import-position, ungrouped-imports</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;CreateCatalogItem&#39;</span><span class="p">,</span>
<span class="s1">&#39;WriteUserEvent&#39;</span><span class="p">,</span>
<span class="s1">&#39;ImportCatalogItems&#39;</span><span class="p">,</span>
<span class="s1">&#39;ImportUserEvents&#39;</span><span class="p">,</span>
<span class="s1">&#39;PredictUserEvent&#39;</span>
<span class="p">]</span>
<span class="n">FAILED_CATALOG_ITEMS</span> <span class="o">=</span> <span class="s2">&quot;failed_catalog_items&quot;</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_recommendation_prediction_client</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;Returns a Recommendation AI - Prediction Service client.&quot;&quot;&quot;</span>
<span class="n">_client</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">PredictionServiceClient</span><span class="p">()</span>
<span class="k">return</span> <span class="n">_client</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_recommendation_catalog_client</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;Returns a Recommendation AI - Catalog Service client.&quot;&quot;&quot;</span>
<span class="n">_client</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">CatalogServiceClient</span><span class="p">()</span>
<span class="k">return</span> <span class="n">_client</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_recommendation_user_event_client</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;Returns a Recommendation AI - UserEvent Service client.&quot;&quot;&quot;</span>
<span class="n">_client</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEventServiceClient</span><span class="p">()</span>
<span class="k">return</span> <span class="n">_client</span>
<div class="viewcode-block" id="CreateCatalogItem"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem">[docs]</a><span class="k">class</span> <span class="nc">CreateCatalogItem</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Creates catalogitem information.</span>
<span class="sd"> The ``PTranform`` returns a PCollectionTuple with a PCollections of</span>
<span class="sd"> successfully and failed created CatalogItems.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> pipeline | CreateCatalogItem(</span>
<span class="sd"> project=&#39;example-gcp-project&#39;,</span>
<span class="sd"> catalog_name=&#39;my-catalog&#39;)</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">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_catalog&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Initializes a :class:`CreateCatalogItem` transform.</span>
<span class="sd"> Args:</span>
<span class="sd"> project (str): Optional. GCP project name in which the catalog</span>
<span class="sd"> data will be imported.</span>
<span class="sd"> retry: Optional. Designation of what</span>
<span class="sd"> errors, if any, should be retried.</span>
<span class="sd"> timeout (float): Optional. The amount of time, in seconds, to wait</span>
<span class="sd"> for the request to complete.</span>
<span class="sd"> metadata: Optional. Strings which</span>
<span class="sd"> should be sent along with the request as metadata.</span>
<span class="sd"> catalog_name (str): Optional. Name of the catalog.</span>
<span class="sd"> Default: &#39;default_catalog&#39;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span> <span class="o">=</span> <span class="n">catalog_name</span>
<div class="viewcode-block" id="CreateCatalogItem.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem.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">pcoll</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="sd">&quot;&quot;&quot;GCP project name needs to be specified in &quot;project&quot; pipeline</span>
<span class="sd"> option&quot;&quot;&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">pcoll</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
<span class="n">_CreateCatalogItemFn</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span><span class="p">))</span></div></div>
<span class="k">class</span> <span class="nc">_CreateCatalogItemFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</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">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</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">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;projects/</span><span class="si">{</span><span class="n">project</span><span class="si">}</span><span class="s2">/locations/global/catalogs/</span><span class="si">{</span><span class="n">catalog_name</span><span class="si">}</span><span class="s2">&quot;</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">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</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_recommendation_catalog_client</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="n">catalog_item</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">CatalogItem</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">CreateCatalogItemRequest</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">catalog_item</span><span class="o">=</span><span class="n">catalog_item</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">created_catalog_item</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">create_catalog_item</span><span class="p">(</span>
<span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">retry</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">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="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">recommendationengine</span><span class="o">.</span><span class="n">CatalogItem</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">created_catalog_item</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">TaggedOutput</span><span class="p">(</span>
<span class="n">FAILED_CATALOG_ITEMS</span><span class="p">,</span>
<span class="n">recommendationengine</span><span class="o">.</span><span class="n">CatalogItem</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">catalog_item</span><span class="p">))</span>
<div class="viewcode-block" id="ImportCatalogItems"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems">[docs]</a><span class="k">class</span> <span class="nc">ImportCatalogItems</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Imports catalogitems in bulk.</span>
<span class="sd"> The `PTransform` returns a PCollectionTuple with PCollections of</span>
<span class="sd"> successfully and failed imported CatalogItems.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> pipeline</span>
<span class="sd"> | ImportCatalogItems(</span>
<span class="sd"> project=&#39;example-gcp-project&#39;,</span>
<span class="sd"> catalog_name=&#39;my-catalog&#39;)</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">max_batch_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5000</span><span class="p">,</span>
<span class="n">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_catalog&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Initializes a :class:`ImportCatalogItems` transform</span>
<span class="sd"> Args:</span>
<span class="sd"> batch_size (int): Required. Maximum number of catalogitems per</span>
<span class="sd"> request.</span>
<span class="sd"> project (str): Optional. GCP project name in which the catalog</span>
<span class="sd"> data will be imported.</span>
<span class="sd"> retry: Optional. Designation of what</span>
<span class="sd"> errors, if any, should be retried.</span>
<span class="sd"> timeout (float): Optional. The amount of time, in seconds, to wait</span>
<span class="sd"> for the request to complete.</span>
<span class="sd"> metadata: Optional. Strings which</span>
<span class="sd"> should be sent along with the request as metadata.</span>
<span class="sd"> catalog_name (str): Optional. Name of the catalog.</span>
<span class="sd"> Default: &#39;default_catalog&#39;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span> <span class="o">=</span> <span class="n">max_batch_size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span> <span class="o">=</span> <span class="n">catalog_name</span>
<div class="viewcode-block" id="ImportCatalogItems.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems.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">pcoll</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;GCP project name needs to be specified in &quot;project&quot; pipeline option&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">pcoll</span> <span class="o">|</span> <span class="n">GroupIntoBatches</span><span class="o">.</span><span class="n">WithShardedKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span><span class="p">)</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
<span class="n">_ImportCatalogItemsFn</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span><span class="p">)))</span></div></div>
<span class="k">class</span> <span class="nc">_ImportCatalogItemsFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</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">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">retry</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">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">catalog_name</span><span class="o">=</span><span class="kc">None</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">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;projects/</span><span class="si">{</span><span class="n">project</span><span class="si">}</span><span class="s2">/locations/global/catalogs/</span><span class="si">{</span><span class="n">catalog_name</span><span class="si">}</span><span class="s2">&quot;</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">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</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_recommendation_catalog_client</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="n">catalog_items</span> <span class="o">=</span> <span class="p">[</span><span class="n">recommendationengine</span><span class="o">.</span><span class="n">CatalogItem</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">element</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
<span class="n">catalog_inline_source</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">CatalogInlineSource</span><span class="p">(</span>
<span class="p">{</span><span class="s2">&quot;catalog_items&quot;</span><span class="p">:</span> <span class="n">catalog_items</span><span class="p">})</span>
<span class="n">input_config</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">InputConfig</span><span class="p">(</span>
<span class="n">catalog_inline_source</span><span class="o">=</span><span class="n">catalog_inline_source</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">ImportCatalogItemsRequest</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">input_config</span><span class="o">=</span><span class="n">input_config</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</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">import_catalog_items</span><span class="p">(</span>
<span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span>
<span class="n">retry</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">retry</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">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="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="nb">len</span><span class="p">(</span><span class="n">catalog_items</span><span class="p">))</span>
<span class="k">yield</span> <span class="n">operation</span><span class="o">.</span><span class="n">result</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">TaggedOutput</span><span class="p">(</span><span class="n">FAILED_CATALOG_ITEMS</span><span class="p">,</span> <span class="n">catalog_items</span><span class="p">)</span>
<div class="viewcode-block" id="WriteUserEvent"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent">[docs]</a><span class="k">class</span> <span class="nc">WriteUserEvent</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Write user event information.</span>
<span class="sd"> The `PTransform` returns a PCollectionTuple with PCollections of</span>
<span class="sd"> successfully and failed written UserEvents.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> pipeline</span>
<span class="sd"> | WriteUserEvent(</span>
<span class="sd"> project=&#39;example-gcp-project&#39;,</span>
<span class="sd"> catalog_name=&#39;my-catalog&#39;,</span>
<span class="sd"> event_store=&#39;my_event_store&#39;)</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">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_catalog&quot;</span><span class="p">,</span>
<span class="n">event_store</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_event_store&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Initializes a :class:`WriteUserEvent` transform.</span>
<span class="sd"> Args:</span>
<span class="sd"> project (str): Optional. GCP project name in which the catalog</span>
<span class="sd"> data will be imported.</span>
<span class="sd"> retry: Optional. Designation of what</span>
<span class="sd"> errors, if any, should be retried.</span>
<span class="sd"> timeout (float): Optional. The amount of time, in seconds, to wait</span>
<span class="sd"> for the request to complete.</span>
<span class="sd"> metadata: Optional. Strings which</span>
<span class="sd"> should be sent along with the request as metadata.</span>
<span class="sd"> catalog_name (str): Optional. Name of the catalog.</span>
<span class="sd"> Default: &#39;default_catalog&#39;</span>
<span class="sd"> event_store (str): Optional. Name of the event store.</span>
<span class="sd"> Default: &#39;default_event_store&#39;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span> <span class="o">=</span> <span class="n">catalog_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span> <span class="o">=</span> <span class="n">event_store</span>
<div class="viewcode-block" id="WriteUserEvent.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent.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">pcoll</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;GCP project name needs to be specified in &quot;project&quot; pipeline option&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">pcoll</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
<span class="n">_WriteUserEventFn</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span><span class="p">))</span></div></div>
<span class="k">class</span> <span class="nc">_WriteUserEventFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
<span class="n">FAILED_USER_EVENTS</span> <span class="o">=</span> <span class="s2">&quot;failed_user_events&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">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">retry</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">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">catalog_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">event_store</span><span class="o">=</span><span class="kc">None</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">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;projects/</span><span class="si">{</span><span class="n">project</span><span class="si">}</span><span class="s2">/locations/global/catalogs/&quot;</span>\
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">catalog_name</span><span class="si">}</span><span class="s2">/eventStores/</span><span class="si">{</span><span class="n">event_store</span><span class="si">}</span><span class="s2">&quot;</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">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</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_recommendation_user_event_client</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="n">user_event</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEvent</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">WriteUserEventRequest</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">user_event</span><span class="o">=</span><span class="n">user_event</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">created_user_event</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">write_user_event</span><span class="p">(</span><span class="n">request</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">recommendationengine</span><span class="o">.</span><span class="n">UserEvent</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">created_user_event</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">TaggedOutput</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">FAILED_USER_EVENTS</span><span class="p">,</span>
<span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEvent</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">user_event</span><span class="p">))</span>
<div class="viewcode-block" id="ImportUserEvents"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.ImportUserEvents">[docs]</a><span class="k">class</span> <span class="nc">ImportUserEvents</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Imports userevents in bulk.</span>
<span class="sd"> The `PTransform` returns a PCollectionTuple with PCollections of</span>
<span class="sd"> successfully and failed imported UserEvents.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> pipeline</span>
<span class="sd"> | ImportUserEvents(</span>
<span class="sd"> project=&#39;example-gcp-project&#39;,</span>
<span class="sd"> catalog_name=&#39;my-catalog&#39;,</span>
<span class="sd"> event_store=&#39;my_event_store&#39;)</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">max_batch_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5000</span><span class="p">,</span>
<span class="n">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_catalog&quot;</span><span class="p">,</span>
<span class="n">event_store</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_event_store&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Initializes a :class:`WriteUserEvent` transform.</span>
<span class="sd"> Args:</span>
<span class="sd"> batch_size (int): Required. Maximum number of catalogitems</span>
<span class="sd"> per request.</span>
<span class="sd"> project (str): Optional. GCP project name in which the catalog</span>
<span class="sd"> data will be imported.</span>
<span class="sd"> retry: Optional. Designation of what</span>
<span class="sd"> errors, if any, should be retried.</span>
<span class="sd"> timeout (float): Optional. The amount of time, in seconds, to wait</span>
<span class="sd"> for the request to complete.</span>
<span class="sd"> metadata: Optional. Strings which</span>
<span class="sd"> should be sent along with the request as metadata.</span>
<span class="sd"> catalog_name (str): Optional. Name of the catalog.</span>
<span class="sd"> Default: &#39;default_catalog&#39;</span>
<span class="sd"> event_store (str): Optional. Name of the event store.</span>
<span class="sd"> Default: &#39;default_event_store&#39;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span> <span class="o">=</span> <span class="n">max_batch_size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span> <span class="o">=</span> <span class="n">catalog_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span> <span class="o">=</span> <span class="n">event_store</span>
<div class="viewcode-block" id="ImportUserEvents.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.ImportUserEvents.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">pcoll</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;GCP project name needs to be specified in &quot;project&quot; pipeline option&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">pcoll</span> <span class="o">|</span> <span class="n">GroupIntoBatches</span><span class="o">.</span><span class="n">WithShardedKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_batch_size</span><span class="p">)</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
<span class="n">_ImportUserEventsFn</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span><span class="p">)))</span></div></div>
<span class="k">class</span> <span class="nc">_ImportUserEventsFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
<span class="n">FAILED_USER_EVENTS</span> <span class="o">=</span> <span class="s2">&quot;failed_user_events&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">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">retry</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">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">catalog_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">event_store</span><span class="o">=</span><span class="kc">None</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">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;projects/</span><span class="si">{</span><span class="n">project</span><span class="si">}</span><span class="s2">/locations/global/catalogs/&quot;</span>\
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">catalog_name</span><span class="si">}</span><span class="s2">/eventStores/</span><span class="si">{</span><span class="n">event_store</span><span class="si">}</span><span class="s2">&quot;</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">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</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_recommendation_user_event_client</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="n">user_events</span> <span class="o">=</span> <span class="p">[</span><span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEvent</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">element</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
<span class="n">user_event_inline_source</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEventInlineSource</span><span class="p">(</span>
<span class="p">{</span><span class="s2">&quot;user_events&quot;</span><span class="p">:</span> <span class="n">user_events</span><span class="p">})</span>
<span class="n">input_config</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">InputConfig</span><span class="p">(</span>
<span class="n">user_event_inline_source</span><span class="o">=</span><span class="n">user_event_inline_source</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">ImportUserEventsRequest</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">input_config</span><span class="o">=</span><span class="n">input_config</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</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">write_user_event</span><span class="p">(</span><span class="n">request</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="nb">len</span><span class="p">(</span><span class="n">user_events</span><span class="p">))</span>
<span class="k">yield</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">PredictResponse</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">operation</span><span class="o">.</span><span class="n">result</span><span class="p">())</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">TaggedOutput</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">FAILED_USER_EVENTS</span><span class="p">,</span> <span class="n">user_events</span><span class="p">)</span>
<div class="viewcode-block" id="PredictUserEvent"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.PredictUserEvent">[docs]</a><span class="k">class</span> <span class="nc">PredictUserEvent</span><span class="p">(</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Make a recommendation prediction.</span>
<span class="sd"> The `PTransform` returns a PCollection</span>
<span class="sd"> Example usage::</span>
<span class="sd"> pipeline</span>
<span class="sd"> | PredictUserEvent(</span>
<span class="sd"> project=&#39;example-gcp-project&#39;,</span>
<span class="sd"> catalog_name=&#39;my-catalog&#39;,</span>
<span class="sd"> event_store=&#39;my_event_store&#39;,</span>
<span class="sd"> placement_id=&#39;recently_viewed_default&#39;)</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">project</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">retry</span><span class="p">:</span> <span class="n">Retry</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">120</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="n">catalog_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_catalog&quot;</span><span class="p">,</span>
<span class="n">event_store</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default_event_store&quot;</span><span class="p">,</span>
<span class="n">placement_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Initializes a :class:`PredictUserEvent` transform.</span>
<span class="sd"> Args:</span>
<span class="sd"> project (str): Optional. GCP project name in which the catalog</span>
<span class="sd"> data will be imported.</span>
<span class="sd"> retry: Optional. Designation of what</span>
<span class="sd"> errors, if any, should be retried.</span>
<span class="sd"> timeout (float): Optional. The amount of time, in seconds, to wait</span>
<span class="sd"> for the request to complete.</span>
<span class="sd"> metadata: Optional. Strings which</span>
<span class="sd"> should be sent along with the request as metadata.</span>
<span class="sd"> catalog_name (str): Optional. Name of the catalog.</span>
<span class="sd"> Default: &#39;default_catalog&#39;</span>
<span class="sd"> event_store (str): Optional. Name of the event store.</span>
<span class="sd"> Default: &#39;default_event_store&#39;</span>
<span class="sd"> placement_id (str): Required. ID of the recommendation engine</span>
<span class="sd"> placement. This id is used to identify the set of models that</span>
<span class="sd"> will be used to make the prediction.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">project</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">placement_id</span> <span class="o">=</span> <span class="n">placement_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span> <span class="o">=</span> <span class="n">catalog_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span> <span class="o">=</span> <span class="n">event_store</span>
<span class="k">if</span> <span class="n">placement_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;placement_id must be specified&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">placement_id</span> <span class="o">=</span> <span class="n">placement_id</span>
<div class="viewcode-block" id="PredictUserEvent.expand"><a class="viewcode-back" href="../../../../apache_beam.ml.gcp.recommendations_ai.html#apache_beam.ml.gcp.recommendations_ai.PredictUserEvent.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">pcoll</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="o">=</span> <span class="n">pcoll</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;GCP project name needs to be specified in &quot;project&quot; pipeline option&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">pcoll</span> <span class="o">|</span> <span class="n">ParDo</span><span class="p">(</span>
<span class="n">_PredictUserEventFn</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">retry</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">catalog_name</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_store</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">placement_id</span><span class="p">))</span></div></div>
<span class="k">class</span> <span class="nc">_PredictUserEventFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
<span class="n">FAILED_PREDICTIONS</span> <span class="o">=</span> <span class="s2">&quot;failed_predictions&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">project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">retry</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">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">catalog_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">event_store</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">placement_id</span><span class="o">=</span><span class="kc">None</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">retry</span> <span class="o">=</span> <span class="n">retry</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">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;projects/</span><span class="si">{</span><span class="n">project</span><span class="si">}</span><span class="s2">/locations/global/catalogs/&quot;</span>\
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">catalog_name</span><span class="si">}</span><span class="s2">/eventStores/</span><span class="si">{</span><span class="n">event_store</span><span class="si">}</span><span class="s2">/placements/&quot;</span>\
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">placement_id</span><span class="si">}</span><span class="s2">&quot;</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">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</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_recommendation_prediction_client</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="n">user_event</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">UserEvent</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">recommendationengine</span><span class="o">.</span><span class="n">PredictRequest</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">user_event</span><span class="o">=</span><span class="n">user_event</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">prediction</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">predict</span><span class="p">(</span><span class="n">request</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="p">[</span>
<span class="n">recommendationengine</span><span class="o">.</span><span class="n">PredictResponse</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">prediction</span><span class="o">.</span><span class="n">pages</span>
<span class="p">]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">TaggedOutput</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">FAILED_PREDICTIONS</span><span class="p">,</span> <span class="n">user_event</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>