neuralseek 1.0.1

package/src/model/ScoreBody.js

@@ -0,0 +1,63 @@
+/*
+ * 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 ScoreBody model module.
+ * @module model/ScoreBody
+ * @version 1.0.1
+ */
+export default class ScoreBody {
+  /**
+   * Constructs a new <code>ScoreBody</code>.
+   * @alias module:model/ScoreBody
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>ScoreBody</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/ScoreBody} obj Optional instance to populate.
+   * @return {module:model/ScoreBody} The populated <code>ScoreBody</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new ScoreBody();
+      if (data.hasOwnProperty('text'))
+        obj.text = ApiClient.convertToType(data['text'], 'String');
+      if (data.hasOwnProperty('passages'))
+        obj.passages = ApiClient.convertToType(data['passages'], ['String']);
+    }
+    return obj;
+  }
+}
+
+/**
+ * The text to score
+ * @member {String} text
+ * @default ''
+ */
+ScoreBody.prototype.text = '';
+
+/**
+ * The rating score. An integer, 0-5. 0 is worst, 5 is best.  For Thumbs up / Thumbs down send 0 or 5
+ * @member {Array.<String>} passages
+ */
+ScoreBody.prototype.passages = undefined;
+

package/src/model/Seek.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 SeekOptions from './SeekOptions';
+import SeekStreamParams from './SeekStreamParams';
+import SeekStreamUserSession from './SeekStreamUserSession';
+
+/**
+ * The Seek model module.
+ * @module model/Seek
+ * @version 1.0.1
+ */
+export default class Seek {
+  /**
+   * Constructs a new <code>Seek</code>.
+   * @alias module:model/Seek
+   * @class
+   * @param question {String} The user's question for NeuralSeek
+   */
+  constructor(question) {
+    this.question = question;
+  }
+
+  /**
+   * Constructs a <code>Seek</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/Seek} obj Optional instance to populate.
+   * @return {module:model/Seek} The populated <code>Seek</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new Seek();
+      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 = SeekOptions.constructFromObject(data['options']);
+    }
+    return obj;
+  }
+}
+
+/**
+ * The user's question for NeuralSeek
+ * @member {String} question
+ * @default ''
+ */
+Seek.prototype.question = '';
+
+/**
+ * @member {module:model/SeekStreamUserSession} userSession
+ */
+Seek.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
+ */
+Seek.prototype.params = undefined;
+
+/**
+ * @member {module:model/SeekOptions} options
+ */
+Seek.prototype.options = undefined;
+

package/src/model/SeekOptions.js

@@ -0,0 +1,216 @@
+/*
+ * 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 SeekOptions model module.
+ * @module model/SeekOptions
+ * @version 1.0.1
+ */
+export default class SeekOptions {
+  /**
+   * Constructs a new <code>SeekOptions</code>.
+   * Optional object for runtime override of Seek options.
+   * @alias module:model/SeekOptions
+   * @class
+   */
+  constructor() {
+  }
+
+  /**
+   * Constructs a <code>SeekOptions</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/SeekOptions} obj Optional instance to populate.
+   * @return {module:model/SeekOptions} The populated <code>SeekOptions</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekOptions();
+      if (data.hasOwnProperty('personalize'))
+        obj.personalize = SeekStreamOptionsPersonalize.constructFromObject(data['personalize']);
+      if (data.hasOwnProperty('proposalID'))
+        obj.proposalID = ApiClient.convertToType(data['proposalID'], 'String');
+      if (data.hasOwnProperty('streaming'))
+        obj.streaming = ApiClient.convertToType(data['streaming'], 'Boolean');
+      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
+ */
+SeekOptions.prototype.personalize = undefined;
+
+/**
+ * Override all settings by passing a NeuralSeek Proposal ID.
+ * @member {String} proposalID
+ * @default ''
+ */
+SeekOptions.prototype.proposalID = '';
+
+/**
+ * Return the response via SSE streaming.  This is not compatible with most Virtual Agent platforms, and is intentded for direct website use.
+ * @member {Boolean} streaming
+ * @default false
+ */
+SeekOptions.prototype.streaming = false;
+
+/**
+ * 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 ''
+ */
+SeekOptions.prototype.seekLLM = '';
+
+/**
+ * Valid values are: en, es, de, it, fr, ja, ar
+ * @member {String} language
+ * @default ''
+ */
+SeekOptions.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 ''
+ */
+SeekOptions.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
+ */
+SeekOptions.prototype.lastTurn = undefined;
+
+/**
+ * Enable Prompt engineering.  Valid values are the strings 'true' and 'false'
+ * @member {String} promptEngineering
+ * @default ''
+ */
+SeekOptions.prototype.promptEngineering = '';
+
+/**
+ * Prepend a phrase to cleansed user input. Must enable Prompt Engineering inside the NeuralSeek \"Configure\" page
+ * @member {String} promptEngineeringPhrase
+ * @default ''
+ */
+SeekOptions.prototype.promptEngineeringPhrase = '';
+
+/**
+ * The verbosity of the answer. A whole number 1-4
+ * @member {Number} answerLength
+ */
+SeekOptions.prototype.answerLength = undefined;
+
+/**
+ * URL of the current page when using with a web-based Virtual Agent
+ * @member {String} url
+ * @default ''
+ */
+SeekOptions.prototype.url = '';
+
+/**
+ * Stump Speech text. Fallback for when all else fails.
+ * @member {String} stump
+ * @default ''
+ */
+SeekOptions.prototype.stump = '';
+
+/**
+ * Include generation source results. Defaults to false.
+ * @member {Boolean} includeSourceResults
+ * @default false
+ */
+SeekOptions.prototype.includeSourceResults = false;
+
+/**
+ * Include highlights from source results. Defaults to false.
+ * @member {Boolean} includeHighlights
+ * @default false
+ */
+SeekOptions.prototype.includeHighlights = false;
+
+/**
+ * Include generation source results, and output them into a formatted string.  Defaults to false.
+ * @member {Boolean} includeSourceResultsFormatted
+ * @default false
+ */
+SeekOptions.prototype.includeSourceResultsFormatted = false;
+
+/**
+ * When including source results, how many to include.'
+ * @member {Number} sourceResultsNumber
+ * @default 3
+ */
+SeekOptions.prototype.sourceResultsNumber = 3;
+
+/**
+ * When including source results, how long of a summary to include.'
+ * @member {Number} sourceResultsSummaryLength
+ * @default 100
+ */
+SeekOptions.prototype.sourceResultsSummaryLength = 100;
+
+/**
+ * Return the final state of all variables in a dense object
+ * @member {Boolean} returnVariables
+ * @default false
+ */
+SeekOptions.prototype.returnVariables = false;
+
+/**
+ * Return the final state of all variables in the same format as the input params
+ * @member {Boolean} returnVariablesExpanded
+ * @default false
+ */
+SeekOptions.prototype.returnVariablesExpanded = false;
+

package/src/model/SeekResponse.js

@@ -0,0 +1,281 @@
+/*
+ * 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 SeekResponsePassages from './SeekResponsePassages';
+import SeekResponseVariablesExpanded from './SeekResponseVariablesExpanded';
+
+/**
+ * The SeekResponse model module.
+ * @module model/SeekResponse
+ * @version 1.0.1
+ */
+export default class SeekResponse {
+  /**
+   * Constructs a new <code>SeekResponse</code>.
+   * @alias module:model/SeekResponse
+   * @class
+   * @param answer {String} The generated answer
+   * @param score {Number} The final confidence score of the answer (0-100)
+   */
+  constructor(answer, score) {
+    this.answer = answer;
+    this.score = score;
+  }
+
+  /**
+   * Constructs a <code>SeekResponse</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/SeekResponse} obj Optional instance to populate.
+   * @return {module:model/SeekResponse} The populated <code>SeekResponse</code> instance.
+   */
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new SeekResponse();
+      if (data.hasOwnProperty('answer'))
+        obj.answer = ApiClient.convertToType(data['answer'], 'String');
+      if (data.hasOwnProperty('ufa'))
+        obj.ufa = ApiClient.convertToType(data['ufa'], 'String');
+      if (data.hasOwnProperty('answerId'))
+        obj.answerId = ApiClient.convertToType(data['answerId'], 'String');
+      if (data.hasOwnProperty('thumbs'))
+        obj.thumbs = ApiClient.convertToType(data['thumbs'], 'String');
+      if (data.hasOwnProperty('thumbsSVG'))
+        obj.thumbsSVG = ApiClient.convertToType(data['thumbsSVG'], 'String');
+      if (data.hasOwnProperty('intent'))
+        obj.intent = ApiClient.convertToType(data['intent'], 'String');
+      if (data.hasOwnProperty('category'))
+        obj.category = ApiClient.convertToType(data['category'], 'Number');
+      if (data.hasOwnProperty('categoryName'))
+        obj.categoryName = ApiClient.convertToType(data['categoryName'], 'String');
+      if (data.hasOwnProperty('score'))
+        obj.score = ApiClient.convertToType(data['score'], 'Number');
+      if (data.hasOwnProperty('KBscore'))
+        obj.kBscore = ApiClient.convertToType(data['KBscore'], 'Number');
+      if (data.hasOwnProperty('semanticAnalysis'))
+        obj.semanticAnalysis = ApiClient.convertToType(data['semanticAnalysis'], 'String');
+      if (data.hasOwnProperty('cachedResult'))
+        obj.cachedResult = ApiClient.convertToType(data['cachedResult'], 'String');
+      if (data.hasOwnProperty('langCode'))
+        obj.langCode = ApiClient.convertToType(data['langCode'], 'String');
+      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('time'))
+        obj.time = ApiClient.convertToType(data['time'], 'Number');
+      if (data.hasOwnProperty('kbTime'))
+        obj.kbTime = ApiClient.convertToType(data['kbTime'], 'Number');
+      if (data.hasOwnProperty('protectTime'))
+        obj.protectTime = ApiClient.convertToType(data['protectTime'], 'Number');
+      if (data.hasOwnProperty('categorySelectionTime'))
+        obj.categorySelectionTime = ApiClient.convertToType(data['categorySelectionTime'], 'Number');
+      if (data.hasOwnProperty('promptInjection'))
+        obj.promptInjection = ApiClient.convertToType(data['promptInjection'], 'Number');
+      if (data.hasOwnProperty('sourceResultsFormatted'))
+        obj.sourceResultsFormatted = ApiClient.convertToType(data['sourceResultsFormatted'], 'String');
+      if (data.hasOwnProperty('passages'))
+        obj.passages = ApiClient.convertToType(data['passages'], [SeekResponsePassages]);
+      if (data.hasOwnProperty('kbCoverage'))
+        obj.kbCoverage = ApiClient.convertToType(data['kbCoverage'], 'Number');
+      if (data.hasOwnProperty('sentiment'))
+        obj.sentiment = ApiClient.convertToType(data['sentiment'], 'Number');
+      if (data.hasOwnProperty('semanticScore'))
+        obj.semanticScore = ApiClient.convertToType(data['semanticScore'], 'Number');
+      if (data.hasOwnProperty('variables'))
+        obj.variables = ApiClient.convertToType(data['variables'], Object);
+      if (data.hasOwnProperty('variablesExpanded'))
+        obj.variablesExpanded = ApiClient.convertToType(data['variablesExpanded'], [SeekResponseVariablesExpanded]);
+    }
+    return obj;
+  }
+}
+
+/**
+ * The generated answer
+ * @member {String} answer
+ * @default ''
+ */
+SeekResponse.prototype.answer = '';
+
+/**
+ * The raw answer from the LLM before guardrails are applied.
+ * @member {String} ufa
+ * @default ''
+ */
+SeekResponse.prototype.ufa = '';
+
+/**
+ * The id of the answer. Use this to refer to it from other endpoints, such as the Rating endpoint
+ * @member {String} answerId
+ * @default ''
+ */
+SeekResponse.prototype.answerId = '';
+
+/**
+ * The URL of a rating HTML page with an SVG to embed with the answer to allow easy rating.
+ * @member {String} thumbs
+ * @default ''
+ */
+SeekResponse.prototype.thumbs = '';
+
+/**
+ * The URL of a rating SVG to display with the answer to allow easy rating.
+ * @member {String} thumbsSVG
+ * @default ''
+ */
+SeekResponse.prototype.thumbsSVG = '';
+
+/**
+ * The intent of the answer.
+ * @member {String} intent
+ * @default ''
+ */
+SeekResponse.prototype.intent = '';
+
+/**
+ * The category id of the answer.
+ * @member {Number} category
+ */
+SeekResponse.prototype.category = undefined;
+
+/**
+ * The category name of the answer.
+ * @member {String} categoryName
+ * @default ''
+ */
+SeekResponse.prototype.categoryName = '';
+
+/**
+ * The final confidence score of the answer (0-100)
+ * @member {Number} score
+ */
+SeekResponse.prototype.score = undefined;
+
+/**
+ * The KnowledgeBase confidence of the answer's source documentation  (0-100)
+ * @member {Number} kBscore
+ */
+SeekResponse.prototype.kBscore = undefined;
+
+/**
+ * Semantic Analysis
+ * @member {String} semanticAnalysis
+ * @default ''
+ */
+SeekResponse.prototype.semanticAnalysis = '';
+
+/**
+ * If the result came from cache, will be set to the string 'true'
+ * @member {String} cachedResult
+ * @default ''
+ */
+SeekResponse.prototype.cachedResult = '';
+
+/**
+ * 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.
+ * @member {String} langCode
+ * @default ''
+ */
+SeekResponse.prototype.langCode = '';
+
+/**
+ * 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.
+ * @member {String} url
+ * @default ''
+ */
+SeekResponse.prototype.url = '';
+
+/**
+ * The top document (if available) used to train the answer. Set the field you want returned here in on the Configure tab
+ * @member {String} document
+ * @default ''
+ */
+SeekResponse.prototype.document = '';
+
+/**
+ * Total processing time in milliseconds
+ * @member {Number} time
+ */
+SeekResponse.prototype.time = undefined;
+
+/**
+ * KnowledgeBase response time in milliseconds
+ * @member {Number} kbTime
+ */
+SeekResponse.prototype.kbTime = undefined;
+
+/**
+ * PI time in milliseconds
+ * @member {Number} protectTime
+ */
+SeekResponse.prototype.protectTime = undefined;
+
+/**
+ * Category Selection time in milliseconds
+ * @member {Number} categorySelectionTime
+ */
+SeekResponse.prototype.categorySelectionTime = undefined;
+
+/**
+ * Prompt injection value
+ * @member {Number} promptInjection
+ */
+SeekResponse.prototype.promptInjection = undefined;
+
+/**
+ * A listing of the passages used for answer summarization. This will only return if includeSourceResultsFormatted is set to true on the request
+ * @member {String} sourceResultsFormatted
+ * @default ''
+ */
+SeekResponse.prototype.sourceResultsFormatted = '';
+
+/**
+ * A listing of the passages used for answer summarization. This will only return if includeSourceResults is set to true on the request
+ * @member {Array.<module:model/SeekResponsePassages>} passages
+ */
+SeekResponse.prototype.passages = undefined;
+
+/**
+ * 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.
+ * @member {Number} kbCoverage
+ */
+SeekResponse.prototype.kbCoverage = undefined;
+
+/**
+ * Sentiment score
+ * @member {Number} sentiment
+ */
+SeekResponse.prototype.sentiment = undefined;
+
+/**
+ * Semantic score (if enabled)
+ * @member {Number} semanticScore
+ */
+SeekResponse.prototype.semanticScore = undefined;
+
+/**
+ * The returned variable.
+ * @member {Object} variables
+ */
+SeekResponse.prototype.variables = undefined;
+
+/**
+ * The returned variable, in the format of the input params
+ * @member {Array.<module:model/SeekResponseVariablesExpanded>} variablesExpanded
+ */
+SeekResponse.prototype.variablesExpanded = undefined;
+