Skip to content

Commit 2bc0494

Browse files
pozilpozil
committed
feat: initial commit
0 parents  commit 2bc0494

File tree

15 files changed

+5154
-0
lines changed

15 files changed

+5154
-0
lines changed

‎.gitignore‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Log files
2+
logs
3+
*.log
4+
*-debug.log
5+
*-error.log
6+
7+
# Secret configuration
8+
.env
9+
keys
10+
11+
# Tooling files
12+
node_modules
13+
jsconfig.json
14+
.vscode
15+
.idea
16+
17+
# MacOS system files
18+
.DS_Store
19+
20+
# Windows system files
21+
Thumbs.db
22+
ehthumbs.db
23+
[Dd]esktop.ini
24+
$RECYCLE.BIN/
25+
26+
# Sample code
27+
sample*

‎.prettierignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

‎.prettierrc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"trailingComma": "none",
3+
"singleQuote": true,
4+
"tabWidth": 4
5+
}

‎LICENSE‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README.md‎

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
# Node client for the Salesforce Agent API
2+
3+
See the [API documentation](https://developer.salesforce.com/docs/einstein/genai/guide/agent-api.html) and the [Postman collection](https://www.postman.com/salesforce-developers/salesforce-developers/collection/gwv9bjy/agent-api-pilot) for more information on the Salesforce Agent API.
4+
5+
- [Quick Start Example](#quick-start-example)
6+
- [Configuration](#configuration)
7+
- [Logging](#logging)
8+
- [Reference](#reference)
9+
10+
## Quick Start Example
11+
12+
Here's an example that will get you started quickly with streaming events.
13+
14+
1. Install the client library and `dotenv` with
15+
16+
```sh
17+
npm install salesforce-agent-api-client dotenv
18+
```
19+
20+
1. Create a `.env` file at the root of your project and [configure it](#configuration) with the the following template:
21+
22+
```properties
23+
INSTANCE_URL=
24+
CLIENT_ID=
25+
CLIENT_SECRET=
26+
AGENT_ID=
27+
```
28+
29+
1. Create an `index.js` file with the following code:
30+
31+
```js
32+
import * as dotenv from 'dotenv';
33+
import AgentApiClient from 'salesforce-agent-api-client';
34+
35+
// Hard-coded prompt used for a single demo run
36+
const SAMPLE_PROMPT = 'What does "AI" stand for?';
37+
38+
// Load config from .env file
39+
dotenv.config();
40+
const config = {
41+
instanceUrl: process.env.INSTANCE_URL,
42+
clientId: process.env.CLIENT_ID,
43+
clientSecret: process.env.CLIENT_SECRET,
44+
agentId: process.env.AGENT_ID
45+
};
46+
47+
// Configure Agent API client
48+
const client = new AgentApiClient(config);
49+
50+
// Authenticate
51+
await client.authenticate();
52+
53+
// Prepare SSE stream event handler
54+
function streamEventHandler({ data, event }) {
55+
const eventData = JSON.parse(data);
56+
console.log('Event: %s', event);
57+
console.log(JSON.stringify(eventData, null, 2));
58+
// TODO: add custom logic to process events
59+
}
60+
61+
// Prepare SSE stream disconnect handler
62+
async function streamDisconnectHandler() {
63+
// On disconnect, close the session
64+
await client.closeSession(sessionId);
65+
}
66+
67+
// Create a new session
68+
const sessionId = await client.createSession();
69+
const variables = [];
70+
try {
71+
// Sends an streaming message
72+
const eventSource = client.sendStreamingMessage(
73+
sessionId,
74+
SAMPLE_PROMPT,
75+
variables,
76+
streamEventHandler,
77+
streamDisconnectHandler
78+
);
79+
} catch (error) {
80+
console.log(error);
81+
await client.closeSession(sessionId);
82+
}
83+
```
84+
85+
1. Run the code with `node index.js`.
86+
87+
If everything goes well, the output should look like this:
88+
89+
```
90+
Agent API: authenticated on https://coralcloudresorts19-dev-ed.develop.my.salesforce.com (API endpoint: https://api.salesforce.com)
91+
Agent API: created session a4923398-0d60-4529-9f7a-91f021409875
92+
Agent API: sending async message 1740068546539 with text: What does AI stand for?
93+
Event: INFORM
94+
{
95+
"timestamp": 1740068551742,
96+
"originEventId": "1740068546968-REQ",
97+
"traceId": "66b8d7d8f3aac7bb404730970c88659d",
98+
"offset": 0,
99+
"message": {
100+
"type": "Inform",
101+
"id": "f5d3d83f-3bc7-4d81-9f8f-4b7e75522aa3",
102+
"feedbackId": "12636229-b716-4fcd-ba0b-6a498e27caab",
103+
"planId": "12636229-b716-4fcd-ba0b-6a498e27caab",
104+
"isContentSafe": true,
105+
"message": "How can I assist you with any customer support issues today?",
106+
"result": [],
107+
"citedReferences": []
108+
}
109+
}
110+
Event: END_OF_TURN
111+
{
112+
"timestamp": 1740068551746,
113+
"originEventId": "1740068546968-REQ",
114+
"traceId": "66b8d7d8f3aac7bb404730970c88659d",
115+
"offset": 0,
116+
"message": {
117+
"type": "EndOfTurn",
118+
"id": "696fd6f5-53bc-4366-b37c-fbf0a74ce992"
119+
}
120+
}
121+
SSE disconnected. Preventing auto reconnect.
122+
Agent API: closed session a4923398-0d60-4529-9f7a-91f021409875
123+
```
124+
125+
## Configuration
126+
127+
Object that describes the client configuration:
128+
129+
| Name | Type | Description |
130+
| -------------- | ------ | ---------------------------- |
131+
| `instanceUrl` | string | Your Salesforce Org domain. |
132+
| `clientId` | string | Connected app client ID. |
133+
| `clientSecret` | string | Connected app client secret. |
134+
| `agentId` | string | Agent ID. |
135+
136+
## Logging
137+
138+
The client uses debug level messages so you can lower the default logging level if you need more information.
139+
140+
The documentation examples use the default client logger (the console). The console is fine for a test environment but you'll want to switch to a custom logger with asynchronous logging for increased performance.
141+
142+
You can pass a logger like pino in the client constructor:
143+
144+
```js
145+
import pino from 'pino';
146+
147+
const config = {
148+
/* your config goes here */
149+
};
150+
const logger = pino();
151+
const client = new PubSubApiClient(config, logger);
152+
```
153+
154+
## Reference
155+
156+
### AgentApiClient
157+
158+
Client for the Salesforce Agent API
159+
160+
#### `AgentApiClient(configuration, [logger])`
161+
162+
Builds a new Agent API client.
163+
164+
| Name | Type | Description |
165+
| --------------- | ------------------------------- | ------------------------------------------------------------------------------------------- |
166+
| `configuration` | [Configuration](#configuration) | The client configuration (authentication...). |
167+
| `logger` | Logger | An optional [custom logger](#logging). The client uses the console if no value is supplied. |
168+
169+
#### `async authenticate() → {Promise.<void>}`
170+
171+
Authenticates with Salesforce.
172+
173+
Returns: Promise that resolves once the client is authenticated.
174+
175+
#### `async createSession() → {Promise.<string>}`
176+
177+
Creates an agent session.
178+
179+
Returns: Promise that holds the session ID.
180+
181+
#### `async sendSyncMessage(sessionId, text, variables = []) → {Promise.<any>}`
182+
183+
Sends a synchronous prompt to the agent.
184+
185+
| Name | Type | Description |
186+
| ----------- | -------- | ----------------------------- |
187+
| `sessionId` | string | An agent session ID. |
188+
| `text` | string | The prompt sent to the agent. |
189+
| `variables` | Object[] | Optional context variables. |
190+
191+
Returns: Promise that holds the agent's response.
192+
193+
#### `async sendStreamingMessage(sessionId, text, variables = [], onMessage, onDisconnect) → EventSource`
194+
195+
Sends an asynchronous prompt to the agent.
196+
197+
| Name | Type | Description |
198+
| -------------- | --------------- | -------------------------------------- |
199+
| `sessionId` | string | An agent session ID. |
200+
| `text` | string | The prompt sent to the agent. |
201+
| `variables` | Object[] | Context variables. |
202+
| `onMessage` | MessageCallback | Message callback function. |
203+
| `onDisconnect` | function() | Optional disconnect callback function. |
204+
205+
Returns: a SSE event source. See [EventSource](https://www.npmjs.com/package/eventsource-client) for implementation details.
206+
207+
`MessageCallback(Object: message)` is a callback function from `EventSource`. Notable `message` properties are as follow:
208+
209+
| Name | Type | Description |
210+
| ------- | ------ | ------------------------------------------------------ |
211+
| `event` | string | Event type. One of `INFORM`, `ERROR` or `END_OF_TURN`. |
212+
| `data` | string | The event data. Can be empty. |
213+
214+
#### `async closeSession(sessionId) → {Promise.<void>}`
215+
216+
Closes the agent session.
217+
218+
| Name | Type | Description |
219+
| ----------- | ------ | -------------------- |
220+
| `sessionId` | string | An agent session ID. |
221+
222+
Returns: Promise that resolves once the session is closed.
223+
224+
#### `async submitFeedback(sessionId, feedbackId, feedback, feedbackText) → {Promise.<void>}`
225+
226+
Submits feedback to the agent.
227+
228+
| Name | Type | Description |
229+
| -------------- | ------ | ------------------------------- |
230+
| `sessionId` | string | An agent session ID. |
231+
| `feedbackId` | string | Feedback ID. |
232+
| `feedback` | string | feedback type (`GOOD` or `BAD`) |
233+
| `feedbackText` | string | Optional feedback text |
234+
235+
Returns: Promise that resolves once the feedback is saved.

0 commit comments

Comments
 (0)