@copilotkit/react-core 1.4.6 → 1.4.8-coagents-v0-3.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/CHANGELOG.md +80 -6
- package/README.md +2 -0
- package/dist/{chunk-EUIBVFV6.mjs → chunk-EC5YZTSH.mjs} +91 -57
- package/dist/chunk-EC5YZTSH.mjs.map +1 -0
- package/dist/{chunk-XBVKTDXP.mjs → chunk-TNSI3FLW.mjs} +2 -2
- package/dist/{chunk-JHEAUB3Z.mjs → chunk-X6ZF5WAX.mjs} +1 -1
- package/dist/{chunk-JHEAUB3Z.mjs.map → chunk-X6ZF5WAX.mjs.map} +1 -1
- package/dist/{chunk-O22KGHOQ.mjs → chunk-XIDLJSIH.mjs} +2 -2
- package/dist/chunk-XIDLJSIH.mjs.map +1 -0
- package/dist/hooks/index.js +88 -55
- package/dist/hooks/index.js.map +1 -1
- package/dist/hooks/index.mjs +4 -4
- package/dist/hooks/use-chat.js +88 -55
- package/dist/hooks/use-chat.js.map +1 -1
- package/dist/hooks/use-chat.mjs +1 -1
- package/dist/hooks/use-coagent-state-render.d.ts +2 -2
- package/dist/hooks/use-coagent-state-render.js.map +1 -1
- package/dist/hooks/use-coagent-state-render.mjs +1 -1
- package/dist/hooks/use-coagent.js +88 -55
- package/dist/hooks/use-coagent.js.map +1 -1
- package/dist/hooks/use-coagent.mjs +3 -3
- package/dist/hooks/use-copilot-chat.js +88 -55
- package/dist/hooks/use-copilot-chat.js.map +1 -1
- package/dist/hooks/use-copilot-chat.mjs +2 -2
- package/dist/index.js +88 -55
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +4 -4
- package/package.json +3 -3
- package/src/hooks/use-chat.ts +128 -77
- package/src/hooks/use-coagent-state-render.ts +2 -2
- package/src/hooks/use-coagent.ts +0 -1
- package/dist/chunk-EUIBVFV6.mjs.map +0 -1
- package/dist/chunk-O22KGHOQ.mjs.map +0 -1
- /package/dist/{chunk-XBVKTDXP.mjs.map → chunk-TNSI3FLW.mjs.map} +0 -0
package/dist/index.mjs
CHANGED
|
@@ -7,13 +7,13 @@ import "./chunk-EFZPSZWO.mjs";
|
|
|
7
7
|
import "./chunk-L34MHAXR.mjs";
|
|
8
8
|
import {
|
|
9
9
|
useCoAgent
|
|
10
|
-
} from "./chunk-
|
|
10
|
+
} from "./chunk-XIDLJSIH.mjs";
|
|
11
11
|
import {
|
|
12
12
|
useCopilotAction
|
|
13
13
|
} from "./chunk-Y7MI4PBB.mjs";
|
|
14
14
|
import {
|
|
15
15
|
useCopilotChat
|
|
16
|
-
} from "./chunk-
|
|
16
|
+
} from "./chunk-TNSI3FLW.mjs";
|
|
17
17
|
import {
|
|
18
18
|
useCopilotReadable
|
|
19
19
|
} from "./chunk-AG7FH7OD.mjs";
|
|
@@ -36,7 +36,7 @@ import {
|
|
|
36
36
|
CopilotMessagesContext,
|
|
37
37
|
useCopilotMessagesContext
|
|
38
38
|
} from "./chunk-DCTJZ742.mjs";
|
|
39
|
-
import "./chunk-
|
|
39
|
+
import "./chunk-EC5YZTSH.mjs";
|
|
40
40
|
import {
|
|
41
41
|
useCopilotRuntimeClient
|
|
42
42
|
} from "./chunk-ODN4H66E.mjs";
|
|
@@ -44,7 +44,7 @@ import "./chunk-2KCEHGSI.mjs";
|
|
|
44
44
|
import "./chunk-O7ARI5CV.mjs";
|
|
45
45
|
import {
|
|
46
46
|
useCoAgentStateRender
|
|
47
|
-
} from "./chunk-
|
|
47
|
+
} from "./chunk-X6ZF5WAX.mjs";
|
|
48
48
|
import {
|
|
49
49
|
CopilotContext,
|
|
50
50
|
useCopilotContext
|
package/package.json
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"publishConfig": {
|
|
10
10
|
"access": "public"
|
|
11
11
|
},
|
|
12
|
-
"version": "1.4.
|
|
12
|
+
"version": "1.4.8-coagents-v0-3.1",
|
|
13
13
|
"sideEffects": false,
|
|
14
14
|
"main": "./dist/index.js",
|
|
15
15
|
"module": "./dist/index.mjs",
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"dependencies": {
|
|
43
43
|
"@scarf/scarf": "^1.3.0",
|
|
44
44
|
"untruncate-json": "^0.0.1",
|
|
45
|
-
"@copilotkit/
|
|
46
|
-
"@copilotkit/
|
|
45
|
+
"@copilotkit/shared": "1.4.8-coagents-v0-3.1",
|
|
46
|
+
"@copilotkit/runtime-client-gql": "1.4.8-coagents-v0-3.1"
|
|
47
47
|
},
|
|
48
48
|
"keywords": [
|
|
49
49
|
"copilotkit",
|
package/src/hooks/use-chat.ts
CHANGED
|
@@ -18,6 +18,7 @@ import {
|
|
|
18
18
|
Role,
|
|
19
19
|
CopilotRequestType,
|
|
20
20
|
ActionInputAvailability,
|
|
21
|
+
loadMessagesFromJsonRepresentation,
|
|
21
22
|
} from "@copilotkit/runtime-client-gql";
|
|
22
23
|
|
|
23
24
|
import { CopilotApiConfig } from "../context";
|
|
@@ -187,32 +188,32 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
187
188
|
|
|
188
189
|
const messagesWithContext = [systemMessage, ...(initialMessages || []), ...previousMessages];
|
|
189
190
|
|
|
191
|
+
const filteredActions = actions
|
|
192
|
+
.filter((action) => action.available !== ActionInputAvailability.Disabled || !action.disabled)
|
|
193
|
+
.map((action) => {
|
|
194
|
+
let available: ActionInputAvailability | undefined = ActionInputAvailability.Enabled;
|
|
195
|
+
if (action.disabled) {
|
|
196
|
+
available = ActionInputAvailability.Disabled;
|
|
197
|
+
} else if (action.available === "disabled") {
|
|
198
|
+
available = ActionInputAvailability.Disabled;
|
|
199
|
+
} else if (action.available === "remote") {
|
|
200
|
+
available = ActionInputAvailability.Remote;
|
|
201
|
+
}
|
|
202
|
+
return {
|
|
203
|
+
name: action.name,
|
|
204
|
+
description: action.description || "",
|
|
205
|
+
jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters || [])),
|
|
206
|
+
available,
|
|
207
|
+
};
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
const isAgentRun = agentSessionRef.current !== null;
|
|
211
|
+
|
|
190
212
|
const stream = runtimeClient.asStream(
|
|
191
213
|
runtimeClient.generateCopilotResponse({
|
|
192
214
|
data: {
|
|
193
215
|
frontend: {
|
|
194
|
-
actions:
|
|
195
|
-
.filter(
|
|
196
|
-
(action) =>
|
|
197
|
-
action.available !== ActionInputAvailability.Disabled || !action.disabled,
|
|
198
|
-
)
|
|
199
|
-
.map((action) => {
|
|
200
|
-
let available: ActionInputAvailability | undefined =
|
|
201
|
-
ActionInputAvailability.Enabled;
|
|
202
|
-
if (action.disabled) {
|
|
203
|
-
available = ActionInputAvailability.Disabled;
|
|
204
|
-
} else if (action.available === "disabled") {
|
|
205
|
-
available = ActionInputAvailability.Disabled;
|
|
206
|
-
} else if (action.available === "remote") {
|
|
207
|
-
available = ActionInputAvailability.Remote;
|
|
208
|
-
}
|
|
209
|
-
return {
|
|
210
|
-
name: action.name,
|
|
211
|
-
description: action.description || "",
|
|
212
|
-
jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters || [])),
|
|
213
|
-
available,
|
|
214
|
-
};
|
|
215
|
-
}),
|
|
216
|
+
actions: filteredActions,
|
|
216
217
|
url: window.location.href,
|
|
217
218
|
},
|
|
218
219
|
threadId: threadIdRef.current,
|
|
@@ -259,10 +260,12 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
259
260
|
|
|
260
261
|
const reader = stream.getReader();
|
|
261
262
|
|
|
262
|
-
let actionResults: { [id: string]: string } = {};
|
|
263
263
|
let executedCoAgentStateRenders: string[] = [];
|
|
264
264
|
let followUp: FrontendAction["followUp"] = undefined;
|
|
265
265
|
|
|
266
|
+
let messages: Message[] = [];
|
|
267
|
+
let syncedMessages: Message[] = [];
|
|
268
|
+
|
|
266
269
|
try {
|
|
267
270
|
while (true) {
|
|
268
271
|
let done, value;
|
|
@@ -274,7 +277,6 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
274
277
|
} catch (readError) {
|
|
275
278
|
break;
|
|
276
279
|
}
|
|
277
|
-
|
|
278
280
|
if (done) {
|
|
279
281
|
break;
|
|
280
282
|
}
|
|
@@ -286,7 +288,7 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
286
288
|
threadIdRef.current = value.generateCopilotResponse.threadId || null;
|
|
287
289
|
runIdRef.current = value.generateCopilotResponse.runId || null;
|
|
288
290
|
|
|
289
|
-
|
|
291
|
+
messages = convertGqlOutputToMessages(
|
|
290
292
|
filterAdjacentAgentStateMessages(value.generateCopilotResponse.messages),
|
|
291
293
|
);
|
|
292
294
|
|
|
@@ -296,7 +298,7 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
296
298
|
|
|
297
299
|
newMessages = [];
|
|
298
300
|
|
|
299
|
-
// request failed, display error message
|
|
301
|
+
// request failed, display error message and quit
|
|
300
302
|
if (
|
|
301
303
|
value.generateCopilotResponse.status?.__typename === "FailedResponseStatus" &&
|
|
302
304
|
value.generateCopilotResponse.status.reason === "GUARDRAILS_VALIDATION_FAILED"
|
|
@@ -307,57 +309,16 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
307
309
|
content: value.generateCopilotResponse.status.details?.guardrailsReason || "",
|
|
308
310
|
}),
|
|
309
311
|
];
|
|
312
|
+
setMessages([...previousMessages, ...newMessages]);
|
|
313
|
+
break;
|
|
310
314
|
}
|
|
311
315
|
|
|
312
316
|
// add messages to the chat
|
|
313
317
|
else {
|
|
318
|
+
newMessages = [...messages];
|
|
319
|
+
|
|
314
320
|
for (const message of messages) {
|
|
315
|
-
|
|
316
|
-
// execute regular action executions
|
|
317
|
-
if (
|
|
318
|
-
message.isActionExecutionMessage() &&
|
|
319
|
-
message.status.code !== MessageStatusCode.Pending &&
|
|
320
|
-
message.scope === "client" &&
|
|
321
|
-
onFunctionCall
|
|
322
|
-
) {
|
|
323
|
-
if (!(message.id in actionResults)) {
|
|
324
|
-
// Do not execute a function call if guardrails are enabled but the status is not known
|
|
325
|
-
if (guardrailsEnabled && value.generateCopilotResponse.status === undefined) {
|
|
326
|
-
break;
|
|
327
|
-
}
|
|
328
|
-
// execute action
|
|
329
|
-
try {
|
|
330
|
-
// We update the message state before calling the handler so that the render
|
|
331
|
-
// function can be called with `executing` state
|
|
332
|
-
setMessages([...previousMessages, ...newMessages]);
|
|
333
|
-
|
|
334
|
-
const action = actions.find((action) => action.name === message.name);
|
|
335
|
-
|
|
336
|
-
if (action) {
|
|
337
|
-
followUp = action.followUp;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
const result = await onFunctionCall({
|
|
341
|
-
messages: previousMessages,
|
|
342
|
-
name: message.name,
|
|
343
|
-
args: message.arguments,
|
|
344
|
-
});
|
|
345
|
-
actionResults[message.id] = result;
|
|
346
|
-
} catch (e) {
|
|
347
|
-
actionResults[message.id] = `Failed to execute action ${message.name}`;
|
|
348
|
-
console.error(`Failed to execute action ${message.name}: ${e}`);
|
|
349
|
-
}
|
|
350
|
-
}
|
|
351
|
-
// add the result message
|
|
352
|
-
newMessages.push(
|
|
353
|
-
new ResultMessage({
|
|
354
|
-
result: ResultMessage.encodeResult(actionResults[message.id]),
|
|
355
|
-
actionExecutionId: message.id,
|
|
356
|
-
actionName: message.name,
|
|
357
|
-
}),
|
|
358
|
-
);
|
|
359
|
-
}
|
|
360
|
-
// execute coagent actions
|
|
321
|
+
// execute onCoAgentStateRender handler
|
|
361
322
|
if (
|
|
362
323
|
message.isAgentStateMessage() &&
|
|
363
324
|
!message.active &&
|
|
@@ -383,6 +344,14 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
383
344
|
.find((message) => message.isAgentStateMessage());
|
|
384
345
|
|
|
385
346
|
if (lastAgentStateMessage) {
|
|
347
|
+
if (
|
|
348
|
+
lastAgentStateMessage.state.messages &&
|
|
349
|
+
lastAgentStateMessage.state.messages.length > 0
|
|
350
|
+
) {
|
|
351
|
+
syncedMessages = loadMessagesFromJsonRepresentation(
|
|
352
|
+
lastAgentStateMessage.state.messages,
|
|
353
|
+
);
|
|
354
|
+
}
|
|
386
355
|
setCoagentStatesWithRef((prevAgentStates) => ({
|
|
387
356
|
...prevAgentStates,
|
|
388
357
|
[lastAgentStateMessage.agentName]: {
|
|
@@ -412,14 +381,67 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
412
381
|
setMessages([...previousMessages, ...newMessages]);
|
|
413
382
|
}
|
|
414
383
|
}
|
|
384
|
+
const finalMessages = constructFinalMessages(syncedMessages, previousMessages, newMessages);
|
|
385
|
+
|
|
386
|
+
let didExecuteAction = false;
|
|
387
|
+
|
|
388
|
+
// execute regular action executions that are specific to the frontend (last actions)
|
|
389
|
+
if (onFunctionCall) {
|
|
390
|
+
// Find consecutive action execution messages at the end
|
|
391
|
+
const lastMessages = [];
|
|
392
|
+
for (let i = finalMessages.length - 1; i >= 0; i--) {
|
|
393
|
+
const message = finalMessages[i];
|
|
394
|
+
if (
|
|
395
|
+
message.isActionExecutionMessage() &&
|
|
396
|
+
message.status.code !== MessageStatusCode.Pending
|
|
397
|
+
) {
|
|
398
|
+
lastMessages.unshift(message);
|
|
399
|
+
} else {
|
|
400
|
+
break;
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
for (const message of lastMessages) {
|
|
405
|
+
// We update the message state before calling the handler so that the render
|
|
406
|
+
// function can be called with `executing` state
|
|
407
|
+
setMessages(finalMessages);
|
|
408
|
+
|
|
409
|
+
const action = actions.find((action) => action.name === message.name);
|
|
410
|
+
|
|
411
|
+
if (action) {
|
|
412
|
+
followUp = action.followUp;
|
|
413
|
+
const result = await onFunctionCall({
|
|
414
|
+
messages: finalMessages,
|
|
415
|
+
name: message.name,
|
|
416
|
+
args: message.arguments,
|
|
417
|
+
});
|
|
418
|
+
didExecuteAction = true;
|
|
419
|
+
const messageIndex = finalMessages.findIndex((msg) => msg.id === message.id);
|
|
420
|
+
finalMessages.splice(
|
|
421
|
+
messageIndex + 1,
|
|
422
|
+
0,
|
|
423
|
+
new ResultMessage({
|
|
424
|
+
id: "result-" + message.id,
|
|
425
|
+
result: ResultMessage.encodeResult(result),
|
|
426
|
+
actionExecutionId: message.id,
|
|
427
|
+
actionName: message.name,
|
|
428
|
+
}),
|
|
429
|
+
);
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
setMessages(finalMessages);
|
|
434
|
+
}
|
|
415
435
|
|
|
416
436
|
if (
|
|
417
437
|
// if followUp is not explicitly false
|
|
418
438
|
followUp !== false &&
|
|
419
|
-
//
|
|
420
|
-
(
|
|
421
|
-
//
|
|
422
|
-
(
|
|
439
|
+
// and we executed an action
|
|
440
|
+
(didExecuteAction ||
|
|
441
|
+
// the last message is a server side result
|
|
442
|
+
(!isAgentRun &&
|
|
443
|
+
finalMessages.length &&
|
|
444
|
+
finalMessages[finalMessages.length - 1].isResultMessage()))
|
|
423
445
|
) {
|
|
424
446
|
// run the completion again and return the result
|
|
425
447
|
|
|
@@ -427,7 +449,7 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
427
449
|
// - tried using react-dom's flushSync, but it did not work
|
|
428
450
|
await new Promise((resolve) => setTimeout(resolve, 10));
|
|
429
451
|
|
|
430
|
-
return await runChatCompletionRef.current!(
|
|
452
|
+
return await runChatCompletionRef.current!(finalMessages);
|
|
431
453
|
} else {
|
|
432
454
|
return newMessages.slice();
|
|
433
455
|
}
|
|
@@ -479,3 +501,32 @@ export function useChat(options: UseChatOptions): UseChatHelpers {
|
|
|
479
501
|
runChatCompletion: () => runChatCompletionRef.current!(messages),
|
|
480
502
|
};
|
|
481
503
|
}
|
|
504
|
+
|
|
505
|
+
function constructFinalMessages(
|
|
506
|
+
syncedMessages: Message[],
|
|
507
|
+
previousMessages: Message[],
|
|
508
|
+
newMessages: Message[],
|
|
509
|
+
): Message[] {
|
|
510
|
+
const finalMessages =
|
|
511
|
+
syncedMessages.length > 0 ? [...syncedMessages] : [...previousMessages, ...newMessages];
|
|
512
|
+
|
|
513
|
+
if (syncedMessages.length > 0) {
|
|
514
|
+
const messagesWithAgentState = [...previousMessages, ...newMessages];
|
|
515
|
+
|
|
516
|
+
let previousMessageId: string | undefined = undefined;
|
|
517
|
+
|
|
518
|
+
for (const message of messagesWithAgentState) {
|
|
519
|
+
if (message.isAgentStateMessage()) {
|
|
520
|
+
// insert this message into finalMessages after the position of previousMessageId
|
|
521
|
+
const index = finalMessages.findIndex((msg) => msg.id === previousMessageId);
|
|
522
|
+
if (index !== -1) {
|
|
523
|
+
finalMessages.splice(index + 1, 0, message);
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
previousMessageId = message.id;
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
return finalMessages;
|
|
532
|
+
}
|
|
@@ -12,13 +12,13 @@
|
|
|
12
12
|
* ### Simple Usage
|
|
13
13
|
*
|
|
14
14
|
* ```tsx
|
|
15
|
-
* import {
|
|
15
|
+
* import { useCoAgentStateRender } from "@copilotkit/react-core";
|
|
16
16
|
*
|
|
17
17
|
* type YourAgentState = {
|
|
18
18
|
* agent_state_property: string;
|
|
19
19
|
* }
|
|
20
20
|
*
|
|
21
|
-
*
|
|
21
|
+
* useCoAgentStateRender<YourAgentState>({
|
|
22
22
|
* name: "basic_agent",
|
|
23
23
|
* nodeName: "optionally_specify_a_specific_node",
|
|
24
24
|
* render: ({ status, state, nodeName }) => {
|
package/src/hooks/use-coagent.ts
CHANGED
|
@@ -98,7 +98,6 @@ import {
|
|
|
98
98
|
import { CoagentState } from "../types/coagent-state";
|
|
99
99
|
import { useCopilotChat } from "./use-copilot-chat";
|
|
100
100
|
import { Message } from "@copilotkit/runtime-client-gql";
|
|
101
|
-
import { flushSync } from "react-dom";
|
|
102
101
|
|
|
103
102
|
interface WithInternalStateManagementAndInitial<T> {
|
|
104
103
|
/**
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/hooks/use-chat.ts"],"sourcesContent":["import { useRef } from \"react\";\nimport {\n FunctionCallHandler,\n COPILOT_CLOUD_PUBLIC_API_KEY_HEADER,\n actionParametersToJsonSchema,\n CoAgentStateRenderHandler,\n} from \"@copilotkit/shared\";\nimport {\n Message,\n TextMessage,\n ResultMessage,\n convertMessagesToGqlInput,\n filterAdjacentAgentStateMessages,\n filterAgentStateMessages,\n convertGqlOutputToMessages,\n MessageStatusCode,\n MessageRole,\n Role,\n CopilotRequestType,\n ActionInputAvailability,\n} from \"@copilotkit/runtime-client-gql\";\n\nimport { CopilotApiConfig } from \"../context\";\nimport { FrontendAction } from \"../types/frontend-action\";\nimport { CoagentState } from \"../types/coagent-state\";\nimport { AgentSession } from \"../context/copilot-context\";\nimport { useToast } from \"../components/toast/toast-provider\";\nimport { useCopilotRuntimeClient } from \"./use-copilot-runtime-client\";\n\nexport type UseChatOptions = {\n /**\n * System messages of the chat. Defaults to an empty array.\n */\n initialMessages?: Message[];\n /**\n * Callback function to be called when a function call is received.\n * If the function returns a `ChatRequest` object, the request will be sent\n * automatically to the API and will be used to update the chat.\n */\n onFunctionCall?: FunctionCallHandler;\n\n /**\n * Callback function to be called when a coagent action is received.\n */\n onCoAgentStateRender?: CoAgentStateRenderHandler;\n\n /**\n * Function definitions to be sent to the API.\n */\n actions: FrontendAction<any>[];\n\n /**\n * The CopilotKit API configuration.\n */\n copilotConfig: CopilotApiConfig;\n\n /**\n * The current list of messages in the chat.\n */\n messages: Message[];\n /**\n * The setState-powered method to update the chat messages.\n */\n setMessages: React.Dispatch<React.SetStateAction<Message[]>>;\n\n /**\n * A callback to get the latest system message.\n */\n makeSystemMessageCallback: () => TextMessage;\n\n /**\n * Whether the API request is in progress\n */\n isLoading: boolean;\n\n /**\n * setState-powered method to update the isChatLoading value\n */\n setIsLoading: React.Dispatch<React.SetStateAction<boolean>>;\n\n /**\n * The current list of coagent states.\n */\n coagentStatesRef: React.RefObject<Record<string, CoagentState>>;\n\n /**\n * setState-powered method to update the agent states\n */\n setCoagentStatesWithRef: React.Dispatch<React.SetStateAction<Record<string, CoagentState>>>;\n\n /**\n * The current agent session.\n */\n agentSession: AgentSession | null;\n\n /**\n * setState-powered method to update the agent session\n */\n setAgentSession: React.Dispatch<React.SetStateAction<AgentSession | null>>;\n};\n\nexport type UseChatHelpers = {\n /**\n * Append a user message to the chat list. This triggers the API call to fetch\n * the assistant's response.\n * @param message The message to append\n */\n append: (message: Message) => Promise<void>;\n /**\n * Reload the last AI chat response for the given chat history. If the last\n * message isn't from the assistant, it will request the API to generate a\n * new response.\n */\n reload: () => Promise<void>;\n /**\n * Abort the current request immediately, keep the generated tokens if any.\n */\n stop: () => void;\n\n /**\n * Run the chat completion.\n */\n runChatCompletion: () => Promise<Message[]>;\n};\n\nexport function useChat(options: UseChatOptions): UseChatHelpers {\n const {\n messages,\n setMessages,\n makeSystemMessageCallback,\n copilotConfig,\n setIsLoading,\n initialMessages,\n isLoading,\n actions,\n onFunctionCall,\n onCoAgentStateRender,\n setCoagentStatesWithRef,\n coagentStatesRef,\n agentSession,\n setAgentSession,\n } = options;\n\n const abortControllerRef = useRef<AbortController>();\n const threadIdRef = useRef<string | null>(null);\n const runIdRef = useRef<string | null>(null);\n const { addGraphQLErrorsToast } = useToast();\n\n const runChatCompletionRef = useRef<(previousMessages: Message[]) => Promise<Message[]>>();\n // We need to keep a ref of coagent states and session because of renderAndWait - making sure\n // the latest state is sent to the API\n // This is a workaround and needs to be addressed in the future\n const agentSessionRef = useRef<AgentSession | null>(agentSession);\n agentSessionRef.current = agentSession;\n\n const publicApiKey = copilotConfig.publicApiKey;\n\n const headers = {\n ...(copilotConfig.headers || {}),\n ...(publicApiKey ? { [COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: publicApiKey } : {}),\n };\n\n const runtimeClient = useCopilotRuntimeClient({\n url: copilotConfig.chatApiEndpoint,\n publicApiKey: copilotConfig.publicApiKey,\n headers,\n credentials: copilotConfig.credentials,\n });\n\n const runChatCompletion = async (previousMessages: Message[]): Promise<Message[]> => {\n setIsLoading(true);\n\n // this message is just a placeholder. It will disappear once the first real message\n // is received\n let newMessages: Message[] = [\n new TextMessage({\n content: \"\",\n role: Role.Assistant,\n }),\n ];\n const abortController = new AbortController();\n abortControllerRef.current = abortController;\n\n setMessages([...previousMessages, ...newMessages]);\n\n const systemMessage = makeSystemMessageCallback();\n\n const messagesWithContext = [systemMessage, ...(initialMessages || []), ...previousMessages];\n\n const stream = runtimeClient.asStream(\n runtimeClient.generateCopilotResponse({\n data: {\n frontend: {\n actions: actions\n .filter(\n (action) =>\n action.available !== ActionInputAvailability.Disabled || !action.disabled,\n )\n .map((action) => {\n let available: ActionInputAvailability | undefined =\n ActionInputAvailability.Enabled;\n if (action.disabled) {\n available = ActionInputAvailability.Disabled;\n } else if (action.available === \"disabled\") {\n available = ActionInputAvailability.Disabled;\n } else if (action.available === \"remote\") {\n available = ActionInputAvailability.Remote;\n }\n return {\n name: action.name,\n description: action.description || \"\",\n jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters || [])),\n available,\n };\n }),\n url: window.location.href,\n },\n threadId: threadIdRef.current,\n runId: runIdRef.current,\n messages: convertMessagesToGqlInput(filterAgentStateMessages(messagesWithContext)),\n ...(copilotConfig.cloud\n ? {\n cloud: {\n ...(copilotConfig.cloud.guardrails?.input?.restrictToTopic?.enabled\n ? {\n guardrails: {\n inputValidationRules: {\n allowList:\n copilotConfig.cloud.guardrails.input.restrictToTopic.validTopics,\n denyList:\n copilotConfig.cloud.guardrails.input.restrictToTopic.invalidTopics,\n },\n },\n }\n : {}),\n },\n }\n : {}),\n metadata: {\n requestType: CopilotRequestType.Chat,\n },\n ...(agentSessionRef.current\n ? {\n agentSession: agentSessionRef.current,\n }\n : {}),\n agentStates: Object.values(coagentStatesRef.current!).map((state) => ({\n agentName: state.name,\n state: JSON.stringify(state.state),\n })),\n },\n properties: copilotConfig.properties,\n signal: abortControllerRef.current?.signal,\n }),\n );\n\n const guardrailsEnabled =\n copilotConfig.cloud?.guardrails?.input?.restrictToTopic.enabled || false;\n\n const reader = stream.getReader();\n\n let actionResults: { [id: string]: string } = {};\n let executedCoAgentStateRenders: string[] = [];\n let followUp: FrontendAction[\"followUp\"] = undefined;\n\n try {\n while (true) {\n let done, value;\n\n try {\n const readResult = await reader.read();\n done = readResult.done;\n value = readResult.value;\n } catch (readError) {\n break;\n }\n\n if (done) {\n break;\n }\n\n if (!value?.generateCopilotResponse) {\n continue;\n }\n\n threadIdRef.current = value.generateCopilotResponse.threadId || null;\n runIdRef.current = value.generateCopilotResponse.runId || null;\n\n const messages = convertGqlOutputToMessages(\n filterAdjacentAgentStateMessages(value.generateCopilotResponse.messages),\n );\n\n if (messages.length === 0) {\n continue;\n }\n\n newMessages = [];\n\n // request failed, display error message\n if (\n value.generateCopilotResponse.status?.__typename === \"FailedResponseStatus\" &&\n value.generateCopilotResponse.status.reason === \"GUARDRAILS_VALIDATION_FAILED\"\n ) {\n newMessages = [\n new TextMessage({\n role: MessageRole.Assistant,\n content: value.generateCopilotResponse.status.details?.guardrailsReason || \"\",\n }),\n ];\n }\n\n // add messages to the chat\n else {\n for (const message of messages) {\n newMessages.push(message);\n // execute regular action executions\n if (\n message.isActionExecutionMessage() &&\n message.status.code !== MessageStatusCode.Pending &&\n message.scope === \"client\" &&\n onFunctionCall\n ) {\n if (!(message.id in actionResults)) {\n // Do not execute a function call if guardrails are enabled but the status is not known\n if (guardrailsEnabled && value.generateCopilotResponse.status === undefined) {\n break;\n }\n // execute action\n try {\n // We update the message state before calling the handler so that the render\n // function can be called with `executing` state\n setMessages([...previousMessages, ...newMessages]);\n\n const action = actions.find((action) => action.name === message.name);\n\n if (action) {\n followUp = action.followUp;\n }\n\n const result = await onFunctionCall({\n messages: previousMessages,\n name: message.name,\n args: message.arguments,\n });\n actionResults[message.id] = result;\n } catch (e) {\n actionResults[message.id] = `Failed to execute action ${message.name}`;\n console.error(`Failed to execute action ${message.name}: ${e}`);\n }\n }\n // add the result message\n newMessages.push(\n new ResultMessage({\n result: ResultMessage.encodeResult(actionResults[message.id]),\n actionExecutionId: message.id,\n actionName: message.name,\n }),\n );\n }\n // execute coagent actions\n if (\n message.isAgentStateMessage() &&\n !message.active &&\n !executedCoAgentStateRenders.includes(message.id) &&\n onCoAgentStateRender\n ) {\n // Do not execute a coagent action if guardrails are enabled but the status is not known\n if (guardrailsEnabled && value.generateCopilotResponse.status === undefined) {\n break;\n }\n // execute coagent action\n await onCoAgentStateRender({\n name: message.agentName,\n nodeName: message.nodeName,\n state: message.state,\n });\n executedCoAgentStateRenders.push(message.id);\n }\n }\n\n const lastAgentStateMessage = [...messages]\n .reverse()\n .find((message) => message.isAgentStateMessage());\n\n if (lastAgentStateMessage) {\n setCoagentStatesWithRef((prevAgentStates) => ({\n ...prevAgentStates,\n [lastAgentStateMessage.agentName]: {\n name: lastAgentStateMessage.agentName,\n state: lastAgentStateMessage.state,\n running: lastAgentStateMessage.running,\n active: lastAgentStateMessage.active,\n threadId: lastAgentStateMessage.threadId,\n nodeName: lastAgentStateMessage.nodeName,\n runId: lastAgentStateMessage.runId,\n },\n }));\n if (lastAgentStateMessage.running) {\n setAgentSession({\n threadId: lastAgentStateMessage.threadId,\n agentName: lastAgentStateMessage.agentName,\n nodeName: lastAgentStateMessage.nodeName,\n });\n } else {\n setAgentSession(null);\n }\n }\n }\n\n if (newMessages.length > 0) {\n // Update message state\n setMessages([...previousMessages, ...newMessages]);\n }\n }\n\n if (\n // if followUp is not explicitly false\n followUp !== false &&\n // if we have client side results\n (Object.values(actionResults).length ||\n // or the last message we received is a result\n (newMessages.length && newMessages[newMessages.length - 1].isResultMessage()))\n ) {\n // run the completion again and return the result\n\n // wait for next tick to make sure all the react state updates\n // - tried using react-dom's flushSync, but it did not work\n await new Promise((resolve) => setTimeout(resolve, 10));\n\n return await runChatCompletionRef.current!([...previousMessages, ...newMessages]);\n } else {\n return newMessages.slice();\n }\n } finally {\n setIsLoading(false);\n }\n };\n\n runChatCompletionRef.current = runChatCompletion;\n\n const runChatCompletionAndHandleFunctionCall = async (messages: Message[]): Promise<void> => {\n await runChatCompletionRef.current!(messages);\n };\n\n const append = async (message: Message): Promise<void> => {\n if (isLoading) {\n return;\n }\n\n const newMessages = [...messages, message];\n setMessages(newMessages);\n return runChatCompletionAndHandleFunctionCall(newMessages);\n };\n\n const reload = async (): Promise<void> => {\n if (isLoading || messages.length === 0) {\n return;\n }\n let newMessages = [...messages];\n const lastMessage = messages[messages.length - 1];\n\n if (lastMessage.isTextMessage() && lastMessage.role === \"assistant\") {\n newMessages = newMessages.slice(0, -1);\n }\n\n setMessages(newMessages);\n\n return runChatCompletionAndHandleFunctionCall(newMessages);\n };\n\n const stop = (): void => {\n abortControllerRef.current?.abort();\n };\n\n return {\n append,\n reload,\n stop,\n runChatCompletion: () => runChatCompletionRef.current!(messages),\n };\n}\n"],"mappings":";;;;;;;;;;;;;AAAA,SAAS,cAAc;AACvB;AAAA,EAEE;AAAA,EACA;AAAA,OAEK;AACP;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAyGA,SAAS,QAAQ,SAAyC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM,qBAAqB,OAAwB;AACnD,QAAM,cAAc,OAAsB,IAAI;AAC9C,QAAM,WAAW,OAAsB,IAAI;AAC3C,QAAM,EAAE,sBAAsB,IAAI,SAAS;AAE3C,QAAM,uBAAuB,OAA4D;AAIzF,QAAM,kBAAkB,OAA4B,YAAY;AAChE,kBAAgB,UAAU;AAE1B,QAAM,eAAe,cAAc;AAEnC,QAAM,UAAU,kCACV,cAAc,WAAW,CAAC,IAC1B,eAAe,EAAE,CAAC,mCAAmC,GAAG,aAAa,IAAI,CAAC;AAGhF,QAAM,gBAAgB,wBAAwB;AAAA,IAC5C,KAAK,cAAc;AAAA,IACnB,cAAc,cAAc;AAAA,IAC5B;AAAA,IACA,aAAa,cAAc;AAAA,EAC7B,CAAC;AAED,QAAM,oBAAoB,CAAO,qBAAoD;AAzKvF;AA0KI,iBAAa,IAAI;AAIjB,QAAI,cAAyB;AAAA,MAC3B,IAAI,YAAY;AAAA,QACd,SAAS;AAAA,QACT,MAAM,KAAK;AAAA,MACb,CAAC;AAAA,IACH;AACA,UAAM,kBAAkB,IAAI,gBAAgB;AAC5C,uBAAmB,UAAU;AAE7B,gBAAY,CAAC,GAAG,kBAAkB,GAAG,WAAW,CAAC;AAEjD,UAAM,gBAAgB,0BAA0B;AAEhD,UAAM,sBAAsB,CAAC,eAAe,GAAI,mBAAmB,CAAC,GAAI,GAAG,gBAAgB;AAE3F,UAAM,SAAS,cAAc;AAAA,MAC3B,cAAc,wBAAwB;AAAA,QACpC,MAAM;AAAA,UACJ,UAAU;AAAA,YACR,SAAS,QACN;AAAA,cACC,CAAC,WACC,OAAO,cAAc,wBAAwB,YAAY,CAAC,OAAO;AAAA,YACrE,EACC,IAAI,CAAC,WAAW;AACf,kBAAI,YACF,wBAAwB;AAC1B,kBAAI,OAAO,UAAU;AACnB,4BAAY,wBAAwB;AAAA,cACtC,WAAW,OAAO,cAAc,YAAY;AAC1C,4BAAY,wBAAwB;AAAA,cACtC,WAAW,OAAO,cAAc,UAAU;AACxC,4BAAY,wBAAwB;AAAA,cACtC;AACA,qBAAO;AAAA,gBACL,MAAM,OAAO;AAAA,gBACb,aAAa,OAAO,eAAe;AAAA,gBACnC,YAAY,KAAK,UAAU,6BAA6B,OAAO,cAAc,CAAC,CAAC,CAAC;AAAA,gBAChF;AAAA,cACF;AAAA,YACF,CAAC;AAAA,YACH,KAAK,OAAO,SAAS;AAAA,UACvB;AAAA,UACA,UAAU,YAAY;AAAA,UACtB,OAAO,SAAS;AAAA,UAChB,UAAU,0BAA0B,yBAAyB,mBAAmB,CAAC;AAAA,WAC7E,cAAc,QACd;AAAA,UACE,OAAO,qBACD,+BAAc,MAAM,eAApB,mBAAgC,UAAhC,mBAAuC,oBAAvC,mBAAwD,WACxD;AAAA,YACE,YAAY;AAAA,cACV,sBAAsB;AAAA,gBACpB,WACE,cAAc,MAAM,WAAW,MAAM,gBAAgB;AAAA,gBACvD,UACE,cAAc,MAAM,WAAW,MAAM,gBAAgB;AAAA,cACzD;AAAA,YACF;AAAA,UACF,IACA,CAAC;AAAA,QAET,IACA,CAAC,IA9CD;AAAA,UA+CJ,UAAU;AAAA,YACR,aAAa,mBAAmB;AAAA,UAClC;AAAA,YACI,gBAAgB,UAChB;AAAA,UACE,cAAc,gBAAgB;AAAA,QAChC,IACA,CAAC,IAtDD;AAAA,UAuDJ,aAAa,OAAO,OAAO,iBAAiB,OAAQ,EAAE,IAAI,CAAC,WAAW;AAAA,YACpE,WAAW,MAAM;AAAA,YACjB,OAAO,KAAK,UAAU,MAAM,KAAK;AAAA,UACnC,EAAE;AAAA,QACJ;AAAA,QACA,YAAY,cAAc;AAAA,QAC1B,SAAQ,wBAAmB,YAAnB,mBAA4B;AAAA,MACtC,CAAC;AAAA,IACH;AAEA,UAAM,sBACJ,+BAAc,UAAd,mBAAqB,eAArB,mBAAiC,UAAjC,mBAAwC,gBAAgB,YAAW;AAErE,UAAM,SAAS,OAAO,UAAU;AAEhC,QAAI,gBAA0C,CAAC;AAC/C,QAAI,8BAAwC,CAAC;AAC7C,QAAI,WAAuC;AAE3C,QAAI;AACF,aAAO,MAAM;AACX,YAAI,MAAM;AAEV,YAAI;AACF,gBAAM,aAAa,MAAM,OAAO,KAAK;AACrC,iBAAO,WAAW;AAClB,kBAAQ,WAAW;AAAA,QACrB,SAAS,WAAP;AACA;AAAA,QACF;AAEA,YAAI,MAAM;AACR;AAAA,QACF;AAEA,YAAI,EAAC,+BAAO,0BAAyB;AACnC;AAAA,QACF;AAEA,oBAAY,UAAU,MAAM,wBAAwB,YAAY;AAChE,iBAAS,UAAU,MAAM,wBAAwB,SAAS;AAE1D,cAAMA,YAAW;AAAA,UACf,iCAAiC,MAAM,wBAAwB,QAAQ;AAAA,QACzE;AAEA,YAAIA,UAAS,WAAW,GAAG;AACzB;AAAA,QACF;AAEA,sBAAc,CAAC;AAGf,cACE,WAAM,wBAAwB,WAA9B,mBAAsC,gBAAe,0BACrD,MAAM,wBAAwB,OAAO,WAAW,gCAChD;AACA,wBAAc;AAAA,YACZ,IAAI,YAAY;AAAA,cACd,MAAM,YAAY;AAAA,cAClB,WAAS,WAAM,wBAAwB,OAAO,YAArC,mBAA8C,qBAAoB;AAAA,YAC7E,CAAC;AAAA,UACH;AAAA,QACF,OAGK;AACH,qBAAW,WAAWA,WAAU;AAC9B,wBAAY,KAAK,OAAO;AAExB,gBACE,QAAQ,yBAAyB,KACjC,QAAQ,OAAO,SAAS,kBAAkB,WAC1C,QAAQ,UAAU,YAClB,gBACA;AACA,kBAAI,EAAE,QAAQ,MAAM,gBAAgB;AAElC,oBAAI,qBAAqB,MAAM,wBAAwB,WAAW,QAAW;AAC3E;AAAA,gBACF;AAEA,oBAAI;AAGF,8BAAY,CAAC,GAAG,kBAAkB,GAAG,WAAW,CAAC;AAEjD,wBAAM,SAAS,QAAQ,KAAK,CAACC,YAAWA,QAAO,SAAS,QAAQ,IAAI;AAEpE,sBAAI,QAAQ;AACV,+BAAW,OAAO;AAAA,kBACpB;AAEA,wBAAM,SAAS,MAAM,eAAe;AAAA,oBAClC,UAAU;AAAA,oBACV,MAAM,QAAQ;AAAA,oBACd,MAAM,QAAQ;AAAA,kBAChB,CAAC;AACD,gCAAc,QAAQ,EAAE,IAAI;AAAA,gBAC9B,SAAS,GAAP;AACA,gCAAc,QAAQ,EAAE,IAAI,4BAA4B,QAAQ;AAChE,0BAAQ,MAAM,4BAA4B,QAAQ,SAAS,GAAG;AAAA,gBAChE;AAAA,cACF;AAEA,0BAAY;AAAA,gBACV,IAAI,cAAc;AAAA,kBAChB,QAAQ,cAAc,aAAa,cAAc,QAAQ,EAAE,CAAC;AAAA,kBAC5D,mBAAmB,QAAQ;AAAA,kBAC3B,YAAY,QAAQ;AAAA,gBACtB,CAAC;AAAA,cACH;AAAA,YACF;AAEA,gBACE,QAAQ,oBAAoB,KAC5B,CAAC,QAAQ,UACT,CAAC,4BAA4B,SAAS,QAAQ,EAAE,KAChD,sBACA;AAEA,kBAAI,qBAAqB,MAAM,wBAAwB,WAAW,QAAW;AAC3E;AAAA,cACF;AAEA,oBAAM,qBAAqB;AAAA,gBACzB,MAAM,QAAQ;AAAA,gBACd,UAAU,QAAQ;AAAA,gBAClB,OAAO,QAAQ;AAAA,cACjB,CAAC;AACD,0CAA4B,KAAK,QAAQ,EAAE;AAAA,YAC7C;AAAA,UACF;AAEA,gBAAM,wBAAwB,CAAC,GAAGD,SAAQ,EACvC,QAAQ,EACR,KAAK,CAAC,YAAY,QAAQ,oBAAoB,CAAC;AAElD,cAAI,uBAAuB;AACzB,oCAAwB,CAAC,oBAAqB,iCACzC,kBADyC;AAAA,cAE5C,CAAC,sBAAsB,SAAS,GAAG;AAAA,gBACjC,MAAM,sBAAsB;AAAA,gBAC5B,OAAO,sBAAsB;AAAA,gBAC7B,SAAS,sBAAsB;AAAA,gBAC/B,QAAQ,sBAAsB;AAAA,gBAC9B,UAAU,sBAAsB;AAAA,gBAChC,UAAU,sBAAsB;AAAA,gBAChC,OAAO,sBAAsB;AAAA,cAC/B;AAAA,YACF,EAAE;AACF,gBAAI,sBAAsB,SAAS;AACjC,8BAAgB;AAAA,gBACd,UAAU,sBAAsB;AAAA,gBAChC,WAAW,sBAAsB;AAAA,gBACjC,UAAU,sBAAsB;AAAA,cAClC,CAAC;AAAA,YACH,OAAO;AACL,8BAAgB,IAAI;AAAA,YACtB;AAAA,UACF;AAAA,QACF;AAEA,YAAI,YAAY,SAAS,GAAG;AAE1B,sBAAY,CAAC,GAAG,kBAAkB,GAAG,WAAW,CAAC;AAAA,QACnD;AAAA,MACF;AAEA;AAAA;AAAA,QAEE,aAAa;AAAA,SAEZ,OAAO,OAAO,aAAa,EAAE;AAAA,QAE3B,YAAY,UAAU,YAAY,YAAY,SAAS,CAAC,EAAE,gBAAgB;AAAA,QAC7E;AAKA,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,EAAE,CAAC;AAEtD,eAAO,MAAM,qBAAqB,QAAS,CAAC,GAAG,kBAAkB,GAAG,WAAW,CAAC;AAAA,MAClF,OAAO;AACL,eAAO,YAAY,MAAM;AAAA,MAC3B;AAAA,IACF,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF;AAEA,uBAAqB,UAAU;AAE/B,QAAM,yCAAyC,CAAOA,cAAuC;AAC3F,UAAM,qBAAqB,QAASA,SAAQ;AAAA,EAC9C;AAEA,QAAM,SAAS,CAAO,YAAoC;AACxD,QAAI,WAAW;AACb;AAAA,IACF;AAEA,UAAM,cAAc,CAAC,GAAG,UAAU,OAAO;AACzC,gBAAY,WAAW;AACvB,WAAO,uCAAuC,WAAW;AAAA,EAC3D;AAEA,QAAM,SAAS,MAA2B;AACxC,QAAI,aAAa,SAAS,WAAW,GAAG;AACtC;AAAA,IACF;AACA,QAAI,cAAc,CAAC,GAAG,QAAQ;AAC9B,UAAM,cAAc,SAAS,SAAS,SAAS,CAAC;AAEhD,QAAI,YAAY,cAAc,KAAK,YAAY,SAAS,aAAa;AACnE,oBAAc,YAAY,MAAM,GAAG,EAAE;AAAA,IACvC;AAEA,gBAAY,WAAW;AAEvB,WAAO,uCAAuC,WAAW;AAAA,EAC3D;AAEA,QAAM,OAAO,MAAY;AAtd3B;AAudI,6BAAmB,YAAnB,mBAA4B;AAAA,EAC9B;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA,mBAAmB,MAAM,qBAAqB,QAAS,QAAQ;AAAA,EACjE;AACF;","names":["messages","action"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/hooks/use-coagent.ts"],"sourcesContent":["/**\n * <Callout type=\"info\">\n * Usage of this hook assumes some additional setup in your application, for more information\n * on that see the CoAgents <span className=\"text-blue-500\">[getting started guide](/coagents/quickstart)</span>.\n * </Callout>\n * <Frame className=\"my-12\">\n * <img\n * src=\"/images/coagents/SharedStateCoAgents.gif\"\n * alt=\"CoAgents demonstration\"\n * className=\"w-auto\"\n * />\n * </Frame>\n *\n * This hook is used to integrate an agent into your application. With its use, you can\n * render and update the state of an agent, allowing for a dynamic and interactive experience.\n * We call these shared state experiences agentic copilots, or CoAgents for short.\n *\n * ## Usage\n *\n * ### Simple Usage\n *\n * ```tsx\n * import { useCoAgent } from \"@copilotkit/react-core\";\n *\n * type AgentState = {\n * count: number;\n * }\n *\n * const agent = useCoAgent<AgentState>({\n * name: \"my-agent\",\n * initialState: {\n * count: 0,\n * },\n * });\n *\n * ```\n *\n * `useCoAgent` returns an object with the following properties:\n *\n * ```tsx\n * const {\n * name, // The name of the agent currently being used.\n * nodeName, // The name of the current LangGraph node.\n * state, // The current state of the agent.\n * setState, // A function to update the state of the agent.\n * running, // A boolean indicating if the agent is currently running.\n * start, // A function to start the agent.\n * stop, // A function to stop the agent.\n * run, // A function to re-run the agent. Takes a HintFunction to inform the agent why it is being re-run.\n * } = agent;\n * ```\n *\n * Finally we can leverage these properties to create reactive experiences with the agent!\n *\n * ```tsx\n * const { state, setState } = useCoAgent<AgentState>({\n * name: \"my-agent\",\n * initialState: {\n * count: 0,\n * },\n * });\n *\n * return (\n * <div>\n * <p>Count: {state.count}</p>\n * <button onClick={() => setState({ count: state.count + 1 })}>Increment</button>\n * </div>\n * );\n * ```\n *\n * This reactivity is bidirectional, meaning that changes to the state from the agent will be reflected in the UI and vice versa.\n *\n * ## Parameters\n * <PropertyReference name=\"options\" type=\"UseCoagentOptions<T>\" required>\n * The options to use when creating the coagent.\n * <PropertyReference name=\"name\" type=\"string\" required>\n * The name of the agent to use.\n * </PropertyReference>\n * <PropertyReference name=\"initialState\" type=\"T | any\">\n * The initial state of the agent.\n * </PropertyReference>\n * <PropertyReference name=\"state\" type=\"T | any\">\n * State to manage externally if you are using this hook with external state management.\n * </PropertyReference>\n * <PropertyReference name=\"setState\" type=\"(newState: T | ((prevState: T | undefined) => T)) => void\">\n * A function to update the state of the agent if you are using this hook with external state management.\n * </PropertyReference>\n * </PropertyReference>\n */\n\nimport { useEffect } from \"react\";\nimport {\n CopilotContextParams,\n CopilotMessagesContextParams,\n useCopilotContext,\n useCopilotMessagesContext,\n} from \"../context\";\nimport { CoagentState } from \"../types/coagent-state\";\nimport { useCopilotChat } from \"./use-copilot-chat\";\nimport { Message } from \"@copilotkit/runtime-client-gql\";\nimport { flushSync } from \"react-dom\";\n\ninterface WithInternalStateManagementAndInitial<T> {\n /**\n * The name of the agent being used.\n */\n name: string;\n /**\n * The initial state of the agent.\n */\n initialState: T;\n}\n\ninterface WithInternalStateManagement {\n /**\n * The name of the agent being used.\n */\n name: string;\n /**\n * Optional initialState with default type any\n */\n initialState?: any;\n}\n\ninterface WithExternalStateManagement<T> {\n /**\n * The name of the agent being used.\n */\n name: string;\n /**\n * The current state of the agent.\n */\n state: T;\n /**\n * A function to update the state of the agent.\n */\n setState: (newState: T | ((prevState: T | undefined) => T)) => void;\n}\n\ntype UseCoagentOptions<T> =\n | WithInternalStateManagementAndInitial<T>\n | WithInternalStateManagement\n | WithExternalStateManagement<T>;\n\nexport interface UseCoagentReturnType<T> {\n /**\n * The name of the agent being used.\n */\n name: string;\n /**\n * The name of the current LangGraph node.\n */\n nodeName?: string;\n /**\n * The ID of the thread the agent is running in.\n */\n threadId?: string;\n /**\n * A boolean indicating if the agent is currently running.\n */\n running: boolean;\n /**\n * The current state of the agent.\n */\n state: T;\n /**\n * A function to update the state of the agent.\n */\n setState: (newState: T | ((prevState: T | undefined) => T)) => void;\n /**\n * A function to start the agent.\n */\n start: () => void;\n /**\n * A function to stop the agent.\n */\n stop: () => void;\n /**\n * A function to re-run the agent. The hint function can be used to provide a hint to the agent\n * about why it is being re-run again.\n */\n run: (hint?: HintFunction) => Promise<void>;\n}\n\nexport interface HintFunctionParams {\n /**\n * The previous state of the agent.\n */\n previousState: any;\n /**\n * The current state of the agent.\n */\n currentState: any;\n}\n\nexport type HintFunction = (params: HintFunctionParams) => Message | undefined;\n\n/**\n * This hook is used to integrate an agent into your application. With its use, you can\n * render and update the state of the agent, allowing for a dynamic and interactive experience.\n * We call these shared state experiences \"agentic copilots\". To get started using agentic copilots, which\n * we refer to as CoAgents, checkout the documentation at https://docs.copilotkit.ai/coagents/quickstart.\n */\nexport function useCoAgent<T = any>(options: UseCoagentOptions<T>): UseCoagentReturnType<T> {\n const isExternalStateManagement = (\n options: UseCoagentOptions<T>,\n ): options is WithExternalStateManagement<T> => {\n return \"state\" in options && \"setState\" in options;\n };\n\n const { name } = options;\n\n const isInternalStateManagementWithInitial = (\n options: UseCoagentOptions<T>,\n ): options is WithInternalStateManagementAndInitial<T> => {\n return \"initialState\" in options;\n };\n\n const generalContext = useCopilotContext();\n const messagesContext = useCopilotMessagesContext();\n const context = { ...generalContext, ...messagesContext };\n const { coagentStates, coagentStatesRef, setCoagentStatesWithRef } = context;\n const { appendMessage, runChatCompletion } = useCopilotChat();\n\n const getCoagentState = (coagentStates: Record<string, CoagentState>, name: string) => {\n if (coagentStates[name]) {\n return coagentStates[name];\n } else {\n return {\n name,\n state: isInternalStateManagementWithInitial(options) ? options.initialState : {},\n running: false,\n active: false,\n threadId: undefined,\n nodeName: undefined,\n runId: undefined,\n };\n }\n };\n\n // if we manage state internally, we need to provide a function to set the state\n const setState = (newState: T | ((prevState: T | undefined) => T)) => {\n let coagentState: CoagentState = getCoagentState(coagentStatesRef.current || {}, name);\n const updatedState =\n typeof newState === \"function\" ? (newState as Function)(coagentState.state) : newState;\n\n setCoagentStatesWithRef({\n ...coagentStatesRef.current,\n [name]: {\n ...coagentState,\n state: updatedState,\n },\n });\n };\n\n const coagentState = getCoagentState(coagentStates, name);\n\n const state = isExternalStateManagement(options) ? options.state : coagentState.state;\n\n // Sync internal state with external state if state management is external\n useEffect(() => {\n if (isExternalStateManagement(options)) {\n setState(options.state);\n } else if (coagentStates[name] === undefined) {\n setState(options.initialState === undefined ? {} : options.initialState);\n }\n }, [isExternalStateManagement(options) ? JSON.stringify(options.state) : undefined]);\n\n // Return the state and setState function\n return {\n name,\n nodeName: coagentState.nodeName,\n state,\n setState,\n running: coagentState.running,\n start: () => {\n startAgent(name, context);\n },\n stop: () => {\n stopAgent(name, context);\n },\n run: (hint?: HintFunction) => {\n return runAgent(name, context, appendMessage, runChatCompletion, hint);\n },\n };\n}\n\nfunction startAgent(name: string, context: CopilotContextParams) {\n const { setAgentSession } = context;\n setAgentSession({\n agentName: name,\n });\n}\n\nfunction stopAgent(name: string, context: CopilotContextParams) {\n const { agentSession, setAgentSession } = context;\n if (agentSession && agentSession.agentName === name) {\n setAgentSession(null);\n } else {\n console.warn(`No agent session found for ${name}`);\n }\n}\n\nasync function runAgent(\n name: string,\n context: CopilotContextParams & CopilotMessagesContextParams,\n appendMessage: (message: Message) => Promise<void>,\n runChatCompletion: () => Promise<Message[]>,\n hint?: HintFunction,\n) {\n const { agentSession, setAgentSession } = context;\n if (!agentSession || agentSession.agentName !== name) {\n setAgentSession({\n agentName: name,\n });\n }\n\n let previousState: any = null;\n for (let i = context.messages.length - 1; i >= 0; i--) {\n const message = context.messages[i];\n if (message.isAgentStateMessage() && message.agentName === name) {\n previousState = message.state;\n }\n }\n\n let state = context.coagentStatesRef.current?.[name]?.state || {};\n\n if (hint) {\n const hintMessage = hint({ previousState, currentState: state });\n if (hintMessage) {\n await appendMessage(hintMessage);\n } else {\n await runChatCompletion();\n }\n } else {\n await runChatCompletion();\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA0FA,SAAS,iBAAiB;AAiHnB,SAAS,WAAoB,SAAwD;AAC1F,QAAM,4BAA4B,CAChCA,aAC8C;AAC9C,WAAO,WAAWA,YAAW,cAAcA;AAAA,EAC7C;AAEA,QAAM,EAAE,KAAK,IAAI;AAEjB,QAAM,uCAAuC,CAC3CA,aACwD;AACxD,WAAO,kBAAkBA;AAAA,EAC3B;AAEA,QAAM,iBAAiB,kBAAkB;AACzC,QAAM,kBAAkB,0BAA0B;AAClD,QAAM,UAAU,kCAAK,iBAAmB;AACxC,QAAM,EAAE,eAAe,kBAAkB,wBAAwB,IAAI;AACrE,QAAM,EAAE,eAAe,kBAAkB,IAAI,eAAe;AAE5D,QAAM,kBAAkB,CAACC,gBAA6CC,UAAiB;AACrF,QAAID,eAAcC,KAAI,GAAG;AACvB,aAAOD,eAAcC,KAAI;AAAA,IAC3B,OAAO;AACL,aAAO;AAAA,QACL,MAAAA;AAAA,QACA,OAAO,qCAAqC,OAAO,IAAI,QAAQ,eAAe,CAAC;AAAA,QAC/E,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,UAAU;AAAA,QACV,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAGA,QAAM,WAAW,CAAC,aAAoD;AACpE,QAAIC,gBAA6B,gBAAgB,iBAAiB,WAAW,CAAC,GAAG,IAAI;AACrF,UAAM,eACJ,OAAO,aAAa,aAAc,SAAsBA,cAAa,KAAK,IAAI;AAEhF,4BAAwB,iCACnB,iBAAiB,UADE;AAAA,MAEtB,CAAC,IAAI,GAAG,iCACHA,gBADG;AAAA,QAEN,OAAO;AAAA,MACT;AAAA,IACF,EAAC;AAAA,EACH;AAEA,QAAM,eAAe,gBAAgB,eAAe,IAAI;AAExD,QAAM,QAAQ,0BAA0B,OAAO,IAAI,QAAQ,QAAQ,aAAa;AAGhF,YAAU,MAAM;AACd,QAAI,0BAA0B,OAAO,GAAG;AACtC,eAAS,QAAQ,KAAK;AAAA,IACxB,WAAW,cAAc,IAAI,MAAM,QAAW;AAC5C,eAAS,QAAQ,iBAAiB,SAAY,CAAC,IAAI,QAAQ,YAAY;AAAA,IACzE;AAAA,EACF,GAAG,CAAC,0BAA0B,OAAO,IAAI,KAAK,UAAU,QAAQ,KAAK,IAAI,MAAS,CAAC;AAGnF,SAAO;AAAA,IACL;AAAA,IACA,UAAU,aAAa;AAAA,IACvB;AAAA,IACA;AAAA,IACA,SAAS,aAAa;AAAA,IACtB,OAAO,MAAM;AACX,iBAAW,MAAM,OAAO;AAAA,IAC1B;AAAA,IACA,MAAM,MAAM;AACV,gBAAU,MAAM,OAAO;AAAA,IACzB;AAAA,IACA,KAAK,CAAC,SAAwB;AAC5B,aAAO,SAAS,MAAM,SAAS,eAAe,mBAAmB,IAAI;AAAA,IACvE;AAAA,EACF;AACF;AAEA,SAAS,WAAW,MAAc,SAA+B;AAC/D,QAAM,EAAE,gBAAgB,IAAI;AAC5B,kBAAgB;AAAA,IACd,WAAW;AAAA,EACb,CAAC;AACH;AAEA,SAAS,UAAU,MAAc,SAA+B;AAC9D,QAAM,EAAE,cAAc,gBAAgB,IAAI;AAC1C,MAAI,gBAAgB,aAAa,cAAc,MAAM;AACnD,oBAAgB,IAAI;AAAA,EACtB,OAAO;AACL,YAAQ,KAAK,8BAA8B,MAAM;AAAA,EACnD;AACF;AAEA,SAAe,SACb,MACA,SACA,eACA,mBACA,MACA;AAAA;AArTF;AAsTE,UAAM,EAAE,cAAc,gBAAgB,IAAI;AAC1C,QAAI,CAAC,gBAAgB,aAAa,cAAc,MAAM;AACpD,sBAAgB;AAAA,QACd,WAAW;AAAA,MACb,CAAC;AAAA,IACH;AAEA,QAAI,gBAAqB;AACzB,aAAS,IAAI,QAAQ,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK;AACrD,YAAM,UAAU,QAAQ,SAAS,CAAC;AAClC,UAAI,QAAQ,oBAAoB,KAAK,QAAQ,cAAc,MAAM;AAC/D,wBAAgB,QAAQ;AAAA,MAC1B;AAAA,IACF;AAEA,QAAI,UAAQ,mBAAQ,iBAAiB,YAAzB,mBAAmC,UAAnC,mBAA0C,UAAS,CAAC;AAEhE,QAAI,MAAM;AACR,YAAM,cAAc,KAAK,EAAE,eAAe,cAAc,MAAM,CAAC;AAC/D,UAAI,aAAa;AACf,cAAM,cAAc,WAAW;AAAA,MACjC,OAAO;AACL,cAAM,kBAAkB;AAAA,MAC1B;AAAA,IACF,OAAO;AACL,YAAM,kBAAkB;AAAA,IAC1B;AAAA,EACF;AAAA;","names":["options","coagentStates","name","coagentState"]}
|
|
File without changes
|