blob: e1def944eab99d2e61f2149e643af382776ebed0 [file] [log] [blame]
<html><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><title>NCModelConfig</title><link rel="shortcut icon" type="image/x-icon" href="../../../favicon.ico"></link><script type="text/javascript" src="../../../scripts/theme.js"></script><script type="text/javascript" src="../../../scripts/searchData.js" defer="true"></script><script type="text/javascript" src="../../../scripts/scastieConfiguration.js" defer="true"></script><link rel="stylesheet" href="../../../styles/nord-light.css"></link><link rel="stylesheet" href="../../../styles/scalastyle.css"></link><link rel="stylesheet" href="../../../styles/colors.css"></link><link rel="stylesheet" href="../../../styles/dotty-icons.css"></link><link rel="stylesheet" href="../../../styles/diagram.css"></link><link rel="stylesheet" href="../../../styles/filter-bar.css"></link><link rel="stylesheet" href="../../../styles/code-snippets.css"></link><link rel="stylesheet" href="../../../styles/searchbar.css"></link><link rel="stylesheet" href="../../../styles/social-links.css"></link><link rel="stylesheet" href="../../../styles/ux.css"></link><link rel="stylesheet" href="../../../styles/versions-dropdown.css"></link><link rel="stylesheet" href="../../../styles/fontawesome.css"></link><script type="text/javascript" src="../../../hljs/highlight.min.js" defer="true"></script><script type="text/javascript" src="../../../scripts/hljs-scala3.js" defer="true"></script><script type="text/javascript" src="../../../scripts/ux.js" defer="true"></script><script type="text/javascript" src="../../../scripts/common/component.js" defer="true"></script><script type="text/javascript" src="../../../scripts/common/utils.js" defer="true"></script><script type="text/javascript" src="../../../scripts/components/FilterBar.js" defer="true"></script><script type="text/javascript" src="../../../scripts/components/DocumentableList.js" defer="true"></script><script type="text/javascript" src="../../../scripts/components/Input.js" defer="true"></script><script type="text/javascript" src="../../../scripts/components/FilterGroup.js" defer="true"></script><script type="text/javascript" src="../../../scripts/components/Filter.js" defer="true"></script><script type="text/javascript" src="../../../scripts/scaladoc-scalajs.js" defer="true"></script><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script><script type="text/javascript" src="https://d3js.org/d3.v6.min.js" defer="true"></script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/graphlib-dot@0.6.2/dist/graphlib-dot.min.js" defer="true"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js" defer="true"></script><script type="text/javascript" src="https://scastie.scala-lang.org/embedded.js" defer="true"></script><script type="text/javascript" src="../../../scripts/data.js" defer="true"></script><script>var pathToRoot = "../../../";</script></head><body><div id="container"><div id="leftColumn"><div id="logo"><span><div class="projectName">NLPCraft</div></span><div id="version"><div class="versions-dropdown"><div onclick="dropdownHandler()" id="dropdown-button" class="dropdownbtn dropdownbtnactive"><div class="projectVersion">1.0.0</div><div id="dropdown-content" class="dropdown-content"><input type="text" placeholder="Search..." id="dropdown-input" onkeyup="filterFunction()"></input></div></div></div></div><div class="socials"><a href="https://github.com/apache/incubator-nlpcraft"><span class="social-icon" data-icon-path="github-icon-white.png"></span></a></div></div><div id="paneSearch"></div><nav id="sideMenu2"><div class="ni expanded"><span class="nh expanded"><span class="ar"></span><a href="../../../index.html"><span>NLPCraft</span></a></span><div class="ni expanded"><span class="nh expanded"><span class="ar"></span><a href="../nlpcraft.html"><span class="micon pa"></span><span>org.apache.nlpcraft</span></a></span><div class="ni "><span class="nh "><a href="NCContext.html"><span class="micon tr"></span><span>NCContext</span></a></span></div><div class="ni "><span class="nh "><a href="NCConversation.html"><span class="micon tr"></span><span>NCConversation</span></a></span></div><div class="ni "><span class="nh "><a href="NCCuration.html"><span class="micon cl"></span><span>NCCuration</span></a></span></div><div class="ni "><span class="nh "><a href="NCDialogFlowItem.html"><span class="micon tr"></span><span>NCDialogFlowItem</span></a></span></div><div class="ni "><span class="nh "><a href="NCEntity.html"><span class="micon tr"></span><span>NCEntity</span></a></span></div><div class="ni "><span class="nh "><a href="NCEntityEnricher.html"><span class="micon tr"></span><span>NCEntityEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="NCEntityMapper.html"><span class="micon tr"></span><span>NCEntityMapper</span></a></span></div><div class="ni "><span class="nh "><a href="NCEntityParser.html"><span class="micon tr"></span><span>NCEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="NCEntityValidator.html"><span class="micon tr"></span><span>NCEntityValidator</span></a></span></div><div class="ni "><span class="nh "><a href="NCException.html"><span class="micon cl"></span><span>NCException</span></a></span></div><div class="ni "><span class="nh "><a href="NCIntentMatch.html"><span class="micon tr"></span><span>NCIntentMatch</span></a></span></div><div class="ni "><span class="nh "><a href="NCIntentSkip.html"><span class="micon cl"></span><span>NCIntentSkip</span></a></span></div><div class="ni "><span class="nh "><a href="NCLifecycle.html"><span class="micon tr"></span><span>NCLifecycle</span></a></span></div><div class="ni "><span class="nh "><a href="NCMatchedCallback.html"><span class="micon tr"></span><span>NCMatchedCallback</span></a></span></div><div class="ni "><span class="nh "><a href="NCModel.html"><span class="micon tr"></span><span>NCModel</span></a></span></div><div class="ni "><span class="nh "><a href="NCModelClient.html"><span class="micon cl"></span><span>NCModelClient</span></a></span></div><div class="ni "><span class="nh "><a href="NCModelConfig$.html"><span class="micon ob"></span><span>NCModelConfig</span></a></span></div><div class="ni expanded"><span class="nh selected"><a href="NCModelConfig.html"><span class="micon tr"></span><span>NCModelConfig</span></a></span></div><div class="ni "><span class="nh "><a href="NCPipeline.html"><span class="micon tr"></span><span>NCPipeline</span></a></span></div><div class="ni "><span class="nh "><a href="NCPipelineBuilder.html"><span class="micon cl"></span><span>NCPipelineBuilder</span></a></span></div><div class="ni "><span class="nh "><a href="NCPropertyMap.html"><span class="micon tr"></span><span>NCPropertyMap</span></a></span></div><div class="ni "><span class="nh "><a href="NCPropertyMapAdapter.html"><span class="micon cl"></span><span>NCPropertyMapAdapter</span></a></span></div><div class="ni "><span class="nh "><a href="NCRejection.html"><span class="micon cl"></span><span>NCRejection</span></a></span></div><div class="ni "><span class="nh "><a href="NCRequest.html"><span class="micon tr"></span><span>NCRequest</span></a></span></div><div class="ni "><span class="nh "><a href="NCResult$.html"><span class="micon ob"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="NCResult.html"><span class="micon tr"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="NCResultType.html"><span class="micon en"></span><span>NCResultType</span></a></span></div><div class="ni "><span class="nh "><a href="NCToken.html"><span class="micon tr"></span><span>NCToken</span></a></span></div><div class="ni "><span class="nh "><a href="NCTokenEnricher.html"><span class="micon tr"></span><span>NCTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="NCTokenParser.html"><span class="micon tr"></span><span>NCTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="NCTokenValidator.html"><span class="micon tr"></span><span>NCTokenValidator</span></a></span></div><div class="ni "><span class="nh "><a href="NCVariant.html"><span class="micon tr"></span><span>NCVariant</span></a></span></div><div class="ni "><span class="nh "><a href="NCVariantFilter.html"><span class="micon tr"></span><span>NCVariantFilter</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlp/enrichers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.enrichers</span></a></span><div class="ni "><span class="nh "><a href="nlp/enrichers/NCBracketsTokenEnricher.html"><span class="micon cl"></span><span>NCBracketsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/enrichers/NCDictionaryTokenEnricher.html"><span class="micon cl"></span><span>NCDictionaryTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/enrichers/NCEnStopWordsTokenEnricher.html"><span class="micon cl"></span><span>NCEnStopWordsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/enrichers/NCOpenNLPTokenEnricher.html"><span class="micon cl"></span><span>NCOpenNLPTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/enrichers/NCQuotesTokenEnricher.html"><span class="micon cl"></span><span>NCQuotesTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/enrichers/NCSwearWordsTokenEnricher.html"><span class="micon cl"></span><span>NCSwearWordsTokenEnricher</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlp/parsers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.parsers</span></a></span><div class="ni "><span class="nh "><a href="nlp/parsers/NCNLPEntityParser.html"><span class="micon cl"></span><span>NCNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/parsers/NCOpenNLPEntityParser.html"><span class="micon cl"></span><span>NCOpenNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/parsers/NCOpenNLPTokenParser.html"><span class="micon cl"></span><span>NCOpenNLPTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/parsers/NCSemanticElement.html"><span class="micon tr"></span><span>NCSemanticElement</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/parsers/NCSemanticEntityParser.html"><span class="micon cl"></span><span>NCSemanticEntityParser</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlp/stemmer.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.stemmer</span></a></span><div class="ni "><span class="nh "><a href="nlp/stemmer/NCEnStemmer.html"><span class="micon cl"></span><span>NCEnStemmer</span></a></span></div><div class="ni "><span class="nh "><a href="nlp/stemmer/NCStemmer.html"><span class="micon tr"></span><span>NCStemmer</span></a></span></div></div></div></nav></div><div id="main"><div id="leftToggler"><span class="icon-toggler"></span></div><div id="scaladoc-searchBar"></div><main id="main-content"><div class="breadcrumbs container"><a href="../../../index.html">NLPCraft</a>/<a href="../nlpcraft.html">org.apache.nlpcraft</a>/<a href="NCModelConfig.html">NCModelConfig</a></div><div id="content"><div><div class="cover-header"><a href="NCModelConfig$.html"><span class="micon tr-wc"></span></a><h1>NCModelConfig</h1></div><div class="signature monospace"><span class="annotations monospace"></span><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="NCModelConfig.html" class="documentableName ">NCModelConfig</a><span><span t="k"> extends </span><a href="NCPropertyMap.html" t="t">NCPropertyMap</a></span></div></div><div class="cover"><div class="doc"><p>Model configuration container.</p>
</div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="NCModel.html#getConfig-0">NCModel.getConfig</a></p>
</div></div></dd><dt>Companion:</dt><dd><a href="NCModelConfig$.html">object</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L94">NCModelConfig.scala</a></dd></dl></div><div class="tabs single"><div class="names"><button data-togglable="graph" class="tab showGraph">Graph</button><button data-togglable="supertypes" class="tab ">Supertypes</button></div><div class="contents"><div data-togglable="graph" class="tab showGraph"><div id="inheritance-diagram" class="diagram-class showGraph"><input value="Reset zoom" type="button" class="btn" onclick="zoomOut()"></input><svg id="graph"></svg><script type="text/dot" id="dot"> digraph g {
node0 [id=node0, label="<span style=\"color: #FFFFFF;\">trait <a href=\"NCModelConfig.html\" t=\"t\">NCModelConfig</a></span>", style="fill: #1CAACF;"];
node1 [id=node1, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\" t=\"t\">Object</span></span>", style="fill: #45AD7D;"];
node2 [id=node2, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\" t=\"t\">Any</span></span>", style="fill: #45AD7D;"];
node3 [id=node3, label="<span style=\"color: #FFFFFF;\">trait <span data-unresolved-link=\"\" t=\"t\">Matchable</span></span>", style="fill: #1CAACF;"];
node4 [id=node4, label="<span style=\"color: #FFFFFF;\">trait <a href=\"NCPropertyMap.html\" t=\"t\">NCPropertyMap</a></span>", style="fill: #1CAACF;"];
node0 -> node1;
node1 -> node2;
node1 -> node3;
node3 -> node2;
node0 -> node4;
node4 -> node1;
}
</script></div></div><div data-togglable="supertypes" class="tab "><div class="symbol monospace"><div>trait <a href="NCPropertyMap.html" t="t">NCPropertyMap</a></div><div>class <span data-unresolved-link="" t="t">Object</span></div><div>trait <span data-unresolved-link="" t="t">Matchable</span></div><div>class <span data-unresolved-link="" t="t">Any</span></div></div></div></div></div><div class="documentableFilter"><div class="filterUpperContainer"><button class="filterToggleButton" data-test-id="filterToggleButton">
<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"/>
</svg>
</button><input class="filterableInput" placeholder="Filter all members" data-test-id="filterBarInput"></input></div><div class="filterLowerContainer"></div></div><div class="membersList"><div class="tabs"><div class="names"><button data-togglable="Value members" class="tab selected">Value members</button></div><div class="contents"><div data-togglable="Value members" class="tab selected"><h2 data-togglable="Value members">Value members</h2><div class="documentableList"><h3 class="groupHeader">Abstract methods</h3><div class="documentableElement" id="getId-0"><a link="NCModelConfig.html#getId-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getId-0" class="documentableName ">getId</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets unique, immutable, global model ID.</p>
</div><div class="cover"><div class="doc"><p>Gets unique, immutable, global model ID.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L98">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="getName-0"><a link="NCModelConfig.html#getName-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getName-0" class="documentableName ">getName</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets readable model name. Note that unlike model ID the model name can be changed.</p>
</div><div class="cover"><div class="doc"><p>Gets readable model name. Note that unlike model ID the model name can be changed.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L103">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="getVersion-0"><a link="NCModelConfig.html#getVersion-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getVersion-0" class="documentableName ">getVersion</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets model version.</p>
</div><div class="cover"><div class="doc"><p>Gets model version.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L108">NCModelConfig.scala</a></dd></dl></div></div></div></div></div></div><div class="documentableList"><h3 class="groupHeader">Concrete methods</h3><div class="documentableElement" id="getConversationDepth-0"><a link="NCModelConfig.html#getConversationDepth-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getConversationDepth-0" class="documentableName ">getConversationDepth</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets maximum depth of the conversation (i.e. number of subsequent individual user requests) after
which the older requests will be &quot;forgotten&quot; and removed from the conversation context.</p>
</div><div class="cover"><div class="doc"><p>Gets maximum depth of the conversation (i.e. number of subsequent individual user requests) after
which the older requests will be &quot;forgotten&quot; and removed from the conversation context.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L130">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="getConversationTimeout-0"><a link="NCModelConfig.html#getConversationTimeout-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getConversationTimeout-0" class="documentableName ">getConversationTimeout</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets timeout in millis after which the current conversation for a given user will
be &quot;forgotten&quot; and its context removed from the STM.</p>
</div><div class="cover"><div class="doc"><p>Gets timeout in millis after which the current conversation for a given user will
be &quot;forgotten&quot; and its context removed from the STM.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L124">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="getDescription-0"><a link="NCModelConfig.html#getDescription-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getDescription-0" class="documentableName ">getDescription</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets optional model description. Default value is <code>None</code>.</p>
</div><div class="cover"><div class="doc"><p>Gets optional model description. Default value is <code>None</code>.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L113">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="getOrigin-0"><a link="NCModelConfig.html#getOrigin-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#getOrigin-0" class="documentableName ">getOrigin</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Gets optional model origin. Default value is <code>None</code>.</p>
</div><div class="cover"><div class="doc"><p>Gets optional model origin. Default value is <code>None</code>.</p>
</div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L118">NCModelConfig.scala</a></dd></dl></div></div></div></div></div></div><div class="documentableList"><h3 class="groupHeader">Inherited methods</h3><div class="documentableElement" id="apply-229" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#apply-229" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#apply-229" class="documentableName ">apply</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>): <span t="t">T</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Returns the value to which the specified key is mapped, or <code>null</code> if this map contains no mapping for the key.</p>
</div><div class="cover"><div class="doc"><p>Returns the value to which the specified key is mapped, or <code>null</code> if this map contains no mapping for the key.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>The key whose associated value is to be returned.</p>
</dd></dl></dd><dt>Returns:</dt><dd><p>The value to which the specified key is mapped, or <code>null</code> if this map contains no mapping for the key.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#apply-229">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L35">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="clear-94c" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#clear-94c" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#clear-94c" class="documentableName ">clear</a><span>(): <a href="https://www.scala-lang.org/api/2.13.8/scala/Unit.html" t="t">Unit</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Removes all of the mappings from this map. The map will be empty after this call returns.</p>
</div><div class="cover"><div class="doc"><p>Removes all of the mappings from this map. The map will be empty after this call returns.</p>
</div><dl class="attributes"><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#clear-94c">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L99">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="contains-fffffd1b" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#contains-fffffd1b" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#contains-fffffd1b" class="documentableName ">contains</a><span>(<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html" t="t">Boolean</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Returns <code>true</code> if this map contains a mapping for the specified key.</p>
</div><div class="cover"><div class="doc"><p>Returns <code>true</code> if this map contains a mapping for the specified key.</p>
</div><dl class="attributes"><dt>Returns:</dt><dd><p><code>true</code> if this map contains a mapping for the specified key.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#contains-fffffd1b">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L70">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="get-fffff9d3" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#get-fffff9d3" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#get-fffff9d3" class="documentableName ">get</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<span t="t">T</span>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Returns the value to which the specified key is mapped.</p>
</div><div class="cover"><div class="doc"><p>Returns the value to which the specified key is mapped.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>The key whose associated value is to be returned.</p>
</dd></dl></dd><dt>Returns:</dt><dd><p>The value to which the specified key is mapped as an optional.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#get-fffff9d3">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L43">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="keysSet-0" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#keysSet-0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#keysSet-0" class="documentableName ">keysSet</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/collection/immutable/Set.html" t="t">Set</a>[<a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Returns a set view of the keys contained in this map.</p>
</div><div class="cover"><div class="doc"><p>Returns a set view of the keys contained in this map.</p>
</div><dl class="attributes"><dt>Returns:</dt><dd><p>A set view of the keys contained in this map.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#keysSet-0">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L94">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="put-9bc" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#put-9bc" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#put-9bc" class="documentableName ">put</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>obj: <span data-unresolved-link="" t="t">Any</span>): <span t="t">T</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Associates the specified value with the specified key in this map. If the map previously contained a mapping
for the key, the old value is replaced by the specified value.</p>
</div><div class="cover"><div class="doc"><p>Associates the specified value with the specified key in this map. If the map previously contained a mapping
for the key, the old value is replaced by the specified value.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>Key with which the specified value is to be associated.</p>
</dd><dt>obj</dt><dd><p>Value to be associated with the specified key.</p>
</dd></dl></dd><dt>Returns:</dt><dd><p>The previous value associated with key, or <code>null</code> if there was no mapping for key.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#put-9bc">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L53">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="putIfAbsent-9bc" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#putIfAbsent-9bc" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#putIfAbsent-9bc" class="documentableName ">putIfAbsent</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>obj: <span t="t">T</span>): <span t="t">T</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>If the specified key is not already associated with a value (or is mapped to <code>null</code>) associates it with
the given value and returns <code>null</code>, else returns the current value.</p>
</div><div class="cover"><div class="doc"><p>If the specified key is not already associated with a value (or is mapped to <code>null</code>) associates it with
the given value and returns <code>null</code>, else returns the current value.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>Key with which the specified value is to be associate</p>
</dd><dt>obj</dt><dd><p>Value to be associated with the specified key</p>
</dd></dl></dd><dt>Returns:</dt><dd><p>The previous value associated with the specified key, or <code>null</code> if there was no mapping for the key.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#putIfAbsent-9bc">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L63">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="remove-fffff468" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#remove-fffff468" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#remove-fffff468" class="documentableName ">remove</a><span>(<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>obj: <span data-unresolved-link="" t="t">Any</span>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html" t="t">Boolean</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Removes the entry for the specified key only if it is currently mapped to the specified value.</p>
</div><div class="cover"><div class="doc"><p>Removes the entry for the specified key only if it is currently mapped to the specified value.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>Key with which the specified value is associated value.</p>
</dd><dt>obj</dt><dd><p>Value expected to be associated with the specified key.</p>
</dd></dl></dd><dt>Returns:</dt><dd><p><code>true</code> if the value was removed.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#remove-fffff468">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L87">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="remove-229" data-f-inherited="NCPropertyMap"><a link="NCModelConfig.html#remove-229" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="NCModelConfig.html#remove-229" class="documentableName ">remove</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>key: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>): <span t="t">T</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Removes the mapping for a key from this map if it is present.</p>
</div><div class="cover"><div class="doc"><p>Removes the mapping for a key from this map if it is present.</p>
</div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>key</dt><dd><p>Key whose mapping is to be removed from the map.</p>
</dd></dl></dd><dt>Returns:</dt><dd><p>The previous value associated with key, or <code>null</code> if there was no mapping for key.</p>
</dd><dt>Inherited from:</dt><dd><a href="NCPropertyMap.html#remove-229">NCPropertyMap</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L78">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div></div></div></div></div></div></div></div></main><footer><div id="generated-by"><span class="footer-text">Generated by</span><a href="https://github.com/lampepfl/dotty/tree/master/scaladoc"><img src="../../../images/scaladoc_logo.svg" alt="scaladoc" class="scaladoc_logo"></img><img src="../../../images/scaladoc_logo_dark.svg" alt="scaladoc" class="scaladoc_logo_dark"></img></a></div><span id="footer-text">Apache NLPCraft</span><div class="socials"><span class="footer-text">Social links</span><a href="https://github.com/apache/incubator-nlpcraft"><span class="social-icon" data-icon-path="github-icon-black.png"></span></a></div><div class="mode"><span class="footer-text">Mode</span><label id="theme-toggle" class="switch"><input type="checkbox"></input><span class="slider"></span></label></div><span class="go-to-top-icon"><a href="#container"><span class="icon-vertical_align_top"></span><span class="footer-text">Back to top</span></a></span></footer></div></div></body></html>