@scout9/admin 1.0.0-alpha.0.0.4 → 1.0.0-alpha.0.0.6

package/build/api.d.ts

@@ -242,7 +242,7 @@ export interface ContextDetectionDocument {
      * @type {string}
      * @memberof ContextDetectionDocument
      */
-    'id': string;
+    'intent'?: string;
 }
 /**
  *
@@ -255,7 +255,7 @@ export interface ContextDetectionEntity {
      * @type {string}
      * @memberof ContextDetectionEntity
      */
-    'utteranceId': string;
+    'utteranceId'?: string;
     /**
      * The classification of the given text
      * @type {string}
@@ -320,16 +320,73 @@ export interface ContextDetectionTest {
     'text': string;
     /**
      *
-     * @type {string}
+     * @type {ContextDetectionTestExpected}
      * @memberof ContextDetectionTest
      */
-    'targetUtteranceId': string;
+    'expected': ContextDetectionTestExpected;
+}
+/**
+ * The expected result of the test
+ * @export
+ * @interface ContextDetectionTestExpected
+ */
+export interface ContextDetectionTestExpected {
     /**
      *
      * @type {string}
-     * @memberof ContextDetectionTest
+     * @memberof ContextDetectionTestExpected
+     */
+    'intent'?: string;
+    /**
+     *
+     * @type {Array<ParsedContextEntity>}
+     * @memberof ContextDetectionTestExpected
+     */
+    'entities'?: Array<ParsedContextEntity>;
+}
+/**
+ *
+ * @export
+ * @interface ContextTestRequest
+ */
+export interface ContextTestRequest {
+    /**
+     * The context id to test
+     * @type {string}
+     * @memberof ContextTestRequest
+     */
+    'context': string;
+    /**
+     *
+     * @type {Array<ContextDetectionTest>}
+     * @memberof ContextTestRequest
+     */
+    'data'?: Array<ContextDetectionTest>;
+    /**
+     * If true, the context will be saved to the database as an update call
+     * @type {boolean}
+     * @memberof ContextTestRequest
+     */
+    'save'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ContextTestResponse
+ */
+export interface ContextTestResponse {
+    /**
+     * The context id to test
+     * @type {string}
+     * @memberof ContextTestResponse
+     */
+    'message'?: string;
+    /**
+     * Success percentage of the context detection in decimal format
+     * @type {number}
+     * @memberof ContextTestResponse
      */
-    'targetOption': string;
+    'success'?: number;
 }
 /**
  *
@@ -3880,6 +3937,13 @@ export declare const Operator: {
     readonly NotIn: "not-in";
 };
 export type Operator = typeof Operator[keyof typeof Operator];
+/**
+ * @type ParsedContextEntity
+ * @export
+ */
+export type ParsedContextEntity = string | {
+    [key: string]: any;
+};
 /**
  *
  * @export
@@ -5665,6 +5729,65 @@ export interface Workflow {
      */
     'onError'?: string;
 }
