@cognigy/rest-api-client 4.94.0 → 4.96.0

package/types/index.d.ts

@@ -1982,7 +1982,7 @@ declare const analyticsSourceTypes: readonly [
 export interface IBaseAnalyticsSourceData extends IBaseAnalyticsData {
 	intentScore: number;
 	intentFlow: string;
-	understood: boolean;
+	understood: boolean | null;
 	type: TAnalyticsType;
 	source: TAnalyticsSource;
 	schemaVersion: number;
@@ -2536,6 +2536,8 @@ export interface ICallEventFailoverSettings {
 	dialCallerId?: string;
 	dialMusic?: string;
 	dialTimeout?: number;
+	enableTimeLimit?: boolean;
+	timeLimit?: number;
 	dialTranscribeEnabled?: boolean;
 	dialTranscribeVendor?: string;
 	dialTranscribeLanguage?: string;
@@ -2946,8 +2948,8 @@ export interface IWebchatEndpointSharedSettings extends ITypingIndicatorSettings
 	 */
 	enableFileUpload: boolean;
 	/**
-	 * Whether to display a persistent
-	 * menu in the Webchat.
+	* Whether to display a persistent
+	* menu in the Webchat.
 	 */
 	enablePersistentMenu: boolean;
 	/**
@@ -3207,6 +3209,15 @@ export interface IWebchat3EndpointLayoutSettings {
 	 * of input messages with a delay for the webchat
 	  */
 	enableInputCollation: boolean;
+	/**
+	* Whether to display a persistent
+	* menu in the Webchat.
+	 */
+	enablePersistentMenu: boolean;
+	/**
+	 * The persistent menu for the webchat
+	 */
+	persistentMenu: IWebchatPersistentMenu;
 	/**
 		 * This setting configures the delay for the automatic
 	 * input collation in miliseconds. Defaults to 1000
@@ -3252,6 +3263,18 @@ export interface IWebchat3EndpointLayoutSettings {
 	 * Advanced watermark URL settings for the webchat
 	 */
 	watermarkUrl: string;
+	/**
+	 * Setting to hide the chat bubble around AI Agent Messages
+	 */
+	disableBotOutputBorder: boolean;
+	/**
+	 * Set a number that will be used as a percentage value for the max-width of AI Agent Messages
+	 */
+	botOutputMaxWidthPercentage: number;
+	/**
+	 * Configure the width of the Webchat in px
+	 */
+	chatWindowWidth: number;
 }
 export interface IWebchat3EndpointColorsSettings {
 	/**
@@ -3335,6 +3358,23 @@ export interface IWebchat3EndpointBehaviorSettings {
 	 * a connectivity indicator should be displayed
 	 */
 	enableConnectionStatusIndicator: boolean;
+	/**
+	 * This setting enables collation of streamed
+	 * messages into one message bubble.
+	 */
+	collateStreamedOutputs: boolean;
+	/**
+	 * This setting enables output messages to appear progressively.
+	 */
+	progressiveMessageRendering: boolean;
+	/**
+	 * Whether the webchat renders Text messages as markdown
+	 */
+	renderMarkdown: boolean;
+	/**
+	 * This setting determines how scrolling behaves if chat is scrolled to bottom and a new message comes in.
+	 */
+	scrollingBehavior: string;
 }
 export interface IWebchat3EndpointStartBehaviorSettings {
 	/**
@@ -4186,6 +4226,7 @@ declare const generativeAIModels: readonly [
 	"amazon.nova-pro-v1:0",
 	"amazon.nova-micro-v1:0",
 	"anthropic.claude-3-5-sonnet-20240620-v1:0",
+	"claude-3-7-sonnet-20250219",
 	"text-embedding-3-small",
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
@@ -8414,10 +8455,85 @@ export interface IGraphAgentAssistConfig {
 	referenceId: string;
 	properties: Pick<IAgentAssistConfig, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 }
+/**
+ * @openapi
+ * components:
+ *   parameters:
+ *     globalResourceQueryParam:
+ *       in: query
+ *       name: resourceLevel
+ *       description: Scope of the resource (global "organisation" or project).
+ *       required: false
+ *       schema:
+ *         $ref: '#/components/schemas/ResourceLevel'
+ *   schemas:
+ *     ResourceLevel:
+ *       type: string
+ *       enum:
+ *         - organisation
+ *         - project
+ *       description: General scope of the resource.
+ *       default: project
+ *
+ *     ProjectScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - project
+ *           description: Scope for project-level resources.
+ *
+ *     GlobalScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - organisation
+ *           description: Scope for globally scoped resources.
+ *       required:
+ *         - resourceLevel
+ *
+ *     AssignedToProjects:
+ *       type: object
+ *       properties:
+ *         assignedToProjects:
+ *           type: array
+ *           items:
+ *             type: string
+ *             description: MongoDB ObjectId representing a project
+ *
+ *     IGlobalResourceFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/GlobalScopedResource'
+ *         - $ref: '#/components/schemas/AssignedToProjects'
+ *
+ *     IProjectResourceFields_2_0:
+ *        $ref: '#/components/schemas/ProjectScopedResource'
+ *
+ *     IGlobalResourceData:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
+ *         - type: object
+ *           properties:
+ *             id:
+ *               type: string
+ *               description: The unique identifier for the resource.
+ *               example: 507f191e810c19729de860eb
+ *
+ *     IGlobalResource:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceData'
+ */
+export interface IGlobalResource {
+	resourceLevel?: "organisation" | "project";
+	assignedToProjects?: TMongoId[];
+}
 export interface IConnectionFields {
 	[key: string]: string;
 }
-export interface IConnection extends IEntityMeta {
+export interface IConnection extends IEntityMeta, Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8483,7 +8599,7 @@ export declare type TLLMFallback = {
 		emailNotificationList: string[];
 	};
 };
-export interface ILargeLanguageModel extends IEntityMeta {
+export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8495,7 +8611,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
 	provider: TGenerativeAIProviders;
 	connectionId: string;
 	isDefault: boolean;
-	projectReference: TMongoId;
+	projectReference?: TMongoId;
 	organisationReference: TMongoId;
 	azureOpenAI?: IAzureOpenAIMeta;
 	googleVertexAI?: IGoogleVertexAIMeta;
@@ -9231,6 +9347,12 @@ export interface ISpeakingStyle {
 	formality: string;
 	[key: string]: string;
 }
+export interface IVoiceConfigParams {
+	ttsVoice: string;
+	ttsLanguage: string;
+	ttsVendor: TVoiceGateway2TTSVendor | "none";
+	ttsModel: string;
+}
 declare const contactProfileOptions: readonly [
 	"none",
 	"selectedProfileFields",
@@ -9252,6 +9374,8 @@ export interface IAiAgent extends IEntityMeta {
 	knowledgeReferenceId: string;
 	description: string;
 	speakingStyle: ISpeakingStyle;
+	voiceConfigs: IVoiceConfigParams;
+	enableVoiceConfigs: boolean;
 	safetySettings: ISafetySettings;
 	instructions: string;
 	contactProfilesOption: TContactProfileOptions;
@@ -9982,6 +10106,10 @@ export interface IRunGenerativeAIPromptOptions {
 			maxImageFileSizeInBytes?: number;
 		};
 	};
+	/**
+	   * Option to prevent the replacing of \n with " " in streamed outputs
+	   */
+	preventNewLineRemoval?: boolean;
 }
 export interface IAzureOpenAIProviderFieldsV2 {
 	apiKey: string;
@@ -14496,7 +14624,7 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
  *                   description: The type of connection.
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnectionIndexItem_2_0 {
+export interface IConnectionIndexItem_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -14508,7 +14636,7 @@ export interface IConnectionIndexItem_2_0 {
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
 }
-export interface IIndexConnectionsRestData_2_0 extends IRestPagination<IConnectionIndexItem_2_0>, Partial<IProjectScope> {
+export interface IIndexConnectionsRestData_2_0 extends IRestPagination<IConnectionIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope> {
 }
 export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IConnectionIndexItem_2_0> {
 }
@@ -14579,7 +14707,7 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
  *         - $ref: '#/components/schemas/IConnectionData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnection_2_0 {
+export interface IConnection_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16059,6 +16187,8 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
 		dialCallerId?: string;
 		dialMusic?: string;
 		dialTimeout?: number;
+		enableTimeLimit?: boolean;
+		timeLimit?: number;
 		dialTranscriptionWebhook?: string;
 		recognitionChannel: number;
 		sttLanguage: string;
@@ -16633,103 +16763,111 @@ export interface IGoogleGeminiMeta_2_0 {
  *
  * components:
  *   schemas:
- *     ILargeLanguageModelFields_2_0:
- *       allOf:
- *         - type: object
- *           required: ['name', 'modelType', 'provider', 'connectionId']
+ *     ILargeLanguageModelFieldsBase_2_0:
+ *       type: object
+ *       required: ['name', 'modelType', 'provider', 'connectionId']
+ *       properties:
+ *         name:
+ *           type: string
+ *           example: "LLM Name"
+ *         description:
+ *           type: string
+ *           example: "LLM meaningful description"
+ *         modelType:
+ *           $ref: '#/components/schemas/TGenerativeAIModels'
+ *         modelGroup:
+ *           $ref: '#/components/schemas/TModelGroups'
+ *         isCustomModel:
+ *           type: boolean
+ *           example: true
+ *         provider:
+ *           $ref: '#/components/schemas/TGenerativeAIProviders'
+ *         connectionId:
+ *           type: string
+ *           description: The reference id of the GenerativeAI Provider Connection
+ *           format: uuid
+ *         openAI:
+ *           type: object
+ *           description: OpenAI specific meta data
  *           properties:
- *             name:
+ *             customModel:
  *               type: string
- *               example: "LLM Name"
- *             description:
+ *               example: gpt-4-32k-0613
+ *               description: The custom model name. This does not work with embedding models
+ *         anthropic:
+ *           type: object
+ *           description: Anthropic specific meta data
+ *           properties:
+ *             customModel:
  *               type: string
- *               example: "LLM meaningful description"
- *             modelType:
- *               $ref: '#/components/schemas/TGenerativeAIModels'
- *             modelGroup:
- *               $ref: '#/components/schemas/TModelGroups'
- *             isCustomModel:
- *               type: boolean
- *               example: true
- *             provider:
- *               $ref: '#/components/schemas/TGenerativeAIProviders'
- *             connectionId:
+ *               example: claude-3-opus-20240229
+ *               description: The custom model name. This does not work with embedding models
+ *         azureOpenAI:
+ *           type: object
+ *           description: Azure OpenAI specific meta data
+ *           properties:
+ *             resourceName:
  *               type: string
- *               description: The reference id of the GenerativeAI Provider Connection
- *               format: uuid
+ *             deploymentName:
+ *               type: string
+ *             apiVersion:
+ *               type: string
+ *             baseCustomUrl:
+ *               type: string
+ *               example:
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
+ *         googleVertexAI:
+ *           type: object
+ *           description: Google VertexAI specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *             apiEndpoint:
+ *               type: string
+ *             publisher:
+ *               type: string
+ *         googleGemini:
+ *           type: object
+ *           description: Google Gemini specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *         alephAlpha:
+ *           type: object
+ *           description: Aleph Alpha specific meta data
+ *           properties:
+ *             customModel:
+ *               type: string
+ *               example: luminous-003
+ *               description: The custom model name. This does not work with embedding models
+ *             baseCustomUrl:
+ *               type: string
+ *               example: https://api.aleph-alpha.com
+ *
+ *     ILargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IProjectResourceFields_2_0'
+ *         - type: object
+ *           properties:
  *             isDefault:
  *               type: boolean
  *               description: Sets the LLM to default (fallback) if no other LLM is set
  *               example: false
- *             openAI:
- *               type: object
- *               description: OpenAI specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: gpt-4-32k-0613
- *                   description: The custom model name. This does not work with embedding models
- *             anthropic:
- *               type: object
- *               description: Anthropic specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: claude-3-opus-20240229
- *                   description: The custom model name. This does not work with embedding models
- *             azureOpenAI:
- *               type: object
- *               description: Azure OpenAI specific meta data
- *               properties:
- *                 resourceName:
- *                   type: string
- *                 deploymentName:
- *                   type: string
- *                 apiVersion:
- *                   type: string
- *                 baseCustomUrl:
- *                   type: string
- *                   example:
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
- *             googleVertexAI:
- *               type: object
- *               description: Google VertexAI specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *                 apiEndpoint:
- *                   type: string
- *                 publisher:
- *                   type: string
- *             googleGemini:
- *               type: object
- *               description: Google Gemini specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *             alephAlpha:
- *               type: object
- *               description: Aleph Alpha specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: luminous-003
- *                   description: The custom model name. This does not work with embedding models
- *                 baseCustomUrl:
- *                   type: string
- *                   example: https://api.aleph-alpha.com
  *             fallbacks:
  *               type: array
  *               description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
  *               items:
  *                 $ref: '#/components/schemas/ILLMFallback_2_0'
- *
+ *     IGlobalLargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
  *     ILargeLanguageModelCreate_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
- *
  *     ILargeLanguageModelData_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
@@ -16739,13 +16877,25 @@ export interface IGoogleGeminiMeta_2_0 {
  *               type: string
  *               description: The reference id of the LargeLanguageModel
  *               format: uuid
- *
+ *     IGlobalLargeLanguageModelData_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelFields_2_0'
+ *         - type: object
+ *           properties:
+ *             referenceId:
+ *               type: string
+ *               description: The reference id of the LargeLanguageModel
+ *               format: uuid
+ *     IGlobalLargeLanguageModel_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
+ *         - $ref: '#/components/schemas/IEntityMeta'
  *     ILargeLanguageModel_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModel_2_0 {
+export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16811,7 +16961,7 @@ export interface ILargeLanguageModel_2_0 {
  *               example: false
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModelIndexItem_2_0 {
+export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16827,11 +16977,11 @@ export interface ILargeLanguageModelIndexItem_2_0 {
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
 }
-export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
+export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Pick<IGlobalResource, "resourceLevel">, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
 }
 export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
 }
-export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
+export interface ICreateLargeLanguageModelRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
 }
 export interface ICreateLargeLanguageModelRestData_2_0 extends ICreateLargeLanguageModelRestDataBody_2_0 {
 }
@@ -17646,6 +17796,23 @@ export interface IGenerateNluScoresRestReturnValue_2_0 {
  *             formality:
  *               type: string
  *           example: { "completeness": "concise", "formality": "formal" }
+ *         voiceConfigs:
+ *           type: object
+ *           properties:
+ *             ttsVoice:
+ *               type: string
+ *             ttsLanguage:
+ *               type: string
+ *             ttsVendor:
+ *               enum: ["aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none"]
+ *               type: string
+ *             ttsModel:
+ *               type: string
+ *           example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2" }
+ *         enableVoiceConfigs:
+ *           type: boolean
+ *           description: Enables the use of voice configuration.
+ *           example: false
  *         safetySettings:
  *           type: object
  *           properties:
@@ -17692,6 +17859,8 @@ export interface IAiAgent_2_0 {
 	knowledgeReferenceId: string;
 	description: string;
 	speakingStyle: ISpeakingStyle;
+	voiceConfigs: IVoiceConfigParams;
+	enableVoiceConfigs: boolean;
 	safetySettings: ISafetySettings;
 	contactProfilesOption: TContactProfileOptions;
 	contactProfilesSelected: string[];