@cognigy/rest-api-client 0.13.2 → 0.14.0

package/build/shared/interfaces/resources/intent/IIntent.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.intentSchema = exports.intentDataSchema = exports.intentInDBDataSchema = exports.localizedIntentDataSchema = exports.overrideIntentDefaultRepliesAsExamplesTypes = exports.intentTypes = void 0;
 const IEntityMeta_1 = require("../IEntityMeta");
 const IIntentFeedbackReport_1 = require("./IIntentFeedbackReport");
+const IIntentRelation_1 = require("./IIntentRelation");
 exports.intentTypes = ["yesNoIntent", "default"];
 exports.overrideIntentDefaultRepliesAsExamplesTypes = [
     "useFlowSettings",
@@ -33,7 +34,7 @@ exports.intentInDBDataSchema = {
     title: "intentInDBDataSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), { feedbackReport: IIntentFeedbackReport_1.intentFeedbackInDBReportSchema, localizedData: { type: "array", items: exports.localizedIntentDataSchema }, enabledLocaleReferences: { type: "array", items: { format: "mongo-id" } }, name: { type: "string", format: "resource-name" }, intentType: { type: "string", enum: [...exports.intentTypes] }, intentRelationReferences: {
+    properties: Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), { feedbackReport: IIntentFeedbackReport_1.intentFeedbackInDBReportSchema, localizedData: { type: "array", items: exports.localizedIntentDataSchema }, enabledLocaleReferences: { type: "array", items: { format: "mongo-id" } }, name: { type: "string", format: "resource-name" }, description: { type: "string", format: "resource-description" }, intentType: { type: "string", enum: [...exports.intentTypes] }, intentRelationReferences: {
             type: "array",
             items: { type: "string", format: "mongo-id" }
         }, tags: {
@@ -45,7 +46,7 @@ exports.intentInDBDataSchema = {
                 { type: "boolean" },
                 { type: "array", items: { type: "string", format: "mongo-id" } }
             ]
-        }, flowReferenceId: { type: "string", format: "uuid" }, referenceId: { type: "string", format: "uuid" }, flowReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" }, analyticsLabel: { type: "string", format: "analytics-label" }, overrideIntentDefaultRepliesAsExamples: {
+        }, biasTowardsParentOrChildIntents: { type: "string", enum: [...IIntentRelation_1.biasTowardsParentOrChildIntentsTypes] }, flowReferenceId: { type: "string", format: "uuid" }, referenceId: { type: "string", format: "uuid" }, flowReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" }, analyticsLabel: { type: "string", format: "analytics-label" }, overrideIntentDefaultRepliesAsExamples: {
             type: ["string", "null"],
             enum: [...exports.overrideIntentDefaultRepliesAsExamplesTypes]
         } })
