@cognigy/rest-api-client 2025.23.0 → 2025.25.0

package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js

@@ -18,4 +18,18 @@ export var ESentimentTypeRest_2_0;
     ESentimentTypeRest_2_0["NEUTRAL"] = "NEUTRAL";
     ESentimentTypeRest_2_0["NEGATIVE"] = "NEGATIVE";
 })(ESentimentTypeRest_2_0 || (ESentimentTypeRest_2_0 = {}));
+export var ESimulationStatusRest_2_0;
+(function (ESimulationStatusRest_2_0) {
+    ESimulationStatusRest_2_0["SUCCESS"] = "success";
+    ESimulationStatusRest_2_0["FAILED"] = "failed";
+    ESimulationStatusRest_2_0["ERROR"] = "error";
+})(ESimulationStatusRest_2_0 || (ESimulationStatusRest_2_0 = {}));
+export var ESimulationErrorCategoryRest_2_0;
+(function (ESimulationErrorCategoryRest_2_0) {
+    ESimulationErrorCategoryRest_2_0["NONE"] = "none";
+    ESimulationErrorCategoryRest_2_0["AI_AGENT_TIMEOUT"] = "ai_agent_timeout";
+    ESimulationErrorCategoryRest_2_0["LLM_PROVIDER_ERROR"] = "llm_provider_error";
+    ESimulationErrorCategoryRest_2_0["AI_AGENT_ERROR"] = "ai_agent_error";
+    ESimulationErrorCategoryRest_2_0["UNKNOWN"] = "unknown";
+})(ESimulationErrorCategoryRest_2_0 || (ESimulationErrorCategoryRest_2_0 = {}));
 //# sourceMappingURL=ISimulationRunRest_2_0.js.map

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

@@ -3,4 +3,9 @@ export const SimulationRunBatchStatus = [
     "COMPLETED",
     "FAILED"
 ];
+export var SuccessCriterionTypeRest_2_0;
+(function (SuccessCriterionTypeRest_2_0) {
+    SuccessCriterionTypeRest_2_0["TEXT"] = "text";
+    SuccessCriterionTypeRest_2_0["GOAL_COMPLETED"] = "goalCompleted";
+})(SuccessCriterionTypeRest_2_0 || (SuccessCriterionTypeRest_2_0 = {}));
 //# sourceMappingURL=ISimulationRunBatchRest_2_0.js.map

package/package.json

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

package/types/index.d.ts

