neuralseek 1.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,206 @@
+# neuralSeek
+
+NeuralSeek - JavaScript client for neuralSeek
+NeuralSeek - The business LLM accelerator
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.1
+- Package version: 1.0.1
+- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
+For more information, please visit [https://neuralseek.com](https://neuralseek.com)
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/),
+please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install neuralSeek --save
+```
+
+#### git
+#
+If the library is hosted at a git repository, e.g.
+https://github.com/GIT_USER_ID/GIT_REPO_ID
+then install it via:
+
+```shell
+    npm install GIT_USER_ID/GIT_REPO_ID --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
+the above steps with Node.js and installing browserify with `npm install -g browserify`,
+perform the following (assuming *main.js* is your entry file):
+
+```shell
+browserify main.js > bundle.js
+```
+
+Then include *bundle.js* in the HTML pages.
+
+### Webpack Configuration
+
+Using Webpack you may encounter the following error: "Module not found: Error:
+Cannot resolve module", most certainly you should disable AMD loader. Add/merge
+the following section to your webpack config:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+var NeuralSeek = require('neuralSeek');
+var defaultClient = NeuralSeek.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+var apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix['apikey'] = "Token"
+
+var api = new NeuralSeek.AnalyticsApi()
+var opts = { 
+  'body': new NeuralSeek.AnalyticsBody() // {AnalyticsBody} The request object.  You may optionally limit the result set using \"count\"
+};
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.analytics(opts, callback);
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*NeuralSeek.AnalyticsApi* | [**analytics**](docs/AnalyticsApi.md#analytics) | **POST** /analytics | Instance Analytics
+*NeuralSeek.CategorizeApi* | [**categorize**](docs/CategorizeApi.md#categorize) | **POST** /categorize | Categorize text into an Intent & Category
+*NeuralSeek.ExtractEntitiesApi* | [**extractEntities**](docs/ExtractEntitiesApi.md#extractEntities) | **POST** /extract | Extract entitites from text
+*NeuralSeek.GuardrailsApi* | [**pii**](docs/GuardrailsApi.md#pii) | **POST** /pii | Find PII in a user utterance
+*NeuralSeek.GuardrailsApi* | [**score**](docs/GuardrailsApi.md#score) | **POST** /score | Run the Semantic Scoring model on text against an array of passages
+*NeuralSeek.KeysApi* | [**keycheck**](docs/KeysApi.md#keycheck) | **POST** /keycheck | Validate an api key
+*NeuralSeek.KeysApi* | [**otp**](docs/KeysApi.md#otp) | **POST** /otp | Create a One Time Password
+*NeuralSeek.LogsApi* | [**logExternalAgent**](docs/LogsApi.md#logExternalAgent) | **POST** /logExternalAgent | Log external agent execution details
+*NeuralSeek.LogsApi* | [**logs**](docs/LogsApi.md#logs) | **POST** /logs | Instance Logs
+*NeuralSeek.MAIstroApi* | [**chat**](docs/MAIstroApi.md#chat) | **POST** /chat/completions | Chat Completions - compatible mAIStro endpoint
+*NeuralSeek.MAIstroApi* | [**maistro**](docs/MAIstroApi.md#maistro) | **POST** /maistro | Run mAistro NTL or agent
+*NeuralSeek.MAIstroApi* | [**maistroAgentGet**](docs/MAIstroApi.md#maistroAgentGet) | **GET** /maistro/{agent} | Run a mAIstro agent via GET
+*NeuralSeek.MAIstroApi* | [**maistroBatch**](docs/MAIstroApi.md#maistroBatch) | **POST** /maistro_batch | Call mAIstro NTL or an agent via batch
+*NeuralSeek.MAIstroApi* | [**maistroBatchDelete**](docs/MAIstroApi.md#maistroBatchDelete) | **DELETE** /maistro_batch | Cancel current mAIstro batch run
+*NeuralSeek.MAIstroApi* | [**maistroBatchGet**](docs/MAIstroApi.md#maistroBatchGet) | **GET** /maistro_batch | Get mAIstro batch results
+*NeuralSeek.MAIstroApi* | [**maistroStream**](docs/MAIstroApi.md#maistroStream) | **POST** /maistro_stream | Stream mAIstro NTL or an agent
+*NeuralSeek.MAIstroAgentRatingsApi* | [**maistroRate**](docs/MAIstroAgentRatingsApi.md#maistroRate) | **POST** /maistroRate | Rate an Agent
+*NeuralSeek.MAIstroAgentRatingsApi* | [**maistroRatings**](docs/MAIstroAgentRatingsApi.md#maistroRatings) | **POST** /maistroRatings | Get the average user ratings for an agent
+*NeuralSeek.SeekApi* | [**seek**](docs/SeekApi.md#seek) | **POST** /seek | Seek an answer from NeuralSeek
+*NeuralSeek.SeekApi* | [**seekStream**](docs/SeekApi.md#seekStream) | **POST** /seek_stream | Stream a Seek an answer from NeuralSeek
+*NeuralSeek.SeekAnswerRatingsApi* | [**answerRatings**](docs/SeekAnswerRatingsApi.md#answerRatings) | **POST** /answerRatings | Get the average user ratings for an answer
+*NeuralSeek.SeekAnswerRatingsApi* | [**rate**](docs/SeekAnswerRatingsApi.md#rate) | **POST** /rate | Rate an answer
+*NeuralSeek.ServiceTestApi* | [**servicetest**](docs/ServiceTestApi.md#servicetest) | **GET** /test | Service check
+*NeuralSeek.TestQuestionsApi* | [**getTestResults**](docs/TestQuestionsApi.md#getTestResults) | **GET** /getTestResults | Get Test Results
+*NeuralSeek.TestQuestionsApi* | [**test**](docs/TestQuestionsApi.md#test) | **POST** /test | Test questions via batch upload
+*NeuralSeek.TrainKBApi* | [**train**](docs/TrainKBApi.md#train) | **POST** /train | Submit KnowledgeBase Training
+*NeuralSeek.TranslateApi* | [**deleteTranslateGlossary**](docs/TranslateApi.md#deleteTranslateGlossary) | **DELETE** /translateGlossary | Delete the custom translations
+*NeuralSeek.TranslateApi* | [**identifyLanguage**](docs/TranslateApi.md#identifyLanguage) | **POST** /identify | Identify the source language
+*NeuralSeek.TranslateApi* | [**identifyLanguageJSON**](docs/TranslateApi.md#identifyLanguageJSON) | **POST** /identify-single | Identify the source language (JSON)
+*NeuralSeek.TranslateApi* | [**translate**](docs/TranslateApi.md#translate) | **POST** /translate | Translate text into a desired language
+*NeuralSeek.TranslateApi* | [**translateGlossary**](docs/TranslateApi.md#translateGlossary) | **POST** /translateGlossary | Add custom translations
+*NeuralSeek.UserDataApi* | [**deleteUserData**](docs/UserDataApi.md#deleteUserData) | **DELETE** /user_data | Delete all user data
+
+## Documentation for Models
+
+ - [NeuralSeek.AnalyticsBody](docs/AnalyticsBody.md)
+ - [NeuralSeek.AnswerRatingsBody](docs/AnswerRatingsBody.md)
+ - [NeuralSeek.CategorizeBody](docs/CategorizeBody.md)
+ - [NeuralSeek.ChatCompletionsBody](docs/ChatCompletionsBody.md)
+ - [NeuralSeek.ChatcompletionsMessages](docs/ChatcompletionsMessages.md)
+ - [NeuralSeek.ChatcompletionsTools](docs/ChatcompletionsTools.md)
+ - [NeuralSeek.ExtractBody](docs/ExtractBody.md)
+ - [NeuralSeek.IdentifysingleBody](docs/IdentifysingleBody.md)
+ - [NeuralSeek.InlineResponse200](docs/InlineResponse200.md)
+ - [NeuralSeek.InlineResponse2001](docs/InlineResponse2001.md)
+ - [NeuralSeek.InlineResponse20010](docs/InlineResponse20010.md)
+ - [NeuralSeek.InlineResponse20011](docs/InlineResponse20011.md)
+ - [NeuralSeek.InlineResponse20012](docs/InlineResponse20012.md)
+ - [NeuralSeek.InlineResponse20013](docs/InlineResponse20013.md)
+ - [NeuralSeek.InlineResponse2002](docs/InlineResponse2002.md)
+ - [NeuralSeek.InlineResponse2002Render](docs/InlineResponse2002Render.md)
+ - [NeuralSeek.InlineResponse2003](docs/InlineResponse2003.md)
+ - [NeuralSeek.InlineResponse2003Data](docs/InlineResponse2003Data.md)
+ - [NeuralSeek.InlineResponse2004](docs/InlineResponse2004.md)
+ - [NeuralSeek.InlineResponse2004Choices](docs/InlineResponse2004Choices.md)
+ - [NeuralSeek.InlineResponse2004Message](docs/InlineResponse2004Message.md)
+ - [NeuralSeek.InlineResponse2005](docs/InlineResponse2005.md)
+ - [NeuralSeek.InlineResponse2005TopIntents](docs/InlineResponse2005TopIntents.md)
+ - [NeuralSeek.InlineResponse2006](docs/InlineResponse2006.md)
+ - [NeuralSeek.InlineResponse2006ExtractedEntities](docs/InlineResponse2006ExtractedEntities.md)
+ - [NeuralSeek.InlineResponse2007](docs/InlineResponse2007.md)
+ - [NeuralSeek.InlineResponse2007Translations](docs/InlineResponse2007Translations.md)
+ - [NeuralSeek.InlineResponse2008](docs/InlineResponse2008.md)
+ - [NeuralSeek.InlineResponse2009](docs/InlineResponse2009.md)
+ - [NeuralSeek.LogExternalAgentBody](docs/LogExternalAgentBody.md)
+ - [NeuralSeek.LogExternalAgentEntries](docs/LogExternalAgentEntries.md)
+ - [NeuralSeek.LogsBody](docs/LogsBody.md)
+ - [NeuralSeek.MaistroBatchBody](docs/MaistroBatchBody.md)
+ - [NeuralSeek.MaistroBody](docs/MaistroBody.md)
+ - [NeuralSeek.MaistroOptions](docs/MaistroOptions.md)
+ - [NeuralSeek.MaistroRateBody](docs/MaistroRateBody.md)
+ - [NeuralSeek.MaistroRatingsBody](docs/MaistroRatingsBody.md)
+ - [NeuralSeek.MaistroStreamBody](docs/MaistroStreamBody.md)
+ - [NeuralSeek.MaistroStreamOptions](docs/MaistroStreamOptions.md)
+ - [NeuralSeek.PiiBody](docs/PiiBody.md)
+ - [NeuralSeek.RateBody](docs/RateBody.md)
+ - [NeuralSeek.ScoreBody](docs/ScoreBody.md)
+ - [NeuralSeek.Seek](docs/Seek.md)
+ - [NeuralSeek.SeekOptions](docs/SeekOptions.md)
+ - [NeuralSeek.SeekResponse](docs/SeekResponse.md)
+ - [NeuralSeek.SeekResponsePassages](docs/SeekResponsePassages.md)
+ - [NeuralSeek.SeekResponseVariablesExpanded](docs/SeekResponseVariablesExpanded.md)
+ - [NeuralSeek.SeekStreamBody](docs/SeekStreamBody.md)
+ - [NeuralSeek.SeekStreamOptions](docs/SeekStreamOptions.md)
+ - [NeuralSeek.SeekStreamOptionsLastTurn](docs/SeekStreamOptionsLastTurn.md)
+ - [NeuralSeek.SeekStreamOptionsPersonalize](docs/SeekStreamOptionsPersonalize.md)
+ - [NeuralSeek.SeekStreamParams](docs/SeekStreamParams.md)
+ - [NeuralSeek.SeekStreamUserSession](docs/SeekStreamUserSession.md)
+ - [NeuralSeek.SeekStreamUserSessionMetadata](docs/SeekStreamUserSessionMetadata.md)
+ - [NeuralSeek.SeekStreamUserSessionSystem](docs/SeekStreamUserSessionSystem.md)
+ - [NeuralSeek.TestBody](docs/TestBody.md)
+ - [NeuralSeek.TestBody1](docs/TestBody1.md)
+ - [NeuralSeek.TrainBody](docs/TrainBody.md)
+ - [NeuralSeek.TranslateBody](docs/TranslateBody.md)
+ - [NeuralSeek.TranslateGlossaryBody](docs/TranslateGlossaryBody.md)
+ - [NeuralSeek.TranslateGlossaryBody1](docs/TranslateGlossaryBody1.md)
+
+## Documentation for Authorization
+
+
+### apiKey
+
+- **Type**: API key
+- **API key parameter name**: apikey
+- **Location**: HTTP header
+

package/docs/AnalyticsApi.md

@@ -0,0 +1,59 @@
+# NeuralSeek.AnalyticsApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**analytics**](AnalyticsApi.md#analytics) | **POST** /analytics | Instance Analytics
+
+<a name="analytics"></a>
+# **analytics**
+> analytics(opts)
+
+Instance Analytics
+
+Retrieve an analytics dataset for your instance
+
+### Example
+```javascript
+import {NeuralSeek} from 'neuralSeek';
+let defaultClient = NeuralSeek.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeek.AnalyticsApi();
+let opts = { 
+  'body': new NeuralSeek.AnalyticsBody() // AnalyticsBody | The request object.  You may optionally limit the result set using \"count\"
+};
+apiInstance.analytics(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AnalyticsBody**](AnalyticsBody.md)| The request object.  You may optionally limit the result set using \&quot;count\&quot; | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+

package/docs/AnalyticsBody.md

@@ -0,0 +1,6 @@
+# NeuralSeek.AnalyticsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Number** | The number of rows to return | [optional] 

package/docs/AnswerRatingsBody.md

@@ -0,0 +1,7 @@
+# NeuralSeek.AnswerRatingsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answerId** | **Number** | The answer id | [optional] 
+**_number** | **Number** | The number of previous user ratings to average. Leave blank to average all ratings. | [optional] 

package/docs/CategorizeApi.md

@@ -0,0 +1,58 @@
+# NeuralSeek.CategorizeApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**categorize**](CategorizeApi.md#categorize) | **POST** /categorize | Categorize text into an Intent & Category
+
+<a name="categorize"></a>
+# **categorize**
+> InlineResponse2005 categorize(body)
+
+Categorize text into an Intent &amp; Category
+
+Categorize text into an Intent &amp; Category
+
+### Example
+```javascript
+import {NeuralSeek} from 'neuralSeek';
+let defaultClient = NeuralSeek.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeek.CategorizeApi();
+let body = new NeuralSeek.CategorizeBody(); // CategorizeBody | The request object.
+
+apiInstance.categorize(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CategorizeBody**](CategorizeBody.md)| The request object. | 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+

package/docs/CategorizeBody.md

@@ -0,0 +1,6 @@
+# NeuralSeek.CategorizeBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question** | **String** | The text to categorize | [optional] [default to '']

package/docs/ChatCompletionsBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.ChatCompletionsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **String** | The mAIstro agent to call | 
+**messages** | [**[ChatcompletionsMessages]**](ChatcompletionsMessages.md) |  | [optional] 
+**tools** | [**ChatcompletionsTools**](ChatcompletionsTools.md) |  | [optional] 
+**stream** | **Boolean** | Whether to stream responses as server-sent events | [optional] 

package/docs/ChatcompletionsMessages.md

@@ -0,0 +1,16 @@
+# NeuralSeek.ChatcompletionsMessages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | The role of the message sender | [optional] 
+**content** | **String** | The content of the message | [optional] 
+
+<a name="RoleEnum"></a>
+## Enum: RoleEnum
+
+* `user` (value: `"user"`)
+* `assistant` (value: `"assistant"`)
+* `system` (value: `"system"`)
+* `tool` (value: `"tool"`)
+

package/docs/ChatcompletionsTools.md

@@ -0,0 +1,13 @@
+# NeuralSeek.ChatcompletionsTools
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of tool to call. Only \"agent\" is valid | [optional] 
+**params** | [**[SeekStreamParams]**](SeekStreamParams.md) | An array of parameters to use when calling the mAIstro agent\" | [optional] 
+
+<a name="TypeEnum"></a>
+## Enum: TypeEnum
+
+* `agent` (value: `"agent"`)
+

package/docs/ExtractBody.md

@@ -0,0 +1,11 @@
+# NeuralSeek.ExtractBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The text to extract entitites from | [optional] 
+**language** | **String** | The 2-char language code to be used when generating a promptEntity response. Only set this if you want to override the configured language in NeuralSeek. | [optional] 
+**entities** | **String** | An array of objects, stringified. The properties of the object are name, description, and format | [optional] 
+**slots** | **Object** | Provide an object of variable names, with a type property set to an entity type to match to in total across multiple turns of a conversation. NeuralSeek will return a promptEntity to display to the user to continue to fil the slots.  As slots are filled the value field will be populated.  Continue to send this entire filed back as input thru the multiple turns of the conversation, untill Complete is set to true.  Complete will be set to true when all slots are filled | [optional] 
+**confirmSlots** | **Boolean** | When using Slots, once all slots have been filled display a summary and ask for a confirmation before setting the 'complete' flag | [optional] 
+**confirmEverySlot** | **Boolean** | When using Slots, on every turn recite the slot that was just previously filled. | [optional] 

package/docs/ExtractEntitiesApi.md

@@ -0,0 +1,58 @@
+# NeuralSeek.ExtractEntitiesApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**extractEntities**](ExtractEntitiesApi.md#extractEntities) | **POST** /extract | Extract entitites from text
+
+<a name="extractEntities"></a>
+# **extractEntities**
+> InlineResponse2006 extractEntities(body)
+
+Extract entitites from text
+
+Extract entitites from text
+
+### Example
+```javascript
+import {NeuralSeek} from 'neuralSeek';
+let defaultClient = NeuralSeek.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeek.ExtractEntitiesApi();
+let body = new NeuralSeek.ExtractBody(); // ExtractBody | The request object.
+
+apiInstance.extractEntities(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ExtractBody**](ExtractBody.md)| The request object. | 
+
+### Return type
+
+[**InlineResponse2006**](InlineResponse2006.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+