@cognigy/rest-api-client 2025.15.1 → 2025.16.0

package/types/index.d.ts

@@ -4389,6 +4389,7 @@ declare const generativeAIModels: readonly [
 	"pixtral-large-latest",
 	"mistral-medium-latest",
 	"mistral-small-latest",
+	"text-davinci-003",
 	"text-embedding-3-small",
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
@@ -4416,11 +4417,7 @@ declare const generativeAIModels: readonly [
  *         - claude-v1-100k
  *         - claude-instant-v1
  *         - claude-3-opus-20240229
- *         - text-bison@001
  *         - custom-model
- *         - gemini-1.0-pro
- *         - gemini-1.5-pro
- *         - gemini-1.5-flash
  *         - gemini-2.0-flash
  *         - gemini-2.0-flash-lite
  *         - mistral-large-2411
@@ -8835,7 +8832,7 @@ export interface IGraphLargeLanguageModel {
 	_id: TMongoId;
 	name: string;
 	referenceId: string;
-	properties: Pick<ILargeLanguageModel, "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
+	properties: Pick<ILargeLanguageModel, "modelType" | "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 	dependencies?: IGraphLargeLanguageModelDependencyAttachment[];
 }
 export interface ISystemSlots {
@@ -10671,9 +10668,9 @@ export interface IActions {
 	logDebugMessageWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
 	logDebugErrorWithMeta?: (message: string | object, metadata: IOutputEventMetadata, header?: string) => void;
 	mergeProfile?: (contactId: string) => Promise<any>;
-	parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
-	parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
-	parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => any;
+	parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => Promise<string>;
+	parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => Promise<string>;
+	parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => Promise<any>;
 	output?: (text: string, data: any, settings?: ISayNodeSettings) => Promise<void>;
 	outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => Promise<void>;
 	reloadBrainFlow?: (flowReferenceId: string) => Promise<void>;
@@ -11267,10 +11264,10 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	setNextNode: (nodeId: string, newFlowId?: string) => void;
 	resetNextNodes: () => void;
 	stopExecution: () => void;
-	parseCognigyScriptCondition: (condition: string) => string;
-	parseCognigyScriptText: (text: string) => string;
-	parseCognigyScriptResultLocation?: (text: string) => any;
-	evaluateRule: (rule: IRule) => boolean;
+	parseCognigyScriptCondition: (condition: string) => Promise<string>;
+	parseCognigyScriptText: (text: string) => Promise<string>;
+	parseCognigyScriptResultLocation?: (text: string) => Promise<any>;
+	evaluateRule: (rule: IRule) => Promise<boolean>;
 	/**
 	 * @deprecated since 4.98.0.
 	 * Use thinkV2 instead
@@ -11340,7 +11337,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	addToInput: (key: string, value: any) => void;
 	resetCognigyScriptInput?: () => void;
 	setForwardDatesOnly?: () => void;
-	parseCognigyScript?: (text: string, condition?: boolean) => string;
+	parseCognigyScript?: (text: string, condition?: boolean) => Promise<string>;
 	trackAnalyticsStep?: (step: string) => void;
 	triggerFunction?: (config: ITriggerFunctionNodeParams["config"]) => Promise<boolean>;
 	initAppSession: (params: {
@@ -11761,9 +11758,9 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
  *         label:
  *           oneOf:
  *             - type: string
- *               description: The label that should be used when a new Node of this type is created
+ *               description: The label that should be used when a new Knowledge of this type is created
  *             - type: object
- *               description: A localized version of the label that should be used when a new Node of this type is created
+ *               description: A localized version of the label that should be used when a new Knowledge of this type is created
  *               properties:
  *                 default:
  *                   type: string
@@ -11782,7 +11779,7 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
  *             - type: string
  *               description: A short line of text that describes what this Node is used for
  *             - type: object
- *               description: A localized version of a short line of text that describes what this Node is used for
+ *               description: A localized version of a short line of text that describes what this Knowledge is used for
  *               properties:
  *                 default:
  *                   type: string
@@ -11801,11 +11798,27 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
  *           items:
  *             type: object
  *             properties:
- *               type:
- *                 type: string
- *                 enum:
- *                   - text
- *                   - rule
+*               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:
@@ -11846,6 +11859,27 @@ export interface IKnowledgeDescriptor {
 	/** The form defines how fields and sections should be rendered in order */
 	form?: INodeFieldAndSectionFormElement[];
 }
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IKnowledgeDescriptorAggregatedItem:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IKnowledgeDescriptor'
+ *         - type: object
+ *           properties:
+ *             extension:
+ *               type: string
+ *               description: The extension name that this knowledge descriptor belongs to
+ *             extensionImg:
+ *               type: string
+ *               description: The image URL of the extension that this knowledge descriptor belongs to
+ */
+export interface IKnowledgeDescriptorAggregatedItem extends IKnowledgeDescriptor {
+	extension: string;
+	extensionImg: string;
+}
 export declare type IExtensionType = "nodes";
 export interface IExtension extends IExtensionData, IExtensionNodePackage {
 }
@@ -13832,7 +13866,7 @@ export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
  *         templateId:
  *           type: string
  *           description: The ID of the AI Agent template to hire.
- *           example: insurance-agent-olivia
+ *           example: airline-support-agent-en
  *         overrideAiAgentReferenceId:
  *           type: string
  *           description: The reference ID of the AI Agent to override the AI Agent from the hired package.
@@ -13853,6 +13887,51 @@ export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRe
 }
 export interface IValidateAiAgentNameRestReturnValue_2_0 {
 }
+export interface IGetAiAgentJobAndToolsRestDataParams_2_0 {
+	aiAgentId: string;
+}
+export interface IGetAiAgentJobAndToolsRestData_2_0 extends IGetAiAgentJobAndToolsRestDataParams_2_0 {
+}
+/**
+ * Interface for a Tool attached to a Job node.
+ * Allows future tool types without code changes.
+ */
+export interface IAiAgentJobToolNode_2_0 {
+	_id: string;
+	referenceId: string;
+	type: string;
+	label: string;
+	comment: string;
+	commentColor: string;
+	analyticsLabel: string | null;
+	isDisabled: boolean;
+	isEntryPoint: boolean;
+	extension: string;
+	config: Record<string, any>;
+}
+/**
+ * Interface for a Job Node with its associated Tool nodes, as returned by the endpoint.
+ */
+export interface IAiAgentJobNodeWithTools_2_0 {
+	_id: string;
+	referenceId: string;
+	type: string;
+	label: string;
+	comment: string;
+	commentColor: string;
+	analyticsLabel: string | null;
+	isDisabled: boolean;
+	isEntryPoint: boolean;
+	extension: string;
+	chartId: string;
+	flowId: string;
+	config: Record<string, any>;
+	tools: IAiAgentJobToolNode_2_0[];
+}
+/**
+ * The main return type for the endpoint - always an array of job nodes (each with tools).
+ */
+export declare type IGetAiAgentJobAndToolsRestReturnValue_2_0 = IAiAgentJobNodeWithTools_2_0[];
 /**
  * @openapi
  *
@@ -18122,6 +18201,13 @@ export interface IUpdateKnowledgeStoreRestData_2_0 extends IUpdateKnowledgeStore
 }
 export interface IUpdateKnowledgeStoreRestReturnValue_2_0 {
 }
+export interface IIndexKnowledgeDescriptorsRestDataParams_2_0 {
+	knowledgeStoreId: string;
+}
+export interface IIndexKnowledgeDescriptorsRestData_2_0 extends IIndexKnowledgeDescriptorsRestDataParams_2_0 {
+}
+export interface IIndexKnowledgeDescriptorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeDescriptorAggregatedItem> {
+}
 declare const knowledgeSourceStatus: readonly [
 	"ready",
 	"ingesting",
@@ -18437,6 +18523,17 @@ export interface IUpdateKnowledgeChunkRestData_2_0 extends IUpdateKnowledgeChunk
 }
 export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
 }
+export interface IRunKnowledgeExtensionRestDataParams_2_0 {
+	knowledgeStoreId: string;
+}
+export interface IRunKnowledgeExtensionRestDataBody_2_0 {
+	extension: string;
+	type: string;
+	updateKnowledge: boolean;
+	config: object;
+}
+export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensionRestDataParams_2_0, IRunKnowledgeExtensionRestDataBody_2_0 {
+}
 /**
  * @openapi
  *
@@ -18884,6 +18981,13 @@ export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
 		role: "user" | "assistant";
 		content: string;
 	}[];
+	runGenerativeAIParams?: {
+		responseFormat?: "json_object" | "text" | "default";
+		maxTokens?: number;
+		topK?: number;
+		timeoutInMs?: number;
+		temperature?: number;
+	};
 }
 export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
 	projectId: string;
@@ -18891,7 +18995,7 @@ export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
 export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
 }
 export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
-	output: string;
+	output: string | object;
 }
 export interface ResourcesAPIGroup_2_0 {
 	searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
@@ -19116,6 +19220,7 @@ export interface ResourcesAPIGroup_2_0 {
 	validateAiAgentName: TRestAPIOperation<IValidateAiAgentNameRestData_2_0, IValidateAiAgentNameRestReturnValue_2_0>;
 	getAiAgentHiringTemplates: TRestAPIOperation<IGetAiAgentHiringTemplatesRestData_2_0, IGetAiAgentHiringTemplatesRestReturnValue_2_0>;
 	hireAiAgent: TRestAPIOperation<IHireAiAgentRestData_2_0, IHireAiAgentRestReturnValue_2_0>;
+	getAiAgentJobsAndTools: TRestAPIOperation<IGetAiAgentJobAndToolsRestData_2_0, IGetAiAgentJobAndToolsRestReturnValue_2_0>;
 	generateNodeOutput: TRestAPIOperation<IGenerateNodeOutputRestData_2_0, IGenerateNodeOutputRestReturnValue_2_0>;
 	indexLargeLanguageModels: TRestAPIOperation<IIndexLargeLanguageModelsRestData_2_0, IIndexLargeLanguageModelsRestReturnValue_2_0>;
 	createLargeLanguageModel: TRestAPIOperation<ICreateLargeLanguageModelRestData_2_0, ICreateLargeLanguageModelRestReturnValue_2_0>;
@@ -19130,6 +19235,8 @@ 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>;
+	indexKnowledgeDescriptors: TRestAPIOperation<IIndexKnowledgeDescriptorsRestData_2_0, IIndexKnowledgeDescriptorsRestReturnValue_2_0>;
 	indexKnowledgeSources: TRestAPIOperation<IIndexKnowledgeSourcesRestData_2_0, IIndexKnowledgeSourcesRestReturnValue_2_0>;
 	createKnowledgeSource: TRestAPIOperation<ICreateKnowledgeSourceRestData_2_0, ICreateKnowledgeSourceRestReturnValue_2_0>;
 	readKnowledgeSource: TRestAPIOperation<IReadKnowledgeSourceRestData_2_0, IReadKnowledgeSourceRestReturnValue_2_0>;
@@ -20625,6 +20732,118 @@ export interface IGetKnowledgeQueryCounterOrganisationRestData_2_0 {
 export interface IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0 {
 	items: IKnowledgeQueryCounterAggregatedValue_2_0[];
 }
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IConversationCounterAggregatedValue_3_0:
+ *       type: object
+ *       properties:
+ *         conversations:
+ *           type: number
+ *         day:
+ *           type: number
+ *         month:
+ *           type: number
+ *         year:
+ *           type: number
+ *         perChannel:
+ *           type: array
+ *           items:
+ *             type: object
+ *             properties:
+ *               channel:
+ *                 type: string
+ *               conversations:
+ *                 type: number
+ */
+export interface IConversationCounterPreAggregatedValue_3_0 {
+	/** The number of conversations in the time-span */
+	conversations: number;
+	/** The day, e.g., 1 for the first day in the month */
+	day: number;
+	/** The month of the year, e.g., 1 for January */
+	month: number;
+	/** The year, e.g., 2020 */
+	year: number;
+	/** Details on which channels those conversations happened */
+	perChannel: Array<{
+		/** The channel name */
+		channel: string;
+		/** The number of conversations for the specific channel */
+		conversations: number;
+	}>;
+}
+export interface IGetConversationCounterRestDataParams_3_0 {
+	projectId: string;
+}
+export interface IGetConversationCounterRestData_3_0 extends IGetConversationCounterRestDataParams_3_0 {
+	year: number;
+	month: number;
+}
+export interface IGetConversationCounterRestReturnValue_3_0 {
+	items: IConversationCounterPreAggregatedValue_3_0[];
+}
+export interface IGetConversationCounterOrganisationRestData_3_0 {
+	year: number;
+	month: number;
+}
+export interface IGetConversationCounterOrganisationRestReturnValue_3_0 {
+	items: IConversationCounterPreAggregatedValue_3_0[];
+}
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     ICallCounterAggregatedValue_3_0:
+ *       type: object
+ *       properties:
+ *         day:
+ *           type: number
+ *         month:
+ *           type: number
+ *         year:
+ *           type: number
+ *         maxConcurrency:
+ *           type: number
+ *         callMinutes:
+ *           type: number
+ *         processedCalls:
+ *           type: number
+ */
+export interface ICallCounterPreAggregatedValue_3_0 {
+	/** The number of calls in the time-span */
+	processedCalls: number;
+	/** The day, e.g., 1 for the first day in the month */
+	day: number;
+	/** The month of the year, e.g., 1 for January */
+	month: number;
+	/** The year, e.g., 2020 */
+	year: number;
+	/** The maximum concurrency in the time-span */
+	maxConcurrency: number;
+	/** The number of call minutes in the time-span */
+	callMinutes: number;
+}
+export interface IGetCallCounterRestDataParams_3_0 {
+	projectId: string;
+}
+export interface IGetCallCounterRestData_3_0 extends IGetCallCounterRestDataParams_3_0 {
+	year: number;
+	month: number;
+}
+export interface IGetCallCounterRestReturnValue_3_0 {
+	items: ICallCounterPreAggregatedValue_3_0[];
+}
+export interface IGetCallCounterOrganisationRestData_3_0 {
+	year: number;
+	month: number;
+}
+export interface IGetCallCounterOrganisationRestReturnValue_3_0 {
+	items: ICallCounterPreAggregatedValue_3_0[];
+}
 export interface MetricsAPIGroup_2_0 {
 	indexTasks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexTasksRestData_2_0>, IIndexTasksRestReturnValue_2_0>;
 	readTask: TRestAPIOperation<IReadTaskRestData_2_0, IReadTaskRestReturnValue_2_0>;
@@ -20651,6 +20870,10 @@ export interface MetricsAPIGroup_2_0 {
 	batchTrainerRecords: TRestAPIOperation<IBatchTrainerRecordsRestData_2_0, IBatchTrainerRecordsRestReturnValue_2_0>;
 	getConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_2_0, IGetConversationCounterRestReturnValue_2_0>;
 	getConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_2_0, IGetConversationCounterOrganisationRestReturnValue_2_0>;
+	getPreAggregatedConversationCounter: TRestAPIOperation<IGetConversationCounterRestData_3_0, IGetConversationCounterRestReturnValue_3_0>;
+	getPreAggregatedConversationCounterOrganisation: TRestAPIOperation<IGetConversationCounterOrganisationRestData_3_0, IGetConversationCounterOrganisationRestReturnValue_3_0>;
+	getPreAggregatedCallCounter: TRestAPIOperation<IGetCallCounterRestData_3_0, IGetCallCounterRestReturnValue_3_0>;
+	getPreAggregatedCallCounterOrganisation: TRestAPIOperation<IGetCallCounterOrganisationRestData_3_0, IGetCallCounterOrganisationRestReturnValue_3_0>;
 	getKnowledgeQueryCounter: TRestAPIOperation<IGetKnowledgeQueryCounterRestData_2_0, IGetKnowledgeQueryCounterRestReturnValue_2_0>;
 	getKnowledgeQueryCounterOrganisation: TRestAPIOperation<IGetKnowledgeQueryCounterOrganisationRestData_2_0, IGetKnowledgeQueryCounterOrganisationRestReturnValue_2_0>;
 	indexConversations: TRestAPIOperation<IIndexConversationsRestRestData_2_0, IIndexConversationsRestRestReturnValue_2_0>;
@@ -23380,6 +23603,16 @@ export interface IGenerateBulkPersonaRestReturnValue_2_0 {
 		missionTypesCount: number;
 	};
 }
+export interface IStopSimulationRunBatchRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunBatchRestDataQuery_2_0 {
+	simulationReference: string;
+	simulationRunBatchReference: string;
+}
+export interface IStopSimulationRunBatchRestReturnValue_2_0 {
+	simulationRunBatchId: ISimulationRunBatchRest_2_0;
+}
 export interface SimulationAPIGroup_2_0 {
 	indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
 	createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -23390,6 +23623,7 @@ export interface SimulationAPIGroup_2_0 {
 	indexSimulationRunBatches: TRestAPIOperation<IIndexSimulationRunBatchesRestData_2_0, IIndexSimulationRunBatchesRestReturnValue_2_0>;
 	getAllSimulationRunBatches: TRestAPIOperation<IGetAllSimulationRunBatchesRestData_2_0, IGetAllSimulationRunBatchesRestReturnValue_2_0>;
 	readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
+	stopSimulationRunBatch: TRestAPIOperation<IStopSimulationRunBatchRestData_2_0, IStopSimulationRunBatchRestReturnValue_2_0>;
 	indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
 	readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_2_0>;
 	getPersonaOptions: TRestAPIOperation<IGetPersonaOptionsRestData_2_0, IGetPersonaOptionsRestReturnValue_2_0>;