@cognigy/rest-api-client 2025.15.1 → 2025.17.0

package/dist/esm/shared/generativeAI/utils/prompts/contextAwareUserQueryRephrasing.js

@@ -0,0 +1,81 @@
+const contextAwareUserQueryRephrasingBasePrompt = `You are classifying and rephrasing user queries. Your rephrased user queries will be used as input for RAG and other LLM calls.
+
+Instructions:
+  - Do not respond to the user query as in a real conversation. 
+  - Determine whether the latest user query relates to the recent chat history. 
+  - If it does, rephrase the latest user query, possibly including details from the previous chat history. 
+  - If it does not, respond with "false". 
+  
+What follows are some example conversations, followed last by the real conversation which you are working on.`;
+const example1 = [
+    { role: "user", content: "Hi, my name is Micheal. I'm looking for support regarding an issue." },
+    { role: "assistant", content: "Great, let's get you connected with an agent. What is your customer ID?" },
+    { role: "user", content: "My ID is S0-F45T" },
+    { role: "assistant", content: "false" },
+];
+const example2 = [
+    { role: "user", content: "The Toyota Proace City looks quite nice. I'm looking to fit a bunch of stuff in the car. How much capacity does it have?" },
+    { role: "assistant", content: "There are two variants: L1 has 3,8 m3 loading volume and L2 has 4,4 m3 loading volume." },
+    { role: "user", content: "And how much can I load?" },
+    { role: "assistant", content: "What is the maximum payload and towing capacity of the Toyota Proace City?" },
+];
+const example3 = [
+    { role: "user", content: "I am looking for a new smartphone." },
+    { role: "assistant", content: "What features are you interested in?" },
+    { role: "user", content: "I want a good camera and long battery life." },
+    { role: "assistant", content: "Great! Are you looking for a specific brand or operating system, like Android or iOS?" },
+    { role: "user", content: "I prefer Android devices." },
+    { role: "assistant", content: "Do you have a budget in mind?" },
+    { role: "user", content: "I would like to keep it under $800." },
+    { role: "user", content: "Can you recommend a model?" },
+    { role: "assistant", content: "Can you suggest an Android smartphone under $800 with a good camera and long battery life?" },
+];
+export const contextAwareUserQueryRephrasingChatPrompt = [
+    {
+        role: "system",
+        content: contextAwareUserQueryRephrasingBasePrompt,
+    },
+    ...example1,
+    ...example2,
+    ...example3,
+];
+const mapExampleToPrompt = (example) => {
+    return example.map(message => message.role === "user" ? `User: ${message.content}` : `Assistant: ${message.content}`).join("\n");
+};
+export const alternativeContextAwareUserQueryRephrasingChatPrompt = [
+    {
+        role: "system",
+        content: `# Role and Objective
+You are classifying and rephrasing user queries. Your rephrased user queries will be used as input for RAG and other LLM calls.
+
+# Instructions
+- Do not respond to the user query as in a real conversation. 
+- Determine whether the latest user query relates to the previous messages. 
+- If it does relate, rephrase the latest user query, possibly including details from the previous messages. 
+- If it does not relate, respond with "false". 
+  
+## Rephrasing
+- View the previous messages and look at related context in the immediate past.
+- Pull relevant context from those messages and include them in the rephrased user query. 
+- Such context include, but is not limited to, user or product information, names, and dates. 
+
+# Output Format
+- Rephrased user query
+- or false, if unrelated to the previous messages
+
+# Examples
+
+## Example 1
+${mapExampleToPrompt(example1)}
+
+## Example 2
+${mapExampleToPrompt(example2)}
+
+## Example 3
+${mapExampleToPrompt(example3)}
+
+# Final instructions and prompt to think step by step
+- Let’s think step-by-step.`,
+    },
+];
+//# sourceMappingURL=contextAwareUserQueryRephrasing.js.map

package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js

