neuralseek 1.0.1

package/docs/SeekAnswerRatingsApi.md

@@ -0,0 +1,109 @@
+# NeuralSeek.SeekAnswerRatingsApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**answerRatings**](SeekAnswerRatingsApi.md#answerRatings) | **POST** /answerRatings | Get the average user ratings for an answer
+[**rate**](SeekAnswerRatingsApi.md#rate) | **POST** /rate | Rate an answer
+
+<a name="answerRatings"></a>
+# **answerRatings**
+> InlineResponse2001 answerRatings(body)
+
+Get the average user ratings for an answer
+
+Get the average user ratings for an answer
+
+### 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.SeekAnswerRatingsApi();
+let body = new NeuralSeek.AnswerRatingsBody(); // AnswerRatingsBody | The request object.
+
+apiInstance.answerRatings(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AnswerRatingsBody**](AnswerRatingsBody.md)| The request object. | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="rate"></a>
+# **rate**
+> rate(body)
+
+Rate an answer
+
+Allow users to give feedback in on answers generated
+
+### 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.SeekAnswerRatingsApi();
+let body = new NeuralSeek.RateBody(); // RateBody | The request object.
+
+apiInstance.rate(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RateBody**](RateBody.md)| The request object. | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+

package/docs/SeekApi.md

@@ -0,0 +1,109 @@
+# NeuralSeek.SeekApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**seek**](SeekApi.md#seek) | **POST** /seek | Seek an answer from NeuralSeek
+[**seekStream**](SeekApi.md#seekStream) | **POST** /seek_stream | Stream a Seek an answer from NeuralSeek
+
+<a name="seek"></a>
+# **seek**
+> SeekResponse seek(body)
+
+Seek an answer from NeuralSeek
+
+This endpoint takes an input object with a user question, context and options and returns a response object
+
+### 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.SeekApi();
+let body = new NeuralSeek.Seek(); // Seek | The request object.  Must include the question and a context.
+
+apiInstance.seek(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Seek**](Seek.md)| The request object.  Must include the question and a context. | 
+
+### Return type
+
+[**SeekResponse**](SeekResponse.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="seekStream"></a>
+# **seekStream**
+> InlineResponse200 seekStream(body)
+
+Stream a Seek an answer from NeuralSeek
+
+This endpoint takes an input object with a user question, context and options and returns a response object
+
+### 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.SeekApi();
+let body = new NeuralSeek.SeekStreamBody(); // SeekStreamBody | The request object.  Must include the question and a context.
+
+apiInstance.seekStream(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SeekStreamBody**](SeekStreamBody.md)| The request object.  Must include the question and a context. | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/event-stream
+

package/docs/SeekOptions.md

@@ -0,0 +1,24 @@
+# NeuralSeek.SeekOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personalize** | [**SeekStreamOptionsPersonalize**](SeekStreamOptionsPersonalize.md) |  | [optional] 
+**proposalID** | **String** | Override all settings by passing a NeuralSeek Proposal ID. | [optional] [default to '']
+**streaming** | **Boolean** | Return the response via SSE streaming.  This is not compatible with most Virtual Agent platforms, and is intentded for direct website use. | [optional] [default to false]
+**seekLLM** | **String** | Override the LLM load balancer and force seek to use a specific LLM.  Input the LLM code here.  You must have a valid model card set up on the configure tab for the code you input. | [optional] [default to '']
+**language** | **String** | Valid values are: en, es, de, it, fr, ja, ar | [optional] [default to '']
+**filter** | **String** | Text to use as a filter against the filter field set in the KnowledgeBase configuration. Use commas to separate multiple strings for an 'or' filter. You can use the filter to isolate a certain subset of documents in the knowledgebase. | [optional] [default to '']
+**lastTurn** | [**[SeekStreamOptionsLastTurn]**](SeekStreamOptionsLastTurn.md) | lastTurn is a flexible object. It is backwards compatible with the original single turn object, as well as compatible with the Watson Assistant session history format. | [optional] 
+**promptEngineering** | **String** | Enable Prompt engineering.  Valid values are the strings 'true' and 'false' | [optional] [default to '']
+**promptEngineeringPhrase** | **String** | Prepend a phrase to cleansed user input. Must enable Prompt Engineering inside the NeuralSeek \"Configure\" page | [optional] [default to '']
+**answerLength** | **Number** | The verbosity of the answer. A whole number 1-4 | [optional] 
+**url** | **String** | URL of the current page when using with a web-based Virtual Agent | [optional] [default to '']
+**stump** | **String** | Stump Speech text. Fallback for when all else fails. | [optional] [default to '']
+**includeSourceResults** | **Boolean** | Include generation source results. Defaults to false. | [optional] [default to false]
+**includeHighlights** | **Boolean** | Include highlights from source results. Defaults to false. | [optional] [default to false]
+**includeSourceResultsFormatted** | **Boolean** | Include generation source results, and output them into a formatted string.  Defaults to false. | [optional] [default to false]
+**sourceResultsNumber** | **Number** | When including source results, how many to include.' | [optional] [default to 3]
+**sourceResultsSummaryLength** | **Number** | When including source results, how long of a summary to include.' | [optional] [default to 100]
+**returnVariables** | **Boolean** | Return the final state of all variables in a dense object | [optional] [default to false]
+**returnVariablesExpanded** | **Boolean** | Return the final state of all variables in the same format as the input params | [optional] [default to false]

package/docs/SeekResponse.md

@@ -0,0 +1,32 @@
+# NeuralSeek.SeekResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answer** | **String** | The generated answer | [default to '']
+**ufa** | **String** | The raw answer from the LLM before guardrails are applied. | [optional] [default to '']
+**answerId** | **String** | The id of the answer. Use this to refer to it from other endpoints, such as the Rating endpoint | [optional] [default to '']
+**thumbs** | **String** | The URL of a rating HTML page with an SVG to embed with the answer to allow easy rating. | [optional] [default to '']
+**thumbsSVG** | **String** | The URL of a rating SVG to display with the answer to allow easy rating. | [optional] [default to '']
+**intent** | **String** | The intent of the answer. | [optional] [default to '']
+**category** | **Number** | The category id of the answer. | [optional] 
+**categoryName** | **String** | The category name of the answer. | [optional] [default to '']
+**score** | **Number** | The final confidence score of the answer (0-100) | 
+**kBscore** | **Number** | The KnowledgeBase confidence of the answer's source documentation  (0-100) | [optional] 
+**semanticAnalysis** | **String** | Semantic Analysis | [optional] [default to '']
+**cachedResult** | **String** | If the result came from cache, will be set to the string 'true' | [optional] [default to '']
+**langCode** | **String** | The language code of the answer. If you set the input language code to 'xx' to identify the language, this is useful to condition of the found language and response. | [optional] [default to '']
+**url** | **String** | The top scoring URL (if available) used to train the answer. Set the field you want returned here in on the Configure tab. The field must contain a URL, or it will be ignored. | [optional] [default to '']
+**document** | **String** | The top document (if available) used to train the answer. Set the field you want returned here in on the Configure tab | [optional] [default to '']
+**time** | **Number** | Total processing time in milliseconds | [optional] 
+**kbTime** | **Number** | KnowledgeBase response time in milliseconds | [optional] 
+**protectTime** | **Number** | PI time in milliseconds | [optional] 
+**categorySelectionTime** | **Number** | Category Selection time in milliseconds | [optional] 
+**promptInjection** | **Number** | Prompt injection value | [optional] 
+**sourceResultsFormatted** | **String** | A listing of the passages used for answer summarization. This will only return if includeSourceResultsFormatted is set to true on the request | [optional] [default to '']
+**passages** | [**[SeekResponsePassages]**](SeekResponsePassages.md) | A listing of the passages used for answer summarization. This will only return if includeSourceResults is set to true on the request | [optional] 
+**kbCoverage** | **Number** | KnowledgeBase coverage score. How much content was returned from the KnowledgeBase on the subject asked as compared to benchmarks. Low coverage is not necessarily indicitive of bad content. | [optional] 
+**sentiment** | **Number** | Sentiment score | [optional] 
+**semanticScore** | **Number** | Semantic score (if enabled) | [optional] 
+**variables** | **Object** | The returned variable. | [optional] 
+**variablesExpanded** | [**[SeekResponseVariablesExpanded]**](SeekResponseVariablesExpanded.md) | The returned variable, in the format of the input params | [optional] 

package/docs/SeekResponsePassages.md

@@ -0,0 +1,11 @@
+# NeuralSeek.SeekResponsePassages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**passage** | **String** | The passage text, summarized to the length set by sourceResultsSummaryLength | [optional] [default to '']
+**id** | **String** | The id of the source document in the KB. | [optional] [default to '']
+**score** | **Number** | The score of the passage. | [optional] 
+**url** | **String** | The URL (if available) of the source document. | [optional] [default to '']
+**document** | **String** | The name of the source document. | [optional] [default to '']
+**train** | **String** | The training token for the document. Use this when calling the /train endpoint. | [optional] [default to '']

package/docs/SeekResponseVariablesExpanded.md

@@ -0,0 +1,7 @@
+# NeuralSeek.SeekResponseVariablesExpanded
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The variable name | [optional] [default to '']
+**value** | **String** | The variable value | [optional] [default to '']

package/docs/SeekStreamBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.SeekStreamBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question** | **String** | The user's question for NeuralSeek | [default to '']
+**userSession** | [**SeekStreamUserSession**](SeekStreamUserSession.md) |  | [optional] 
+**params** | [**[SeekStreamParams]**](SeekStreamParams.md) | An array of parameters to use in evaluation of the seek when calling mAIstro during a seek. | [optional] 
+**options** | [**SeekStreamOptions**](SeekStreamOptions.md) |  | [optional] 

package/docs/SeekStreamOptions.md

@@ -0,0 +1,23 @@
+# NeuralSeek.SeekStreamOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personalize** | [**SeekStreamOptionsPersonalize**](SeekStreamOptionsPersonalize.md) |  | [optional] 
+**proposalID** | **String** | Override all settings by passing a NeuralSeek Proposal ID. | [optional] [default to '']
+**seekLLM** | **String** | Override the LLM load balancer and force seek to use a specific LLM.  Input the LLM code here.  You must have a valid model card set up on the configure tab for the code you input. | [optional] [default to '']
+**language** | **String** | Valid values are: en, es, de, it, fr, ja, ar | [optional] [default to '']
+**filter** | **String** | Text to use as a filter against the filter field set in the KnowledgeBase configuration. Use commas to separate multiple strings for an 'or' filter. You can use the filter to isolate a certain subset of documents in the knowledgebase. | [optional] [default to '']
+**lastTurn** | [**[SeekStreamOptionsLastTurn]**](SeekStreamOptionsLastTurn.md) | lastTurn is a flexible object. It is backwards compatible with the original single turn object, as well as compatible with the Watson Assistant session history format. | [optional] 
+**promptEngineering** | **String** | Enable Prompt engineering.  Valid values are the strings 'true' and 'false' | [optional] [default to '']
+**promptEngineeringPhrase** | **String** | Prepend a phrase to cleansed user input. Must enable Prompt Engineering inside the NeuralSeek \"Configure\" page | [optional] [default to '']
+**answerLength** | **Number** | The verbosity of the answer. A whole number 1-4 | [optional] 
+**url** | **String** | URL of the current page when using with a web-based Virtual Agent | [optional] [default to '']
+**stump** | **String** | Stump Speech text. Fallback for when all else fails. | [optional] [default to '']
+**includeSourceResults** | **Boolean** | Include generation source results. Defaults to false. | [optional] [default to false]
+**includeHighlights** | **Boolean** | Include highlights from source results. Defaults to false. | [optional] [default to false]
+**includeSourceResultsFormatted** | **Boolean** | Include generation source results, and output them into a formatted string.  Defaults to false. | [optional] [default to false]
+**sourceResultsNumber** | **Number** | When including source results, how many to include.' | [optional] [default to 3]
+**sourceResultsSummaryLength** | **Number** | When including source results, how long of a summary to include.' | [optional] [default to 100]
+**returnVariables** | **Boolean** | Return the final state of all variables in a dense object | [optional] [default to false]
+**returnVariablesExpanded** | **Boolean** | Return the final state of all variables in the same format as the input params | [optional] [default to false]

package/docs/SeekStreamOptionsLastTurn.md

@@ -0,0 +1,7 @@
+# NeuralSeek.SeekStreamOptionsLastTurn
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **String** | The user input | [optional] [default to '']
+**response** | **String** | The system response.  Text strings only here.  | [optional] [default to '']

package/docs/SeekStreamOptionsPersonalize.md

@@ -0,0 +1,10 @@
+# NeuralSeek.SeekStreamOptionsPersonalize
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preferredName** | **String** | The name the user should be referred to by | [optional] [default to '']
+**noWelcome** | **String** | The user has already been welcomed, do not re-welcome.  Valid value is 'true' or 'false'.  Default value is 'false'. | [optional] [default to '']
+**forceFirstPerson** | **String** | Use a first-person speaking style, even if no preferredName is set.  Valid value is 'true' or 'false'.  Default value is 'false'. | [optional] [default to '']
+**products** | **[String]** | An array of products this customer currently consumes from your company | [optional] 
+**additionalDetails** | **String** | Additional details to pass to language generation | [optional] [default to '']

package/docs/SeekStreamParams.md

@@ -0,0 +1,7 @@
+# NeuralSeek.SeekStreamParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The parameter name | [optional] [default to '']
+**value** | **String** | The parameter value | [optional] [default to '']

package/docs/SeekStreamUserSession.md

@@ -0,0 +1,7 @@
+# NeuralSeek.SeekStreamUserSession
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**SeekStreamUserSessionMetadata**](SeekStreamUserSessionMetadata.md) |  | [optional] 
+**system** | [**SeekStreamUserSessionSystem**](SeekStreamUserSessionSystem.md) |  | [optional] 

package/docs/SeekStreamUserSessionMetadata.md

@@ -0,0 +1,6 @@
+# NeuralSeek.SeekStreamUserSessionMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **String** | A unique user identifier. | [optional] [default to '']

package/docs/SeekStreamUserSessionSystem.md

@@ -0,0 +1,6 @@
+# NeuralSeek.SeekStreamUserSessionSystem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sessionId** | **String** | A session identifier for the defined user. | [optional] [default to '']

package/docs/ServiceTestApi.md

@@ -0,0 +1,46 @@
+# NeuralSeek.ServiceTestApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**servicetest**](ServiceTestApi.md#servicetest) | **GET** /test | Service check
+
+<a name="servicetest"></a>
+# **servicetest**
+> servicetest()
+
+Service check
+
+Responds 200
+
+### Example
+```javascript
+import {NeuralSeek} from 'neuralSeek';
+
+let apiInstance = new NeuralSeek.ServiceTestApi();
+apiInstance.servicetest((error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+

package/docs/TestBody.md

@@ -0,0 +1,6 @@
+# NeuralSeek.TestBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **Blob** |  | [optional] 

package/docs/TestBody1.md

@@ -0,0 +1,6 @@
+# NeuralSeek.TestBody1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**proposalID** | **String** | An optional Proposal ID to use for the test | [optional] [default to '']

package/docs/TestQuestionsApi.md

@@ -0,0 +1,107 @@
+# NeuralSeek.TestQuestionsApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getTestResults**](TestQuestionsApi.md#getTestResults) | **GET** /getTestResults | Get Test Results
+[**test**](TestQuestionsApi.md#test) | **POST** /test | Test questions via batch upload
+
+<a name="getTestResults"></a>
+# **getTestResults**
+> getTestResults()
+
+Get Test Results
+
+Retrieve an results from the test endpoint
+
+### 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.TestQuestionsApi();
+apiInstance.getTestResults((error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+<a name="test"></a>
+# **test**
+> test(opts)
+
+Test questions via batch upload
+
+Test questions via batch upload
+
+### 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.TestQuestionsApi();
+let opts = { 
+  'file': "file_example", // Blob | 
+  'body': new NeuralSeek.TestBody1() // TestBody1 | The questions csv.  Must adhere to the template https://api.neuralseek.com/q.csv After upload you will receive a 202 response and the server will begin processing.  Check for your completed results on the getTestResults endpoint.
+};
+apiInstance.test(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **Blob**|  | [optional] 
+ **body** | [**TestBody1**](TestBody1.md)| The questions csv.  Must adhere to the template https://api.neuralseek.com/q.csv After upload you will receive a 202 response and the server will begin processing.  Check for your completed results on the getTestResults endpoint. | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data, application/json
+ - **Accept**: Not defined
+

package/docs/TrainBody.md

@@ -0,0 +1,7 @@
+# NeuralSeek.TrainBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**train** | **String** | The training token. Get this from passages/train | [optional] [default to '']
+**score** | **Number** | The relevancy score. An integer, 0-100 | [optional] 

package/docs/TrainKBApi.md

@@ -0,0 +1,58 @@
+# NeuralSeek.TrainKBApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**train**](TrainKBApi.md#train) | **POST** /train | Submit KnowledgeBase Training
+
+<a name="train"></a>
+# **train**
+> train(body)
+
+Submit KnowledgeBase Training
+
+Submit KnowledgeBase Training
+
+### 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.TrainKBApi();
+let body = new NeuralSeek.TrainBody(); // TrainBody | The request object.  Must include the question and a context.
+
+apiInstance.train(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TrainBody**](TrainBody.md)| The request object.  Must include the question and a context. | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+