+/**
+ * CustomContextApi - axios parameter creator
+ * @export
+ */
+export declare const CustomContextApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest: (contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CustomContextApi - functional programming interface
+ * @export
+ */
+export declare const CustomContextApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextTestResponse>>;
+};
+/**
+ * CustomContextApi - factory interface
+ * @export
+ */
+export declare const CustomContextApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: any): AxiosPromise<ContextTestResponse>;
+};
+/**
+ * CustomContextApi - object-oriented interface
+ * @export
+ * @class CustomContextApi
+ * @extends {BaseAPI}
+ */
+export declare class CustomContextApi extends BaseAPI {
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomContextApi
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
+}
 /**
  * Scout9Api - axios parameter creator
  * @export
@@ -5759,6 +5882,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     contextDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest: (contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Update a context
@@ -6268,6 +6399,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     contextDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteContextResponse>>;
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextTestResponse>>;
     /**
      *
      * @summary Update a context
@@ -6777,6 +6916,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     contextDelete(id: string, options?: any): AxiosPromise<DeleteContextResponse>;
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: any): AxiosPromise<ContextTestResponse>;
     /**
      *
      * @summary Update a context
@@ -7299,6 +7446,15 @@ export declare class Scout9Api extends BaseAPI {
      * @memberof Scout9Api
      */
     contextDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextResponse, any>>;
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
     /**
      *
      * @summary Update a context

package/build/api.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Scout9Api = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.UpdateAgentsRequestAgentsInnerModelEnum = exports.UpdateAgentRequestModelEnum = exports.Operator = exports.MessageGetResponseInnerRoleEnum = exports.MessageCreateRequestRoleEnum = exports.MessageBaseRoleEnum = exports.MessageRoleEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.ListAgentsResponseInnerModelEnum = exports.GetApiOperationResponseMethodEnum = exports.GetAgentResponseModelEnum = exports.GenerateResponseRoleEnum = exports.CreateAgentsRequestAgentsInnerModelEnum = exports.CreateAgentRequestModelEnum = exports.ConversationEnvironment = exports.ConversationContextFieldConditionOperatorEnum = exports.ApiOperationMethodEnum = exports.AgentModelEnum = void 0;
+exports.Scout9Api = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.CustomContextApi = exports.CustomContextApiFactory = exports.CustomContextApiFp = exports.CustomContextApiAxiosParamCreator = exports.UpdateAgentsRequestAgentsInnerModelEnum = exports.UpdateAgentRequestModelEnum = exports.Operator = exports.MessageGetResponseInnerRoleEnum = exports.MessageCreateRequestRoleEnum = exports.MessageBaseRoleEnum = exports.MessageRoleEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.ListAgentsResponseInnerModelEnum = exports.GetApiOperationResponseMethodEnum = exports.GetAgentResponseModelEnum = exports.GenerateResponseRoleEnum = exports.CreateAgentsRequestAgentsInnerModelEnum = exports.CreateAgentRequestModelEnum = exports.ConversationEnvironment = exports.ConversationContextFieldConditionOperatorEnum = exports.ApiOperationMethodEnum = exports.AgentModelEnum = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -161,6 +161,106 @@ exports.UpdateAgentsRequestAgentsInnerModelEnum = {
     Bard: 'bard',
     Null: 'null'
 };
+/**
+ * CustomContextApi - axios parameter creator
+ * @export
+ */
+const CustomContextApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextTest: async (contextTestRequest, options = {}) => {
+            // verify required parameter 'contextTestRequest' is not null or undefined
+            (0, common_1.assertParamExists)('contextTest', 'contextTestRequest', contextTestRequest);
+            const localVarPath = `/v1-contextTest`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(contextTestRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+exports.CustomContextApiAxiosParamCreator = CustomContextApiAxiosParamCreator;
+/**
+ * CustomContextApi - functional programming interface
+ * @export
+ */
+const CustomContextApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.CustomContextApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async contextTest(contextTestRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.contextTest(contextTestRequest, options);
+            return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+        },
+    };
+};
+exports.CustomContextApiFp = CustomContextApiFp;
+/**
+ * CustomContextApi - factory interface
+ * @export
+ */
+const CustomContextApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.CustomContextApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextTest(contextTestRequest, options) {
+            return localVarFp.contextTest(contextTestRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.CustomContextApiFactory = CustomContextApiFactory;
+/**
+ * CustomContextApi - object-oriented interface
+ * @export
+ * @class CustomContextApi
+ * @extends {BaseAPI}
+ */
+class CustomContextApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomContextApi
+     */
+    contextTest(contextTestRequest, options) {
+        return (0, exports.CustomContextApiFp)(this.configuration).contextTest(contextTestRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.CustomContextApi = CustomContextApi;
 /**
  * Scout9Api - axios parameter creator
  * @export
@@ -503,6 +603,36 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextTest: async (contextTestRequest, options = {}) => {
+            // verify required parameter 'contextTestRequest' is not null or undefined
+            (0, common_1.assertParamExists)('contextTest', 'contextTestRequest', contextTestRequest);
+            const localVarPath = `/v1-contextTest`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(contextTestRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Update a context
@@ -2194,6 +2324,17 @@ const Scout9ApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.contextDelete(id, options);
             return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
         },
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async contextTest(contextTestRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.contextTest(contextTestRequest, options);
+            return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+        },
         /**
          *
          * @summary Update a context
@@ -2882,6 +3023,16 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
         contextDelete(id, options) {
             return localVarFp.contextDelete(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Test a custom context before training
+         * @param {ContextTestRequest} contextTestRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextTest(contextTestRequest, options) {
+            return localVarFp.contextTest(contextTestRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Update a context
@@ -3530,6 +3681,17 @@ class Scout9Api extends base_1.BaseAPI {
     contextDelete(id, options) {
         return (0, exports.Scout9ApiFp)(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Test a custom context before training
+     * @param {ContextTestRequest} contextTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    contextTest(contextTestRequest, options) {
+        return (0, exports.Scout9ApiFp)(this.configuration).contextTest(contextTestRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Update a context

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/admin",
-  "version": "1.0.0-alpha.0.0.4",
+  "version": "1.0.0-alpha.0.0.6",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",