@@ -33,6 +33,7 @@ export const generativeAIModels = [
     "claude-sonnet-4-0",
     "text-bison@001",
     "custom-model",
+    "custom-embedding-model",
     "gemini-1.0-pro",
     "gemini-1.5-pro",
     "gemini-1.5-flash",
@@ -50,6 +51,7 @@ export const generativeAIModels = [
     "pixtral-large-latest",
     "mistral-medium-latest",
     "mistral-small-latest",
+    "text-davinci-003",
     ...embeddingModels,
 ];
 export const generativeAIProviders = [

package/dist/esm/shared/interfaces/messageAPI/handover.js

@@ -130,6 +130,12 @@ export const createHandoverRequestDataSchema = {
         enableHandoverConnectMessageRingCentralEngage: {
             type: "boolean"
         },
+        enableHandoverDisconnectMessageSalesforceMIAW: {
+            type: "boolean"
+        },
+        enableHandoverConnectMessageSalesforceMIAW: {
+            type: "boolean"
+        },
         "notifySessionId": {
             "type": "string",
         },

package/dist/esm/shared/interfaces/resources/IGetAiAgentJobsTools.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IGetAiAgentJobsTools.js.map

package/dist/esm/shared/interfaces/resources/IKnowledgeDescriptor.js

@@ -1,4 +1,4 @@
-import { nodeDescriptorSchema, nodeFieldSchema, } from "./INodeDescriptorSet";
+import { nodeDescriptorSchema, nodeFieldSchema } from "./INodeDescriptorSet";
 export const knowledgeFieldTypes = [
     "text",
     "rule",
@@ -17,13 +17,13 @@ export const knowledgeFieldTypes = [
     "daterange",
     "connection",
     "condition",
-    "description",
+    "description"
 ];
 export const knowledgeFieldSchema = {
     title: "knowledgeFieldSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign({}, nodeFieldSchema.properties), { type: { type: "string", enum: [...knowledgeFieldTypes] }, key: { type: "string", minLength: 1, maxLength: 200 } }),
+    properties: Object.assign(Object.assign({}, nodeFieldSchema.properties), { type: { type: "string", enum: [...knowledgeFieldTypes] }, key: { type: "string", minLength: 1, maxLength: 200 } })
 };
 const { type, summary, defaultLabel, sections, form } = nodeDescriptorSchema.properties;
 export const knowledgeDescriptorSchema = {
@@ -36,7 +36,39 @@ export const knowledgeDescriptorSchema = {
         summary,
         sections,
         form,
-        fields: { type: "array", items: knowledgeFieldSchema },
-    },
+        fields: { type: "array", items: knowledgeFieldSchema }
+    }
+};
+const filterNonConfigFields = ({ type }) => !["description"].includes(type);
+export const buildConfigValidationSchema = (fields) => ({
+    type: "object",
+    additionalProperties: false,
+    required: (fields || []).filter(filterNonConfigFields).map(({ key }) => key),
+    properties: Object.assign({}, (fields || []).filter(filterNonConfigFields).reduce((result, field) => (Object.assign(Object.assign({}, result), { [field.key]: mapFieldToSchema(field) })), {}))
+});
+const mapFieldToSchema = ({ type, params }) => {
+    switch (type) {
+        case "checkbox":
+        case "toggle":
+            return { type: "boolean" };
+        case "number":
+        case "slider":
+            return { type: "number" };
+        case "textArray":
+            return {
+                type: "array",
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+            };
+        case "json":
+            return {
+                type: ["object", "array"],
+                additionalProperties: true
+            };
+        default:
+            return {
+                type: "string",
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+            };
+    }
 };
 //# sourceMappingURL=IKnowledgeDescriptor.js.map

package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js

@@ -54,6 +54,7 @@ export const openAICompatibleMetaSchema = {
         customModel: { type: "string" },
         baseCustomUrl: { type: "string" },
         customAuthHeader: { type: "string" },
+        embeddingVectorSize: { type: "number" },
     }
 };
 export const azureOpenAIMetaSchema = {
@@ -159,4 +160,17 @@ export const largeLanguageModelSchema = {
     properties: Object.assign(Object.assign(Object.assign({}, largeLanguageModelDataSchema.properties), entityMetaSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" }, referenceId: { type: "string", format: "uuid" } })
 };
 export const largeLanguageModelQuerySchema = createQuerySchema("largeLanguageModelQuerySchema", largeLanguageModelSchema);
+export const isIGraphLargeLanguageModel = (resource) => {
+    return (resource &&
+        resource.type === "largeLanguageModel" &&
+        resource._id &&
+        resource.name &&
+        resource.referenceId &&
+        resource.properties &&
+        resource.properties.modelType &&
+        resource.properties.createdAt &&
+        resource.properties.createdBy &&
+        resource.properties.lastChanged &&
+        resource.properties.lastChangedBy);
+};
 //# sourceMappingURL=ILargeLanguageModel.js.map

package/dist/esm/shared/interfaces/restAPI/management/authentication/ICreateJWTToken.js

@@ -0,0 +1 @@
+//# sourceMappingURL=ICreateJWTToken.js.map

package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/ICallCounterPreAggregatedValue_3_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICallCounterPreAggregatedValue_3_0.js.map

package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterOrganisationRest_3_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IGetCallCounterOrganisationRest_3_0.js.map

package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/IGetCallCounterRest_3_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IGetCallCounterRest_3_0.js.map

package/dist/esm/shared/interfaces/restAPI/metrics/callCounter/v3.0/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentJobNodeWithTools_2_0.js

@@ -0,0 +1,65 @@
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     IAiAgentJobNodeWithTools_2_0:
+ *       type: object
+ *       properties:
+ *         _id:
+ *           type: string
+ *         referenceId:
+ *           type: string
+ *         type:
+ *           type: string
+ *           example: "aiAgentJob"
+ *         label:
+ *           type: string
+ *         comment:
+ *           type: string
+ *         commentColor:
+ *           type: string
+ *         analyticsLabel:
+ *           type: string
+ *           nullable: true
+ *         isDisabled:
+ *           type: boolean
+ *         isEntryPoint:
+ *           type: boolean
+ *         extension:
+ *           type: string
+ *         config:
+ *           type: object
+ *           description: Job node configuration (content varies by implementation)
+ *         tools:
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/IAiAgentJobToolNode_2_0'
+ *     IAiAgentJobToolNode_2_0:
+ *       type: object
+ *       properties:
+ *         _id:
+ *           type: string
+ *         referenceId:
+ *           type: string
+ *         type:
+ *           type: string
+ *         label:
+ *           type: string
+ *         comment:
+ *           type: string
+ *         commentColor:
+ *           type: string
+ *         analyticsLabel:
+ *           type: string
+ *           nullable: true
+ *         isDisabled:
+ *           type: boolean
+ *         isEntryPoint:
+ *           type: boolean
+ *         extension:
+ *           type: string
+ *         config:
+ *           type: object
+ *           description: Tool node configuration (content varies by tool type)
+ */
+//# sourceMappingURL=IAiAgentJobNodeWithTools_2_0.js.map

package/dist/esm/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentJobAndToolsRest_2_0 .js

@@ -0,0 +1,3 @@
+/* Interfaces */
+export {};
+//# sourceMappingURL=IGetAiAgentJobAndToolsRest_2_0%20.js.map

package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IIndexKnowledgeDescriptorsRest_2_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IIndexKnowledgeDescriptorsRest_2_0.js.map

package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/extension/IRunKnowledgeExtensionRest_2_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRunKnowledgeExtensionRest_2_0.js.map

package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/index.js

@@ -1,2 +1,3 @@
-export {};
+export * from "./IIndexKnowledgeDescriptorsRest_2_0";
+export * from "./extension/IRunKnowledgeExtensionRest_2_0";
 //# sourceMappingURL=index.js.map

package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IStopSimulationRunBatchRest_2_0.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStopSimulationRunBatchRest_2_0.js.map

package/dist/esm/shared/interfaces/security/ICallCounterPreAggregatedValue.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICallCounterPreAggregatedValue.js.map

package/dist/esm/test.js

@@ -0,0 +1,39 @@
+/* import { RestAPIClient, TRestAPIClient } from "./RestAPIClient";
+import * as fs from "fs";
+const FormData = require("form-data");
+
+const OAUTH_CLIENT_ID = "cognigy-ui";
+const OAUTH_CLIENT_SECRET =
+    "KR7yxR3rAhZ9sEn923dZ5KeNs9SVuwBjHxXKpmqtvSNXw5xWz35Y5YRtTBt96Jaa";
+const baseUrl = "https://api.test";
+
+const instance = new RestAPIClient({
+    numberOfRetries: 2,
+    baseUrl,
+    versions: {
+        administration: "2.0",
+        external: "2.0",
+        metrics: "2.0",
+        resources: "2.0",
+        sessions: "2.0"
+    },
+    timeout: 10000
+});
+
+(async () => {
+
+    const base64SnapshotString = fs.readFileSync('./src/IDE/fixtures/snapshots/overrideSnapshotConnections_project.csnap')
+    const form = new FormData();
+
+    form.append("projectId", projectId);
+    form.append("file", base64SnapshotString, "snapshot.csnap");
+
+    const slot = await instance.uploadExtension({
+        projectId: "your-project-id"
+        fs.readFileSync('./src/IDE/fixtures/snapshots/overrideSnapshotConnections_project.csnap'),
+        user: "your-user-id",
+    });
+    console.log(slot);
+})();
+ */
+//# sourceMappingURL=test.js.map

package/package.json

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