@cognigy/rest-api-client 2025.16.0 → 2025.18.0

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,15 +36,15 @@ 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) })), {}))
+    properties: Object.assign({}, (fields || []).filter(filterNonConfigFields).reduce((result, field) => (Object.assign(Object.assign({}, result), { [field.key]: mapFieldToSchema(field) })), {})),
 });
 const mapFieldToSchema = ({ type, params }) => {
     switch (type) {
@@ -55,19 +55,20 @@ const mapFieldToSchema = ({ type, params }) => {
         case "slider":
             return { type: "number" };
         case "textArray":
+        case "chipInput":
             return {
                 type: "array",
-                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0,
             };
         case "json":
             return {
                 type: ["object", "array"],
-                additionalProperties: true
+                additionalProperties: true,
             };
         default:
             return {
                 type: "string",
-                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0
+                minLength: (params === null || params === void 0 ? void 0 : params.required) ? 1 : 0,
             };
     }
 };

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/resources/TResourceType.js

@@ -156,6 +156,7 @@ export const searchableResourceTypes = [
     "playbook",
     "project",
     "snapshot",
+    "simulation",
 ];
 export const packageableResourceTypes = [
     "aiAgent",

package/package.json

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

package/types/index.d.ts

@@ -771,6 +771,10 @@ declare class InvalidArgumentError extends BadRequestError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
 		[key: string]: any;
 	}, logLevel?: TLogLevel);
+	toRFC7807Response(data?: {
+		path?: string;
+		traceId?: string;
+	}): IErrorResponse;
 }
 declare class MethodNotAllowedError extends BaseError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
@@ -781,6 +785,10 @@ declare class MissingArgumentError extends BadRequestError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
 		[key: string]: any;
 	}, logLevel?: TLogLevel);
+	toRFC7807Response(data?: {
+		path?: string;
+		traceId?: string;
+	}): IErrorResponse;
 }
 declare class NetworkError extends BaseError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
