| <!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 (1.8.0_161) on Thu Nov 28 14:41:31 PST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>NCClient (NLPCraft Java Client 0.4.0)</title> |
| <meta name="date" content="2019-11-28"> |
| <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="NCClient (NLPCraft Java Client 0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":18,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="../../../resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="../../../resources/sh/styles/shCoreDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="../../../resources/sh/styles/shThemeDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script> |
| <!-- ========= 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="../../../org/nlpcraft/client/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCClient.html">Use</a></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 class="aboutLanguage">NLPCraft Java Client 0.4.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/nlpcraft/client/NCClient.html" target="_top">Frames</a></li> |
| <li><a href="NCClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.nlpcraft.client</div> |
| <h2 title="Interface NCClient" class="title">Interface NCClient</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">NCClient</span></pre> |
| <div class="block">Java client API. Java REST client provides native and easy-to-use wrapper for NLPCraft |
| <a target=_ href="https://nlpcraft.org/using-rest.html">REST APIs</a> for any JVM-based languages |
| like Java, Scala, Kotlin or Groovy. Note that NLPCraft REST APIs allow to submit the request to existing |
| deployed data model and perform other related, auxiliary operations. To create data models you need to |
| use main <a target=_ href="https://nlpcraft.org/apis/latest/index.html">NLPCraft APIs</a>. |
| <p> |
| <b>External User ID</b><br> |
| Several methods on Java client accept external "on-behalf-of" user ID (<code>usrExtId</code>) additionally to the regular |
| user ID (<code>usrID</code>). In these methods zero, one or both IDs should be provided. If none are provided |
| the ID of the currently signed in user will be used, and if both are provided they should point to the same user. |
| External user ID allows to use user identification from the external systems without a need to import all the |
| existing users into NLPCraft in the first place. |
| <p> |
| Typical usage pattern for integrating NLPCraft into existing |
| system is to create a single administrative NLPCraft user, sign in with that account and then use external |
| "on-behalf-of" user IDs in all the requests. This way you get the same functionality as if using ordinary user IDs |
| but without a need to migrate and synchronize all user accounts from the existing system to NLPCraft. |
| <p> |
| <b>Usage</b><br> |
| Java client usage is straightforward - create client instance using <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a> and use this |
| instance for all API calls: |
| <pre class="brush: java"> |
| // Get client instance with all defaults. |
| NCClient cli = new NCClientBuilder().build(); |
| |
| // Perform any necessary calls... |
| NCResult res = cli.askSync("my.model.id", txt); |
| |
| // Close client & sign out at the end. |
| cli.close(); |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCNewCompany.html" title="interface in org.nlpcraft.client">NCNewCompany</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#addCompany-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">addCompany</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> website, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> country, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> region, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> city, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> postalCode, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminEmail, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminPasswd, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminFirstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminLastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminAvatarUrl)</code> |
| <div class="block">Adds new company with given parameters.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#addFeedback-java.lang.String-double-java.lang.String-java.lang.Long-java.lang.String-">addFeedback</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srvReqId, |
| double score, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> comment, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Adds feedback for given request.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#addUser-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-java.util.Map-java.lang.String-">addUser</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> passwd, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avatarUrl, |
| boolean isAdmin, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> properties, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> extId)</code> |
| <div class="block">Adds new user to the company of the currently signed in user.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#ask-java.lang.String-java.lang.String-">ask</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt)</code> |
| <div class="block">Submits request for asynchronous processing.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#ask-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-">ask</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> data, |
| boolean enableLog, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Submits request for asynchronous processing.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-">askSync</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt)</code> |
| <div class="block">Submits request for synchronous processing.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-">askSync</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> data, |
| boolean enableLog, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Submits request for synchronous processing.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#cancel-java.util.Set-java.lang.Long-java.lang.String-">cancel</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> srvReqIds, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Cancels the previously submitted sentence and removes its result, if any, from the server storage.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#check-java.util.Set-java.lang.Integer-java.lang.Long-java.lang.String-">check</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> srvReqIds, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> maxRows, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Gets the status and result (OK or failure) of the previously submitted requests.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#clearConversation-java.lang.String-java.lang.Long-java.lang.String-">clearConversation</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Clears conversation context for the given model and the specified user.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#clearDialog-java.lang.String-java.lang.Long-java.lang.String-">clearDialog</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Clears the dialog flow for the given model ID and specified user.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#close--">close</a></span>()</code> |
| <div class="block">Closes the client and signs out from the REST server.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#deleteCompany--">deleteCompany</a></span>()</code> |
| <div class="block">Deletes company and all its users and other associated data.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#deleteFeedback-java.lang.Long-">deleteFeedback</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id)</code> |
| <div class="block">Deletes feedback record.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#deleteUser-java.lang.Long-java.lang.String-">deleteUser</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Deletes given user.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCFeedback.html" title="interface in org.nlpcraft.client">NCFeedback</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getAllFeedback-java.lang.String-java.lang.Long-java.lang.String-">getAllFeedback</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srvReqId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Gets all feedback records for given request ID and user.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client">NCUser</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getAllUsers--">getAllUsers</a></span>()</code> |
| <div class="block">Gets all user records for the current signed in user company.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getClientBaseUrl--">getClientBaseUrl</a></span>()</code> |
| <div class="block">Gets base URL this client is configured with.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getClientUserEmail--">getClientUserEmail</a></span>()</code> |
| <div class="block">Gets current signed in user email for this client.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getClientUserPassword--">getClientUserPassword</a></span>()</code> |
| <div class="block">Gets current signed in user password for this client.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCCompany.html" title="interface in org.nlpcraft.client">NCCompany</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getCompany--">getCompany</a></span>()</code> |
| <div class="block">Gets the company descriptor for the current signed in user.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCProbe.html" title="interface in org.nlpcraft.client">NCProbe</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getProbes--">getProbes</a></span>()</code> |
| <div class="block">Gets all active (connected to the REST server) probes for the current signed in user company.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client">NCUser</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#getUser-java.lang.Long-java.lang.String-">getUser</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId)</code> |
| <div class="block">Gets user record.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#isClientCancelOnExit--">isClientCancelOnExit</a></span>()</code> |
| <div class="block">Gets whether or not this client is configured with cancel-on-exit logic.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#isClientEmbeddedMode--">isClientEmbeddedMode</a></span>()</code> |
| <div class="block">Gets whether or not this client is configured with embedded probe.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#resetCompanyToken--">resetCompanyToken</a></span>()</code> |
| <div class="block">Sets and returns new company probe authentication token.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#resetUserPassword-java.lang.Long-java.lang.String-">resetUserPassword</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPasswd)</code> |
| <div class="block">Resets password for the given user.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#updateCompany-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">updateCompany</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> website, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> country, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> region, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> city, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> postalCode)</code> |
| <div class="block">Updates company information for the current signed in user.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#updateUser-long-java.lang.String-java.lang.String-java.lang.String-java.util.Map-">updateUser</a></span>(long id, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avatarUrl, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> properties)</code> |
| <div class="block">Updates given user.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClient.html#updateUserAdmin-java.lang.Long-boolean-">updateUserAdmin</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id, |
| boolean isAdmin)</code> |
| <div class="block">Grants or denies given user administrative privileges.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getClientUserEmail--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientUserEmail</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClientUserEmail()</pre> |
| <div class="block">Gets current signed in user email for this client.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current signed in user email for this client.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientUserPassword--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientUserPassword</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClientUserPassword()</pre> |
| <div class="block">Gets current signed in user password for this client.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current signed in user password for this client.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClientEmbeddedMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClientEmbeddedMode</h4> |
| <pre>boolean isClientEmbeddedMode()</pre> |
| <div class="block">Gets whether or not this client is configured with embedded probe.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether or not this client is configured with embedded probe.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClientCancelOnExit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClientCancelOnExit</h4> |
| <pre>boolean isClientCancelOnExit()</pre> |
| <div class="block">Gets whether or not this client is configured with cancel-on-exit logic.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether or not this client is configured with cancel-on-exit logic</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientBaseUrl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientBaseUrl</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClientBaseUrl()</pre> |
| <div class="block">Gets base URL this client is configured with.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Base URL this client is configured with.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><code>NCClientBuilder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearConversation-java.lang.String-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearConversation</h4> |
| <pre>void clearConversation(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Clears conversation context for the given model and the specified user. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin users can specify |
| user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - Model ID.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClient.html#clearDialog-java.lang.String-java.lang.Long-java.lang.String-"><code>clearDialog(String, Long, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearDialog-java.lang.String-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearDialog</h4> |
| <pre>void clearDialog(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Clears the dialog flow for the given model ID and specified user. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin users can specify |
| user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - Model ID.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClient.html#clearConversation-java.lang.String-java.lang.Long-java.lang.String-"><code>clearConversation(String, Long, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFeedback-java.lang.String-double-java.lang.String-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFeedback</h4> |
| <pre>long addFeedback(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srvReqId, |
| double score, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> comment, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Adds feedback for given request. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin users can specify |
| user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srvReqId</code> - ID of the request to add feedback for.</dd> |
| <dd><code>score</code> - Feedback score, between <code>0</code> and <code>1</code> inclusive. Higher score indicates better result.</dd> |
| <dd><code>comment</code> - Optional feedback comment.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the newly added feedback record.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteFeedback-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteFeedback</h4> |
| <pre>void deleteFeedback(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Deletes feedback record.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - Optional ID of the feedback record to delete. if - all feedback |
| records for the current user will be deleted.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllFeedback-java.lang.String-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllFeedback</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCFeedback.html" title="interface in org.nlpcraft.client">NCFeedback</a>> getAllFeedback(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srvReqId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets all feedback records for given request ID and user. If request ID is not provided all feedback records |
| for the specified user will be returned. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin users can specify |
| user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srvReqId</code> - Optional request ID.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of feedback records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addUser-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-java.util.Map-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addUser</h4> |
| <pre>long addUser(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> passwd, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avatarUrl, |
| boolean isAdmin, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> properties, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> extId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Adds new user to the company of the currently signed in user. Current signed in user must have |
| administrative privileges. |
| <p> |
| <b>User IDs</b><br> |
| This method accepts optional external "on-behalf-of" user ID. If this ID is provided than this method |
| will update the existing user record located by that ID instead of creating a new user record.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>email</code> - New user email.</dd> |
| <dd><code>passwd</code> - New user password. Note that NLPCraft doesn't store passwords and therefore cannot |
| retrieve them later.</dd> |
| <dd><code>firstName</code> - New user first name.</dd> |
| <dd><code>lastName</code> - New user last name.</dd> |
| <dd><code>avatarUrl</code> - Optional new user avatar URL. Can be <code>null</code>.</dd> |
| <dd><code>isAdmin</code> - Whether or not the new user will have administrative privileges.</dd> |
| <dd><code>properties</code> - Map of additional user-defined user properties.</dd> |
| <dd><code>extId</code> - Optional external "on-behalf-of" user ID. Can be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the newly created user.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateUser-long-java.lang.String-java.lang.String-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateUser</h4> |
| <pre>void updateUser(long id, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avatarUrl, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> properties) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Updates given user. Current signed in user must have administrative privileges.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - User ID.</dd> |
| <dd><code>firstName</code> - Mandatory user first name.</dd> |
| <dd><code>lastName</code> - Mandatory user last name.</dd> |
| <dd><code>avatarUrl</code> - Optional user avatar URL. Can be <code>null</code>.</dd> |
| <dd><code>properties</code> - Optional user properties. Can be <code>null</code> or empty.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetUserPassword-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetUserPassword</h4> |
| <pre>void resetUserPassword(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPasswd) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Resets password for the given user. Note that NLPCraft doesn't store clear text passwords and therefore |
| passwords cannot be retrieved - they can only be reset. Current signed in user must have |
| administrative privileges.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - ID of the user for which to reset the password.</dd> |
| <dd><code>newPasswd</code> - New password.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateUserAdmin-java.lang.Long-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateUserAdmin</h4> |
| <pre>void updateUserAdmin(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id, |
| boolean isAdmin) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Grants or denies given user administrative privileges. Current signed in user must have |
| administrative privileges.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - ID of the user for which to change administrative privileges.</dd> |
| <dd><code>isAdmin</code> - Administrative privileges flag.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteUser-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteUser</h4> |
| <pre>void deleteUser(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Deletes given user. Note that you cannot delete the last admin in the company. |
| Current signed in user must have administrative privileges. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUser-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUser</h4> |
| <pre><a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client">NCUser</a> getUser(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets user record. Note that only users with administrative privileges can get user records for |
| other users in the company. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>User record.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllUsers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllUsers</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client">NCUser</a>> getAllUsers() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets all user records for the current signed in user company. Current signed in user must |
| have administrative privileges.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of user records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProbes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProbes</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCProbe.html" title="interface in org.nlpcraft.client">NCProbe</a>> getProbes() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets all active (connected to the REST server) probes for the current signed in user company. |
| Current signed in user must have administrative privileges.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of active probes.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ask-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ask</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ask(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> data, |
| boolean enableLog, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Submits request for asynchronous processing. This method will return immediately and you have to |
| use <a href="../../../org/nlpcraft/client/NCClient.html#check-java.util.Set-java.lang.Integer-java.lang.Long-java.lang.String-"><code>check(Set, Integer, Long, String)</code></a> method to check its result. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - ID of the model to submit the request to.</dd> |
| <dd><code>txt</code> - Text to process.</dd> |
| <dd><code>data</code> - Optional JSON data payload.</dd> |
| <dd><code>enableLog</code> - Whether or not to enable processing log collection.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Server request ID of the submitted request.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"><code>askSync(String, String, String, boolean, Long, String)</code></a>, |
| <a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-"><code>askSync(String, String)</code></a>, |
| <a href="../../../org/nlpcraft/client/NCClient.html#ask-java.lang.String-java.lang.String-"><code>ask(String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ask-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ask</h4> |
| <pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ask(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Submits request for asynchronous processing. This is a shortcut call that is equivalent to: |
| <pre class="brush: java"> |
| ask(mdlId, txt, null, false, null, null); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - ID of the model to submit the request to.</dd> |
| <dd><code>txt</code> - Text to process.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Server request ID of the submitted request.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="askSync-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>askSync</h4> |
| <pre><a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a> askSync(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> data, |
| boolean enableLog, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Submits request for synchronous processing. This method will block and return only when result is available or |
| internal time out expired. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - ID of the model to submit the request to.</dd> |
| <dd><code>txt</code> - Text to process.</dd> |
| <dd><code>data</code> - Optional JSON data payload.</dd> |
| <dd><code>enableLog</code> - Whether or not to enable processing log collection.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Query processing result.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-"><code>askSync(String, String)</code></a>, |
| <a href="../../../org/nlpcraft/client/NCClient.html#ask-java.lang.String-java.lang.String-"><code>ask(String, String)</code></a>, |
| <a href="../../../org/nlpcraft/client/NCClient.html#ask-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"><code>ask(String, String, String, boolean, Long, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="askSync-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>askSync</h4> |
| <pre>default <a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a> askSync(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdlId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> txt) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Submits request for synchronous processing. This is a shortcut call that is equivalent to: |
| <pre class="brush: java"> |
| askSync(mdlId, txt, null, false, null, null); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mdlId</code> - ID of the model to submit the request to.</dd> |
| <dd><code>txt</code> - Text to process.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Query processing result.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="check-java.util.Set-java.lang.Integer-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>check</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/nlpcraft/client/NCResult.html" title="interface in org.nlpcraft.client">NCResult</a>> check(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> srvReqIds, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> maxRows, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets the status and result (OK or failure) of the previously submitted requests. Request statuses |
| returned sorted by their registration time, starting from newest. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srvReqIds</code> - Optional server request IDs for which to get the statuses. If not provided - statuses for |
| all currently processed requests for the specified user will be returned. Invalid or unknown |
| server request IDs will be ignored.</dd> |
| <dd><code>maxRows</code> - Optional maximum number of returned items - by default all statuses will be returned. |
| Can be <code>null</code>.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of results.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancel-java.util.Set-java.lang.Long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>void cancel(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> srvReqIds, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> usrId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usrExtId) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Cancels the previously submitted sentence and removes its result, if any, from the server storage. |
| Must be called when query result is no longer needed (i.e. downloaded by all client apps) to release the server memory. |
| Note that query results will auto-expire on server after a certain period of time. Note also that even |
| when the embedded probe is used the results are still stored on the server and have to be cancelled or |
| otherwise will be timed out. |
| <p> |
| <b>User IDs</b><br> |
| This method allows multiple ways of specifying the ID of the user. If neither <code>usrId</code> |
| or <code>usrExtId</code> are provided (both are <code>null</code>) then the currently signed in user ID |
| of this client instance will be used by default. If both user IDs are provided they must identify the same |
| user in NLPCraft. If only external "on-behalf-of" <code>usrExtId</code> parameter is provided and such user |
| doesn't yet exist in NLPCraft - it will be automatically created. Note that only admin |
| users can specify user ID other than their own (as either <code>usrId</code> or <code>usrExtId</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srvReqIds</code> - Server IDs of the requests to cancel. Optional, all current user requests will be |
| cancelled by default. Invalid or unknown server request IDs will be ignored.</dd> |
| <dd><code>usrId</code> - Optional user ID.</dd> |
| <dd><code>usrExtId</code> - Optional external "on-behalf-of" user ID.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addCompany-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCompany</h4> |
| <pre><a href="../../../org/nlpcraft/client/NCNewCompany.html" title="interface in org.nlpcraft.client">NCNewCompany</a> addCompany(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> website, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> country, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> region, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> city, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> postalCode, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminEmail, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminPasswd, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminFirstName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminLastName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> adminAvatarUrl) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Adds new company with given parameters. Administrative privileges required. Note that to create a new |
| company you also need to supply information for its first administrative user account which will be |
| created in the same time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Company name.</dd> |
| <dd><code>website</code> - Optional company website.</dd> |
| <dd><code>country</code> - Optional company address country.</dd> |
| <dd><code>region</code> - Optional company address region.</dd> |
| <dd><code>city</code> - Optional company address city.</dd> |
| <dd><code>address</code> - Optional company address.</dd> |
| <dd><code>postalCode</code> - Optional company address postal code.</dd> |
| <dd><code>adminEmail</code> - Company administrator email.</dd> |
| <dd><code>adminPasswd</code> - Company administrator password.</dd> |
| <dd><code>adminFirstName</code> - Optional company administrator first name.</dd> |
| <dd><code>adminLastName</code> - Optional company administrator last name.</dd> |
| <dd><code>adminAvatarUrl</code> - Optional company administrator avatar URL.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>New company data.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompany--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompany</h4> |
| <pre><a href="../../../org/nlpcraft/client/NCCompany.html" title="interface in org.nlpcraft.client">NCCompany</a> getCompany() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets the company descriptor for the current signed in user.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Company descriptor.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateCompany-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateCompany</h4> |
| <pre>void updateCompany(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> website, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> country, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> region, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> city, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> postalCode) |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Updates company information for the current signed in user. Current signed in user must have |
| administrative privileges. Note that users cannot update or get information about other |
| companies.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Company name.</dd> |
| <dd><code>website</code> - Optional company website.</dd> |
| <dd><code>country</code> - Optional company address country.</dd> |
| <dd><code>region</code> - Optional company address region.</dd> |
| <dd><code>city</code> - Optional company address city.</dd> |
| <dd><code>address</code> - Optional company address.</dd> |
| <dd><code>postalCode</code> - Optional company address postal code.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetCompanyToken--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetCompanyToken</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resetCompanyToken() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Sets and returns new company probe authentication token. |
| Administrative privileges required for resetting company token.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>New company probe token.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteCompany--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteCompany</h4> |
| <pre>void deleteCompany() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Deletes company and all its users and other associated data. Administrative privileges required.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close() |
| throws <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a>, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Closes the client and signs out from the REST server. Any further calls to this client will result in |
| exception.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of client-specific errors.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of generic I/O errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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="../../../org/nlpcraft/client/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCClient.html">Use</a></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 class="aboutLanguage"><span style="vertical-align: super">NLPCraft Java Client 0.4.0</span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/nlpcrafters/nlpcraft-java-client " target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/subscription" data-icon="octicon-eye" aria-label="Watch nlpcrafters/nlpcraft-java-client on GitHub">Watch</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client" data-icon="octicon-star" aria-label="Star nlpcrafters/nlpcraft-java-client on GitHub">Star</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/fork" data-icon="octicon-repo-forked" aria-label="Fork nlpcrafters/nlpcraft-java-client on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java ../../../resources/sh/scripts/shBrushJava.js', 'js jscript javascript ../../../resources/sh/scripts/shBrushJScript.js', 'text plain ../../../resources/sh/scripts/shBrushPlain.js', 'py python ../../../resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb ../../../resources/sh/scripts/shBrushRuby.js', 'scala ../../../resources/sh/scripts/shBrushScala.js', 'sql ../../../resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html ../../../resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/nlpcraft/client/NCClient.html" target="_top">Frames</a></li> |
| <li><a href="NCClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2019 NLPCraft Project. All rights reserved.</small></p> |
| </body> |
| </html> |
