@salesforce/agents 0.6.3 → 0.7.1
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/lib/agent.d.ts +13 -3
- package/lib/agent.js +53 -5
- package/lib/agent.js.map +1 -1
- package/lib/index.d.ts +2 -2
- package/lib/index.js +2 -1
- package/lib/index.js.map +1 -1
- package/lib/types.d.ts +111 -1
- package/package.json +1 -1
package/lib/agent.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Connection, SfProject } from '@salesforce/core';
|
|
2
|
-
import { type SfAgent, type AgentCreateConfig, type AgentCreateResponse, type AgentJobSpec, type AgentJobSpecV2, type AgentJobSpecCreateConfig, type AgentJobSpecCreateConfigV2 } from './types.js';
|
|
2
|
+
import { type SfAgent, type AgentCreateConfig, type AgentCreateConfigV2, type AgentCreateResponse, type AgentCreateResponseV2, type AgentJobSpec, type AgentJobSpecV2, type AgentJobSpecCreateConfig, type AgentJobSpecCreateConfigV2 } from './types.js';
|
|
3
3
|
/**
|
|
4
4
|
* Events emitted during Agent.create() for consumers to listen to and keep track of progress
|
|
5
5
|
*
|
|
@@ -11,6 +11,11 @@ export declare const AgentCreateLifecycleStages: {
|
|
|
11
11
|
CreatingRemotely: string;
|
|
12
12
|
RetrievingMetadata: string;
|
|
13
13
|
};
|
|
14
|
+
export declare const AgentCreateLifecycleStagesV2: {
|
|
15
|
+
Creating: string;
|
|
16
|
+
Previewing: string;
|
|
17
|
+
Retrieving: string;
|
|
18
|
+
};
|
|
14
19
|
/**
|
|
15
20
|
* Class for creating Agents and agent specs.
|
|
16
21
|
*/
|
|
@@ -36,6 +41,13 @@ export declare class Agent implements SfAgent {
|
|
|
36
41
|
* @returns {Promise<AgentCreateResponse>}
|
|
37
42
|
*/
|
|
38
43
|
create(config: AgentCreateConfig): Promise<AgentCreateResponse>;
|
|
44
|
+
/**
|
|
45
|
+
* Creates an agent from a configuration, optionally saving the agent in an org.
|
|
46
|
+
*
|
|
47
|
+
* @param config a configuration for creating or previewing an agent
|
|
48
|
+
* @returns
|
|
49
|
+
*/
|
|
50
|
+
createV2(config: AgentCreateConfigV2): Promise<AgentCreateResponseV2>;
|
|
39
51
|
/**
|
|
40
52
|
* Create an agent spec from provided data.
|
|
41
53
|
*
|
|
@@ -47,8 +59,6 @@ export declare class Agent implements SfAgent {
|
|
|
47
59
|
/**
|
|
48
60
|
* Create an agent spec from provided data.
|
|
49
61
|
*
|
|
50
|
-
* V2 API: /connect/ai-assist/draft-agent-topics
|
|
51
|
-
*
|
|
52
62
|
* @param config The configuration used to generate an agent spec.
|
|
53
63
|
*/
|
|
54
64
|
createSpecV2(config: AgentJobSpecCreateConfigV2): Promise<AgentJobSpecV2>;
|
package/lib/agent.js
CHANGED
|
@@ -9,7 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
9
9
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.Agent = exports.AgentCreateLifecycleStages = void 0;
|
|
12
|
+
exports.Agent = exports.AgentCreateLifecycleStagesV2 = exports.AgentCreateLifecycleStages = void 0;
|
|
13
13
|
const node_util_1 = require("node:util");
|
|
14
14
|
const node_path_1 = __importDefault(require("node:path"));
|
|
15
15
|
const node_fs_1 = __importDefault(require("node:fs"));
|
|
@@ -30,6 +30,11 @@ exports.AgentCreateLifecycleStages = {
|
|
|
30
30
|
CreatingRemotely: 'creatingremotely',
|
|
31
31
|
RetrievingMetadata: 'retrievingmetadata',
|
|
32
32
|
};
|
|
33
|
+
exports.AgentCreateLifecycleStagesV2 = {
|
|
34
|
+
Creating: 'creatingAgent',
|
|
35
|
+
Previewing: 'previewingAgent',
|
|
36
|
+
Retrieving: 'retrievingAgent',
|
|
37
|
+
};
|
|
33
38
|
/**
|
|
34
39
|
* Class for creating Agents and agent specs.
|
|
35
40
|
*/
|
|
@@ -103,6 +108,51 @@ class Agent {
|
|
|
103
108
|
}
|
|
104
109
|
return response;
|
|
105
110
|
}
|
|
111
|
+
/**
|
|
112
|
+
* Creates an agent from a configuration, optionally saving the agent in an org.
|
|
113
|
+
*
|
|
114
|
+
* @param config a configuration for creating or previewing an agent
|
|
115
|
+
* @returns
|
|
116
|
+
*/
|
|
117
|
+
async createV2(config) {
|
|
118
|
+
const url = '/connect/ai-assist/create-agent';
|
|
119
|
+
// When previewing agent creation just return the response.
|
|
120
|
+
if (!config.saveAgent) {
|
|
121
|
+
this.logger.debug(`Previewing agent creation using config: ${(0, node_util_1.inspect)(config)} in project: ${this.project.getPath()}`);
|
|
122
|
+
await core_1.Lifecycle.getInstance().emit(exports.AgentCreateLifecycleStagesV2.Previewing, {});
|
|
123
|
+
return this.maybeMock.request('POST', url, config);
|
|
124
|
+
}
|
|
125
|
+
// When saving agent creation we need to retrieve the created metadata.
|
|
126
|
+
this.logger.debug(`Creating agent using config: ${(0, node_util_1.inspect)(config)} in project: ${this.project.getPath()}`);
|
|
127
|
+
await core_1.Lifecycle.getInstance().emit(exports.AgentCreateLifecycleStagesV2.Creating, {});
|
|
128
|
+
const response = await this.maybeMock.request('POST', url, config);
|
|
129
|
+
await core_1.Lifecycle.getInstance().emit(exports.AgentCreateLifecycleStagesV2.Retrieving, {});
|
|
130
|
+
//
|
|
131
|
+
// When retrieving all agent metadata by a Bot API name works in SDR we can use that.
|
|
132
|
+
//
|
|
133
|
+
// Query for the Bot API name by the Bot ID.
|
|
134
|
+
// const botApiName = this.connection.singleRecordQuery('get bot from response.agentId?.botId');
|
|
135
|
+
// const cs = await ComponentSetBuilder.build({
|
|
136
|
+
// metadata: {
|
|
137
|
+
// metadataEntries: [`Bot:${}`],
|
|
138
|
+
// directoryPaths: [this.project.getDefaultPackage().path],
|
|
139
|
+
// }
|
|
140
|
+
// });
|
|
141
|
+
// const retrieve = await cs.retrieve({
|
|
142
|
+
// usernameOrConnection: this.connection,
|
|
143
|
+
// merge: true,
|
|
144
|
+
// format: 'source',
|
|
145
|
+
// output: this.project.getDefaultPackage().path ?? 'force-app',
|
|
146
|
+
// });
|
|
147
|
+
// const retrieveResult = await retrieve.pollStatus({
|
|
148
|
+
// frequency: Duration.milliseconds(200),
|
|
149
|
+
// timeout: Duration.minutes(5),
|
|
150
|
+
// });
|
|
151
|
+
// if (!retrieveResult.response.success) {
|
|
152
|
+
// throw new SfError(`Unable to retrieve ${retrieveResult.response.id}`);
|
|
153
|
+
// }
|
|
154
|
+
return response;
|
|
155
|
+
}
|
|
106
156
|
/**
|
|
107
157
|
* Create an agent spec from provided data.
|
|
108
158
|
*
|
|
@@ -127,8 +177,6 @@ class Agent {
|
|
|
127
177
|
/**
|
|
128
178
|
* Create an agent spec from provided data.
|
|
129
179
|
*
|
|
130
|
-
* V2 API: /connect/ai-assist/draft-agent-topics
|
|
131
|
-
*
|
|
132
180
|
* @param config The configuration used to generate an agent spec.
|
|
133
181
|
*/
|
|
134
182
|
async createSpecV2(config) {
|
|
@@ -157,8 +205,8 @@ class Agent {
|
|
|
157
205
|
}
|
|
158
206
|
}
|
|
159
207
|
const response = await this.maybeMock.request('POST', url, body);
|
|
160
|
-
if (response.isSuccess && response.
|
|
161
|
-
return { ...config, topics: response.
|
|
208
|
+
if (response.isSuccess && response.topicDrafts) {
|
|
209
|
+
return { ...config, topics: response.topicDrafts };
|
|
162
210
|
}
|
|
163
211
|
else {
|
|
164
212
|
throw core_1.SfError.create({
|
package/lib/agent.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent.js","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,yCAAoC;AACpC,0DAA6B;AAC7B,sDAAyB;AACzB,2CAA+F;AAC/F,+EAAyE;AACzE,yCAA2C;
|
|
1
|
+
{"version":3,"file":"agent.js","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,yCAAoC;AACpC,0DAA6B;AAC7B,sDAAyB;AACzB,2CAA+F;AAC/F,+EAAyE;AACzE,yCAA2C;AAgB3C,6CAAyC;AAEzC,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;AAEvE;;;;GAIG;AACU,QAAA,0BAA0B,GAAG;IACxC,eAAe,EAAE,iBAAiB;IAClC,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,kBAAkB,EAAE,oBAAoB;CACzC,CAAC;AAEW,QAAA,4BAA4B,GAAG;IAC1C,QAAQ,EAAE,eAAe;IACzB,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,iBAAiB;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAa,KAAK;IAWmC;IAV3C,MAAM,CAAS;IACf,SAAS,CAAY;IACZ,UAAU,CAAa;IAExC;;;;;OAKG;IACH,YAAmB,UAAsB,EAAU,OAAkB;QAAlB,YAAO,GAAP,OAAO,CAAW;QACnE,IAAI,CAAC,MAAM,GAAG,aAAM,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CAAC,MAAyB;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,IAAA,mBAAO,EAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,kCAA0B,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAEnF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,kCAA0B,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACrF,MAAM,EAAE,GAAG,MAAM,4CAAmB,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,cAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,cAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9G,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC7B,MAAM,IAAI,cAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,IAAI,oBAAoB,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9F,CAAC;QAED,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,kCAA0B,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAEpF,MAAM,SAAS,GAAG,CAChB,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CACrC;;kDAE0C,MAAM,CAAC,IAAI,GAAG,EACxD,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CACF,CAAC,EAAE,CAAC;QAEL,MAAM,GAAG,GAAG,GACV,IAAI,CAAC,UAAU,CAAC,WAClB,mBAAmB,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,8BAA8B,CAAC;QAEjF,MAAM,IAAI,GAA0B;YAClC,SAAS;YACT,aAAa,EAAE,MAAM,CAAC,OAAO;YAC7B,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,SAAS,EAAE,MAAM,CAAC,IAAI;SACvB,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAsB,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAEtF,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,kCAA0B,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAEtF,MAAM,gBAAgB,GAAG,CACvB,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CACjC,+EAA+E,SAAS,IAAI,CAC7F,CACF,CAAC,OAAO,CAAC;QACV,kFAAkF;QAClF,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QAExF,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC;YACjC,oBAAoB,EAAE,IAAI,CAAC,UAAU;YACrC,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,IAAI,IAAI,WAAW;SAC7D,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC;YAC/C,SAAS,EAAE,cAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9B,OAAO,EAAE,cAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;SAClC,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,cAAO,CAAC,sBAAsB,cAAc,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,MAA2B;QAC/C,MAAM,GAAG,GAAG,iCAAiC,CAAC;QAE9C,2DAA2D;QAC3D,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,2CAA2C,IAAA,mBAAO,EAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CACnG,CAAC;YACF,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,oCAA4B,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAwB,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;QAED,uEAAuE;QACvE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,IAAA,mBAAO,EAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,oCAA4B,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAwB,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAE1F,MAAM,gBAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,oCAA4B,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAEhF,EAAE;QACF,qFAAqF;QACrF,EAAE;QAEF,4CAA4C;QAC5C,gGAAgG;QAChG,+CAA+C;QAC/C,gBAAgB;QAChB,oCAAoC;QACpC,+DAA+D;QAC/D,MAAM;QACN,MAAM;QACN,uCAAuC;QACvC,2CAA2C;QAC3C,iBAAiB;QACjB,sBAAsB;QACtB,kEAAkE;QAClE,MAAM;QACN,qDAAqD;QACrD,2CAA2C;QAC3C,kCAAkC;QAClC,MAAM;QAEN,0CAA0C;QAC1C,2EAA2E;QAC3E,IAAI;QAEJ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,MAAgC;QACtD,IAAI,SAAuB,CAAC;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAA6B,KAAK,EAAE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QACpH,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC5C,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,cAAO,CAAC,MAAM,CAAC;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,OAAO,EAAE,QAAQ,CAAC,YAAY,IAAI,SAAS;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAAkC;QAC1D,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAG,uCAAuC,CAAC;QAEpD,MAAM,IAAI,GAAyB;YACjC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,cAAc,EAAE;gBACd,WAAW,EAAE;oBACX,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,WAAW,EAAE,MAAM,CAAC,WAAW;oBAC/B,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;iBAC9C;aACF;YACD,kBAAkB,EAAE;gBAClB,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,EAAE;aAC5C;SACF,CAAC;QACF,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QACzE,CAAC;QACD,IAAI,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,GAAG,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,EAAE,CAAC;YACvF,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC5B,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;YAChF,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAA2B,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3F,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC/C,OAAO,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,MAAM,cAAO,CAAC,MAAM,CAAC;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,OAAO,EAAE,QAAQ,CAAC,YAAY,IAAI,SAAS;aAC5C,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,kDAAkD;IAC1C,qBAAqB,CAAC,MAAkC;QAC9D,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACpE,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC/D,MAAM,QAAQ,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,kDAAkD;IAC1C,oBAAoB,CAAC,MAAgC;QAC3D,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAC/E,MAAM,WAAW,GAAG,aAAa,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,MAAM,WAAW,GAAG,QAAQ,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,kBAAkB,GAAG,eAAe,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5E,MAAM,yBAAyB,GAAG,sBAAsB,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACjG,MAAM,qBAAqB,GAAG,cAAc,CAAC,CAAC,CAAC,mBAAmB,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxF,OAAO,2BAA2B,WAAW,IAAI,WAAW,IAAI,kBAAkB,IAAI,yBAAyB,GAAG,qBAAqB,EAAE,CAAC;IAC5I,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,MAAyB;QACpD,MAAM,kBAAkB,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QAC9G,MAAM,UAAU,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1G,MAAM,eAAe,GAAG,mBAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAAC,IAAI,wBAAwB,CAAC,CAAC;QAC9F,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC;QAC3E,MAAM,oBAAoB,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC7E,6EAA6E;QAC7E,MAAM,OAAO,GAAG,CACd,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CACrC,4EAA4E,CAC7E,CACF,CAAC,QAAQ,CAAC;QAEX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,IAAA,mBAAO,EAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,iBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC1D,iBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;SACnD,CAAC,CAAC;QACH,gDAAgD;QAChD,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,iBAAE,CAAC,QAAQ,CAAC,SAAS,CACnB,eAAe,EACf;;mCAE2B,MAAM,CAAC,IAAI;mCACX,MAAM,CAAC,IAAI;;;OAGvC,CACA;YACD,iBAAE,CAAC,QAAQ,CAAC,SAAS,CACnB,aAAa,EACb;;;iBAGS,MAAM,CAAC,IAAI;gBACZ,MAAM,CAAC,IAAI;;eAEZ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6IH,MAAM,CAAC,kBAAkB;aAC/B,MAAM,CAAC,IAAI;;;;;;CAMvB,CACM;YACD,iBAAE,CAAC,QAAQ,CAAC,SAAS,CACnB,oBAAoB,EACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BA+DoB,MAAM,CAAC,IAAI;;;;;;;;;CAStC,CACM;SACF,CAAC,CAAC;QAEH,OAAO,CAAC,eAAe,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;IAChE,CAAC;CACF;AAtfD,sBAsfC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { type AgentCreateConfig, type AgentCreateResponse, type AgentJobSpec, type AgentJobSpecV2, type AgentJobSpecCreateConfig, type AgentJobSpecCreateConfigV2, type AgentJobSpecCreateResponse, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, SfAgent, } from './types';
|
|
2
|
-
export { Agent, AgentCreateLifecycleStages } from './agent';
|
|
1
|
+
export { type AgentCreateConfig, type AgentCreateConfigV2, type AgentCreateResponse, type AgentCreateResponseV2, type AgentJobSpec, type AgentJobSpecV2, type AgentJobSpecCreateConfig, type AgentJobSpecCreateConfigV2, type AgentJobSpecCreateResponse, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, SfAgent, } from './types';
|
|
2
|
+
export { Agent, AgentCreateLifecycleStages, AgentCreateLifecycleStagesV2 } from './agent';
|
|
3
3
|
export { AgentTester, convertTestResultsToFormat, type AgentTestResultsResponse, type AgentTestStartResponse, type AgentTestStatusResponse, type TestCaseResult, type TestStatus, } from './agentTester';
|
package/lib/index.js
CHANGED
|
@@ -6,10 +6,11 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.convertTestResultsToFormat = exports.AgentTester = exports.AgentCreateLifecycleStages = exports.Agent = void 0;
|
|
9
|
+
exports.convertTestResultsToFormat = exports.AgentTester = exports.AgentCreateLifecycleStagesV2 = exports.AgentCreateLifecycleStages = exports.Agent = void 0;
|
|
10
10
|
var agent_1 = require("./agent");
|
|
11
11
|
Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_1.Agent; } });
|
|
12
12
|
Object.defineProperty(exports, "AgentCreateLifecycleStages", { enumerable: true, get: function () { return agent_1.AgentCreateLifecycleStages; } });
|
|
13
|
+
Object.defineProperty(exports, "AgentCreateLifecycleStagesV2", { enumerable: true, get: function () { return agent_1.AgentCreateLifecycleStagesV2; } });
|
|
13
14
|
var agentTester_1 = require("./agentTester");
|
|
14
15
|
Object.defineProperty(exports, "AgentTester", { enumerable: true, get: function () { return agentTester_1.AgentTester; } });
|
|
15
16
|
Object.defineProperty(exports, "convertTestResultsToFormat", { enumerable: true, get: function () { return agentTester_1.convertTestResultsToFormat; } });
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAiBH,iCAA0F;AAAjF,8FAAA,KAAK,OAAA;AAAE,mHAAA,0BAA0B,OAAA;AAAE,qHAAA,4BAA4B,OAAA;AACxE,6CAQuB;AAPrB,0GAAA,WAAW,OAAA;AACX,yHAAA,0BAA0B,OAAA"}
|
package/lib/types.d.ts
CHANGED
|
@@ -68,6 +68,70 @@ export type AgentJobSpecCreateConfigV2 = {
|
|
|
68
68
|
export type AgentCreateConfig = AgentJobSpecCreateConfig & {
|
|
69
69
|
jobSpec: AgentJobSpec;
|
|
70
70
|
};
|
|
71
|
+
export type AgentCreateConfigV2 = DraftAgentTopicsBody & {
|
|
72
|
+
generationInfo: {
|
|
73
|
+
defaultInfo: {
|
|
74
|
+
/**
|
|
75
|
+
* List of topics from an agent spec.
|
|
76
|
+
*/
|
|
77
|
+
preDefinedTopics?: DraftAgentTopics;
|
|
78
|
+
};
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* Whether to persist the agent creation in the org (true) or preview
|
|
82
|
+
* what would be created (false).
|
|
83
|
+
*
|
|
84
|
+
* Default: false
|
|
85
|
+
*/
|
|
86
|
+
saveAgent?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* Settings for the agent being created. Needed only when saveAgent=true
|
|
89
|
+
*/
|
|
90
|
+
agentSettings?: {
|
|
91
|
+
/**
|
|
92
|
+
* The name to use for the Agent metadata to be created.
|
|
93
|
+
*/
|
|
94
|
+
agentName: string;
|
|
95
|
+
/**
|
|
96
|
+
* The API name to use for the Agent metadata to be created.
|
|
97
|
+
*/
|
|
98
|
+
agentApiName?: string;
|
|
99
|
+
/**
|
|
100
|
+
* The GenAiPlanner metadata ID if already created in the org.
|
|
101
|
+
*/
|
|
102
|
+
plannerId?: string;
|
|
103
|
+
/**
|
|
104
|
+
* User ID of an existing user.
|
|
105
|
+
*
|
|
106
|
+
* Determines what this agent can access and do. If your agent uses
|
|
107
|
+
* features or objects that require additional permissions, assign
|
|
108
|
+
* a custom user.
|
|
109
|
+
*/
|
|
110
|
+
userId?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Store conversation transcripts, including end-user data, in event logs
|
|
113
|
+
* for this agent for troubleshooting. If false, conversation data is
|
|
114
|
+
* replaced with, "Sensitive data not available."
|
|
115
|
+
*
|
|
116
|
+
* Default: false
|
|
117
|
+
*/
|
|
118
|
+
enrichLogs?: boolean;
|
|
119
|
+
/**
|
|
120
|
+
* The conversational style of your agent's responses. Can be one of:
|
|
121
|
+
* formal, casual, or neutral.
|
|
122
|
+
*
|
|
123
|
+
* Default: casual
|
|
124
|
+
*/
|
|
125
|
+
tone?: 'casual' | 'formal' | 'neutral';
|
|
126
|
+
/**
|
|
127
|
+
* The language your agent uses in conversations. Agent currently
|
|
128
|
+
* supports English only.
|
|
129
|
+
*
|
|
130
|
+
* Default: en_US
|
|
131
|
+
*/
|
|
132
|
+
primaryLanguage?: 'en_US';
|
|
133
|
+
};
|
|
134
|
+
};
|
|
71
135
|
/**
|
|
72
136
|
* The request body to send to the `draft-agent-topics` API.
|
|
73
137
|
*/
|
|
@@ -111,6 +175,52 @@ export type AgentCreateResponse = {
|
|
|
111
175
|
isSuccess: boolean;
|
|
112
176
|
errorMessage?: string;
|
|
113
177
|
};
|
|
178
|
+
export type AgentCreateResponseV2 = {
|
|
179
|
+
isSuccess: boolean;
|
|
180
|
+
errorMessage?: string;
|
|
181
|
+
/**
|
|
182
|
+
* If the agent was created with saveAgent=true, these are the
|
|
183
|
+
* IDs that make up an agent; Bot, BotVersion, and GenAiPlanner metadata.
|
|
184
|
+
*/
|
|
185
|
+
agentId?: {
|
|
186
|
+
botId: string;
|
|
187
|
+
botVersionId: string;
|
|
188
|
+
plannerId: string;
|
|
189
|
+
};
|
|
190
|
+
agentDefinition: {
|
|
191
|
+
agentDescription: string;
|
|
192
|
+
topics: [
|
|
193
|
+
{
|
|
194
|
+
scope: string;
|
|
195
|
+
topic: string;
|
|
196
|
+
actions: [
|
|
197
|
+
{
|
|
198
|
+
actionName: string;
|
|
199
|
+
exampleOutput: string;
|
|
200
|
+
actionDescription: string;
|
|
201
|
+
inputs: [
|
|
202
|
+
{
|
|
203
|
+
inputName: string;
|
|
204
|
+
inputDataType: string;
|
|
205
|
+
inputDescription: string;
|
|
206
|
+
}
|
|
207
|
+
];
|
|
208
|
+
outputs: [
|
|
209
|
+
{
|
|
210
|
+
outputName: string;
|
|
211
|
+
outputDataType: string;
|
|
212
|
+
outputDescription: string;
|
|
213
|
+
}
|
|
214
|
+
];
|
|
215
|
+
}
|
|
216
|
+
];
|
|
217
|
+
instructions: string[];
|
|
218
|
+
classificationDescription: string;
|
|
219
|
+
}
|
|
220
|
+
];
|
|
221
|
+
sampleUtterances: string[];
|
|
222
|
+
};
|
|
223
|
+
};
|
|
114
224
|
export type DraftAgentTopics = [
|
|
115
225
|
{
|
|
116
226
|
name: string;
|
|
@@ -123,5 +233,5 @@ export type DraftAgentTopics = [
|
|
|
123
233
|
export type DraftAgentTopicsResponse = {
|
|
124
234
|
isSuccess: boolean;
|
|
125
235
|
errorMessage?: string;
|
|
126
|
-
|
|
236
|
+
topicDrafts: DraftAgentTopics;
|
|
127
237
|
};
|