@@ -2862,8 +2862,6 @@ declare const generativeAIModels: readonly [
  *         - luminous-extended-control
  *         - luminous-embedding-128
  *         - Pharia-1-Embedding-4608
- *         - claude-v1-100k
- *         - claude-instant-v1
  *         - claude-3-opus-20240229
  *         - custom-model
  *         - custom-embedding-model
@@ -3030,9 +3028,8 @@ export interface IVoiceGateway2VadParams {
 	voiceMs?: number;
 	mode?: number;
 }
-export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
 export interface IVoiceGateway2SynthesizerParams {
-	vendor?: TVoiceGateway2TTSVendor | "default" | "none";
+	vendor?: string;
 	language?: string;
 	voice?: string;
 	label?: string;
@@ -3047,11 +3044,10 @@ export interface IVoiceGateway2SynthesizerParams {
 	disableCache?: boolean;
 	model?: string;
 }
-export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
 export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
 export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
 export interface IVoiceGateway2RecognizerParams {
-	vendor?: TVoiceGateway2STTVendor | "default" | "none";
+	vendor?: string;
 	language?: string;
 	label?: string;
 	fallbackVendor?: string;
@@ -3447,6 +3443,9 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
 	privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
 		cancelButtonText: string;
 	};
+	transcription: {
+		enabled: boolean;
+	};
 }
 export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | IZoomContactCenterEndpointSettings | {};
 export declare type TAvayaVoice = "man" | "woman" | string;
@@ -9679,7 +9678,7 @@ export interface ISpeakingStyle {
 export interface IVoiceConfigParams {
 	ttsVoice: string;
 	ttsLanguage: string;
-	ttsVendor: TVoiceGateway2TTSVendor | "none";
+	ttsVendor: string;
 	ttsModel: string;
 	ttsLabel: string;
 	ttsDisableCache: boolean;
@@ -10693,6 +10692,101 @@ export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeF
 	isDisabled: boolean;
 	analyticsLabel?: string;
 }
+/**
+ * @param meta.contactNumber DirectQuery views this is as an identifier similar to a session ID
+ */
+export interface ICXoneKnowledgehubRequestBody {
+	schemaVersion?: string;
+	timestamp: string;
+	meta: {
+		tenantId?: string;
+		contactNumber: string;
+		agentUid?: string;
+		provider: string;
+	};
+	query: {
+		uid: string;
+		text: string;
+		persona?: string;
+		language?: string;
+	};
+	kbFiltering?: {
+		conversationContextRefId?: string;
+		filters?: string;
+	};
+	config: {
+		kbAnswers: {
+			promptEditorProfileId?: string;
+			answers: {
+				enabled: boolean;
+				maxWords: number;
+			};
+			images: {
+				enabled: boolean;
+				maxImages: number;
+			};
+			links: {
+				enabled: boolean;
+				maxLinks: number;
+			};
+		};
+		kbProcessSteps: {
+			enabled: boolean;
+			maxSteps: number;
+			maxTitleWords: number;
+			maxStepWords: number;
+		};
+		awsBedrock: {
+			knowledgeHubId: string;
+			awsBedrockKbId: string;
+			maxKernels: number;
+			shareable: boolean;
+			promptTemplate?: {
+				textPromptTemplate: string;
+				modelArn: string;
+			};
+		};
+	};
+}
+export interface ICXoneKnowledgehubResponseBody {
+	timestamp: string;
+	kbAnswers: {
+		uid: string;
+		conversationContextRefId?: string;
+		kbCompletions: Array<{
+			uid: string;
+			kbCompletion: string;
+			restriction: "Public" | "Private" | "Combine";
+			citations: Array<{
+				text: string;
+				start: number;
+				end: number;
+			}>;
+		}>;
+		kbImages: Array<{
+			uid: string;
+			pageId: number;
+			title: string;
+			link: string;
+			thumbnail: string;
+			restriction: "Public" | "Private";
+		}>;
+		kbLinks: Array<{
+			uid: string;
+			pageId: number;
+			title: string;
+			link: string;
+			restriction: "Public" | "Private";
+		}>;
+	};
+}
+export interface INiceCXoneKnowledgehubFields {
+	accessKey: string;
+	secretKey: string;
+	clientId?: string;
+	clientSecret?: string;
+	endpointUrl?: string;
+}
 export interface IGetConversationTranscriptParams {
 	turnLimit: number;
 }
@@ -10860,6 +10954,7 @@ export interface IActions {
 	getEndpointSettings: () => IEndpointSettings;
 	getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
 	addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
+	executeNiceCxoneKnowledgehubApiRequest(knowledgehubConnection: INiceCXoneKnowledgehubFields, requestBody: ICXoneKnowledgehubRequestBody): Promise<ICXoneKnowledgehubResponseBody>;
 }
 export interface IGetMetaDataActionValue {
 	sessionId: string;
@@ -16805,7 +16900,7 @@ export interface IVoiceConfigParams {
 	ttsVoice: string;
 	ttsLanguage: string;
 	ttsModel: string;
-	ttsVendor: TVoiceGateway2TTSVendor | "default" | "none";
+	ttsVendor: string;
 	ttsLabel: string;
 	azureSttContextId: string;
 	azureSpeechRecognitionMode: string;
@@ -16918,7 +17013,7 @@ export interface IVoiceConfigParams {
 	sttHintsDynamicHints: string[] | undefined;
 	ttsVoice: string;
 	ttsLanguage: string;
-	ttsVendor: TVoiceGateway2TTSVendor;
+	ttsVendor: string;
 	ttsModel: string;
 	sttDisablePunctuation: boolean;
 	azureSttContextId: string;
@@ -20017,7 +20112,8 @@ export interface IMemory {
 	text: string;
 }
 declare const profileTypes: readonly [
-	"simulator"
+	"simulator",
+	"regular"
 ];
 export declare type TProfileTypes = (typeof profileTypes)[number];
 /**
@@ -21476,7 +21572,8 @@ declare const actionTypes: readonly [
 	"loginSucceeded",
 	"loginFailed",
 	"loginError",
-	"unauthorized"
+	"unauthorized",
+	"disableCreditCardRedaction"
 ];
 export declare type TActionType = typeof actionTypes[number];
 /**
@@ -22443,6 +22540,9 @@ export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDa
  *         businessUnitId:
  *           type: string
  *           description: The business unit ID
+ *         tenantId:
+ *           type: string
+ *           description: The tenant ID
  *     IOrganisation_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/IOrganisationData_2_0'
@@ -22466,6 +22566,8 @@ export interface IOrganisation_2_0 {
 	name: string;
 	/** The business unit ID */
 	businessUnitId?: string;
+	/** The tenant ID */
+	tenantId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -22566,6 +22668,9 @@ export interface IOrganisationDataPrivacySettings_2_0 {
  *         businessUnitId:
  *           type: string
  *           description: The business unit ID
+ *         tenantId:
+ *           type: string
+ *           description: The tenant ID
  *         name:
  *           type: string
  *           description: The name of this organisation
@@ -22606,6 +22711,8 @@ export interface IOrganisationIndexItem_2_0 {
 	name: string;
 	/** The business unit ID */
 	businessUnitId?: string;
+	/** The tenant ID */
+	tenantId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -23455,6 +23562,8 @@ export interface IProjectMetadataRest_2_0 {
 }
 export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
 	id: string;
+	_id: string;
+	referenceId: string;
 	name: string;
 	persona: string;
 	personaName: string;
@@ -23462,13 +23571,17 @@ export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
 	successCriteria: ISuccessCriteriaRest_2_0[];
 	maxTurns?: number;
 	timeout?: number;
+	aiAgentReferenceId?: string;
+	aiAgentId?: string;
+	flowReferenceId?: string;
+	flowId?: string;
+	jobNodeId?: string;
 	createdAt?: number;
 	createdBy: string;
 	updatedAt?: number;
 	updatedBy: string;
 	lastChanged: number;
 	lastChangedBy?: string;
-	expiresAt?: Date;
 }
 export interface IIndexSimulationsRestDataQuery_2_0 {
 	projectId?: string;
@@ -23599,6 +23712,8 @@ export interface ISuccessCriteriaGoalParams_2_0 {
 	name: string;
 }
 export interface ISuccessCriteriaRest_2_0 {
+	name?: string;
+	text?: string;
 	type: SuccessCriterionType_2_0;
 	params: ISuccessCriteriaTextParams_2_0 | ISuccessCriteriaGoalParams_2_0;
 }
@@ -23607,6 +23722,34 @@ declare enum ESentimentTypeRest_2_0 {
 	NEUTRAL = "NEUTRAL",
 	NEGATIVE = "NEGATIVE"
 }
+declare enum ESimulationStatusRest_2_0 {
+	SUCCESS = "success",
+	FAILED = "failed",
+	ERROR = "error"
+}
+declare enum ESimulationErrorCategoryRest_2_0 {
+	NONE = "none",
+	AI_AGENT_TIMEOUT = "ai_agent_timeout",
+	LLM_PROVIDER_ERROR = "llm_provider_error",
+	AI_AGENT_ERROR = "ai_agent_error",
+	UNKNOWN = "unknown"
+}
+export interface ISimulationErrorInfoRest_2_0 {
+	category: ESimulationErrorCategoryRest_2_0;
+	message?: string;
+	technicalDetails?: string;
+}
+export interface ISuccessRateRest_2_0 {
+	percentage: number;
+	fraction: string;
+	achieved: number;
+	total: number;
+}
+export interface ISuccessCriterionResultRest_2_0 {
+	criterion: ISuccessCriteriaRest_2_0;
+	achieved: boolean;
+	reason: string;
+}
 export interface ISimulationRunRest_2_0 {
 	id: string;
 	organisationReference: string;
@@ -23615,15 +23758,21 @@ export interface ISimulationRunRest_2_0 {
 	simulationRunBatchReference: string;
 	sequence: number;
 	largeLanguageModelReferenceId: string;
+	endPointType?: string;
 	turns: ITurnRest_2_0[];
 	totalTurns: number;
+	maxTurns?: number;
 	successCriteria: ISuccessCriteriaRest_2_0[];
 	metrics: {
 		sentiment: ESentimentTypeRest_2_0;
-		outOfScope: string;
-		efficiency: number;
-		topic: string;
 		success: boolean;
+		results?: ISuccessCriterionResultRest_2_0[];
+		successRate?: ISuccessRateRest_2_0;
+		summary?: string;
+		isBatchStopped?: boolean;
+		isConversationEnded?: boolean;
+		errorInfo?: ISimulationErrorInfoRest_2_0;
+		status?: ESimulationStatusRest_2_0;
 	};
 	createdAt: number;
 	createdBy: string;
@@ -23639,30 +23788,63 @@ export declare type TSimulationRunBatchStatusRest_2_0 = typeof SimulationRunBatc
 export interface IBatchSuccessCriteriaOverview_2_0 extends ISuccessCriteriaRest_2_0 {
 	percentage: number;
 }
+export interface IEfficiencyScoreRest_2_0 {
+	label: string;
+	start: number;
+	end: number;
+	counter: number;
+}
+export interface IAverageSuccessRateForRunsRest_2_0 {
+	percentage: number;
+	fraction: string;
+	achieved: number;
+	total: number;
+	average: number;
+}
+export interface IBatchMetricsRest_2_0 {
+	_v: number;
+	efficiencyScore?: IEfficiencyScoreRest_2_0[];
+	turnsDistribution?: IEfficiencyScoreRest_2_0[];
+	successRate?: number;
+	averageSuccessRateForRuns?: IAverageSuccessRateForRunsRest_2_0;
+	successCriterias?: IBatchSuccessCriteriaOverview_2_0[];
+	averageTurns?: number;
+	averageSentiment?: string;
+	runResults?: {
+		succeeded: number;
+		failed: number;
+		notExecuted?: number;
+	};
+}
 export interface ISimulationRunBatchRest_2_0 {
 	id: string;
+	_id: string;
 	name: string;
 	status: TSimulationRunBatchStatusRest_2_0;
 	numberOfExecutions: number;
-	successRate?: number;
-	efficiency?: number;
 	simulationReference: string;
 	projectReference: string;
 	organisationReference: string;
+	endPointType?: string;
 	runConfig: {
 		flowReferenceId: string;
 		localeReferenceId?: string;
 		entrypoint: string;
+		largeLanguageModelReferenceId: string;
+		userId?: string;
+		finalPing?: number;
+	};
+	simulationFrozen: {
+		persona: string;
+		personaName: string;
+		mission: string;
 	};
 	createdAt: number;
 	createdBy: string;
-	largeLanguageModelReferenceId: string;
 	updatedAt?: number;
 	completedAt?: number;
 	expiresAt?: Date;
-	batchMetrics?: {
-		results?: IBatchSuccessCriteriaOverview_2_0[];
-	};
+	batchMetrics?: IBatchMetricsRest_2_0;
 }
 export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
 	projectId: string;
@@ -23742,7 +23924,7 @@ export interface IMissionType_2_0 {
 }
 export interface SuccessCriteria {
 	name: string;
-	description: string;
+	text: string;
 }
 export interface IPersonaType_2_0 {
 	name: string;