@@ -56,6 +57,7 @@ exports.intentDataSchema = {
     additionalProperties: false,
     properties: {
         name: { type: "string", format: "resource-name" },
+        description: { type: "string", format: "resource-description" },
         intentType: { type: "string", enum: [...exports.intentTypes] },
         condition: { type: ["string", "null"], maxLength: 2000 },
         intentRelationReferences: {
@@ -89,6 +91,7 @@ exports.intentDataSchema = {
                 { type: "array", items: { type: "string", format: "mongo-id" } }
             ]
         },
+        biasTowardsParentOrChildIntents: { type: "string", enum: [...IIntentRelation_1.biasTowardsParentOrChildIntentsTypes] },
         flowReferenceId: { type: "string", format: "uuid" },
         feedbackReport: IIntentFeedbackReport_1.intentFeedbackReportDataSchema,
         analyticsLabel: { type: "string", format: "analytics-label" },

package/build/shared/interfaces/resources/intent/IIntentRelation.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.intentRelationSchema = void 0;
+exports.intentRelationSchema = exports.biasTowardsParentOrChildIntentsTypes = void 0;
+exports.biasTowardsParentOrChildIntentsTypes = ["parents", "children"];
 exports.intentRelationSchema = {
     title: "intentHierarchyRelationSchema",
     type: "object",
@@ -14,6 +15,7 @@ exports.intentRelationSchema = {
                 { type: "array", items: { type: "string", format: "mongo-id" } }
             ]
         },
+        biasTowardsParentOrChildIntents: { type: "string", enum: [...exports.biasTowardsParentOrChildIntentsTypes] },
         intentReference: { type: "string", format: "mongo-id" },
         flowReference: { type: "string", format: "mongo-id" },
         projectReference: { type: "string", format: "mongo-id" },

package/build/shared/interfaces/resources/settings/IAgentSettings.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.agentSettingsSchema = exports.agentSettingsDataSchema = exports.generateAgentSettingsRedisKey = void 0;
 const IEntityMeta_1 = require("../IEntityMeta");
 const ISharedSettings_1 = require("./ISharedSettings");
+const IGenerativeAISettings_1 = require("./IGenerativeAISettings");
 const arrayTranslationProviders = [
     "none",
     "microsoft",
@@ -57,7 +58,7 @@ exports.agentSettingsDataSchema = {
                     additionalProperties: false,
                     properties: {
                         apiKey: { type: "string", maxLength: 255 },
-                        region: { type: "string", maxLength: 50 },
+                        region: { type: "string", maxLength: 50 }
                     }
                 },
                 aws: {
@@ -67,7 +68,7 @@ exports.agentSettingsDataSchema = {
                         accessKeyId: { type: "string", maxLength: 255 },
                         secretAccessKey: { type: "string", maxLength: 255 },
                         sessionToken: { type: "string", default: undefined },
-                        region: { type: "string", maxLength: 50, default: undefined },
+                        region: { type: "string", maxLength: 50, default: undefined }
                     }
                 },
                 google: {
@@ -78,14 +79,18 @@ exports.agentSettingsDataSchema = {
                         fileToken: { type: "string", maxLength: 350 },
                         credentialsStringified: { type: "string", maxLength: 2000 },
                         clientEmail: { type: "string", maxLength: 250 },
-                        privateKey: { type: "string", maxLength: 2000 },
+                        privateKey: { type: "string", maxLength: 2000 }
                     }
                 },
                 audioPreviewProviderCustomBaseUrl: { type: "string", maxLength: 255 },
                 audioPreviewRetries: { type: "integer", minimum: 0, maximum: 3 },
                 audioPreviewTimeout: { type: "integer", minimum: 0, maximum: 8000 },
-                audioPreviewCacheExpiry: { type: "integer", enum: [0, 3600, 84600] },
+                audioPreviewCacheExpiry: { type: "integer", enum: [0, 3600, 84600] }
             }
+        }, generativeAISettings: {
+            type: "object",
+            additionalProperties: false,
+            properties: Object.assign({}, IGenerativeAISettings_1.generativeAISettingsDataSchema.properties)
         } })
 };
 exports.agentSettingsSchema = {

package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generativeAISettingsDataSchema = exports.generativeAIMetaAzureOpenAIDataSchema = exports.generativeAIMetaOpenAIDataSchema = exports.azureOpenAIModels = exports.openAIModels = exports.generativeAIProviders = exports.generativeAIUseCases = void 0;
+exports.generativeAIUseCases = [
+    "intentGeneration",
+    "ouputContextualization",
+    "lexiconGeneration",
+    "flowGeneration",
+    "flowExplanation"
+];
+exports.generativeAIProviders = ["none", "openAI", "azureOpenAI"];
+/**
+ * For Open.AI default should be => "text-davinci-003"
+ * For Azure OpenAI default should be => "text-davinci-002"
+ */
+exports.openAIModels = ["text-davinci-003"];
+exports.azureOpenAIModels = ["text-davinci-002"];
+exports.generativeAIMetaOpenAIDataSchema = {
+    title: "generativeAIMetaOpenAIDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["model", "temperature"],
+    properties: {
+        model: {
+            type: "string",
+            maxLength: 50
+        },
+        temperature: {
+            type: "number",
+            minimum: 0,
+            maximum: 1
+        }
+    }
+};
+exports.generativeAIMetaAzureOpenAIDataSchema = {
+    title: "generativeAIMetaAzureOpenAIDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["model", "temperature"],
+    properties: {
+        model: {
+            type: "string",
+            maxLength: 50
+        },
+        temperature: {
+            type: "number",
+            minimum: 0,
+            maximum: 1
+        }
+    }
+};
+exports.generativeAISettingsDataSchema = {
+    title: "generativeAISettingsDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["generativeAIProvider"],
+    properties: {
+        generativeAIProvider: {
+            type: "string",
+            enum: [...exports.generativeAIProviders]
+        },
+        openAI: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                provider: {
+                    type: "string",
+                    enum: [...exports.generativeAIProviders]
+                },
+                connectionId: { type: "string", maxLength: 255 },
+                intentGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaOpenAIDataSchema.properties)
+                },
+                ouputContextualization: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaOpenAIDataSchema.properties)
+                },
+                lexiconGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaOpenAIDataSchema.properties)
+                },
+                flowGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaOpenAIDataSchema.properties)
+                },
+                flowExplanation: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaOpenAIDataSchema.properties)
+                }
+            }
+        },
+        azureOpenAI: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                provider: {
+                    type: "string",
+                    enum: [...exports.generativeAIProviders]
+                },
+                connectionId: { type: "string", maxLength: 255 },
+                intentGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaAzureOpenAIDataSchema.properties)
+                },
+                ouputContextualization: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaAzureOpenAIDataSchema.properties)
+                },
+                lexiconGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaAzureOpenAIDataSchema.properties)
+                },
+                flowGeneration: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaAzureOpenAIDataSchema.properties)
+                },
+                flowExplanation: {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: Object.assign({}, exports.generativeAIMetaAzureOpenAIDataSchema.properties)
+                }
+            }
+        }
+    }
+};
+//# sourceMappingURL=IGenerativeAISettings.js.map

