@cognigy/rest-api-client 2026.2.0-rc1 → 2026.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -3
- package/README.md +0 -15
- package/build/apigroups/ResourcesAPIGroup_2_0.js +384 -134
- package/build/shared/errors/ErrorCode.js +1 -2
- package/build/shared/errors/ErrorCollection.js +0 -1
- package/build/shared/interfaces/handover.js +0 -1
- package/build/shared/interfaces/resources/IAuditEvent.js +13 -1
- package/build/shared/interfaces/resources/TResourceType.js +2 -0
- package/build/shared/interfaces/user.js +2 -0
- package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +384 -134
- package/dist/esm/shared/errors/ErrorCode.js +1 -2
- package/dist/esm/shared/errors/ErrorCollection.js +0 -1
- package/dist/esm/shared/interfaces/handover.js +0 -1
- package/dist/esm/shared/interfaces/resources/IAuditEvent.js +13 -1
- package/dist/esm/shared/interfaces/resources/TResourceType.js +2 -0
- package/dist/esm/shared/interfaces/user.js +2 -0
- package/package.json +3 -6
- package/types/index.d.ts +44 -425
- package/build/apigroups/aiAgentsV2/agent.js +0 -3
- package/build/apigroups/aiAgentsV2/agentAPI.js +0 -38
- package/build/apigroups/aiAgentsV2/agentPersona.js +0 -3
- package/build/apigroups/aiAgentsV2/agentPersonaAPI.js +0 -38
- package/build/apigroups/aiAgentsV2/tool.js +0 -3
- package/build/apigroups/aiAgentsV2/toolAPI.js +0 -35
- package/build/apigroups/aiAgentsV2/toolDescriptor.js +0 -3
- package/build/apigroups/aiAgentsV2/toolDescriptorAPI.js +0 -13
- package/build/spec/aiAgentV2.spec.js +0 -564
- package/dist/esm/apigroups/aiAgentsV2/agent.js +0 -2
- package/dist/esm/apigroups/aiAgentsV2/agentAPI.js +0 -24
- package/dist/esm/apigroups/aiAgentsV2/agentPersona.js +0 -2
- package/dist/esm/apigroups/aiAgentsV2/agentPersonaAPI.js +0 -24
- package/dist/esm/apigroups/aiAgentsV2/aiAgentV2API.js +0 -2
- package/dist/esm/apigroups/aiAgentsV2/tool.js +0 -2
- package/dist/esm/apigroups/aiAgentsV2/toolAPI.js +0 -21
- package/dist/esm/apigroups/aiAgentsV2/toolDescriptor.js +0 -2
- package/dist/esm/apigroups/aiAgentsV2/toolDescriptorAPI.js +0 -9
- package/dist/esm/spec/aiAgentV2.spec.js +0 -563
|
@@ -3,10 +3,9 @@ export var ErrorCode;
|
|
|
3
3
|
ErrorCode[ErrorCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
|
|
4
4
|
ErrorCode[ErrorCode["UNAUTHORIZED_ERROR"] = 401] = "UNAUTHORIZED_ERROR";
|
|
5
5
|
ErrorCode[ErrorCode["PAYMENT_REQUIRED_ERROR"] = 402] = "PAYMENT_REQUIRED_ERROR";
|
|
6
|
-
ErrorCode[ErrorCode["FORBIDDEN_ERROR"] = 403] = "FORBIDDEN_ERROR";
|
|
7
|
-
ErrorCode[ErrorCode["NOT_FOUND"] = 404] = "NOT_FOUND";
|
|
8
6
|
ErrorCode[ErrorCode["PAYLOAD_TOO_LARGE_ERROR"] = 413] = "PAYLOAD_TOO_LARGE_ERROR";
|
|
9
7
|
ErrorCode[ErrorCode["TOO_MANY_REQUESTS_ERROR"] = 429] = "TOO_MANY_REQUESTS_ERROR";
|
|
8
|
+
ErrorCode[ErrorCode["FORBIDDEN_ERROR"] = 403] = "FORBIDDEN_ERROR";
|
|
10
9
|
ErrorCode[ErrorCode["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
|
|
11
10
|
ErrorCode[ErrorCode["SERVICE_UNAVAILABLE_ERROR"] = 503] = "SERVICE_UNAVAILABLE_ERROR";
|
|
12
11
|
ErrorCode[ErrorCode["GATEWAY_TIMEOUT_ERROR"] = 504] = "GATEWAY_TIMEOUT_ERROR";
|
|
@@ -48,7 +48,6 @@ export const ErrorCollection = {
|
|
|
48
48
|
[ErrorCode.METHOD_NOT_ALLOWED_ERROR]: MethodNotAllowedError,
|
|
49
49
|
[ErrorCode.MISSING_ARGUMENT_ERROR]: MissingArgumentError,
|
|
50
50
|
[ErrorCode.NETWORK_ERROR]: NetworkError,
|
|
51
|
-
[ErrorCode.NOT_FOUND]: ResourceNotFoundError,
|
|
52
51
|
[ErrorCode.NOT_IMPLEMENTED_ERROR]: NotImplementedError,
|
|
53
52
|
[ErrorCode.PAYLOAD_TOO_LARGE_ERROR]: PayloadTooLargeError,
|
|
54
53
|
[ErrorCode.PROCESS_ERROR]: ProcessError,
|
|
@@ -119,7 +119,6 @@ export const handoverSettingsSchema = {
|
|
|
119
119
|
redactTranscriptTileMessages: { type: "boolean" },
|
|
120
120
|
enableAgentCopilotAuthentication: { type: "boolean" },
|
|
121
121
|
agentCopilotAuthentication: { type: "string" },
|
|
122
|
-
blockNonJWTRequests: { type: "boolean" },
|
|
123
122
|
oAuth2Connection: { type: "string" },
|
|
124
123
|
}
|
|
125
124
|
}
|
|
@@ -115,7 +115,19 @@ export const actionTypes = [
|
|
|
115
115
|
"loginError",
|
|
116
116
|
"unauthorized",
|
|
117
117
|
"disableCreditCardRedaction",
|
|
118
|
-
"runKnowledgeConnector"
|
|
118
|
+
"runKnowledgeConnector",
|
|
119
|
+
"createSimulation",
|
|
120
|
+
"updateSimulation",
|
|
121
|
+
"deleteSimulation",
|
|
122
|
+
"scheduleSimulation",
|
|
123
|
+
"cloneSimulation",
|
|
124
|
+
"createScheduler",
|
|
125
|
+
"updateScheduler",
|
|
126
|
+
"deleteScheduler",
|
|
127
|
+
"generatePersonaPackages",
|
|
128
|
+
"regeneratePersonaField",
|
|
129
|
+
"bulkGeneratePersonaPackages",
|
|
130
|
+
"createScenarioFromTranscript",
|
|
119
131
|
];
|
|
120
132
|
export const auditEventSchema = {
|
|
121
133
|
title: "auditEventSchema",
|
|
@@ -11,6 +11,8 @@ export const userDataSchema = {
|
|
|
11
11
|
acceptedTOS: { type: "boolean" },
|
|
12
12
|
disabled: { type: "boolean" },
|
|
13
13
|
roles: { type: "array", additionalItems: false, items: { type: "string", format: "organisation-wide-role" } },
|
|
14
|
+
cxoneEmail: { type: "string", format: "email" },
|
|
15
|
+
cxoneId: { type: "string", format: "uuid" },
|
|
14
16
|
}
|
|
15
17
|
};
|
|
16
18
|
export const userSchema = {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cognigy/rest-api-client",
|
|
3
|
-
"version": "2026.
|
|
3
|
+
"version": "2026.3.0",
|
|
4
4
|
"description": "Cognigy REST-Client",
|
|
5
5
|
"main": "build/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
"type-check:watch": "npm run type-check -- --watch",
|
|
19
19
|
"test:only": "npm run test:unit",
|
|
20
20
|
"test:unit": "nyc mocha --opts .mocharc && rimraf ./.nyc_output",
|
|
21
|
-
"test:aiAgentsV2": "node --import=tsx --test --test-timeout=120000 --test-force-exit --test-reporter spec ./src/spec/aiAgentV2.spec.ts",
|
|
22
21
|
"prepublishOnly": "npm run build"
|
|
23
22
|
},
|
|
24
23
|
"repository": {},
|
|
@@ -31,7 +30,6 @@
|
|
|
31
30
|
"author": "Cognigy GmbH",
|
|
32
31
|
"license": "Cognigy Proprietary License",
|
|
33
32
|
"dependencies": {
|
|
34
|
-
"@cognigy/extension-tools": "0.17.0-rc4",
|
|
35
33
|
"ajv": "6.12.6",
|
|
36
34
|
"axios": "1.8.3",
|
|
37
35
|
"form-data": "4.0.4",
|
|
@@ -53,7 +51,7 @@
|
|
|
53
51
|
"@rollup/plugin-json": "4.1.0",
|
|
54
52
|
"@rollup/plugin-node-resolve": "13.3.0",
|
|
55
53
|
"@rollup/plugin-typescript": "8.3.4",
|
|
56
|
-
"@types/node": "
|
|
54
|
+
"@types/node": "18.7.6",
|
|
57
55
|
"@types/sinon": "10.0.13",
|
|
58
56
|
"@types/tus-js-client": "^2.1.0",
|
|
59
57
|
"@typescript-eslint/eslint-plugin": "5.33.1",
|
|
@@ -72,7 +70,6 @@
|
|
|
72
70
|
"regenerator-runtime": "0.13.9",
|
|
73
71
|
"rimraf": "3.0.2",
|
|
74
72
|
"rollup": "2.78.0",
|
|
75
|
-
"tsx": "4.21",
|
|
76
73
|
"typescript": "4.7.4"
|
|
77
74
|
},
|
|
78
75
|
"engines": {
|
|
@@ -80,4 +77,4 @@
|
|
|
80
77
|
"npm": ">=10.1.0",
|
|
81
78
|
"vscode": "^1.22.0"
|
|
82
79
|
}
|
|
83
|
-
}
|
|
80
|
+
}
|
package/types/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
// Generated by dts-bundle-generator v6.12.0
|
|
2
2
|
|
|
3
|
-
import { IToolDescriptor } from '@cognigy/extension-tools';
|
|
4
3
|
import { AxiosResponseHeaders } from 'axios';
|
|
5
4
|
|
|
6
5
|
export declare type Options = {
|
|
@@ -535,10 +534,9 @@ export declare enum ErrorCode {
|
|
|
535
534
|
BAD_REQUEST = 400,
|
|
536
535
|
UNAUTHORIZED_ERROR = 401,
|
|
537
536
|
PAYMENT_REQUIRED_ERROR = 402,
|
|
538
|
-
FORBIDDEN_ERROR = 403,
|
|
539
|
-
NOT_FOUND = 404,
|
|
540
537
|
PAYLOAD_TOO_LARGE_ERROR = 413,
|
|
541
538
|
TOO_MANY_REQUESTS_ERROR = 429,
|
|
539
|
+
FORBIDDEN_ERROR = 403,
|
|
542
540
|
BAD_GATEWAY = 502,
|
|
543
541
|
SERVICE_UNAVAILABLE_ERROR = 503,
|
|
544
542
|
GATEWAY_TIMEOUT_ERROR = 504,
|
|
@@ -874,7 +872,6 @@ export interface IErrorCollection {
|
|
|
874
872
|
[ErrorCode.INVALID_ARGUMENT_ERROR]: typeof InvalidArgumentError;
|
|
875
873
|
[ErrorCode.METHOD_NOT_ALLOWED_ERROR]: typeof MethodNotAllowedError;
|
|
876
874
|
[ErrorCode.MISSING_ARGUMENT_ERROR]: typeof MissingArgumentError;
|
|
877
|
-
[ErrorCode.NOT_FOUND]: typeof ResourceNotFoundError;
|
|
878
875
|
[ErrorCode.NETWORK_ERROR]: typeof NetworkError;
|
|
879
876
|
[ErrorCode.NOT_IMPLEMENTED_ERROR]: typeof NotImplementedError;
|
|
880
877
|
[ErrorCode.PAYLOAD_TOO_LARGE_ERROR]: typeof PayloadTooLargeError;
|
|
@@ -986,7 +983,9 @@ declare const arrayTResourceType: readonly [
|
|
|
986
983
|
"snapshot",
|
|
987
984
|
"snippet",
|
|
988
985
|
"aiAgent",
|
|
989
|
-
"simulation"
|
|
986
|
+
"simulation",
|
|
987
|
+
"scheduler",
|
|
988
|
+
"personaGeneration"
|
|
990
989
|
];
|
|
991
990
|
export declare type TResourceType = (typeof arrayTResourceType)[number];
|
|
992
991
|
declare const arrayTChartableResourceType: readonly [
|
|
@@ -2373,7 +2372,6 @@ export interface IAgentAssistSettings {
|
|
|
2373
2372
|
enableTranscriptTileChatInput?: boolean;
|
|
2374
2373
|
redactTranscriptTileMessages?: boolean;
|
|
2375
2374
|
enableAgentCopilotAuthentication?: boolean;
|
|
2376
|
-
blockNonJWTRequests?: boolean;
|
|
2377
2375
|
agentCopilotAuthentication?: string;
|
|
2378
2376
|
/**
|
|
2379
2377
|
* Optional OAuth2 connection id for providers that require it (e.g., Genesys)
|
|
@@ -7834,9 +7832,6 @@ export interface IWebrtcWidgetConfig {
|
|
|
7834
7832
|
* enableAgentCopilotAuthentication:
|
|
7835
7833
|
* type: boolean
|
|
7836
7834
|
* description: Enable authentication for agent copilot
|
|
7837
|
-
* blockNonJWTRequests:
|
|
7838
|
-
* type: boolean
|
|
7839
|
-
* description: Block requests made to the endpoint without a JWT token
|
|
7840
7835
|
* agentCopilotAuthentication:
|
|
7841
7836
|
* type: string
|
|
7842
7837
|
* description: Authentication connection reference Id for agent copilot
|
|
@@ -19749,421 +19744,7 @@ export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesig
|
|
|
19749
19744
|
export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
|
|
19750
19745
|
output: string | object;
|
|
19751
19746
|
}
|
|
19752
|
-
export
|
|
19753
|
-
/**
|
|
19754
|
-
* Unique identifier of the Agent. Used in all API calls.
|
|
19755
|
-
*/
|
|
19756
|
-
id: string;
|
|
19757
|
-
/**
|
|
19758
|
-
* Reference ID of the Agent. Used together with the projectId
|
|
19759
|
-
* to address the Agent during runtime.
|
|
19760
|
-
*/
|
|
19761
|
-
referenceId: string;
|
|
19762
|
-
/**
|
|
19763
|
-
* Cognigy.AI project ID.
|
|
19764
|
-
*/
|
|
19765
|
-
projectId: string;
|
|
19766
|
-
/**
|
|
19767
|
-
* Cognigy.AI organisation/tenant ID.
|
|
19768
|
-
*/
|
|
19769
|
-
organisationId: string;
|
|
19770
|
-
/**
|
|
19771
|
-
* All data of an Agent is localized. Contains localized data
|
|
19772
|
-
* with properties for each locale.
|
|
19773
|
-
*/
|
|
19774
|
-
localizedData: LocalizedAgentData[];
|
|
19775
|
-
createdBy: string;
|
|
19776
|
-
createdAt: number;
|
|
19777
|
-
lastChangedBy: string;
|
|
19778
|
-
lastChangedAt: number;
|
|
19779
|
-
};
|
|
19780
|
-
export declare type LocalizedAgentData = {
|
|
19781
|
-
/**
|
|
19782
|
-
* Cognigy.AI locale reference ID.
|
|
19783
|
-
*/
|
|
19784
|
-
localeReferenceId: string;
|
|
19785
|
-
/**
|
|
19786
|
-
* Name of the Agent. Will be displayed in the UI.
|
|
19787
|
-
*/
|
|
19788
|
-
name: string;
|
|
19789
|
-
/**
|
|
19790
|
-
* Description of the Agent. Will be displayed in the UI.
|
|
19791
|
-
*/
|
|
19792
|
-
description: string;
|
|
19793
|
-
/**
|
|
19794
|
-
* Instructions of the Agent. Will be fed to the LLM as part
|
|
19795
|
-
* of the system prompt.
|
|
19796
|
-
*/
|
|
19797
|
-
instructions: string;
|
|
19798
|
-
/**
|
|
19799
|
-
* References a single Agent Persona object.
|
|
19800
|
-
*/
|
|
19801
|
-
personaReferenceId: string;
|
|
19802
|
-
/**
|
|
19803
|
-
* References all attached Tools this Agent can use during
|
|
19804
|
-
* execution in conjunction with its instructions.
|
|
19805
|
-
*/
|
|
19806
|
-
toolReferenceIds: string[];
|
|
19807
|
-
/**
|
|
19808
|
-
* In place knowledge information for this Agent.
|
|
19809
|
-
*/
|
|
19810
|
-
knowledge: LocalizedAgentKnowledge;
|
|
19811
|
-
};
|
|
19812
|
-
export declare type LocalizedAgentKnowledge = {
|
|
19813
|
-
/**
|
|
19814
|
-
* Always available knowledge for the Agent. This is not RAG
|
|
19815
|
-
* but will be part of the system prompt directly.
|
|
19816
|
-
*/
|
|
19817
|
-
context: string;
|
|
19818
|
-
/**
|
|
19819
|
-
* Additional RAG mode for the Agent. "always" means that the
|
|
19820
|
-
* Agent will always use the configured RAG system. "never" means
|
|
19821
|
-
* that we won't use RAG at all.
|
|
19822
|
-
*/
|
|
19823
|
-
ragMode: "always" | "never";
|
|
19824
|
-
/**
|
|
19825
|
-
* The type of RAG system to use. "cognigy" means using Cognigy.AIs
|
|
19826
|
-
* Knowledge AI capabilities. "expert" and "knowledgeHub" allow integrations
|
|
19827
|
-
* with Nice software products.
|
|
19828
|
-
*/
|
|
19829
|
-
ragType: "cognigy" | "expert" | "knowledgeHub";
|
|
19830
|
-
/**
|
|
19831
|
-
* Rag parameters are specific to the RAG system that was selected.
|
|
19832
|
-
* The shape of this object is different per RAG type.
|
|
19833
|
-
*/
|
|
19834
|
-
ragParameters: Record<string, string>;
|
|
19835
|
-
};
|
|
19836
|
-
export interface AIAgentsV2_AgentV1API {
|
|
19837
|
-
indexAgents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAgentsRestData_1_0>, IIndexAgentsRestReturnValue_1_0>;
|
|
19838
|
-
createAgent: TRestAPIOperation<ICreateAgentRestData_1_0, ICreateAgentRestReturnValue_1_0>;
|
|
19839
|
-
readAgent: TRestAPIOperation<IReadAgentRestData_1_0, IReadAgentRestReturnValue_1_0>;
|
|
19840
|
-
deleteAgent: TRestAPIOperation<IDeleteAgentRestData_1_0, IDeleteAgentRestReturnValue_1_0>;
|
|
19841
|
-
updateAgent: TRestAPIOperation<IUpdateAgentRestData_1_0, IUpdateAgentRestReturnValue_1_0>;
|
|
19842
|
-
}
|
|
19843
|
-
/**
|
|
19844
|
-
* Update Agent
|
|
19845
|
-
*/
|
|
19846
|
-
export interface IUpdateAgentRestDataParams_1_0 {
|
|
19847
|
-
agentId: string;
|
|
19848
|
-
}
|
|
19849
|
-
export interface IUpdateAgentRestDataBody_1_0 extends Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
|
|
19850
|
-
}
|
|
19851
|
-
export interface IUpdateAgentRestData_1_0 extends IUpdateAgentRestDataBody_1_0, IUpdateAgentRestDataParams_1_0 {
|
|
19852
|
-
}
|
|
19853
|
-
export interface IUpdateAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
|
|
19854
|
-
}
|
|
19855
|
-
/**
|
|
19856
|
-
* Delete Agent
|
|
19857
|
-
*/
|
|
19858
|
-
export interface IDeleteAgentRestDataParams_1_0 {
|
|
19859
|
-
agentId: string;
|
|
19860
|
-
}
|
|
19861
|
-
export interface IDeleteAgentRestData_1_0 extends IDeleteAgentRestDataParams_1_0 {
|
|
19862
|
-
}
|
|
19863
|
-
export interface IDeleteAgentRestReturnValue_1_0 {
|
|
19864
|
-
}
|
|
19865
|
-
/**
|
|
19866
|
-
* Read Agent
|
|
19867
|
-
*/
|
|
19868
|
-
export interface IReadAgentRestDataParams_1_0 {
|
|
19869
|
-
agentId: string;
|
|
19870
|
-
}
|
|
19871
|
-
export interface IReadAgentRestData_1_0 extends IReadAgentRestDataParams_1_0 {
|
|
19872
|
-
}
|
|
19873
|
-
export interface IReadAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
|
|
19874
|
-
}
|
|
19875
|
-
/**
|
|
19876
|
-
* Create Agent
|
|
19877
|
-
*/
|
|
19878
|
-
export interface ICreateAgentRestData_1_0 extends Pick<Agent, "projectId">, Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
|
|
19879
|
-
}
|
|
19880
|
-
export interface ICreateAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
|
|
19881
|
-
}
|
|
19882
|
-
/**
|
|
19883
|
-
* List Agent
|
|
19884
|
-
*/
|
|
19885
|
-
export interface IIndexAgentsRestData_1_0 extends IRestPagination<IAgentIndexItem_1_0> {
|
|
19886
|
-
}
|
|
19887
|
-
export interface IAgentIndexItem_1_0 extends Pick<Agent, "id" | "referenceId" | "projectId" | "organisationId" | "createdBy" | "createdAt" | "lastChangedBy" | "lastChangedAt">, Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
|
|
19888
|
-
}
|
|
19889
|
-
export interface IIndexAgentsRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IAgentIndexItem_1_0> {
|
|
19890
|
-
}
|
|
19891
|
-
export declare type AgentPersona = {
|
|
19892
|
-
/**
|
|
19893
|
-
* Unique identifier of the Agent Persona. Used in all API calls.
|
|
19894
|
-
*/
|
|
19895
|
-
id: string;
|
|
19896
|
-
/**
|
|
19897
|
-
* Reference ID of the Agent Persona. Used together with the projectId
|
|
19898
|
-
* to address the Agent Persona during runtime.
|
|
19899
|
-
*/
|
|
19900
|
-
referenceId: string;
|
|
19901
|
-
/**
|
|
19902
|
-
* Name of the Agent Persona, e.g. "Robert"
|
|
19903
|
-
*/
|
|
19904
|
-
name: string;
|
|
19905
|
-
/**
|
|
19906
|
-
* Icon or image for the Agent Persona. This can either contain an image URL
|
|
19907
|
-
* e.g. starting with https:// or it can contain a base64 encoded image string.
|
|
19908
|
-
*/
|
|
19909
|
-
image: string;
|
|
19910
|
-
/**
|
|
19911
|
-
* Whether the image is stored in our optimized format, uses an alpha channel
|
|
19912
|
-
* and whether the AgentPersona can be rendered differently.
|
|
19913
|
-
*/
|
|
19914
|
-
imageOptimizedFormat: boolean;
|
|
19915
|
-
/**
|
|
19916
|
-
* Description of the Agent Persona, e.g. the background story of the persona
|
|
19917
|
-
* could be added here.
|
|
19918
|
-
*/
|
|
19919
|
-
description: string;
|
|
19920
|
-
/**
|
|
19921
|
-
* Defines the tone-of-voide for the Agent Persona, e.g. formal, informal etc.
|
|
19922
|
-
*/
|
|
19923
|
-
speakingStyle: AgentPersonaSpeakingStyle;
|
|
19924
|
-
/**
|
|
19925
|
-
* Voice configuration for the Agent Persona, defining TTS voice settings.
|
|
19926
|
-
*/
|
|
19927
|
-
voiceConfig: AgentPersonaVoiceConfig;
|
|
19928
|
-
/**
|
|
19929
|
-
* Cognigy.AI project ID.
|
|
19930
|
-
*/
|
|
19931
|
-
projectId: string;
|
|
19932
|
-
/**
|
|
19933
|
-
* Cognigy.AI organisation/tenant ID.
|
|
19934
|
-
*/
|
|
19935
|
-
organisationId: string;
|
|
19936
|
-
createdBy: string;
|
|
19937
|
-
createdAt: number;
|
|
19938
|
-
lastChangedBy: string;
|
|
19939
|
-
lastChangedAt: number;
|
|
19940
|
-
};
|
|
19941
|
-
export declare type AgentPersonaSpeakingStyle = {
|
|
19942
|
-
completeness: string;
|
|
19943
|
-
formality: string;
|
|
19944
|
-
};
|
|
19945
|
-
export declare type AgentPersonaVoiceConfig = {
|
|
19946
|
-
ttsVoice: string;
|
|
19947
|
-
ttsLanguage: string;
|
|
19948
|
-
ttsVendor: string;
|
|
19949
|
-
ttsModel: string;
|
|
19950
|
-
ttsLabel: string;
|
|
19951
|
-
ttsDisableCache: boolean;
|
|
19952
|
-
};
|
|
19953
|
-
export interface AIAgentsV2_AgentPersonaV1API {
|
|
19954
|
-
indexAgentPersonas: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAgentPersonasRestData_1_0>, IIndexAgentPersonasRestReturnValue_1_0>;
|
|
19955
|
-
createAgentPersona: TRestAPIOperation<ICreateAgentPersonaRestData_1_0, ICreateAgentPersonaRestReturnValue_1_0>;
|
|
19956
|
-
readAgentPersona: TRestAPIOperation<IReadAgentPersonaRestData_1_0, IReadAgentPersonaRestReturnValue_1_0>;
|
|
19957
|
-
deleteAgentPersona: TRestAPIOperation<IDeleteAgentPersonaRestData_1_0, IDeleteAgentPersonaRestReturnValue_1_0>;
|
|
19958
|
-
updateAgentPersona: TRestAPIOperation<IUpdateAgentPersonaRestData_1_0, IUpdateAgentPersonaRestReturnValue_1_0>;
|
|
19959
|
-
}
|
|
19960
|
-
/**
|
|
19961
|
-
* Update Agent Persona
|
|
19962
|
-
*/
|
|
19963
|
-
export interface IUpdateAgentPersonaRestDataParams_1_0 {
|
|
19964
|
-
agentPersonaId: string;
|
|
19965
|
-
}
|
|
19966
|
-
export interface IUpdateAgentPersonaRestData_1_0 extends IUpdateAgentPersonaRestDataParams_1_0, Pick<AgentPersona, "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig"> {
|
|
19967
|
-
}
|
|
19968
|
-
export interface IUpdateAgentPersonaRestReturnValue_1_0 extends IAgentPersonaIndexItem_1_0 {
|
|
19969
|
-
}
|
|
19970
|
-
/**
|
|
19971
|
-
* Delete Agent Persona
|
|
19972
|
-
*/
|
|
19973
|
-
export interface IDeleteAgentPersonaRestDataParams_1_0 {
|
|
19974
|
-
agentPersonaId: string;
|
|
19975
|
-
}
|
|
19976
|
-
export interface IDeleteAgentPersonaRestData_1_0 extends IDeleteAgentPersonaRestDataParams_1_0 {
|
|
19977
|
-
}
|
|
19978
|
-
export interface IDeleteAgentPersonaRestReturnValue_1_0 {
|
|
19979
|
-
}
|
|
19980
|
-
/**
|
|
19981
|
-
* Read Agent Persona
|
|
19982
|
-
*/
|
|
19983
|
-
export interface IReadAgentPersonaRestDataParams_1_0 {
|
|
19984
|
-
agentPersonaId: string;
|
|
19985
|
-
}
|
|
19986
|
-
export interface IReadAgentPersonaRestData_1_0 extends IReadAgentPersonaRestDataParams_1_0 {
|
|
19987
|
-
}
|
|
19988
|
-
export interface IReadAgentPersonaRestReturnValue_1_0 extends AgentPersona {
|
|
19989
|
-
}
|
|
19990
|
-
/**
|
|
19991
|
-
* Create Agent Persona
|
|
19992
|
-
*/
|
|
19993
|
-
export interface ICreateAgentPersonaRestData_1_0 extends Pick<AgentPersona, "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig" | "projectId"> {
|
|
19994
|
-
}
|
|
19995
|
-
export interface ICreateAgentPersonaRestReturnValue_1_0 extends IAgentPersonaIndexItem_1_0 {
|
|
19996
|
-
}
|
|
19997
|
-
/**
|
|
19998
|
-
* List Agent Personas
|
|
19999
|
-
*/
|
|
20000
|
-
export interface IIndexAgentPersonasRestData_1_0 extends IRestPagination<IAgentPersonaIndexItem_1_0> {
|
|
20001
|
-
}
|
|
20002
|
-
export interface IAgentPersonaIndexItem_1_0 extends Pick<AgentPersona, "id" | "referenceId" | "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig" | "projectId" | "organisationId" | "createdBy" | "createdAt" | "lastChangedBy" | "lastChangedAt"> {
|
|
20003
|
-
}
|
|
20004
|
-
export interface IIndexAgentPersonasRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IAgentPersonaIndexItem_1_0> {
|
|
20005
|
-
}
|
|
20006
|
-
export interface ToolDescriptor extends IToolDescriptor {
|
|
20007
|
-
/**
|
|
20008
|
-
* The image URL field is actually not present in the tool descriptor
|
|
20009
|
-
* that the customer defines in the extension - it is part of the surrounding
|
|
20010
|
-
* extension, but the backend API returning tool descriptors actually includes
|
|
20011
|
-
* it in the response for convenience.
|
|
20012
|
-
*/
|
|
20013
|
-
imageUrl: string;
|
|
20014
|
-
}
|
|
20015
|
-
export interface AIAgentsV2_ToolDescriptorV1API {
|
|
20016
|
-
indexToolDescriptors: TRestAPIOperation<TRestAPIOptionalParameter<IIndexToolDescriptorsRestData_1_0>, IIndexToolDescriptorsRestReturnValue_1_0>;
|
|
20017
|
-
}
|
|
20018
|
-
/**
|
|
20019
|
-
* List Tool Descriptors
|
|
20020
|
-
*/
|
|
20021
|
-
export interface IIndexToolDescriptorsRestData_1_0 extends IRestPagination<IToolDescriptorIndexItem_1_0> {
|
|
20022
|
-
}
|
|
20023
|
-
export interface IToolDescriptorIndexItem_1_0 extends Pick<ToolDescriptor, "type" | "imageUrl" | "defaultLabel" | "defaultDescription" | "defaultParameters"> {
|
|
20024
|
-
id: string;
|
|
20025
|
-
extension: string;
|
|
20026
|
-
projectId: string;
|
|
20027
|
-
organisationId: string;
|
|
20028
|
-
}
|
|
20029
|
-
export declare type IIndexToolDescriptorsRestReturnValue_1_0 = ICursorBasedPaginationReturnValue<IToolDescriptorIndexItem_1_0>;
|
|
20030
|
-
export declare type Tool = {
|
|
20031
|
-
/**
|
|
20032
|
-
* Unique identifier of the Tool. Used in all API calls.
|
|
20033
|
-
*/
|
|
20034
|
-
id: string;
|
|
20035
|
-
/**
|
|
20036
|
-
* Reference ID of the Tool. Used together with the projectId
|
|
20037
|
-
* to address the Tool during runtime.
|
|
20038
|
-
*/
|
|
20039
|
-
referenceId: string;
|
|
20040
|
-
/**
|
|
20041
|
-
* The technical type of the tool, e.g. "createZendeskTicket".
|
|
20042
|
-
*/
|
|
20043
|
-
type: string;
|
|
20044
|
-
/**
|
|
20045
|
-
* Name of the Extension the Tool Descriptor belongs to this tool was
|
|
20046
|
-
* based on.
|
|
20047
|
-
*/
|
|
20048
|
-
extension: string;
|
|
20049
|
-
/**
|
|
20050
|
-
* Name of the Tool. Will be displayed in the UI as well as used by the LLM.
|
|
20051
|
-
*/
|
|
20052
|
-
name: string;
|
|
20053
|
-
/**
|
|
20054
|
-
* Description of the Tool. Will be used by the LLM to determine when to use this Tool.
|
|
20055
|
-
*/
|
|
20056
|
-
description: string;
|
|
20057
|
-
/**
|
|
20058
|
-
* Parameters of the Tool. Defines which parameters need to be provided and
|
|
20059
|
-
* instructs the LLM how to fill those parameters.
|
|
20060
|
-
*/
|
|
20061
|
-
parameters: ToolParameter[];
|
|
20062
|
-
/**
|
|
20063
|
-
* Cognigy.AI project ID.
|
|
20064
|
-
*/
|
|
20065
|
-
projectId: string;
|
|
20066
|
-
/**
|
|
20067
|
-
* Cognigy.AI organisation/tenant ID.
|
|
20068
|
-
*/
|
|
20069
|
-
organisationId: string;
|
|
20070
|
-
createdBy: string;
|
|
20071
|
-
createdAt: number;
|
|
20072
|
-
lastChangedBy: string;
|
|
20073
|
-
lastChangedAt: number;
|
|
20074
|
-
};
|
|
20075
|
-
/**
|
|
20076
|
-
* The current tool / tool parameter implementation is wrong:
|
|
20077
|
-
* https://github.com/Cognigy/ai-agents-v2/blob/b268349a3d9dac9ad436dd785ceb50f8de33eca0/internal/tools/tool.go#L53
|
|
20078
|
-
*/
|
|
20079
|
-
export declare type ToolParameter = {
|
|
20080
|
-
/**
|
|
20081
|
-
* Name of the parameter. Will be displayed in the UI but also used by the
|
|
20082
|
-
* LLM in case it should fill the parameter.
|
|
20083
|
-
*/
|
|
20084
|
-
name: string;
|
|
20085
|
-
/**
|
|
20086
|
-
* Description of the parameter. Will be displayed in the UI and used
|
|
20087
|
-
* by the LLM in case it should fill the parameter. The LLM will then
|
|
20088
|
-
* use it in order to determine what value to provide for this parameter.
|
|
20089
|
-
*/
|
|
20090
|
-
description: string;
|
|
20091
|
-
/**
|
|
20092
|
-
* Defines whether this tool parameter should be filled by the agent (via the LLM)
|
|
20093
|
-
* or should be provided during design-time by the user.
|
|
20094
|
-
*
|
|
20095
|
-
* Example: A user provided parameter would e.g. be an URL for an API endpoint. This
|
|
20096
|
-
* URL would be hardcoded. An example for an agent provided parameter would be a text
|
|
20097
|
-
* of a ticket we want to create via a ticketing tool. This text would be generated
|
|
20098
|
-
* by the LLM based on the actual end-user input.
|
|
20099
|
-
*/
|
|
20100
|
-
mode: "dynamic" | "aiFilled";
|
|
20101
|
-
/**
|
|
20102
|
-
* The type of the parameter. Used to inform the LLM what kind of value
|
|
20103
|
-
* it should provide.
|
|
20104
|
-
*/
|
|
20105
|
-
type: "string" | "number" | "boolean" | "object" | "array";
|
|
20106
|
-
/**
|
|
20107
|
-
* The actual value of the parameter. The tools Tool Descriptor has a "type" property
|
|
20108
|
-
* which defines what the values can be.
|
|
20109
|
-
*
|
|
20110
|
-
* Example: If the Tool Descriptor for this parameter contains type "select" with options "A", "B", "C",
|
|
20111
|
-
* the value here would be a string containing either "A", "B" or "C".
|
|
20112
|
-
*/
|
|
20113
|
-
value: unknown;
|
|
20114
|
-
};
|
|
20115
|
-
export interface AIAgentsV2_ToolV1API {
|
|
20116
|
-
indexTools: TRestAPIOperation<TRestAPIOptionalParameter<IIndexToolsRestData_1_0>, IIndexToolsRestReturnValue_1_0>;
|
|
20117
|
-
createTool: TRestAPIOperation<ICreateToolRestData_1_0, ICreateToolRestReturnValue_1_0>;
|
|
20118
|
-
readTool: TRestAPIOperation<IReadToolRestData_1_0, IReadToolRestReturnValue_1_0>;
|
|
20119
|
-
updateTool: TRestAPIOperation<IUpdateToolRestData_1_0, IUpdateToolRestReturnValue_1_0>;
|
|
20120
|
-
deleteTool: TRestAPIOperation<IDeleteToolRestData_1_0, IDeleteToolRestReturnValue_1_0>;
|
|
20121
|
-
}
|
|
20122
|
-
/**
|
|
20123
|
-
* Update Tool
|
|
20124
|
-
*/
|
|
20125
|
-
export interface IUpdateToolRestDataParams_1_0 {
|
|
20126
|
-
toolId: string;
|
|
20127
|
-
}
|
|
20128
|
-
export interface IUpdateToolRestDataBody_1_0 extends Pick<Tool, "name" | "description" | "parameters"> {
|
|
20129
|
-
}
|
|
20130
|
-
export interface IUpdateToolRestData_1_0 extends IUpdateToolRestDataBody_1_0, IUpdateToolRestDataParams_1_0 {
|
|
20131
|
-
}
|
|
20132
|
-
export interface IUpdateToolRestReturnValue_1_0 extends IToolIndexItem_1_0 {
|
|
20133
|
-
}
|
|
20134
|
-
/**
|
|
20135
|
-
* Delete Tool
|
|
20136
|
-
*/
|
|
20137
|
-
export interface IDeleteToolRestData_1_0 {
|
|
20138
|
-
toolId: string;
|
|
20139
|
-
}
|
|
20140
|
-
export interface IDeleteToolRestReturnValue_1_0 {
|
|
20141
|
-
}
|
|
20142
|
-
/**
|
|
20143
|
-
* Read Tool
|
|
20144
|
-
*/
|
|
20145
|
-
export interface IReadToolRestData_1_0 {
|
|
20146
|
-
toolId: string;
|
|
20147
|
-
}
|
|
20148
|
-
export interface IReadToolRestReturnValue_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "name" | "description" | "parameters" | "projectId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
|
|
20149
|
-
}
|
|
20150
|
-
/**
|
|
20151
|
-
* Create Tool
|
|
20152
|
-
*/
|
|
20153
|
-
export interface ICreateToolRestData_1_0 extends Pick<Tool, "type" | "extension" | "name" | "description" | "parameters" | "projectId"> {
|
|
20154
|
-
}
|
|
20155
|
-
export interface ICreateToolRestReturnValue_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "parameters" | "name" | "description" | "projectId" | "organisationId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
|
|
20156
|
-
}
|
|
20157
|
-
/**
|
|
20158
|
-
* List Tools
|
|
20159
|
-
*/
|
|
20160
|
-
export interface IIndexToolsRestData_1_0 extends IRestPagination<IToolIndexItem_1_0> {
|
|
20161
|
-
}
|
|
20162
|
-
export interface IToolIndexItem_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "name" | "description" | "parameters" | "projectId" | "organisationId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
|
|
20163
|
-
}
|
|
20164
|
-
export interface IIndexToolsRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IToolIndexItem_1_0> {
|
|
20165
|
-
}
|
|
20166
|
-
export interface ResourcesAPIGroup_2_0 extends AIAgentsV2_AgentV1API, AIAgentsV2_AgentPersonaV1API, AIAgentsV2_ToolDescriptorV1API, AIAgentsV2_ToolV1API {
|
|
19747
|
+
export interface ResourcesAPIGroup_2_0 {
|
|
20167
19748
|
searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
|
|
20168
19749
|
indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
|
|
20169
19750
|
batchFlows: TRestAPIOperation<IBatchFlowsRestData_2_0, IBatchFlowsRestReturnValue_2_0>;
|
|
@@ -22482,7 +22063,19 @@ declare const actionTypes: readonly [
|
|
|
22482
22063
|
"loginError",
|
|
22483
22064
|
"unauthorized",
|
|
22484
22065
|
"disableCreditCardRedaction",
|
|
22485
|
-
"runKnowledgeConnector"
|
|
22066
|
+
"runKnowledgeConnector",
|
|
22067
|
+
"createSimulation",
|
|
22068
|
+
"updateSimulation",
|
|
22069
|
+
"deleteSimulation",
|
|
22070
|
+
"scheduleSimulation",
|
|
22071
|
+
"cloneSimulation",
|
|
22072
|
+
"createScheduler",
|
|
22073
|
+
"updateScheduler",
|
|
22074
|
+
"deleteScheduler",
|
|
22075
|
+
"generatePersonaPackages",
|
|
22076
|
+
"regeneratePersonaField",
|
|
22077
|
+
"bulkGeneratePersonaPackages",
|
|
22078
|
+
"createScenarioFromTranscript"
|
|
22486
22079
|
];
|
|
22487
22080
|
export declare type TActionType = typeof actionTypes[number];
|
|
22488
22081
|
/**
|
|
@@ -23954,6 +23547,12 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
|
|
|
23954
23547
|
* type: string
|
|
23955
23548
|
* password:
|
|
23956
23549
|
* type: string
|
|
23550
|
+
* cxoneEmail:
|
|
23551
|
+
* type: string
|
|
23552
|
+
* description: "The email address of the CXOne user, only required for NiCE CXOne users"
|
|
23553
|
+
* cxoneId:
|
|
23554
|
+
* type: string
|
|
23555
|
+
* description: "The CXOne ID of the user, only required for NiCE CXOne users"
|
|
23957
23556
|
* organisation:
|
|
23958
23557
|
* $ref: '#/components/schemas/TMongoId'
|
|
23959
23558
|
* roles:
|
|
@@ -23976,6 +23575,12 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
|
|
|
23976
23575
|
* type: boolean
|
|
23977
23576
|
* disabled:
|
|
23978
23577
|
* type: boolean
|
|
23578
|
+
* cxoneEmail:
|
|
23579
|
+
* type: string
|
|
23580
|
+
* description: "The email address of the CXOne user, only required for NiCE CXOne users"
|
|
23581
|
+
* cxoneId:
|
|
23582
|
+
* type: string
|
|
23583
|
+
* description: "The CXOne ID of the user, only required for NiCE CXOne users"
|
|
23979
23584
|
*
|
|
23980
23585
|
* IManagementUserAdditional_2_0:
|
|
23981
23586
|
* type: object
|
|
@@ -24000,6 +23605,10 @@ export interface IUserManagement_2_0 {
|
|
|
24000
23605
|
id: string;
|
|
24001
23606
|
/** The name of the user */
|
|
24002
23607
|
name: string;
|
|
23608
|
+
/** The email address of the CXOne user, only required for NiCE CXOne users */
|
|
23609
|
+
cxoneEmail?: string;
|
|
23610
|
+
/** The CXOne ID of the user, only required for NiCE CXOne users */
|
|
23611
|
+
cxoneId?: string;
|
|
24003
23612
|
/** The organisation id of the user */
|
|
24004
23613
|
organisation: string;
|
|
24005
23614
|
/** The org-wide roles assigned to this user */
|
|
@@ -24026,6 +23635,12 @@ export interface IUserManagement_2_0 {
|
|
|
24026
23635
|
* type: string
|
|
24027
23636
|
* name:
|
|
24028
23637
|
* type: string
|
|
23638
|
+
* cxoneEmail:
|
|
23639
|
+
* type: string
|
|
23640
|
+
* description: "The email address of the CXOne user, only required for NiCE CXOne users"
|
|
23641
|
+
* cxoneId:
|
|
23642
|
+
* type: string
|
|
23643
|
+
* description: "The CXOne ID of the user, only required for NiCE CXOne users"
|
|
24029
23644
|
* - $ref: '#/components/schemas/IEntityMeta'
|
|
24030
23645
|
*/
|
|
24031
23646
|
export interface IUserManagementIndexItem_2_0 {
|
|
@@ -24035,6 +23650,10 @@ export interface IUserManagementIndexItem_2_0 {
|
|
|
24035
23650
|
id: string;
|
|
24036
23651
|
/** The name of the user */
|
|
24037
23652
|
name: string;
|
|
23653
|
+
/** The email address of the CXOne user, only required for NiCE CXOne users */
|
|
23654
|
+
cxoneEmail?: string;
|
|
23655
|
+
/** The CXOne ID of the user, only required for NiCE CXOne users */
|
|
23656
|
+
cxoneId?: string;
|
|
24038
23657
|
/** The organisation id the user belongs to */
|
|
24039
23658
|
organisation: TMongoId;
|
|
24040
23659
|
createdAt: number;
|