neuralseekui 1.0.0

package/docs/IntentsApi.md

@@ -0,0 +1,364 @@
+# NeuralSeekUi.IntentsApi
+
+All URIs are relative to *https://console.neuralseek.com/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add**](IntentsApi.md#add) | **POST** /addIntent | Add an Intent
+[**callDelete**](IntentsApi.md#callDelete) | **POST** /delUserData | Delete Intents / Data
+[**examples**](IntentsApi.md#examples) | **POST** /loadUserResponse | Add Intent Examples
+[**flag**](IntentsApi.md#flag) | **POST** /flag | Flag an Intent
+[**merge**](IntentsApi.md#merge) | **POST** /merge | Merge Intents
+[**rename**](IntentsApi.md#rename) | **POST** /ren | Rename an Intent
+[**unMerge**](IntentsApi.md#unMerge) | **POST** /unmerge | UnMerge Intents
+
+<a name="add"></a>
+# **add**
+> add(body)
+
+Add an Intent
+
+Add an Intent
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.AddIntentBody(); // AddIntentBody | The request object.
+
+apiInstance.add(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AddIntentBody**](AddIntentBody.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
+
+<a name="callDelete"></a>
+# **callDelete**
+> callDelete(body)
+
+Delete Intents / Data
+
+Delete intents or broader datasets
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.DelUserDataBody(); // DelUserDataBody | The request object.
+
+apiInstance.callDelete(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DelUserDataBody**](DelUserDataBody.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
+
+<a name="examples"></a>
+# **examples**
+> examples(body)
+
+Add Intent Examples
+
+Add Intent Examples
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.LoadUserResponseBody(); // LoadUserResponseBody | The request object.
+
+apiInstance.examples(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**LoadUserResponseBody**](LoadUserResponseBody.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
+
+<a name="flag"></a>
+# **flag**
+> flag(body)
+
+Flag an Intent
+
+Flag an Intent
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.FlagBody(); // FlagBody | The request object.
+
+apiInstance.flag(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**FlagBody**](FlagBody.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
+
+<a name="merge"></a>
+# **merge**
+> merge(body)
+
+Merge Intents
+
+Merge Intents
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.MergeBody(); // MergeBody | The request object.
+
+apiInstance.merge(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MergeBody**](MergeBody.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
+
+<a name="rename"></a>
+# **rename**
+> rename(body)
+
+Rename an Intent
+
+Rename an Intent
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.RenBody(); // RenBody | The request object.
+
+apiInstance.rename(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RenBody**](RenBody.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
+
+<a name="unMerge"></a>
+# **unMerge**
+> unMerge(body)
+
+UnMerge Intents
+
+UnMerge Intents
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.IntentsApi();
+let body = new NeuralSeekUi.UnmergeBody(); // UnmergeBody | The request object.
+
+apiInstance.unMerge(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UnmergeBody**](UnmergeBody.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/LoadUserResponseBody.md

@@ -0,0 +1,7 @@
+# NeuralSeekUi.LoadUserResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**intent** | **String** | The new Intent name | [optional] [default to '']
+**examples** | **String** | One or more example user questions, separated by a \\n | [optional] [default to '']

package/docs/MAIstroApi.md

@@ -0,0 +1,265 @@
+# NeuralSeekUi.MAIstroApi
+
+All URIs are relative to *https://console.neuralseek.com/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**exploreFiles**](MAIstroApi.md#exploreFiles) | **POST** /exploreFiles | List Maistro Files
+[**exploreUpload**](MAIstroApi.md#exploreUpload) | **POST** /exploreUpload | Upload a file to mAIstro
+[**fdel**](MAIstroApi.md#fdel) | **POST** /fdel | Delete Maistro File(s)
+[**maistroFiles**](MAIstroApi.md#maistroFiles) | **POST** /maistroFiles | List Maistro Files (paginated)
+[**maistroOCR**](MAIstroApi.md#maistroOCR) | **POST** /maistroOCR | OCR upload to mAIstro
+
+<a name="exploreFiles"></a>
+# **exploreFiles**
+> exploreFiles(opts)
+
+List Maistro Files
+
+List Maistro Files
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.MAIstroApi();
+let opts = { 
+  'body': new NeuralSeekUi.ExploreFilesBody() // ExploreFilesBody | 
+};
+apiInstance.exploreFiles(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ExploreFilesBody**](ExploreFilesBody.md)|  | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="exploreUpload"></a>
+# **exploreUpload**
+> exploreUpload(opts)
+
+Upload a file to mAIstro
+
+Upload a file to mAIstro.
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.MAIstroApi();
+let opts = { 
+  'file': "file_example" // Blob | 
+};
+apiInstance.exploreUpload(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **Blob**|  | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: Not defined
+
+<a name="fdel"></a>
+# **fdel**
+> fdel(body)
+
+Delete Maistro File(s)
+
+Delete one or more Maistro files
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.MAIstroApi();
+let body = new NeuralSeekUi.FdelBody(); // FdelBody | The request object.
+
+apiInstance.fdel(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**FdelBody**](FdelBody.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
+
+<a name="maistroFiles"></a>
+# **maistroFiles**
+> maistroFiles(opts)
+
+List Maistro Files (paginated)
+
+Paginated and searchable list of mAIstro files
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.MAIstroApi();
+let opts = { 
+  'body': new NeuralSeekUi.MaistroFilesBody() // MaistroFilesBody | 
+};
+apiInstance.maistroFiles(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MaistroFilesBody**](MaistroFilesBody.md)|  | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="maistroOCR"></a>
+# **maistroOCR**
+> maistroOCR(file)
+
+OCR upload to mAIstro
+
+Upload a file and extract OCR text for mAIstro
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.MAIstroApi();
+let file = "file_example"; // Blob | 
+
+apiInstance.maistroOCR(file, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **Blob**|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: Not defined
+

package/docs/MaistroFilesBody.md

@@ -0,0 +1,8 @@
+# NeuralSeekUi.MaistroFilesBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**search** | **String** |  | [optional] 
+**page** | **Number** |  | [optional] [default to 0]
+**limit** | **Number** |  | [optional] [default to 100]

package/docs/MaistroOCRBody.md

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

package/docs/MergeBody.md

@@ -0,0 +1,7 @@
+# NeuralSeekUi.MergeBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**intent** | **String** | The Intent name to use as the final once merged. This Intent name must be part of the rows array | [optional] [default to '']
+**rows** | **[String]** |  | 

package/docs/QuestionsApi.md

@@ -0,0 +1,58 @@
+# NeuralSeekUi.QuestionsApi
+
+All URIs are relative to *https://console.neuralseek.com/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**deleteQuestion**](QuestionsApi.md#deleteQuestion) | **POST** /delQuestion | Delete Question
+
+<a name="deleteQuestion"></a>
+# **deleteQuestion**
+> deleteQuestion(body)
+
+Delete Question
+
+Delete Question
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.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 NeuralSeekUi.QuestionsApi();
+let body = new NeuralSeekUi.DelQuestionBody(); // DelQuestionBody | The request object.
+
+apiInstance.deleteQuestion(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DelQuestionBody**](DelQuestionBody.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
+