package/build/shared/interfaces/resources/settings/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
+exports.generativeAIUseCases = exports.generativeAIProviders = exports.openAIModels = exports.azureOpenAIModels = exports.generativeAISettingsDataSchema = exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
 var IAgentSettings_1 = require("./IAgentSettings");
 Object.defineProperty(exports, "agentSettingsDataSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsDataSchema; } });
 Object.defineProperty(exports, "agentSettingsSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsSchema; } });
@@ -10,4 +10,10 @@ Object.defineProperty(exports, "flowSettingsDataSchema", { enumerable: true, get
 Object.defineProperty(exports, "flowSettingsSchema", { enumerable: true, get: function () { return IFlowSettings_1.flowSettingsSchema; } });
 var ISharedSettings_1 = require("./ISharedSettings");
 Object.defineProperty(exports, "sharedSettingsSchema", { enumerable: true, get: function () { return ISharedSettings_1.sharedSettingsSchema; } });
+var IGenerativeAISettings_1 = require("./IGenerativeAISettings");
+Object.defineProperty(exports, "generativeAISettingsDataSchema", { enumerable: true, get: function () { return IGenerativeAISettings_1.generativeAISettingsDataSchema; } });
+Object.defineProperty(exports, "azureOpenAIModels", { enumerable: true, get: function () { return IGenerativeAISettings_1.azureOpenAIModels; } });
+Object.defineProperty(exports, "openAIModels", { enumerable: true, get: function () { return IGenerativeAISettings_1.openAIModels; } });
+Object.defineProperty(exports, "generativeAIProviders", { enumerable: true, get: function () { return IGenerativeAISettings_1.generativeAIProviders; } });
+Object.defineProperty(exports, "generativeAIUseCases", { enumerable: true, get: function () { return IGenerativeAISettings_1.generativeAIUseCases; } });
 //# sourceMappingURL=index.js.map

package/build/shared/interfaces/restAPI/resources/flow/v2.0/sentence/IGenerateSentencesRest_2_0.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IGenerateSentencesRest_2_0.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "0.13.2",
+	"version": "0.14.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/rollup-plugin-babel.esm.js",