@cognigy/rest-api-client 2025.16.0 → 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",

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/ILargeLanguageModel.js

@@ -54,6 +54,7 @@ export const openAICompatibleMetaSchema = {
         customModel: { type: "string" },
         baseCustomUrl: { type: "string" },
         customAuthHeader: { type: "string" },
+        embeddingVectorSize: { type: "number" },
     }
 };
 export const azureOpenAIMetaSchema = {

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

@@ -0,0 +1 @@
+//# sourceMappingURL=ICreateJWTToken.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.16.0",
+	"version": "2025.17.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",

package/types/index.d.ts

@@ -4372,6 +4372,7 @@ declare const generativeAIModels: readonly [
 	"claude-sonnet-4-0",
 	"text-bison@001",
 	"custom-model",
+	"custom-embedding-model",
 	"gemini-1.0-pro",
 	"gemini-1.5-pro",
 	"gemini-1.5-flash",
@@ -4418,6 +4419,7 @@ declare const generativeAIModels: readonly [
  *         - claude-instant-v1
  *         - claude-3-opus-20240229
  *         - custom-model
+ *         - custom-embedding-model
  *         - gemini-2.0-flash
  *         - gemini-2.0-flash-lite
  *         - mistral-large-2411
@@ -8756,6 +8758,7 @@ export interface IOpenAICompatibleMeta {
 	customModel: string;
 	baseCustomUrl: string;
 	customAuthHeader?: string;
+	embeddingVectorSize?: number;
 }
 export interface IAlephAlphaMeta {
 	customModel?: string;
@@ -9913,6 +9916,22 @@ export interface INodeToExecute {
 	};
 	type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
 }
+export interface OpenAIChatMessage {
+	role: "system" | "user" | "assistant";
+	content: string;
+}
+export interface IGenerativeSlot {
+	tag: string;
+	description: string;
+	value: string;
+	optional?: boolean;
+	validation?: {
+		type: string;
+		value: string;
+		invalidReason: string;
+	};
+	invalid?: boolean;
+}
 export declare type TCompletionPrompt = {
 	prompt: string;
 };
@@ -9924,6 +9943,8 @@ export declare type TChatMessage = {
 export declare type TChatPrompt = {
 	messages: Array<TChatMessage>;
 };
+export declare type TALLPrompts = TCompletionPrompt | TChatPrompt | Array<OpenAIChatMessage>;
+export declare type TPromptParserFun = (originalMsg: TALLPrompts) => TALLPrompts;
 export declare type TSessionUsageInformation = {
 	[key: string]: {
 		llmDisplayName: string;
@@ -10077,11 +10098,15 @@ export declare type ValueOf<T> = T[keyof T];
  * @param limit: the maximum number of entries to read
  * @param rolesWhiteList: (optional) the roles for which the entries should be included, if not provided or empty all entries will be read
  * @param excludeDataOnlyMessagesFilter: (optional) the roles for which data only messages (emtpy text field) will be excluded if type is input/output
+ * @param useTextAlternativeForLLM: (optional) if true, graphical outputs will be included in the transcript, either using the value from the graphical description / fallbackText field, or by converting the data where possible
+ * @param includeTextAlternativeInTranscript: (optional) if true, the text alternative for LLM will be included in the transcript
  */
 export declare type TReadTranscriptOptions = {
 	limit: number;
 	rolesWhiteList?: TTranscriptRoles[];
 	excludeDataOnlyMessagesFilter?: (TranscriptRole.USER | TranscriptRole.AGENT | TranscriptRole.ASSISTANT)[];
+	useTextAlternativeForLLM?: boolean;
+	includeTextAlternativeInTranscript?: boolean;
 };
 declare enum TranscriptRole {
 	ASSISTANT = "assistant",
@@ -10119,6 +10144,7 @@ export declare type TTranscriptAgentOutput = {
 	payload: {
 		text?: string;
 		data?: any;
+		textAlternative?: string;
 	};
 };
 export declare type TTranscriptAssistantOutput = {
@@ -10128,6 +10154,7 @@ export declare type TTranscriptAssistantOutput = {
 	payload: {
 		text?: string;
 		data?: any;
+		textAlternative?: string;
 	};
 };
 export declare type TTranscriptAssistantToolCall = {
@@ -10189,22 +10216,6 @@ export interface ITool {
 export interface IToolParameters {
 	[key: string]: any;
 }
-export interface OpenAIChatMessage {
-	role: "system" | "user" | "assistant";
-	content: string;
-}
-export interface IGenerativeSlot {
-	tag: string;
-	description: string;
-	value: string;
-	optional?: boolean;
-	validation?: {
-		type: string;
-		value: string;
-		invalidReason: string;
-	};
-	invalid?: boolean;
-}
 export interface IRunGenerativeAIPromptOptions {
 	/**
 	 * @deprecated should not inject the prompt anymore, use getPrompt() instead
@@ -10231,7 +10242,7 @@ export interface IRunGenerativeAIPromptOptions {
 	 */
 	toolChoice?: "auto" | "required" | "none";
 	/** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
-	promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
+	promptParser?: (rawPrompt: TALLPrompts) => TALLPrompts;
 	/** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
 	temperature?: number;
 	/** model - (Optional) The OpenAI model to use. Defaults to 'gpt-4o' */
@@ -10401,10 +10412,13 @@ export declare type ISearchTagsFilterOps = "and" | "or";
 export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields {
 	tokenCacheKey: string;
 }
+export interface ILLMProviderMeta extends IAzureOpenAIMeta {
+	customAuthHeader?: string;
+}
 export interface ISearchLLMCredentials {
 	provider: TGenerativeAIProviders;
 	connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
-	providerMetaData: IAzureOpenAIMeta;
+	providerMetaData: ILLMProviderMeta;
 }
 export interface ISearchTagsData {
 	tags: string[];
@@ -10678,6 +10692,7 @@ export interface IActions {
 	rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
 	rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
 	requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
+	runGenerativeAIPromptForUseCase?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, subUseCase?: string, promptParser?: TPromptParserFun, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
 	runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
 	resetContext?: () => object;
 	resetFormBrain?: () => Promise<void>;
@@ -23321,14 +23336,16 @@ export interface IScheduleSimulationRestDataParams_2_0 {
 }
 export interface IScheduleSimulationRestDataBody_2_0 {
 	name: string;
-	largeLanguageModelReferenceId: string;
 	runConfig: {
 		flowReferenceId: string;
 		localeReferenceId?: string;
 		entrypoint: string;
+		largeLanguageModelReferenceId?: string;
+		userId?: string;
 	};
 	projectReference: string;
 	numberOfExecutions: number;
+	endPointType: string;
 }
 export interface IScheduleSimulationRestData_2_0 extends IScheduleSimulationRestDataParams_2_0, IScheduleSimulationRestDataBody_2_0 {
 }
@@ -23496,12 +23513,18 @@ export interface IGetPersonaOptionsRestData_2_0 {
 export interface IMissionType_2_0 {
 	name: string;
 	description: string;
+	successCriteria: SuccessCriteria[];
+}
+export interface SuccessCriteria {
+	name: string;
+	description: string;
 }
 export interface IPersonaType_2_0 {
 	name: string;
 	description: string;
 }
 export interface IGetPersonaOptionsRestReturnValue_2_0 {
+	simulationName: string;
 	missionTypes: IMissionType_2_0[];
 	personaTypes: IPersonaType_2_0[];
 }