neuralseek 1.0.1

package/src/model/SeekResponsePassages.js

@@ -0,0 +1,99 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+
+/**
+ * The SeekResponsePassages model module.
+ * @module model/SeekResponsePassages
+ * @version 1.0.1
+ */
+export default class SeekResponsePassages {
+  /**
+   * Constructs a new <code>SeekResponsePassages</code>.
+   * @alias module:model/SeekResponsePassages
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekResponsePassages</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekResponsePassages} obj Optional instance to populate.
+   * @return {module:model/SeekResponsePassages} The populated <code>SeekResponsePassages</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekResponsePassages();
+      if (data.hasOwnProperty('passage'))
+        obj.passage = ApiClient.convertToType(data['passage'], 'String');
+      if (data.hasOwnProperty('id'))
+        obj.id = ApiClient.convertToType(data['id'], 'String');
+      if (data.hasOwnProperty('score'))
+        obj.score = ApiClient.convertToType(data['score'], 'Number');
+      if (data.hasOwnProperty('url'))
+        obj.url = ApiClient.convertToType(data['url'], 'String');
+      if (data.hasOwnProperty('document'))
+        obj.document = ApiClient.convertToType(data['document'], 'String');
+      if (data.hasOwnProperty('train'))
+        obj.train = ApiClient.convertToType(data['train'], 'String');
+    }
+    return obj;
+  }
+}
+
+/**
+ * The passage text, summarized to the length set by sourceResultsSummaryLength
+ * @member {String} passage
+ * @default ''
+ */
+SeekResponsePassages.prototype.passage = '';
+
+/**
+ * The id of the source document in the KB.
+ * @member {String} id
+ * @default ''
+ */
+SeekResponsePassages.prototype.id = '';
+
+/**
+ * The score of the passage.
+ * @member {Number} score
+ */
+SeekResponsePassages.prototype.score = undefined;
+
+/**
+ * The URL (if available) of the source document.
+ * @member {String} url
+ * @default ''
+ */
+SeekResponsePassages.prototype.url = '';
+
+/**
+ * The name of the source document.
+ * @member {String} document
+ * @default ''
+ */
+SeekResponsePassages.prototype.document = '';
+
+/**
+ * The training token for the document. Use this when calling the /train endpoint.
+ * @member {String} train
+ * @default ''
+ */
+SeekResponsePassages.prototype.train = '';
+

package/src/model/SeekResponseVariablesExpanded.js

@@ -0,0 +1,64 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+
+/**
+ * The SeekResponseVariablesExpanded model module.
+ * @module model/SeekResponseVariablesExpanded
+ * @version 1.0.1
+ */
+export default class SeekResponseVariablesExpanded {
+  /**
+   * Constructs a new <code>SeekResponseVariablesExpanded</code>.
+   * @alias module:model/SeekResponseVariablesExpanded
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekResponseVariablesExpanded</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekResponseVariablesExpanded} obj Optional instance to populate.
+   * @return {module:model/SeekResponseVariablesExpanded} The populated <code>SeekResponseVariablesExpanded</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekResponseVariablesExpanded();
+      if (data.hasOwnProperty('name'))
+        obj.name = ApiClient.convertToType(data['name'], 'String');
+      if (data.hasOwnProperty('value'))
+        obj.value = ApiClient.convertToType(data['value'], 'String');
+    }
+    return obj;
+  }
+}
+
+/**
+ * The variable name
+ * @member {String} name
+ * @default ''
+ */
+SeekResponseVariablesExpanded.prototype.name = '';
+
+/**
+ * The variable value
+ * @member {String} value
+ * @default ''
+ */
+SeekResponseVariablesExpanded.prototype.value = '';
+

package/src/model/SeekStreamBody.js

@@ -0,0 +1,82 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+import SeekStreamOptions from './SeekStreamOptions';
+import SeekStreamParams from './SeekStreamParams';
+import SeekStreamUserSession from './SeekStreamUserSession';
+
+/**
+ * The SeekStreamBody model module.
+ * @module model/SeekStreamBody
+ * @version 1.0.1
+ */
+export default class SeekStreamBody {
+  /**
+   * Constructs a new <code>SeekStreamBody</code>.
+   * @alias module:model/SeekStreamBody
+   * @class
+   * @param question {String} The user's question for NeuralSeek
+   */
+  constructor(question) {
+    this.question = question;
+  }
+
+  /**
+   * Constructs a <code>SeekStreamBody</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekStreamBody} obj Optional instance to populate.
+   * @return {module:model/SeekStreamBody} The populated <code>SeekStreamBody</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekStreamBody();
+      if (data.hasOwnProperty('question'))
+        obj.question = ApiClient.convertToType(data['question'], 'String');
+      if (data.hasOwnProperty('user_session'))
+        obj.userSession = SeekStreamUserSession.constructFromObject(data['user_session']);
+      if (data.hasOwnProperty('params'))
+        obj.params = ApiClient.convertToType(data['params'], [SeekStreamParams]);
+      if (data.hasOwnProperty('options'))
+        obj.options = SeekStreamOptions.constructFromObject(data['options']);
+    }
+    return obj;
+  }
+}
+
+/**
+ * The user's question for NeuralSeek
+ * @member {String} question
+ * @default ''
+ */
+SeekStreamBody.prototype.question = '';
+
+/**
+ * @member {module:model/SeekStreamUserSession} userSession
+ */
+SeekStreamBody.prototype.userSession = undefined;
+
+/**
+ * An array of parameters to use in evaluation of the seek when calling mAIstro during a seek.
+ * @member {Array.<module:model/SeekStreamParams>} params
+ */
+SeekStreamBody.prototype.params = undefined;
+
+/**
+ * @member {module:model/SeekStreamOptions} options
+ */
+SeekStreamBody.prototype.options = undefined;
+

package/src/model/SeekStreamOptions.js

@@ -0,0 +1,207 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+import SeekStreamOptionsLastTurn from './SeekStreamOptionsLastTurn';
+import SeekStreamOptionsPersonalize from './SeekStreamOptionsPersonalize';
+
+/**
+ * The SeekStreamOptions model module.
+ * @module model/SeekStreamOptions
+ * @version 1.0.1
+ */
+export default class SeekStreamOptions {
+  /**
+   * Constructs a new <code>SeekStreamOptions</code>.
+   * Optional object for runtime override of Seek options.
+   * @alias module:model/SeekStreamOptions
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekStreamOptions</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekStreamOptions} obj Optional instance to populate.
+   * @return {module:model/SeekStreamOptions} The populated <code>SeekStreamOptions</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekStreamOptions();
+      if (data.hasOwnProperty('personalize'))
+        obj.personalize = SeekStreamOptionsPersonalize.constructFromObject(data['personalize']);
+      if (data.hasOwnProperty('proposalID'))
+        obj.proposalID = ApiClient.convertToType(data['proposalID'], 'String');
+      if (data.hasOwnProperty('seekLLM'))
+        obj.seekLLM = ApiClient.convertToType(data['seekLLM'], 'String');
+      if (data.hasOwnProperty('language'))
+        obj.language = ApiClient.convertToType(data['language'], 'String');
+      if (data.hasOwnProperty('filter'))
+        obj.filter = ApiClient.convertToType(data['filter'], 'String');
+      if (data.hasOwnProperty('lastTurn'))
+        obj.lastTurn = ApiClient.convertToType(data['lastTurn'], [SeekStreamOptionsLastTurn]);
+      if (data.hasOwnProperty('promptEngineering'))
+        obj.promptEngineering = ApiClient.convertToType(data['promptEngineering'], 'String');
+      if (data.hasOwnProperty('promptEngineeringPhrase'))
+        obj.promptEngineeringPhrase = ApiClient.convertToType(data['promptEngineeringPhrase'], 'String');
+      if (data.hasOwnProperty('answerLength'))
+        obj.answerLength = ApiClient.convertToType(data['answerLength'], 'Number');
+      if (data.hasOwnProperty('url'))
+        obj.url = ApiClient.convertToType(data['url'], 'String');
+      if (data.hasOwnProperty('stump'))
+        obj.stump = ApiClient.convertToType(data['stump'], 'String');
+      if (data.hasOwnProperty('includeSourceResults'))
+        obj.includeSourceResults = ApiClient.convertToType(data['includeSourceResults'], 'Boolean');
+      if (data.hasOwnProperty('includeHighlights'))
+        obj.includeHighlights = ApiClient.convertToType(data['includeHighlights'], 'Boolean');
+      if (data.hasOwnProperty('includeSourceResultsFormatted'))
+        obj.includeSourceResultsFormatted = ApiClient.convertToType(data['includeSourceResultsFormatted'], 'Boolean');
+      if (data.hasOwnProperty('sourceResultsNumber'))
+        obj.sourceResultsNumber = ApiClient.convertToType(data['sourceResultsNumber'], 'Number');
+      if (data.hasOwnProperty('sourceResultsSummaryLength'))
+        obj.sourceResultsSummaryLength = ApiClient.convertToType(data['sourceResultsSummaryLength'], 'Number');
+      if (data.hasOwnProperty('returnVariables'))
+        obj.returnVariables = ApiClient.convertToType(data['returnVariables'], 'Boolean');
+      if (data.hasOwnProperty('returnVariablesExpanded'))
+        obj.returnVariablesExpanded = ApiClient.convertToType(data['returnVariablesExpanded'], 'Boolean');
+    }
+    return obj;
+  }
+}
+
+/**
+ * @member {module:model/SeekStreamOptionsPersonalize} personalize
+ */
+SeekStreamOptions.prototype.personalize = undefined;
+
+/**
+ * Override all settings by passing a NeuralSeek Proposal ID.
+ * @member {String} proposalID
+ * @default ''
+ */
+SeekStreamOptions.prototype.proposalID = '';
+
+/**
+ * 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.
+ * @member {String} seekLLM
+ * @default ''
+ */
+SeekStreamOptions.prototype.seekLLM = '';
+
+/**
+ * Valid values are: en, es, de, it, fr, ja, ar
+ * @member {String} language
+ * @default ''
+ */
+SeekStreamOptions.prototype.language = '';
+
+/**
+ * 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.
+ * @member {String} filter
+ * @default ''
+ */
+SeekStreamOptions.prototype.filter = '';
+
+/**
+ * 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.
+ * @member {Array.<module:model/SeekStreamOptionsLastTurn>} lastTurn
+ */
+SeekStreamOptions.prototype.lastTurn = undefined;
+
+/**
+ * Enable Prompt engineering.  Valid values are the strings 'true' and 'false'
+ * @member {String} promptEngineering
+ * @default ''
+ */
+SeekStreamOptions.prototype.promptEngineering = '';
+
+/**
+ * Prepend a phrase to cleansed user input. Must enable Prompt Engineering inside the NeuralSeek \"Configure\" page
+ * @member {String} promptEngineeringPhrase
+ * @default ''
+ */
+SeekStreamOptions.prototype.promptEngineeringPhrase = '';
+
+/**
+ * The verbosity of the answer. A whole number 1-4
+ * @member {Number} answerLength
+ */
+SeekStreamOptions.prototype.answerLength = undefined;
+
+/**
+ * URL of the current page when using with a web-based Virtual Agent
+ * @member {String} url
+ * @default ''
+ */
+SeekStreamOptions.prototype.url = '';
+
+/**
+ * Stump Speech text. Fallback for when all else fails.
+ * @member {String} stump
+ * @default ''
+ */
+SeekStreamOptions.prototype.stump = '';
+
+/**
+ * Include generation source results. Defaults to false.
+ * @member {Boolean} includeSourceResults
+ * @default false
+ */
+SeekStreamOptions.prototype.includeSourceResults = false;
+
+/**
+ * Include highlights from source results. Defaults to false.
+ * @member {Boolean} includeHighlights
+ * @default false
+ */
+SeekStreamOptions.prototype.includeHighlights = false;
+
+/**
+ * Include generation source results, and output them into a formatted string.  Defaults to false.
+ * @member {Boolean} includeSourceResultsFormatted
+ * @default false
+ */
+SeekStreamOptions.prototype.includeSourceResultsFormatted = false;
+
+/**
+ * When including source results, how many to include.'
+ * @member {Number} sourceResultsNumber
+ * @default 3
+ */
+SeekStreamOptions.prototype.sourceResultsNumber = 3;
+
+/**
+ * When including source results, how long of a summary to include.'
+ * @member {Number} sourceResultsSummaryLength
+ * @default 100
+ */
+SeekStreamOptions.prototype.sourceResultsSummaryLength = 100;
+
+/**
+ * Return the final state of all variables in a dense object
+ * @member {Boolean} returnVariables
+ * @default false
+ */
+SeekStreamOptions.prototype.returnVariables = false;
+
+/**
+ * Return the final state of all variables in the same format as the input params
+ * @member {Boolean} returnVariablesExpanded
+ * @default false
+ */
+SeekStreamOptions.prototype.returnVariablesExpanded = false;
+

package/src/model/SeekStreamOptionsLastTurn.js

@@ -0,0 +1,64 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+
+/**
+ * The SeekStreamOptionsLastTurn model module.
+ * @module model/SeekStreamOptionsLastTurn
+ * @version 1.0.1
+ */
+export default class SeekStreamOptionsLastTurn {
+  /**
+   * Constructs a new <code>SeekStreamOptionsLastTurn</code>.
+   * @alias module:model/SeekStreamOptionsLastTurn
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekStreamOptionsLastTurn</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekStreamOptionsLastTurn} obj Optional instance to populate.
+   * @return {module:model/SeekStreamOptionsLastTurn} The populated <code>SeekStreamOptionsLastTurn</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekStreamOptionsLastTurn();
+      if (data.hasOwnProperty('input'))
+        obj.input = ApiClient.convertToType(data['input'], 'String');
+      if (data.hasOwnProperty('response'))
+        obj.response = ApiClient.convertToType(data['response'], 'String');
+    }
+    return obj;
+  }
+}
+
+/**
+ * The user input
+ * @member {String} input
+ * @default ''
+ */
+SeekStreamOptionsLastTurn.prototype.input = '';
+
+/**
+ * The system response.  Text strings only here. 
+ * @member {String} response
+ * @default ''
+ */
+SeekStreamOptionsLastTurn.prototype.response = '';
+

package/src/model/SeekStreamOptionsPersonalize.js

@@ -0,0 +1,91 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+
+/**
+ * The SeekStreamOptionsPersonalize model module.
+ * @module model/SeekStreamOptionsPersonalize
+ * @version 1.0.1
+ */
+export default class SeekStreamOptionsPersonalize {
+  /**
+   * Constructs a new <code>SeekStreamOptionsPersonalize</code>.
+   * An object that allows NeuralSeek to tailor a response for a specific user
+   * @alias module:model/SeekStreamOptionsPersonalize
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekStreamOptionsPersonalize</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekStreamOptionsPersonalize} obj Optional instance to populate.
+   * @return {module:model/SeekStreamOptionsPersonalize} The populated <code>SeekStreamOptionsPersonalize</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekStreamOptionsPersonalize();
+      if (data.hasOwnProperty('preferredName'))
+        obj.preferredName = ApiClient.convertToType(data['preferredName'], 'String');
+      if (data.hasOwnProperty('noWelcome'))
+        obj.noWelcome = ApiClient.convertToType(data['noWelcome'], 'String');
+      if (data.hasOwnProperty('forceFirstPerson'))
+        obj.forceFirstPerson = ApiClient.convertToType(data['forceFirstPerson'], 'String');
+      if (data.hasOwnProperty('products'))
+        obj.products = ApiClient.convertToType(data['products'], ['String']);
+      if (data.hasOwnProperty('additionalDetails'))
+        obj.additionalDetails = ApiClient.convertToType(data['additionalDetails'], 'String');
+    }
+    return obj;
+  }
+}
+
+/**
+ * The name the user should be referred to by
+ * @member {String} preferredName
+ * @default ''
+ */
+SeekStreamOptionsPersonalize.prototype.preferredName = '';
+
+/**
+ * The user has already been welcomed, do not re-welcome.  Valid value is 'true' or 'false'.  Default value is 'false'.
+ * @member {String} noWelcome
+ * @default ''
+ */
+SeekStreamOptionsPersonalize.prototype.noWelcome = '';
+
+/**
+ * Use a first-person speaking style, even if no preferredName is set.  Valid value is 'true' or 'false'.  Default value is 'false'.
+ * @member {String} forceFirstPerson
+ * @default ''
+ */
+SeekStreamOptionsPersonalize.prototype.forceFirstPerson = '';
+
+/**
+ * An array of products this customer currently consumes from your company
+ * @member {Array.<String>} products
+ */
+SeekStreamOptionsPersonalize.prototype.products = undefined;
+
+/**
+ * Additional details to pass to language generation
+ * @member {String} additionalDetails
+ * @default ''
+ */
+SeekStreamOptionsPersonalize.prototype.additionalDetails = '';
+

package/src/model/SeekStreamParams.js

@@ -0,0 +1,64 @@
+/*
+ * NeuralSeek
+ * NeuralSeek - The business LLM accelerator
+ *
+ * OpenAPI spec version: 1.0.1
+ * Contact: support@NeuralSeek.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.78
+ *
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient';
+
+/**
+ * The SeekStreamParams model module.
+ * @module model/SeekStreamParams
+ * @version 1.0.1
+ */
+export default class SeekStreamParams {
+  /**
+   * Constructs a new <code>SeekStreamParams</code>.
+   * @alias module:model/SeekStreamParams
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekStreamParams</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/SeekStreamParams} obj Optional instance to populate.
+   * @return {module:model/SeekStreamParams} The populated <code>SeekStreamParams</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekStreamParams();
+      if (data.hasOwnProperty('name'))
+        obj.name = ApiClient.convertToType(data['name'], 'String');
+      if (data.hasOwnProperty('value'))
+        obj.value = ApiClient.convertToType(data['value'], 'String');
+    }
+    return obj;
+  }
+}
+
+/**
+ * The parameter name
+ * @member {String} name
+ * @default ''
+ */
+SeekStreamParams.prototype.name = '';
+
+/**
+ * The parameter value
+ * @member {String} value
+ * @default ''
+ */
+SeekStreamParams.prototype.value = '';
+