neuralseek 1.0.1

package/docs/MAIstroAgentRatingsApi.md

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

package/docs/MAIstroApi.md

@@ -0,0 +1,367 @@
+# NeuralSeek.MAIstroApi
+
+All URIs are relative to *https://api.neuralseek.com/v1/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**chat**](MAIstroApi.md#chat) | **POST** /chat/completions | Chat Completions - compatible mAIStro endpoint
+[**maistro**](MAIstroApi.md#maistro) | **POST** /maistro | Run mAistro NTL or agent
+[**maistroAgentGet**](MAIstroApi.md#maistroAgentGet) | **GET** /maistro/{agent} | Run a mAIstro agent via GET
+[**maistroBatch**](MAIstroApi.md#maistroBatch) | **POST** /maistro_batch | Call mAIstro NTL or an agent via batch
+[**maistroBatchDelete**](MAIstroApi.md#maistroBatchDelete) | **DELETE** /maistro_batch | Cancel current mAIstro batch run
+[**maistroBatchGet**](MAIstroApi.md#maistroBatchGet) | **GET** /maistro_batch | Get mAIstro batch results
+[**maistroStream**](MAIstroApi.md#maistroStream) | **POST** /maistro_stream | Stream mAIstro NTL or an agent
+
+<a name="chat"></a>
+# **chat**
+> InlineResponse2004 chat(opts)
+
+Chat Completions - compatible mAIStro endpoint
+
+Call a mAIstro agent using the openAI chat completions schema.
+
+### 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.MAIstroApi();
+let opts = { 
+  'body': new NeuralSeek.ChatCompletionsBody(), // ChatCompletionsBody | 
+  'runid': "runid_example" // String | Optional header to specify the run ID
+};
+apiInstance.chat(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ChatCompletionsBody**](ChatCompletionsBody.md)|  | [optional] 
+ **runid** | **String**| Optional header to specify the run ID | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/event-stream
+
+<a name="maistro"></a>
+# **maistro**
+> InlineResponse2002 maistro(body, opts)
+
+Run mAistro NTL or agent
+
+Freeform prompting using NeuralSeek Template Language or a saved agent
+
+### 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.MAIstroApi();
+let body = new NeuralSeek.MaistroBody(); // MaistroBody | The request object.
+let opts = { 
+  'overrideschema': "", // String | Find variables based on post body.  Return all variables as the base presponse body, overriding the normal NS schema. All POST options will be ignored. Set this to a string value of 'true' to activate
+  'overrideagent': "", // String | If using overrideSchema you must pass your agent name here. All other POST options will be ignored.
+  'debug': "" // String | Include NS debug information in a field named 'neuralseek'. Set this to a string value of 'true' to activate
+};
+apiInstance.maistro(body, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MaistroBody**](MaistroBody.md)| The request object. | 
+ **overrideschema** | **String**| Find variables based on post body.  Return all variables as the base presponse body, overriding the normal NS schema. All POST options will be ignored. Set this to a string value of &#x27;true&#x27; to activate | [optional] 
+ **overrideagent** | **String**| If using overrideSchema you must pass your agent name here. All other POST options will be ignored. | [optional] 
+ **debug** | **String**| Include NS debug information in a field named &#x27;neuralseek&#x27;. Set this to a string value of &#x27;true&#x27; to activate | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="maistroAgentGet"></a>
+# **maistroAgentGet**
+> InlineResponse2002 maistroAgentGet(agent, opts)
+
+Run a mAIstro agent via GET
+
+Run a mAIstro agent via GET
+
+### 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.MAIstroApi();
+let agent = "agent_example"; // String | The saved mAIstro agent to run
+let opts = { 
+  'params': "params_example" // String | Pass your mAIstro params as query parameters in simple name=value format
+};
+apiInstance.maistroAgentGet(agent, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **agent** | **String**| The saved mAIstro agent to run | 
+ **params** | **String**| Pass your mAIstro params as query parameters in simple name&#x3D;value format | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a name="maistroBatch"></a>
+# **maistroBatch**
+> maistroBatch(body)
+
+Call mAIstro NTL or an agent via batch
+
+Freeform prompting using NeuralSeek Template Language or a saved agent run in batch mode
+
+### 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.MAIstroApi();
+let body = new NeuralSeek.MaistroBatchBody(); // MaistroBatchBody | The request object.
+
+apiInstance.maistroBatch(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MaistroBatchBody**](MaistroBatchBody.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="maistroBatchDelete"></a>
+# **maistroBatchDelete**
+> maistroBatchDelete()
+
+Cancel current mAIstro batch run
+
+Cancel current mAIstro batch run
+
+### 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.MAIstroApi();
+apiInstance.maistroBatchDelete((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="maistroBatchGet"></a>
+# **maistroBatchGet**
+> InlineResponse2002 maistroBatchGet()
+
+Get mAIstro batch results
+
+Retrieve results from a mAIstro batch run
+
+### 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.MAIstroApi();
+apiInstance.maistroBatchGet((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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a name="maistroStream"></a>
+# **maistroStream**
+> InlineResponse2003 maistroStream(body)
+
+Stream mAIstro NTL or an agent
+
+Freeform prompting using NeuralSeek Template Language or a saved agent
+
+### 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.MAIstroApi();
+let body = new NeuralSeek.MaistroStreamBody(); // MaistroStreamBody | The request object.
+
+apiInstance.maistroStream(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MaistroStreamBody**](MaistroStreamBody.md)| The request object. | 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/event-stream
+

package/docs/MaistroBatchBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.MaistroBatchBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ntl** | **String** | The NTL script to evaluate.  Include either this or agent - not both | [optional] [default to '']
+**agent** | **String** | The agent to use. Include either this or NTL | [optional] [default to '']
+**params** | [**[SeekStreamParams]**](SeekStreamParams.md) | An array of parameters to use in evaluation of the NTL | [optional] 
+**options** | [**MaistroStreamOptions**](MaistroStreamOptions.md) |  | [optional] 

package/docs/MaistroBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.MaistroBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ntl** | **String** | The NTL script to evaluate.  Include either this or agent - not both | [optional] [default to '']
+**agent** | **String** | The agent to use. Include either this or NTL | [optional] [default to '']
+**params** | [**[SeekStreamParams]**](SeekStreamParams.md) | An array of parameters to use in evaluation of the NTL | [optional] 
+**options** | [**MaistroOptions**](MaistroOptions.md) |  | [optional] 

package/docs/MaistroOptions.md

@@ -0,0 +1,20 @@
+# NeuralSeek.MaistroOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**llm** | **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 '']
+**userId** | **String** | Set the user_id. Useful and required if you have a corporate document filter set | [optional] [default to '']
+**timeout** | **Number** | Timeout in miliseconds. (optional) | [optional] 
+**temperatureMod** | **Number** | Shift the model's baseline temperature weighting by a percentage | [optional] 
+**toppMod** | **Number** | Shift the model's baseline probability weighting by a percentage | [optional] 
+**freqpenaltyMod** | **Number** | Shift the model's baseline frequency penalty weighting by a percentage | [optional] 
+**minTokens** | **Number** | Set the minimum tokens you  want the model to produce | [optional] 
+**maxTokens** | **Number** | Set the maximum tokens you  want the model to produce | [optional] 
+**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] 
+**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]
+**returnRender** | **Boolean** | Return the midstate renders | [optional] [default to false]
+**returnSource** | **Boolean** | Return the source parts | [optional] [default to false]
+**maxRecursion** | **Number** | The maximum number of recursive calls to Explore.  Use caution that you have not created an endless loop as you increase the maximum, as each Explore is charged. | [optional] [default to 10]

package/docs/MaistroRateBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.MaistroRateBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent** | **String** | The Agent | [optional] 
+**runId** | **Number** | The runId | [optional] 
+**score** | **Number** | The rating score. An integer, 0-5. 0 is worst, 5 is best.  For Thumbs up / Thumbs down send 0 or 5 | [optional] 
+**feedback** | **String** | text feedback on the answer | [optional] 

package/docs/MaistroRatingsBody.md

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

package/docs/MaistroStreamBody.md

@@ -0,0 +1,9 @@
+# NeuralSeek.MaistroStreamBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ntl** | **String** | The NTL script to evaluate.  Include either this or agent - not both | [optional] [default to '']
+**agent** | **String** | The agent to use. Include either this or NTL | [optional] [default to '']
+**params** | [**[SeekStreamParams]**](SeekStreamParams.md) | An array of parameters to use in evaluation of the NTL | [optional] 
+**options** | [**MaistroStreamOptions**](MaistroStreamOptions.md) |  | [optional] 

package/docs/MaistroStreamOptions.md

@@ -0,0 +1,19 @@
+# NeuralSeek.MaistroStreamOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**llm** | **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 '']
+**userId** | **String** | Set the user_id. Useful and required if you have a corporate document filter set | [optional] [default to '']
+**timeout** | **Number** | Timeout in miliseconds. (optional) | [optional] 
+**temperatureMod** | **Number** | Shift the model's baseline temperature weighting by a percentage | [optional] 
+**toppMod** | **Number** | Shift the model's baseline probability weighting by a percentage | [optional] 
+**freqpenaltyMod** | **Number** | Shift the model's baseline frequency penalty weighting by a percentage | [optional] 
+**minTokens** | **Number** | Set the minimum tokens you  want the model to produce | [optional] 
+**maxTokens** | **Number** | Set the maximum tokens you  want the model to produce | [optional] 
+**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] 
+**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]
+**returnRender** | **Boolean** | Return the midstate renders | [optional] [default to false]
+**returnSource** | **Boolean** | Return the source parts | [optional] [default to false]
+**maxRecursion** | **Number** | The maximum number of recursive calls to Explore.  Use caution that you have not created an endless loop as you increase the maximum, as each Explore is charged. | [optional] [default to 10]

package/docs/PiiBody.md

@@ -0,0 +1,6 @@
+# NeuralSeek.PiiBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The user utterance to check for PII | [optional] [default to '']

package/docs/RateBody.md

@@ -0,0 +1,8 @@
+# NeuralSeek.RateBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answerId** | **Number** | The answer id | [optional] 
+**score** | **Number** | The rating score. An integer, 0-5. 0 is worst, 5 is best.  For Thumbs up / Thumbs down send 0 or 5 | [optional] 
+**feedback** | **String** | text feedback on the answer | [optional] 

package/docs/ScoreBody.md

@@ -0,0 +1,7 @@
+# NeuralSeek.ScoreBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The text to score | [optional] [default to '']
+**passages** | **[String]** | The rating score. An integer, 0-5. 0 is worst, 5 is best.  For Thumbs up / Thumbs down send 0 or 5 | [optional] 

package/docs/Seek.md

@@ -0,0 +1,9 @@
+# NeuralSeek.Seek
+
+## 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** | [**SeekOptions**](SeekOptions.md) |  | [optional]