neuralseek 1.0.1

package/docs/GuardrailsApi.md

@@ -0,0 +1,109 @@
+# NeuralSeek.GuardrailsApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pii**](GuardrailsApi.md#pii) | **POST** /pii | Find PII in a user utterance
+[**score**](GuardrailsApi.md#score) | **POST** /score | Run the Semantic Scoring model on text against an array of passages
+
+<a name="pii"></a>
+# **pii**
+> [InlineResponse20010] pii(body)
+
+Find PII in a user utterance
+
+Find PII in a user utterance
+
+### 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.GuardrailsApi();
+let body = new NeuralSeek.PiiBody(); // PiiBody | The request object.
+
+apiInstance.pii(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PiiBody**](PiiBody.md)| The request object. | 
+
+### Return type
+
+[**[InlineResponse20010]**](InlineResponse20010.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="score"></a>
+# **score**
+> score(body)
+
+Run the Semantic Scoring model on text against an array of passages
+
+Run the Semantic Scoring model on text against an array of passages
+
+### 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.GuardrailsApi();
+let body = new NeuralSeek.ScoreBody(); // ScoreBody | The request object.  Must include the question and a context.
+
+apiInstance.score(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ScoreBody**](ScoreBody.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
+

package/docs/IdentifysingleBody.md

@@ -0,0 +1,6 @@
+# NeuralSeek.IdentifysingleBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **String** | The input text to identify the language of | [optional] [default to '']

package/docs/InlineResponse200.md

@@ -0,0 +1,6 @@
+# NeuralSeek.InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**SeekResponse**](SeekResponse.md) |  | 

package/docs/InlineResponse2001.md

@@ -0,0 +1,8 @@
+# NeuralSeek.InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Number** | The average score for the answer. | [optional] 
+**total** | **Number** | The total number of user ratings for the answer. | [optional] 
+**feedback** | **String** | User feedback | [optional] 

package/docs/InlineResponse20010.md

@@ -0,0 +1,6 @@
+# NeuralSeek.InlineResponse20010
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pii** | **[String]** | An array of found PII | [optional] 

package/docs/InlineResponse20011.md

@@ -0,0 +1,9 @@
+# NeuralSeek.InlineResponse20011
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_date** | **String** | The timestamp of the entry | [optional] [default to '']
+**question** | **String** | The user question | [optional] [default to '']
+**answer** | **String** | The answer returned | [optional] [default to '']
+**id** | **Number** | The answer id | [optional] 

package/docs/InlineResponse20012.md

@@ -0,0 +1,7 @@
+# NeuralSeek.InlineResponse20012
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** |  | [optional] 
+**message** | **String** |  | [optional] 

package/docs/InlineResponse20013.md

@@ -0,0 +1,6 @@
+# NeuralSeek.InlineResponse20013
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**otp** | **String** | The one time password | [optional] [default to '']

package/docs/InlineResponse2002.md

@@ -0,0 +1,10 @@
+# NeuralSeek.InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answer** | **String** | The generated response | [optional] [default to '']
+**sourceParts** | **[String]** |  | [optional] 
+**render** | [**[InlineResponse2002Render]**](InlineResponse2002Render.md) | The steps used to render the result. | [optional] 
+**variables** | **Object** | The returned variable. | [optional] 
+**variablesExpanded** | [**[SeekResponseVariablesExpanded]**](SeekResponseVariablesExpanded.md) | The returned variable, in the format of the input params | [optional] 

package/docs/InlineResponse2002Render.md

@@ -0,0 +1,9 @@
+# NeuralSeek.InlineResponse2002Render
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**node** | **String** | The node type | [optional] [default to '']
+**vars** | **Object** | The variable values | [optional] 
+**out** | **String** | The output | [optional] [default to '']
+**chained** | **Boolean** | True if the step is chained | [optional] 

package/docs/InlineResponse2003.md

@@ -0,0 +1,6 @@
+# NeuralSeek.InlineResponse2003
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**InlineResponse2003Data**](InlineResponse2003Data.md) |  | 

package/docs/InlineResponse2003Data.md

@@ -0,0 +1,10 @@
+# NeuralSeek.InlineResponse2003Data
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answer** | **String** | The generated response | [optional] [default to '']
+**sourceParts** | **[String]** |  | [optional] 
+**render** | [**[InlineResponse2002Render]**](InlineResponse2002Render.md) | The steps used to render the result. | [optional] 
+**variables** | **Object** | The returned variable. | [optional] 
+**variablesExpanded** | [**[SeekResponseVariablesExpanded]**](SeekResponseVariablesExpanded.md) | The returned variable, in the format of the input params | [optional] 

package/docs/InlineResponse2004.md

@@ -0,0 +1,10 @@
+# NeuralSeek.InlineResponse2004
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the completion | [optional] 
+**_object** | **String** | The type of object returned, should be 'chat.completion' | [optional] 
+**created** | **Number** | Timestamp of when the completion was created | [optional] 
+**model** | **String** | The model used for generating the completion | [optional] 
+**choices** | [**[InlineResponse2004Choices]**](InlineResponse2004Choices.md) |  | [optional] 

package/docs/InlineResponse2004Choices.md

@@ -0,0 +1,8 @@
+# NeuralSeek.InlineResponse2004Choices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Number** | The index of the choice | [optional] 
+**message** | [**InlineResponse2004Message**](InlineResponse2004Message.md) |  | [optional] 
+**finishReason** | **String** | The reason the message generation finished | [optional] 

package/docs/InlineResponse2004Message.md

@@ -0,0 +1,14 @@
+# NeuralSeek.InlineResponse2004Message
+
+## 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"`)
+

package/docs/InlineResponse2005.md

@@ -0,0 +1,9 @@
+# NeuralSeek.InlineResponse2005
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**intent** | **String** | The matched Intent | [optional] [default to '']
+**category** | **String** | The matched Category | [optional] [default to '']
+**categoryId** | **Number** | The Category id | [optional] 
+**topIntents** | [**InlineResponse2005TopIntents**](InlineResponse2005TopIntents.md) |  | [optional] 

package/docs/InlineResponse2005TopIntents.md

@@ -0,0 +1,7 @@
+# NeuralSeek.InlineResponse2005TopIntents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Number** | The score of the intent | [optional] 
+**intent** | **String** | The intent name | [optional] [default to '']

package/docs/InlineResponse2006.md

@@ -0,0 +1,9 @@
+# NeuralSeek.InlineResponse2006
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**extractedEntities** | [**[InlineResponse2006ExtractedEntities]**](InlineResponse2006ExtractedEntities.md) |  | [optional] 
+**complete** | **Boolean** | If slots are passed, complete will be set to true when all slots are filled | [optional] [default to false]
+**promptEntity** | **String** | A message to display to the user asking them to provide input for the next group of unfilled slots. | [optional] 
+**slots** | **Object** | If the slots parameter is filled on the input, NeuralSeek will return it and begin filling the value fields. 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] 

package/docs/InlineResponse2006ExtractedEntities.md

@@ -0,0 +1,6 @@
+# NeuralSeek.InlineResponse2006ExtractedEntities
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **String** | The found entity | [optional] [default to '']

package/docs/InlineResponse2007.md

@@ -0,0 +1,12 @@
+# NeuralSeek.InlineResponse2007
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wordCount** | **Number** | The word count. | [optional] 
+**characterCount** | **Number** | The word count. | [optional] 
+**detectedLanguage** | **String** | The 2-digit language code for the detected language. | [optional] [default to '']
+**detectedLanguageConfidence** | **Number** | The detected language confidence. | [optional] 
+**translationGlossary** | **Boolean** | Returns true if a glossary is loaded and matched any input. | [optional] 
+**translationGlossaryExact** | **Boolean** | Returns true if a glossary is loaded and an entry exactly matched the input. | [optional] 
+**translations** | [**[InlineResponse2007Translations]**](InlineResponse2007Translations.md) |  | [optional] 

package/docs/InlineResponse2007Translations.md

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

package/docs/InlineResponse2008.md

@@ -0,0 +1,7 @@
+# NeuralSeek.InlineResponse2008
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | The 2-character language code of the identified language. | [optional] [default to '']
+**confidence** | **Number** | The confidence of the language identification. | [optional] 

package/docs/InlineResponse2009.md

@@ -0,0 +1,7 @@
+# NeuralSeek.InlineResponse2009
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | The 2-character language code of the identified language. | [optional] [default to '']
+**confidence** | **Number** | The confidence of the language identification | [optional] 

package/docs/KeysApi.md

@@ -0,0 +1,99 @@
+# NeuralSeek.KeysApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**keycheck**](KeysApi.md#keycheck) | **POST** /keycheck | Validate an api key
+[**otp**](KeysApi.md#otp) | **POST** /otp | Create a One Time Password
+
+<a name="keycheck"></a>
+# **keycheck**
+> keycheck()
+
+Validate an api key
+
+Validate an api key
+
+### 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.KeysApi();
+apiInstance.keycheck((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="otp"></a>
+# **otp**
+> InlineResponse20013 otp()
+
+Create a One Time Password
+
+Create a One Time Password for use instead of an api key in unsecure environments, such as the browser. The password will expire after one use, and is valid for 30 minutes. This password can only be used for seek, mAIstro, extract, categorize, score, and logs operations.
+
+### 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.KeysApi();
+apiInstance.otp((error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse20013**](InlineResponse20013.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+

package/docs/LogExternalAgentBody.md

@@ -0,0 +1,11 @@
+# NeuralSeek.LogExternalAgentBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**runId** | **Number** | Unique numeric identifier for the execution run | 
+**templateName** | **String** | Name of the Agent being executed | 
+**user** | **String** | User identifier who initiated the execution | 
+**time** | **Number** | The total time of the Agent run in ms | [optional] 
+**resultsLink** | **String** | Link to detailed execution results | 
+**entries** | [**[LogExternalAgentEntries]**](LogExternalAgentEntries.md) |  | 

package/docs/LogExternalAgentEntries.md

@@ -0,0 +1,34 @@
+# NeuralSeek.LogExternalAgentEntries
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**llmtime** | **Number** | The LLM time in ms | [optional] 
+**inputtokencount** | **Number** | Number of input tokens | [optional] 
+**generatedtokencount** | **Number** | Number of generated tokens | [optional] 
+**llm** | **String** | LLM model identifier | [optional] 
+**llmcode** | **String** | LLM specific code | [optional] 
+**kbtime** | **Number** | Knowledge base processing time in ms | [optional] 
+**kb** | **String** | Knowledge base identifier | [optional] 
+**kbScore** | **Number** | Knowledge base relevance score | [optional] 
+**kbCoverage** | **Number** | Knowledge base coverage percentage | [optional] 
+**elementTime** | **Number** | Time taken for element processing in ms | [optional] 
+**element** | **String** | Type of element being timed | [optional] 
+
+<a name="TypeEnum"></a>
+## Enum: TypeEnum
+
+* `lLMTime` (value: `"LLMTime"`)
+* `lLMCacheTime` (value: `"LLMCacheTime"`)
+* `kBTime` (value: `"KBTime"`)
+* `elementTime` (value: `"ElementTime"`)
+
+
+<a name="ElementEnum"></a>
+## Enum: ElementEnum
+
+* `model` (value: `"model"`)
+* `rest` (value: `"rest"`)
+* `database` (value: `"database"`)
+

package/docs/LogsApi.md

@@ -0,0 +1,110 @@
+# NeuralSeek.LogsApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**logExternalAgent**](LogsApi.md#logExternalAgent) | **POST** /logExternalAgent | Log external agent execution details
+[**logs**](LogsApi.md#logs) | **POST** /logs | Instance Logs
+
+<a name="logExternalAgent"></a>
+# **logExternalAgent**
+> InlineResponse20012 logExternalAgent(body)
+
+Log external agent execution details
+
+Records various timing and performance metrics for external agent execution
+
+### 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.LogsApi();
+let body = new NeuralSeek.LogExternalAgentBody(); // LogExternalAgentBody | 
+
+apiInstance.logExternalAgent(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**LogExternalAgentBody**](LogExternalAgentBody.md)|  | 
+
+### Return type
+
+[**InlineResponse20012**](InlineResponse20012.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="logs"></a>
+# **logs**
+> [InlineResponse20011] logs(opts)
+
+Instance Logs
+
+Retrieve logs 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.LogsApi();
+let opts = { 
+  'body': new NeuralSeek.LogsBody() // LogsBody | The request object.
+};
+apiInstance.logs(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**LogsBody**](LogsBody.md)| The request object. | [optional] 
+
+### Return type
+
+[**[InlineResponse20011]**](InlineResponse20011.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+

package/docs/LogsBody.md

@@ -0,0 +1,8 @@
+# NeuralSeek.LogsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Number** | The number of rows to return, max of 100 | [optional] [default to 100]
+**skip** | **Number** | The number of result sets to skip for paging | [optional] [default to 0]
+**search** | **String** | An optional search string | [optional] [default to '']