| |
| |
| <!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 module — 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" /> |
| <link rel="next" title="apache_beam.ml.gcp.videointelligenceml module" href="apache_beam.ml.gcp.videointelligenceml.html" /> |
| <link rel="prev" title="apache_beam.ml.gcp.naturallanguageml module" href="apache_beam.ml.gcp.naturallanguageml.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 class="current"> |
| <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 current"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.ml.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.ml.gcp.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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> »</li> |
| |
| <li><a href="apache_beam.ml.html">apache_beam.ml package</a> »</li> |
| |
| <li><a href="apache_beam.ml.gcp.html">apache_beam.ml.gcp package</a> »</li> |
| |
| <li>apache_beam.ml.gcp.recommendations_ai module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.ml.gcp.recommendations_ai.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-apache_beam.ml.gcp.recommendations_ai"> |
| <span id="apache-beam-ml-gcp-recommendations-ai-module"></span><h1>apache_beam.ml.gcp.recommendations_ai module<a class="headerlink" href="#module-apache_beam.ml.gcp.recommendations_ai" title="Permalink to this headline">¶</a></h1> |
| <p>A connector for sending API requests to the GCP Recommendations AI |
| API (<a class="reference external" href="https://cloud.google.com/recommendations">https://cloud.google.com/recommendations</a>).</p> |
| <dl class="class"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.recommendations_ai.</code><code class="descname">CreateCatalogItem</code><span class="sig-paren">(</span><em>project: str = None</em>, <em>retry: google.api_core.retry.Retry = None</em>, <em>timeout: float = 120</em>, <em>metadata: Sequence[Tuple[str</em>, <em>str]] = ()</em>, <em>catalog_name: str = 'default_catalog'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#CreateCatalogItem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>Creates catalogitem information. |
| The <code class="docutils literal notranslate"><span class="pre">PTranform</span></code> returns a PCollectionTuple with a PCollections of |
| successfully and failed created CatalogItems.</p> |
| <p>Example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> <span class="o">|</span> <span class="n">CreateCatalogItem</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span> |
| <span class="n">catalog_name</span><span class="o">=</span><span class="s1">'my-catalog'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem" title="apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">CreateCatalogItem</span></code></a> transform.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>project</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. GCP project name in which the catalog |
| data will be imported.</li> |
| <li><strong>retry</strong> – Optional. Designation of what |
| errors, if any, should be retried.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait |
| for the request to complete.</li> |
| <li><strong>metadata</strong> – Optional. Strings which |
| should be sent along with the request as metadata.</li> |
| <li><strong>catalog_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the catalog. |
| Default: ‘default_catalog’</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#CreateCatalogItem.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.CreateCatalogItem.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.recommendations_ai.</code><code class="descname">ImportCatalogItems</code><span class="sig-paren">(</span><em>max_batch_size: int = 5000</em>, <em>project: str = None</em>, <em>retry: google.api_core.retry.Retry = None</em>, <em>timeout: float = 120</em>, <em>metadata: Sequence[Tuple[str</em>, <em>str]] = ()</em>, <em>catalog_name: str = 'default_catalog'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#ImportCatalogItems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>Imports catalogitems in bulk. |
| The <cite>PTransform</cite> returns a PCollectionTuple with PCollections of |
| successfully and failed imported CatalogItems.</p> |
| <p>Example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> |
| <span class="o">|</span> <span class="n">ImportCatalogItems</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span> |
| <span class="n">catalog_name</span><span class="o">=</span><span class="s1">'my-catalog'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems" title="apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportCatalogItems</span></code></a> transform</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>batch_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a>) – Required. Maximum number of catalogitems per |
| request.</li> |
| <li><strong>project</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. GCP project name in which the catalog |
| data will be imported.</li> |
| <li><strong>retry</strong> – Optional. Designation of what |
| errors, if any, should be retried.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait |
| for the request to complete.</li> |
| <li><strong>metadata</strong> – Optional. Strings which |
| should be sent along with the request as metadata.</li> |
| <li><strong>catalog_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the catalog. |
| Default: ‘default_catalog’</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#ImportCatalogItems.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.ImportCatalogItems.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.WriteUserEvent"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.recommendations_ai.</code><code class="descname">WriteUserEvent</code><span class="sig-paren">(</span><em>project: str = None</em>, <em>retry: google.api_core.retry.Retry = None</em>, <em>timeout: float = 120</em>, <em>metadata: Sequence[Tuple[str</em>, <em>str]] = ()</em>, <em>catalog_name: str = 'default_catalog'</em>, <em>event_store: str = 'default_event_store'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#WriteUserEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>Write user event information. |
| The <cite>PTransform</cite> returns a PCollectionTuple with PCollections of |
| successfully and failed written UserEvents.</p> |
| <p>Example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> |
| <span class="o">|</span> <span class="n">WriteUserEvent</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span> |
| <span class="n">catalog_name</span><span class="o">=</span><span class="s1">'my-catalog'</span><span class="p">,</span> |
| <span class="n">event_store</span><span class="o">=</span><span class="s1">'my_event_store'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent" title="apache_beam.ml.gcp.recommendations_ai.WriteUserEvent"><code class="xref py py-class docutils literal notranslate"><span class="pre">WriteUserEvent</span></code></a> transform.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>project</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. GCP project name in which the catalog |
| data will be imported.</li> |
| <li><strong>retry</strong> – Optional. Designation of what |
| errors, if any, should be retried.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait |
| for the request to complete.</li> |
| <li><strong>metadata</strong> – Optional. Strings which |
| should be sent along with the request as metadata.</li> |
| <li><strong>catalog_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the catalog. |
| Default: ‘default_catalog’</li> |
| <li><strong>event_store</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the event store. |
| Default: ‘default_event_store’</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.WriteUserEvent.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#WriteUserEvent.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.ImportUserEvents"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.recommendations_ai.</code><code class="descname">ImportUserEvents</code><span class="sig-paren">(</span><em>max_batch_size: int = 5000</em>, <em>project: str = None</em>, <em>retry: google.api_core.retry.Retry = None</em>, <em>timeout: float = 120</em>, <em>metadata: Sequence[Tuple[str</em>, <em>str]] = ()</em>, <em>catalog_name: str = 'default_catalog'</em>, <em>event_store: str = 'default_event_store'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#ImportUserEvents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.ImportUserEvents" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>Imports userevents in bulk. |
| The <cite>PTransform</cite> returns a PCollectionTuple with PCollections of |
| successfully and failed imported UserEvents.</p> |
| <p>Example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> |
| <span class="o">|</span> <span class="n">ImportUserEvents</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span> |
| <span class="n">catalog_name</span><span class="o">=</span><span class="s1">'my-catalog'</span><span class="p">,</span> |
| <span class="n">event_store</span><span class="o">=</span><span class="s1">'my_event_store'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.recommendations_ai.WriteUserEvent" title="apache_beam.ml.gcp.recommendations_ai.WriteUserEvent"><code class="xref py py-class docutils literal notranslate"><span class="pre">WriteUserEvent</span></code></a> transform.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>batch_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a>) – Required. Maximum number of catalogitems |
| per request.</li> |
| <li><strong>project</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. GCP project name in which the catalog |
| data will be imported.</li> |
| <li><strong>retry</strong> – Optional. Designation of what |
| errors, if any, should be retried.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait |
| for the request to complete.</li> |
| <li><strong>metadata</strong> – Optional. Strings which |
| should be sent along with the request as metadata.</li> |
| <li><strong>catalog_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the catalog. |
| Default: ‘default_catalog’</li> |
| <li><strong>event_store</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the event store. |
| Default: ‘default_event_store’</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.ImportUserEvents.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#ImportUserEvents.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.ImportUserEvents.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.PredictUserEvent"> |
| <em class="property">class </em><code class="descclassname">apache_beam.ml.gcp.recommendations_ai.</code><code class="descname">PredictUserEvent</code><span class="sig-paren">(</span><em>project: str = None</em>, <em>retry: google.api_core.retry.Retry = None</em>, <em>timeout: float = 120</em>, <em>metadata: Sequence[Tuple[str</em>, <em>str]] = ()</em>, <em>catalog_name: str = 'default_catalog'</em>, <em>event_store: str = 'default_event_store'</em>, <em>placement_id: str = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#PredictUserEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.PredictUserEvent" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>Make a recommendation prediction. |
| The <cite>PTransform</cite> returns a PCollection</p> |
| <p>Example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pipeline</span> |
| <span class="o">|</span> <span class="n">PredictUserEvent</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'example-gcp-project'</span><span class="p">,</span> |
| <span class="n">catalog_name</span><span class="o">=</span><span class="s1">'my-catalog'</span><span class="p">,</span> |
| <span class="n">event_store</span><span class="o">=</span><span class="s1">'my_event_store'</span><span class="p">,</span> |
| <span class="n">placement_id</span><span class="o">=</span><span class="s1">'recently_viewed_default'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Initializes a <a class="reference internal" href="#apache_beam.ml.gcp.recommendations_ai.PredictUserEvent" title="apache_beam.ml.gcp.recommendations_ai.PredictUserEvent"><code class="xref py py-class docutils literal notranslate"><span class="pre">PredictUserEvent</span></code></a> transform.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>project</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. GCP project name in which the catalog |
| data will be imported.</li> |
| <li><strong>retry</strong> – Optional. Designation of what |
| errors, if any, should be retried.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – Optional. The amount of time, in seconds, to wait |
| for the request to complete.</li> |
| <li><strong>metadata</strong> – Optional. Strings which |
| should be sent along with the request as metadata.</li> |
| <li><strong>catalog_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the catalog. |
| Default: ‘default_catalog’</li> |
| <li><strong>event_store</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Optional. Name of the event store. |
| Default: ‘default_event_store’</li> |
| <li><strong>placement_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Required. ID of the recommendation engine |
| placement. This id is used to identify the set of models that |
| will be used to make the prediction.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.ml.gcp.recommendations_ai.PredictUserEvent.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/ml/gcp/recommendations_ai.html#PredictUserEvent.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.ml.gcp.recommendations_ai.PredictUserEvent.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.ml.gcp.videointelligenceml.html" class="btn btn-neutral float-right" title="apache_beam.ml.gcp.videointelligenceml module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.ml.gcp.naturallanguageml.html" class="btn btn-neutral float-left" title="apache_beam.ml.gcp.naturallanguageml module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |