blob: 46ca76a116e2bc7cc1545bc3e4b386086a2d3681 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>SequenceClassificationModel (Apache OpenNLP Tools 2.3.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: opennlp.tools.ml.model, interface: SequenceClassificationModel">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">opennlp.tools.ml.model</a></div>
<h1 title="Interface SequenceClassificationModel" class="title">Interface SequenceClassificationModel&lt;T&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - The type of the object which is the source.</dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../BeamSearch.html" title="class in opennlp.tools.ml">BeamSearch</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SequenceClassificationModel&lt;T&gt;</span></div>
<div class="block">A classification model that can label an input <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#bestSequence(T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequence</a><wbr>(<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Finds the <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> with the highest probability.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequences</a><wbr>(int&nbsp;numSequences,
<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
double&nbsp;minSequenceScore,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Finds the n most probable <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequences</a><wbr>(int&nbsp;numSequences,
<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Finds the n most probable <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOutcomes()" class="member-name-link">getOutcomes</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="bestSequence(T[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
<h3 id="bestSequence(java.lang.Object[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequence</h3>
<div class="member-signature"><span class="return-type"><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a></span>&nbsp;<span class="element-name">bestSequence</span><wbr><span class="parameters">(<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</span></div>
<div class="block">Finds the <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> with the highest probability.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>sequence</code> - The <a href="SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model"><code>sequence</code></a> used as input.</dd>
<dd><code>additionalContext</code> - An array that provides additional information (context).</dd>
<dd><code>cg</code> - The <a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>BeamSearchContextGenerator</code></a> to use.</dd>
<dd><code>validator</code> - The <a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate with.</dd>
<dt>Returns:</dt>
<dd>The <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> with the highest probability.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="bestSequences(int,T[],java.lang.Object[],double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
<h3 id="bestSequences(int,java.lang.Object[],java.lang.Object[],double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</h3>
<div class="member-signature"><span class="return-type"><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</span>&nbsp;<span class="element-name">bestSequences</span><wbr><span class="parameters">(int&nbsp;numSequences,
<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
double&nbsp;minSequenceScore,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</span></div>
<div class="block">Finds the n most probable <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numSequences</code> - The number of sequences to compute.</dd>
<dd><code>sequence</code> - The <a href="SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model"><code>sequence</code></a> used as input.</dd>
<dd><code>additionalContext</code> - An array that provides additional information (context).</dd>
<dd><code>minSequenceScore</code> - The minimum score to achieve.</dd>
<dd><code>cg</code> - The <a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>BeamSearchContextGenerator</code></a> to use.</dd>
<dd><code>validator</code> - The <a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate with.</dd>
<dt>Returns:</dt>
<dd>The <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="bestSequences(int,T[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
<h3 id="bestSequences(int,java.lang.Object[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</h3>
<div class="member-signature"><span class="return-type"><a href="../../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</span>&nbsp;<span class="element-name">bestSequences</span><wbr><span class="parameters">(int&nbsp;numSequences,
<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>[]&nbsp;sequence,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;additionalContext,
<a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;cg,
<a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="SequenceClassificationModel.html" title="type parameter in SequenceClassificationModel">T</a>&gt;&nbsp;validator)</span></div>
<div class="block">Finds the n most probable <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numSequences</code> - The number of sequences to compute.</dd>
<dd><code>sequence</code> - The <a href="SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model"><code>sequence</code></a> used as input.</dd>
<dd><code>additionalContext</code> - An array that provides additional information (context).</dd>
<dd><code>cg</code> - The <a href="../../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>BeamSearchContextGenerator</code></a> to use.</dd>
<dd><code>validator</code> - The <a href="../../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate with.</dd>
<dt>Returns:</dt>
<dd>The <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>sequences</code></a> with the highest probability.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOutcomes()">
<h3>getOutcomes</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">getOutcomes</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Retrieves all possible outcomes.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>