blob: b789750320e00508532f534130d091655d83352a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.beam.sdk.extensions.ml (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.beam.sdk.extensions.ml (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/ml/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.extensions.ml</h1>
<div class="docSummary">
<div class="block">Provides DoFns for integration with Google Cloud AI Video Intelligence service.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/AnnotateText.html" title="class in org.apache.beam.sdk.extensions.ml">AnnotateText</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> using the Cloud AI Natural language processing capability.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/AnnotateText.Builder.html" title="class in org.apache.beam.sdk.extensions.ml">AnnotateText.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/CloudVision.html" title="class in org.apache.beam.sdk.extensions.ml">CloudVision</a></td>
<td class="colLast">
<div class="block">Factory class for implementations of <code>AnnotateImages</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/CloudVision.AnnotateImagesFromBytes.html" title="class in org.apache.beam.sdk.extensions.ml">CloudVision.AnnotateImagesFromBytes</a></td>
<td class="colLast">
<div class="block">Accepts <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf"><code>ByteString</code></a> (encoded image contents) with optional <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.SideInput.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.SideInput</code></a> with a <code>Map</code> of <code>ImageContext</code> to
the image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/CloudVision.AnnotateImagesFromBytesWithContext.html" title="class in org.apache.beam.sdk.extensions.ml">CloudVision.AnnotateImagesFromBytesWithContext</a></td>
<td class="colLast">
<div class="block">Accepts <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s of <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf"><code>ByteString</code></a> (encoded image contents) and <code>ImageContext</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/CloudVision.AnnotateImagesFromGcsUri.html" title="class in org.apache.beam.sdk.extensions.ml">CloudVision.AnnotateImagesFromGcsUri</a></td>
<td class="colLast">
<div class="block">Accepts <code>String</code> (image URI on GCS) with optional <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.SideInput.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.SideInput</code></a> with a <code>Map</code> of <code>ImageContext</code> to
the image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/CloudVision.AnnotateImagesFromGcsUriWithContext.html" title="class in org.apache.beam.sdk.extensions.ml">CloudVision.AnnotateImagesFromGcsUriWithContext</a></td>
<td class="colLast">
<div class="block">Accepts <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>s of <code>String</code> (GCS URI to the image) and <code>ImageContext</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPDeidentifyText.html" title="class in org.apache.beam.sdk.extensions.ml">DLPDeidentifyText</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> connecting to Cloud DLP (https://cloud.google.com/dlp/docs/libraries) and
deidentifying text according to provided settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPDeidentifyText.Builder.html" title="class in org.apache.beam.sdk.extensions.ml">DLPDeidentifyText.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPInspectText.html" title="class in org.apache.beam.sdk.extensions.ml">DLPInspectText</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> connecting to Cloud DLP (https://cloud.google.com/dlp/docs/libraries) and
inspecting text for identifying data according to provided settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPInspectText.Builder.html" title="class in org.apache.beam.sdk.extensions.ml">DLPInspectText.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPReidentifyText.html" title="class in org.apache.beam.sdk.extensions.ml">DLPReidentifyText</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> connecting to Cloud DLP (https://cloud.google.com/dlp/docs/libraries) and
inspecting text for identifying data according to provided settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/DLPReidentifyText.Builder.html" title="class in org.apache.beam.sdk.extensions.ml">DLPReidentifyText.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAICreateCatalogItem.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAICreateCatalogItem</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> using the Recommendations AI API (https://cloud.google.com/recommendations).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAIImportCatalogItems.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAIImportCatalogItems</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> connecting to the Recommendations AI API
(https://cloud.google.com/recommendations) and creating <code>CatalogItem</code>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAIImportUserEvents.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAIImportUserEvents</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> connecting to the Recommendations AI API
(https://cloud.google.com/recommendations) and creating <code>UserEvent</code>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAIIO.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAIIO</a></td>
<td class="colLast">
<div class="block">The RecommendationAIIO class acts as a wrapper around the <code>PTransform</code>s that interact with
the Recommendation AI API (https://cloud.google.com/recommendations).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAIPredict.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAIPredict</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> using the Recommendations AI API (https://cloud.google.com/recommendations).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/RecommendationAIWriteUserEvent.html" title="class in org.apache.beam.sdk.extensions.ml">RecommendationAIWriteUserEvent</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> using the Recommendations AI API (https://cloud.google.com/recommendations).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/VideoIntelligence.html" title="class in org.apache.beam.sdk.extensions.ml">VideoIntelligence</a></td>
<td class="colLast">
<div class="block">Factory class for PTransforms integrating with Google Cloud AI - VideoIntelligence service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/VideoIntelligence.AnnotateVideoFromBytes.html" title="class in org.apache.beam.sdk.extensions.ml">VideoIntelligence.AnnotateVideoFromBytes</a></td>
<td class="colLast">
<div class="block">A PTransform taking a PCollection of <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf"><code>ByteString</code></a> and an optional side input with a
context map and emitting lists of <code>VideoAnnotationResults</code> for each element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/VideoIntelligence.AnnotateVideoFromBytesWithContext.html" title="class in org.apache.beam.sdk.extensions.ml">VideoIntelligence.AnnotateVideoFromBytesWithContext</a></td>
<td class="colLast">
<div class="block">A PTransform taking a PCollection of <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> of <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf"><code>ByteString</code></a> and <code>VideoContext</code>
and emitting lists of <code>VideoAnnotationResults</code> for each element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/VideoIntelligence.AnnotateVideoFromUri.html" title="class in org.apache.beam.sdk.extensions.ml">VideoIntelligence.AnnotateVideoFromUri</a></td>
<td class="colLast">
<div class="block">A PTransform taking a PCollection of <code>String</code> and an optional side input with a context
map and emitting lists of <code>VideoAnnotationResults</code> for each element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/ml/VideoIntelligence.AnnotateVideoFromURIWithContext.html" title="class in org.apache.beam.sdk.extensions.ml">VideoIntelligence.AnnotateVideoFromURIWithContext</a></td>
<td class="colLast">
<div class="block">A PTransform taking a PCollection of <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> of <code>String</code> and <code>VideoContext</code> and
emitting lists of <code>VideoAnnotationResults</code> for each element.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.extensions.ml Description">Package org.apache.beam.sdk.extensions.ml Description</h2>
<div class="block">Provides DoFns for integration with Google Cloud AI Video Intelligence service.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/ml/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>