@@ -979,7 +987,8 @@ declare const searchableResourceTypes: readonly [
 	"nluconnector",
 	"playbook",
 	"project",
-	"snapshot"
+	"snapshot",
+	"simulation"
 ];
 export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
 declare const pinnableResourceTypes: readonly [
@@ -4372,6 +4381,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 +4428,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
@@ -5525,15 +5536,15 @@ export interface IMongoosePaginationPluginReturnValue<T = any> {
  *           type: integer
  *           example: 1
  *         next:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
+ *           nullable: true
  *           example: 5ce7c2d833ea1e04d7e6c432
  *         previous:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
- *           example: null
+ *           nullable: true
+ *           example: 5ce7c2d833ea1e04d7e6c432
  */
 export interface ICursorBasedPaginationReturnValue<T> extends IMongoosePaginationPluginReturnValue<T> {
 }
@@ -8756,6 +8767,7 @@ export interface IOpenAICompatibleMeta {
 	customModel: string;
 	baseCustomUrl: string;
 	customAuthHeader?: string;
+	embeddingVectorSize?: number;
 }
 export interface IAlephAlphaMeta {
 	customModel?: string;
@@ -9913,6 +9925,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 +9952,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 +10107,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 +10153,7 @@ export declare type TTranscriptAgentOutput = {
 	payload: {
 		text?: string;
 		data?: any;
+		textAlternative?: string;
 	};
 };
 export declare type TTranscriptAssistantOutput = {
@@ -10128,6 +10163,7 @@ export declare type TTranscriptAssistantOutput = {
 	payload: {
 		text?: string;
 		data?: any;
+		textAlternative?: string;
 	};
 };
 export declare type TTranscriptAssistantToolCall = {
@@ -10189,22 +10225,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 +10251,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 +10421,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[];
@@ -10631,7 +10654,7 @@ export interface IActions {
 	getState?: () => string;
 	getSystemContext?: (key: string) => any;
 	emitEvent?: TEmitter;
-	executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
+	executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => Promise<void>;
 	executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
 	handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
 	/**
@@ -10678,6 +10701,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>;
@@ -10925,6 +10949,11 @@ export interface IPatternMatchResult {
 	detailedMatches?: any[];
 }
 export declare type IPatternTypes = "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber";
+export interface IExecutionMetadata {
+	sessionId: string;
+	projectId: string;
+	organisationId: string;
+}
 export interface IExecutionObjects {
 	input: {
 		[key: string]: any;
@@ -10939,6 +10968,7 @@ export interface IExecutionObjects {
 		[key: string]: any;
 	};
 	lastConversationEntries: ILastConversationEntry[];
+	metadata: IExecutionMetadata;
 }
 export declare type TEmitter = (type: TDebugEventType, payload: TDebugEventPayload, options?: IEmitterOptions) => void;
 export interface IEmitterOptions {
@@ -11286,7 +11316,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	executeCognigyNLU?: (text: string, data: any, inputId: string, pipeline: IGetNluPipelineParams) => Promise<INLProperties>;
 	handleIntentDefaultReply?: (nlProperties: INLProperties) => Promise<any>;
 	executeFlow: (config: IExecuteFlowNodeConfig) => Promise<void>;
-	goToNode?: (config: IGoToNodeParams["config"]["flowNode"]) => Promise<void>;
+	goToNode?: (config: Pick<IGoToNodeParams["config"], "flowNode" | "absorbContext">) => Promise<void>;
 	addConditionalEntrypoint: (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
 	runSQLQuery?: (params: {
 		connection: ISQLConnectionFields;
@@ -11798,27 +11828,27 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
  *           items:
  *             type: object
  *             properties:
-*               type:
-*                 type: string
-*                 enum:
-*                   - text
-*                   - rule
-*                   - json
-*                   - checkbox
-*                   - time
-*                   - date
-*                   - datetime
-*                   - select
-*                   - xml
-*                   - textArray
-*                   - chipInput
-*                   - toggle
-*                   - slider
-*                   - number
-*                   - daterange
-*                   - connection
-*                   - condition
-*                   - description
+ *               type:
+ *                 type: string
+ *                 enum:
+ *                   - text
+ *                   - rule
+ *                   - json
+ *                   - checkbox
+ *                   - time
+ *                   - date
+ *                   - datetime
+ *                   - select
+ *                   - xml
+ *                   - textArray
+ *                   - chipInput
+ *                   - toggle
+ *                   - slider
+ *                   - number
+ *                   - daterange
+ *                   - connection
+ *                   - condition
+ *                   - description
  *               key:
  *                 type: string
  *               label:
@@ -13154,9 +13184,9 @@ export interface IIndexChartNodesRestReturnValue_2_0 extends ICursorBasedPaginat
  *           items:
  *             $ref: '#/components/schemas/TMongoId'
  *         next:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
+ *           nullable: true
  */
 export interface IChartNodeRelation_2_0 {
 	_id: TMongoId;
@@ -18239,6 +18269,11 @@ export interface IKnowledgeSourceMetaData {
 	failReason?: string;
 	tags?: string[];
 	extractedChunks?: number;
+	extension?: {
+		name: string;
+		id: string;
+		type: string;
+	};
 }
 /**
  * @openapi
@@ -18534,6 +18569,8 @@ export interface IRunKnowledgeExtensionRestDataBody_2_0 {
 }
 export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensionRestDataParams_2_0, IRunKnowledgeExtensionRestDataBody_2_0 {
 }
+export interface IRunKnowledgeExtensionRestReturnValue_2_0 extends ICreatedTask_2_0 {
+}
 /**
  * @openapi
  *
@@ -19235,7 +19272,7 @@ export interface ResourcesAPIGroup_2_0 {
 	readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
 	deleteKnowledgeStore: TRestAPIOperation<IDeleteKnowledgeStoreRestData_2_0, IDeleteKnowledgeStoreRestReturnValue_2_0>;
 	updateKnowledgeStore: TRestAPIOperation<IUpdateKnowledgeStoreRestData_2_0, IUpdateKnowledgeStoreRestReturnValue_2_0>;
-	runKnowledgeExtension: TRestAPIOperation<IRunKnowledgeExtensionRestData_2_0, IRunKnowledgeExtensionRestDataBody_2_0>;
+	runKnowledgeExtension: TRestAPIOperation<IRunKnowledgeExtensionRestData_2_0, IRunKnowledgeExtensionRestReturnValue_2_0>;
 	indexKnowledgeDescriptors: TRestAPIOperation<IIndexKnowledgeDescriptorsRestData_2_0, IIndexKnowledgeDescriptorsRestReturnValue_2_0>;
 	indexKnowledgeSources: TRestAPIOperation<IIndexKnowledgeSourcesRestData_2_0, IIndexKnowledgeSourcesRestReturnValue_2_0>;
 	createKnowledgeSource: TRestAPIOperation<ICreateKnowledgeSourceRestData_2_0, ICreateKnowledgeSourceRestReturnValue_2_0>;
@@ -23321,14 +23358,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 +23535,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[];
 }