@copilotkit/react-core 0.37.0-mme-pre.0 → 0.37.0-mme-pre.2

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.
Files changed (114) hide show
  1. package/.turbo/turbo-build.log +156 -156
  2. package/CHANGELOG.md +25 -3
  3. package/dist/{chunk-L3LL6N7J.mjs → chunk-2EQGN5QK.mjs} +3 -3
  4. package/dist/{chunk-BTJD4QON.mjs → chunk-4OIVQMEM.mjs} +3 -3
  5. package/dist/{chunk-2DKLSG5S.mjs → chunk-B244LK6F.mjs} +2 -2
  6. package/dist/{chunk-32T4S22Q.mjs → chunk-B2H3NC4E.mjs} +13 -16
  7. package/dist/chunk-B2H3NC4E.mjs.map +1 -0
  8. package/dist/{chunk-TW5FS2QT.mjs → chunk-DY63PD22.mjs} +8 -4
  9. package/dist/chunk-DY63PD22.mjs.map +1 -0
  10. package/dist/{chunk-S2YA76YW.mjs → chunk-HUKLBIUK.mjs} +42 -24
  11. package/dist/chunk-HUKLBIUK.mjs.map +1 -0
  12. package/dist/{chunk-JWANHQCM.mjs → chunk-LLU5URI5.mjs} +11 -4
  13. package/dist/chunk-LLU5URI5.mjs.map +1 -0
  14. package/dist/{chunk-7YTDTTX5.mjs → chunk-MJKBCG4U.mjs} +3 -2
  15. package/dist/chunk-MJKBCG4U.mjs.map +1 -0
  16. package/dist/{chunk-B5CULQRZ.mjs → chunk-MNZXQ6UH.mjs} +2 -2
  17. package/dist/{chunk-2C4UBKRR.mjs → chunk-NSUYO6TP.mjs} +2 -2
  18. package/dist/chunk-NSUYO6TP.mjs.map +1 -0
  19. package/dist/{chunk-GJGYNK46.mjs → chunk-S5LWO5V3.mjs} +2 -2
  20. package/dist/{chunk-FHGMPFKO.mjs → chunk-SR4RW4CU.mjs} +2 -2
  21. package/dist/{chunk-T6UD6AJ2.mjs → chunk-Z5FB4WBL.mjs} +3 -3
  22. package/dist/components/copilot-provider/copilotkit-props.d.ts +5 -0
  23. package/dist/components/copilot-provider/copilotkit-props.js.map +1 -1
  24. package/dist/components/copilot-provider/copilotkit.js +16 -5
  25. package/dist/components/copilot-provider/copilotkit.js.map +1 -1
  26. package/dist/components/copilot-provider/copilotkit.mjs +2 -2
  27. package/dist/components/copilot-provider/index.js +16 -5
  28. package/dist/components/copilot-provider/index.js.map +1 -1
  29. package/dist/components/copilot-provider/index.mjs +2 -2
  30. package/dist/components/index.js +16 -5
  31. package/dist/components/index.js.map +1 -1
  32. package/dist/components/index.mjs +2 -2
  33. package/dist/context/copilot-context.d.ts +11 -2
  34. package/dist/context/copilot-context.js +7 -3
  35. package/dist/context/copilot-context.js.map +1 -1
  36. package/dist/context/copilot-context.mjs +1 -1
  37. package/dist/context/index.js +7 -3
  38. package/dist/context/index.js.map +1 -1
  39. package/dist/context/index.mjs +1 -1
  40. package/dist/hooks/index.d.ts +2 -2
  41. package/dist/hooks/index.js +56 -36
  42. package/dist/hooks/index.js.map +1 -1
  43. package/dist/hooks/index.mjs +10 -10
  44. package/dist/hooks/use-chat.d.ts +12 -6
  45. package/dist/hooks/use-chat.js +12 -14
  46. package/dist/hooks/use-chat.js.map +1 -1
  47. package/dist/hooks/use-chat.mjs +2 -2
  48. package/dist/hooks/use-copilot-action.js +7 -3
  49. package/dist/hooks/use-copilot-action.js.map +1 -1
  50. package/dist/hooks/use-copilot-action.mjs +2 -2
  51. package/dist/hooks/use-copilot-chat.d.ts +37 -15
  52. package/dist/hooks/use-copilot-chat.js +56 -36
  53. package/dist/hooks/use-copilot-chat.js.map +1 -1
  54. package/dist/hooks/use-copilot-chat.mjs +5 -5
  55. package/dist/hooks/use-copilot-readable.js +7 -3
  56. package/dist/hooks/use-copilot-readable.js.map +1 -1
  57. package/dist/hooks/use-copilot-readable.mjs +2 -2
  58. package/dist/hooks/use-make-copilot-actionable.js +7 -3
  59. package/dist/hooks/use-make-copilot-actionable.js.map +1 -1
  60. package/dist/hooks/use-make-copilot-actionable.mjs +2 -2
  61. package/dist/hooks/use-make-copilot-document-readable.js +7 -3
  62. package/dist/hooks/use-make-copilot-document-readable.js.map +1 -1
  63. package/dist/hooks/use-make-copilot-document-readable.mjs +2 -2
  64. package/dist/hooks/use-make-copilot-readable.js +7 -3
  65. package/dist/hooks/use-make-copilot-readable.js.map +1 -1
  66. package/dist/hooks/use-make-copilot-readable.mjs +2 -2
  67. package/dist/index.js +65 -38
  68. package/dist/index.js.map +1 -1
  69. package/dist/index.mjs +13 -13
  70. package/dist/lib/copilot-task.js +2 -1
  71. package/dist/lib/copilot-task.js.map +1 -1
  72. package/dist/lib/copilot-task.mjs +4 -4
  73. package/dist/lib/index.js +2 -1
  74. package/dist/lib/index.js.map +1 -1
  75. package/dist/lib/index.mjs +4 -4
  76. package/dist/openai-assistants/hooks/index.js +7 -3
  77. package/dist/openai-assistants/hooks/index.js.map +1 -1
  78. package/dist/openai-assistants/hooks/index.mjs +3 -3
  79. package/dist/openai-assistants/hooks/use-copilot-chat-v2.js +7 -3
  80. package/dist/openai-assistants/hooks/use-copilot-chat-v2.js.map +1 -1
  81. package/dist/openai-assistants/hooks/use-copilot-chat-v2.mjs +3 -3
  82. package/dist/openai-assistants/index.js +7 -3
  83. package/dist/openai-assistants/index.js.map +1 -1
  84. package/dist/openai-assistants/index.mjs +3 -3
  85. package/dist/utils/extract.js +2 -1
  86. package/dist/utils/extract.js.map +1 -1
  87. package/dist/utils/extract.mjs +4 -4
  88. package/dist/utils/fetch-chat-completion.js +2 -1
  89. package/dist/utils/fetch-chat-completion.js.map +1 -1
  90. package/dist/utils/fetch-chat-completion.mjs +1 -1
  91. package/dist/utils/index.js +2 -1
  92. package/dist/utils/index.js.map +1 -1
  93. package/dist/utils/index.mjs +4 -4
  94. package/package.json +4 -4
  95. package/src/components/copilot-provider/copilotkit-props.tsx +6 -0
  96. package/src/components/copilot-provider/copilotkit.tsx +7 -0
  97. package/src/context/copilot-context.tsx +27 -6
  98. package/src/hooks/use-chat.ts +29 -18
  99. package/src/hooks/use-copilot-action.ts +1 -1
  100. package/src/hooks/use-copilot-chat.ts +111 -23
  101. package/src/utils/fetch-chat-completion.ts +1 -0
  102. package/dist/chunk-2C4UBKRR.mjs.map +0 -1
  103. package/dist/chunk-32T4S22Q.mjs.map +0 -1
  104. package/dist/chunk-7YTDTTX5.mjs.map +0 -1
  105. package/dist/chunk-JWANHQCM.mjs.map +0 -1
  106. package/dist/chunk-S2YA76YW.mjs.map +0 -1
  107. package/dist/chunk-TW5FS2QT.mjs.map +0 -1
  108. /package/dist/{chunk-L3LL6N7J.mjs.map → chunk-2EQGN5QK.mjs.map} +0 -0
  109. /package/dist/{chunk-BTJD4QON.mjs.map → chunk-4OIVQMEM.mjs.map} +0 -0
  110. /package/dist/{chunk-2DKLSG5S.mjs.map → chunk-B244LK6F.mjs.map} +0 -0
  111. /package/dist/{chunk-B5CULQRZ.mjs.map → chunk-MNZXQ6UH.mjs.map} +0 -0
  112. /package/dist/{chunk-GJGYNK46.mjs.map → chunk-S5LWO5V3.mjs.map} +0 -0
  113. /package/dist/{chunk-FHGMPFKO.mjs.map → chunk-SR4RW4CU.mjs.map} +0 -0
  114. /package/dist/{chunk-T6UD6AJ2.mjs.map → chunk-Z5FB4WBL.mjs.map} +0 -0
@@ -79,6 +79,12 @@ export interface CopilotApiConfig {
79
79
  * ```
80
80
  */
81
81
  backendOnlyProps?: Record<string, any>;
82
+
83
+ /**
84
+ * Indicates whether the user agent should send or receive cookies from the other domain
85
+ * in the case of cross-origin requests.
86
+ */
87
+ credentials?: RequestCredentials;
82
88
  }
83
89
 
84
90
  export type InChatRenderFunction = (props: ActionRenderProps<any>) => string | JSX.Element;
@@ -96,9 +102,6 @@ export interface CopilotContextParams {
96
102
  customEntryPoints?: Record<string, FrontendAction<any>>,
97
103
  ) => FunctionCallHandler;
98
104
 
99
- messages: Message[];
100
- setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
101
-
102
105
  // text context
103
106
  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;
104
107
  removeContext: (id: TreeNodeId) => void;
@@ -109,7 +112,13 @@ export interface CopilotContextParams {
109
112
  removeDocumentContext: (documentId: string) => void;
110
113
  getDocumentsContext: (categories: string[]) => DocumentPointer[];
111
114
 
112
- // suggestions configuration
115
+ // chat
116
+ messages: Message[];
117
+ setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
118
+
119
+ isLoading: boolean;
120
+ setIsLoading: React.Dispatch<React.SetStateAction<boolean>>;
121
+
113
122
  chatSuggestionConfiguration: { [key: string]: CopilotChatSuggestionConfiguration };
114
123
  addChatSuggestionConfiguration: (
115
124
  id: string,
@@ -117,6 +126,9 @@ export interface CopilotContextParams {
117
126
  ) => void;
118
127
  removeChatSuggestionConfiguration: (id: string) => void;
119
128
 
129
+ chatInstructions: string;
130
+ setChatInstructions: React.Dispatch<React.SetStateAction<string>>;
131
+
120
132
  // api endpoints
121
133
  copilotApiConfig: CopilotApiConfig;
122
134
  }
@@ -125,16 +137,25 @@ const emptyCopilotContext: CopilotContextParams = {
125
137
  entryPoints: {},
126
138
  setEntryPoint: () => {},
127
139
  removeEntryPoint: () => {},
128
- getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),
129
- getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),
140
+
130
141
  chatComponentsCache: { current: {} },
131
142
  getContextString: (documents: DocumentPointer[], categories: string[]) =>
132
143
  returnAndThrowInDebug(""),
133
144
  addContext: () => "",
134
145
  removeContext: () => {},
146
+
147
+ getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),
148
+ getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),
149
+
135
150
  messages: [],
136
151
  setMessages: () => returnAndThrowInDebug([]),
137
152
 
153
+ isLoading: false,
154
+ setIsLoading: () => returnAndThrowInDebug(false),
155
+
156
+ chatInstructions: "",
157
+ setChatInstructions: () => returnAndThrowInDebug(""),
158
+
138
159
  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),
139
160
  addDocumentContext: () => returnAndThrowInDebug(""),
140
161
  removeDocumentContext: () => {},
@@ -76,12 +76,6 @@ export type UseChatHelpers = {
76
76
  * Abort the current request immediately, keep the generated tokens if any.
77
77
  */
78
78
  stop: () => void;
79
- /** The current value of the input */
80
- input: string;
81
- /** setState-powered method to update the input value */
82
- setInput: React.Dispatch<React.SetStateAction<string>>;
83
- /** Whether the API request is in progress */
84
- isLoading: boolean;
85
79
  };
86
80
 
87
81
  export type UseChatOptionsWithCopilotConfig = UseChatOptions & {
@@ -94,12 +88,25 @@ export type UseChatOptionsWithCopilotConfig = UseChatOptions & {
94
88
  * The setState-powered method to update the chat messages.
95
89
  */
96
90
  setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
91
+
92
+ /**
93
+ * A callback to get the latest system message.
94
+ */
95
+ makeSystemMessageCallback: () => Message;
96
+
97
+ /**
98
+ * Whether the API request is in progress
99
+ */
100
+ isLoading: boolean;
101
+
102
+ /**
103
+ * setState-powered method to update the isChatLoading value
104
+ */
105
+ setIsLoading: React.Dispatch<React.SetStateAction<boolean>>;
97
106
  };
98
107
 
99
108
  export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelpers {
100
- const { messages, setMessages } = options;
101
- const [input, setInput] = useState("");
102
- const [isLoading, setIsLoading] = useState(false);
109
+ const { messages, setMessages, makeSystemMessageCallback } = options;
103
110
  const abortControllerRef = useRef<AbortController>();
104
111
  const threadIdRef = useRef<string | null>(null);
105
112
  const runIdRef = useRef<string | null>(null);
@@ -110,7 +117,7 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
110
117
  };
111
118
 
112
119
  const runChatCompletion = async (messages: Message[]): Promise<Message[]> => {
113
- setIsLoading(true);
120
+ options.setIsLoading(true);
114
121
 
115
122
  const newMessages: Message[] = [
116
123
  {
@@ -133,7 +140,9 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
133
140
  copilotConfigBody.runId = runIdRef.current;
134
141
  }
135
142
 
136
- const messagesWithContext = [...(options.initialMessages || []), ...messages];
143
+ const systemMessage = makeSystemMessageCallback();
144
+
145
+ const messagesWithContext = [systemMessage, ...(options.initialMessages || []), ...messages];
137
146
  const response = await fetchAndDecodeChatCompletion({
138
147
  copilotConfig: { ...options.copilotConfig, body: copilotConfigBody },
139
148
  messages: messagesWithContext,
@@ -160,7 +169,7 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
160
169
  role: "assistant",
161
170
  },
162
171
  ]);
163
- setIsLoading(false);
172
+ options.setIsLoading(false);
164
173
  throw new Error("Failed to fetch chat completion");
165
174
  }
166
175
 
@@ -274,6 +283,11 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
274
283
 
275
284
  // If we want feedback, run the completion again and return the results
276
285
  if (feedback) {
286
+ // wait for next tick to make sure all the react state updates
287
+ // TODO: This is a hack, is there a more robust way to do this?
288
+ // - tried using react-dom's flushSync, but it did not work
289
+ await new Promise((resolve) => setTimeout(resolve, 10));
290
+
277
291
  return await runChatCompletion([...messages, ...newMessages]);
278
292
  }
279
293
  // otherwise, return the new messages
@@ -281,7 +295,7 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
281
295
  return newMessages.slice();
282
296
  }
283
297
  } finally {
284
- setIsLoading(false);
298
+ options.setIsLoading(false);
285
299
  }
286
300
  };
287
301
 
@@ -290,7 +304,7 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
290
304
  };
291
305
 
292
306
  const append = async (message: Message): Promise<void> => {
293
- if (isLoading) {
307
+ if (options.isLoading) {
294
308
  return;
295
309
  }
296
310
  const newMessages = [...messages, message];
@@ -299,7 +313,7 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
299
313
  };
300
314
 
301
315
  const reload = async (): Promise<void> => {
302
- if (isLoading || messages.length === 0) {
316
+ if (options.isLoading || messages.length === 0) {
303
317
  return;
304
318
  }
305
319
  let newMessages = [...messages];
@@ -321,8 +335,5 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
321
335
  append,
322
336
  reload,
323
337
  stop,
324
- isLoading,
325
- input,
326
- setInput,
327
338
  };
328
339
  }
@@ -4,7 +4,7 @@ import { CopilotContext } from "../context/copilot-context";
4
4
  import { nanoid } from "nanoid";
5
5
  import { Parameter } from "@copilotkit/shared";
6
6
 
7
- // We implement useCopilotActionImplementation dependency handling so that
7
+ // We implement useCopilotAction dependency handling so that
8
8
  // the developer has the option to not provide any dependencies.
9
9
  // In this case, we assume they want to update the handler on each rerender.
10
10
  // To avoid getting stuck in an infinite loop, we update the handler directly,
@@ -1,30 +1,89 @@
1
- import { useMemo, useContext } from "react";
1
+ /**
2
+ * A hook for accessing Copilot's chat API.
3
+ *
4
+ * `useCopilotChat` is a React hook that lets you directly interact with the
5
+ * Copilot instance. Use to implement a fully custom UI (headless UI) or to
6
+ * programmatically interact with the Copilot instance managed by the default
7
+ * UI.
8
+ *
9
+ * <RequestExample>
10
+ * ```jsx useCopilotChat Example
11
+ * import { useCopilotChat }
12
+ * from "@copilotkit/react-core";
13
+ *
14
+ * const { appendMessage } = useCopilotChat();
15
+ * appendMessage({ content: "Hello, world!", role: "user", id: "1" });
16
+ * ```
17
+ * </RequestExample>
18
+ *
19
+ * useCopilotChat returns an object with the following properties:
20
+ * - `visibleMessages`: An array of messages that are currently visible in the chat.
21
+ * - `appendMessage`: A function to append a message to the chat.
22
+ * - `setMessages`: A function to set the messages in the chat.
23
+ * - `deleteMessage`: A function to delete a message from the chat.
24
+ * - `reloadMessages`: A function to reload the messages from the API.
25
+ * - `stopGeneration`: A function to stop the generation of the next message.
26
+ * - `isLoading`: A boolean indicating if the chat is loading.
27
+ *
28
+ */
29
+ import { useMemo, useContext, useRef, useEffect, useCallback } from "react";
2
30
  import { CopilotContext } from "../context/copilot-context";
3
31
  import { Message, ToolDefinition } from "@copilotkit/shared";
4
32
  import { SystemMessageFunction } from "../types";
5
- import { UseChatOptions, useChat } from "./use-chat";
33
+ import { useChat } from "./use-chat";
6
34
  import { defaultCopilotContextCategories } from "../components";
7
35
 
8
- export interface UseCopilotChatOptions extends UseChatOptions {
36
+ export interface UseCopilotChatOptions {
37
+ /**
38
+ * A unique identifier for the chat. If not provided, a random one will be
39
+ * generated. When provided, the `useChat` hook with the same `id` will
40
+ * have shared states across components.
41
+ */
42
+ id?: string;
43
+
44
+ /**
45
+ * HTTP headers to be sent with the API request.
46
+ */
47
+ headers?: Record<string, string> | Headers;
48
+
49
+ /**
50
+ * Extra body object to be sent with the API request.
51
+ * @example
52
+ * Send a `sessionId` to the API along with the messages.
53
+ * ```js
54
+ * useChat({
55
+ * body: {
56
+ * sessionId: '123',
57
+ * }
58
+ * })
59
+ * ```
60
+ */
61
+ body?: object;
62
+ /**
63
+ * System messages of the chat. Defaults to an empty array.
64
+ */
65
+ initialMessages?: Message[];
66
+
67
+ /**
68
+ * A function to generate the system message. Defaults to `defaultSystemMessage`.
69
+ */
9
70
  makeSystemMessage?: SystemMessageFunction;
10
- additionalInstructions?: string;
11
71
  }
12
72
 
13
73
  export interface UseCopilotChatReturn {
14
74
  visibleMessages: Message[];
15
- append: (message: Message) => Promise<void>;
16
- reload: () => Promise<void>;
17
- stop: () => void;
75
+ appendMessage: (message: Message) => Promise<void>;
76
+ setMessages: (messages: Message[]) => void;
77
+ deleteMessage: (messageId: string) => void;
78
+ reloadMessages: () => Promise<void>;
79
+ stopGeneration: () => void;
18
80
  isLoading: boolean;
19
- input: string;
20
- setInput: React.Dispatch<React.SetStateAction<string>>;
21
81
  }
22
82
 
23
83
  export function useCopilotChat({
24
84
  makeSystemMessage,
25
- additionalInstructions,
26
85
  ...options
27
- }: UseCopilotChatOptions): UseCopilotChatReturn {
86
+ }: UseCopilotChatOptions = {}): UseCopilotChatReturn {
28
87
  const {
29
88
  getContextString,
30
89
  getChatCompletionFunctionDescriptions,
@@ -32,28 +91,42 @@ export function useCopilotChat({
32
91
  copilotApiConfig,
33
92
  messages,
34
93
  setMessages,
94
+ isLoading,
95
+ setIsLoading,
96
+ chatInstructions,
35
97
  } = useContext(CopilotContext);
36
98
 
37
- const systemMessage: Message = useMemo(() => {
99
+ // We need to ensure that makeSystemMessageCallback always uses the latest
100
+ // useCopilotReadable data.
101
+ const latestGetContextString = useUpdatedRef(getContextString);
102
+ const deleteMessage = useCallback(
103
+ (messageId: string) => {
104
+ setMessages((prev) => prev.filter((message) => message.id !== messageId));
105
+ },
106
+ [setMessages],
107
+ );
108
+
109
+ const makeSystemMessageCallback = useCallback(() => {
38
110
  const systemMessageMaker = makeSystemMessage || defaultSystemMessage;
39
- const contextString = getContextString([], defaultCopilotContextCategories); // TODO: make the context categories configurable
111
+ // this always gets the latest context string
112
+ const contextString = latestGetContextString.current([], defaultCopilotContextCategories); // TODO: make the context categories configurable
40
113
 
41
114
  return {
42
115
  id: "system",
43
- content: systemMessageMaker(contextString, additionalInstructions),
116
+ content: systemMessageMaker(contextString, chatInstructions),
44
117
  role: "system",
45
- };
46
- }, [getContextString, makeSystemMessage, additionalInstructions]);
118
+ } as Message;
119
+ }, [getContextString, makeSystemMessage, chatInstructions]);
47
120
 
48
121
  const functionDescriptions: ToolDefinition[] = useMemo(() => {
49
122
  return getChatCompletionFunctionDescriptions();
50
123
  }, [getChatCompletionFunctionDescriptions]);
51
124
 
52
- const { append, reload, stop, isLoading, input, setInput } = useChat({
125
+ const { append, reload, stop } = useChat({
53
126
  ...options,
54
127
  copilotConfig: copilotApiConfig,
55
128
  id: options.id,
56
- initialMessages: [systemMessage].concat(options.initialMessages || []),
129
+ initialMessages: options.initialMessages || [],
57
130
  tools: functionDescriptions,
58
131
  onFunctionCall: getFunctionCallHandler(),
59
132
  headers: { ...options.headers },
@@ -62,6 +135,9 @@ export function useCopilotChat({
62
135
  },
63
136
  messages,
64
137
  setMessages,
138
+ makeSystemMessageCallback,
139
+ isLoading,
140
+ setIsLoading,
65
141
  });
66
142
 
67
143
  const visibleMessages = messages.filter(
@@ -71,15 +147,27 @@ export function useCopilotChat({
71
147
 
72
148
  return {
73
149
  visibleMessages,
74
- append,
75
- reload,
76
- stop,
150
+ appendMessage: append,
151
+ setMessages,
152
+ reloadMessages: reload,
153
+ stopGeneration: stop,
154
+ deleteMessage,
77
155
  isLoading,
78
- input,
79
- setInput,
80
156
  };
81
157
  }
82
158
 
159
+ // store `value` in a ref and update
160
+ // it whenever it changes.
161
+ function useUpdatedRef<T>(value: T) {
162
+ const ref = useRef(value);
163
+
164
+ useEffect(() => {
165
+ ref.current = value;
166
+ }, [value]);
167
+
168
+ return ref;
169
+ }
170
+
83
171
  export function defaultSystemMessage(
84
172
  contextString: string,
85
173
  additionalInstructions?: string,
@@ -65,6 +65,7 @@ export async function fetchChatCompletion({
65
65
  ...(copilotConfig.cloud ? { cloud: copilotConfig.cloud } : {}),
66
66
  }),
67
67
  signal,
68
+ credentials: copilotConfig.credentials,
68
69
  });
69
70
 
70
71
  return response;
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/hooks/use-copilot-action.ts"],"sourcesContent":["import { useRef, useContext, useEffect } from \"react\";\nimport { FrontendAction } from \"../types/frontend-action\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport { nanoid } from \"nanoid\";\nimport { Parameter } from \"@copilotkit/shared\";\n\n// We implement useCopilotActionImplementation dependency handling so that\n// the developer has the option to not provide any dependencies.\n// In this case, we assume they want to update the handler on each rerender.\n// To avoid getting stuck in an infinite loop, we update the handler directly,\n// skipping React state updates.\n// This is ok in this case, because the handler is not part of any UI that\n// needs to be updated.\n// useCallback, useMemo or other memoization techniques are not suitable here,\n// because they will cause a infinite rerender loop.\nexport function useCopilotAction<const T extends Parameter[] | [] = []>(\n action: FrontendAction<T>,\n dependencies?: any[],\n): void {\n const { setEntryPoint, removeEntryPoint, entryPoints, chatComponentsCache } =\n useContext(CopilotContext);\n const idRef = useRef<string>(nanoid());\n\n // If the developer doesn't provide dependencies, we assume they want to\n // update handler and render function when the action object changes.\n // This ensures that any captured variables in the handler are up to date.\n if (dependencies === undefined) {\n if (entryPoints[idRef.current]) {\n entryPoints[idRef.current].handler = action.handler as any;\n if (typeof action.render === \"function\") {\n if (chatComponentsCache.current !== null) {\n chatComponentsCache.current[action.name] = action.render;\n }\n }\n }\n }\n\n useEffect(() => {\n setEntryPoint(idRef.current, action as any);\n if (chatComponentsCache.current !== null && action.render !== undefined) {\n chatComponentsCache.current[action.name] = action.render;\n }\n return () => {\n // NOTE: For now, we don't remove the chatComponentsCache entry when the action is removed.\n // This is because we currently don't have access to the messages array in CopilotContext.\n removeEntryPoint(idRef.current);\n };\n }, [\n setEntryPoint,\n removeEntryPoint,\n action.description,\n action.name,\n // This should be faster than deep equality checking\n // In addition, all major JS engines guarantee the order of object keys\n JSON.stringify(action.parameters),\n // include render only if it's a string\n typeof action.render === \"string\" ? action.render : undefined,\n // dependencies set by the developer\n ...(dependencies || []),\n ]);\n}\n\n// Usage Example:\n// useCopilotAction({\n// name: \"myAction\",\n// parameters: [\n// { name: \"arg1\", type: \"string\", enum: [\"option1\", \"option2\", \"option3\"], required: false },\n// { name: \"arg2\", type: \"number\" },\n// {\n// name: \"arg3\",\n// type: \"object\",\n// attributes: [\n// { name: \"nestedArg1\", type: \"boolean\" },\n// { name: \"xyz\", required: false },\n// ],\n// },\n// { name: \"arg4\", type: \"number[]\" },\n// ],\n// handler: ({ arg1, arg2, arg3, arg4 }) => {\n// const x = arg3.nestedArg1;\n// const z = arg3.xyz;\n// console.log(arg1, arg2, arg3);\n// },\n// });\n\n// useCopilotAction({\n// name: \"myAction\",\n// handler: () => {\n// console.log(\"No parameters provided.\");\n// },\n// });\n"],"mappings":";;;;;AAAA,SAAS,QAAQ,YAAY,iBAAiB;AAG9C,SAAS,cAAc;AAYhB,SAAS,iBACd,QACA,cACM;AACN,QAAM,EAAE,eAAe,kBAAkB,aAAa,oBAAoB,IACxE,WAAW,cAAc;AAC3B,QAAM,QAAQ,OAAe,OAAO,CAAC;AAKrC,MAAI,iBAAiB,QAAW;AAC9B,QAAI,YAAY,MAAM,OAAO,GAAG;AAC9B,kBAAY,MAAM,OAAO,EAAE,UAAU,OAAO;AAC5C,UAAI,OAAO,OAAO,WAAW,YAAY;AACvC,YAAI,oBAAoB,YAAY,MAAM;AACxC,8BAAoB,QAAQ,OAAO,IAAI,IAAI,OAAO;AAAA,QACpD;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,YAAU,MAAM;AACd,kBAAc,MAAM,SAAS,MAAa;AAC1C,QAAI,oBAAoB,YAAY,QAAQ,OAAO,WAAW,QAAW;AACvE,0BAAoB,QAAQ,OAAO,IAAI,IAAI,OAAO;AAAA,IACpD;AACA,WAAO,MAAM;AAGX,uBAAiB,MAAM,OAAO;AAAA,IAChC;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA,OAAO;AAAA,IACP,OAAO;AAAA;AAAA;AAAA,IAGP,KAAK,UAAU,OAAO,UAAU;AAAA;AAAA,IAEhC,OAAO,OAAO,WAAW,WAAW,OAAO,SAAS;AAAA;AAAA,IAEpD,GAAI,gBAAgB,CAAC;AAAA,EACvB,CAAC;AACH;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/hooks/use-chat.ts"],"sourcesContent":["import { useRef, useState, useContext, useEffect } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport {\n Message,\n ToolDefinition,\n FunctionCallHandler,\n encodeResult,\n FunctionCall,\n COPILOT_CLOUD_PUBLIC_API_KEY_HEADER,\n} from \"@copilotkit/shared\";\n\nimport { nanoid } from \"nanoid\";\nimport { fetchAndDecodeChatCompletion } from \"../utils/fetch-chat-completion\";\nimport { CopilotApiConfig } from \"../context\";\nimport untruncateJson from \"untruncate-json\";\n\nexport type UseChatOptions = {\n /**\n * The API endpoint that accepts a `{ messages: Message[] }` object and returns\n * a stream of tokens of the AI chat response. Defaults to `/api/chat`.\n */\n api?: string;\n /**\n * A unique identifier for the chat. If not provided, a random one will be\n * generated. When provided, the `useChat` hook with the same `id` will\n * have shared states across components.\n */\n id?: string;\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 * HTTP headers to be sent with the API request.\n */\n headers?: Record<string, string> | Headers;\n /**\n * Extra body object to be sent with the API request.\n * @example\n * Send a `sessionId` to the API along with the messages.\n * ```js\n * useChat({\n * body: {\n * sessionId: '123',\n * }\n * })\n * ```\n */\n body?: object;\n /**\n * Function definitions to be sent to the API.\n */\n tools?: ToolDefinition[];\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 /** The current value of the input */\n input: string;\n /** setState-powered method to update the input value */\n setInput: React.Dispatch<React.SetStateAction<string>>;\n /** Whether the API request is in progress */\n isLoading: boolean;\n};\n\nexport type UseChatOptionsWithCopilotConfig = UseChatOptions & {\n copilotConfig: CopilotApiConfig;\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\nexport function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelpers {\n const { messages, setMessages } = options;\n const [input, setInput] = useState(\"\");\n const [isLoading, setIsLoading] = useState(false);\n const abortControllerRef = useRef<AbortController>();\n const threadIdRef = useRef<string | null>(null);\n const runIdRef = useRef<string | null>(null);\n const publicApiKey = options.copilotConfig.publicApiKey;\n const headers = {\n ...(options.headers || {}),\n ...(publicApiKey ? { [COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: publicApiKey } : {}),\n };\n\n const runChatCompletion = async (messages: Message[]): Promise<Message[]> => {\n setIsLoading(true);\n\n const newMessages: Message[] = [\n {\n id: nanoid(),\n createdAt: new Date(),\n content: \"\",\n role: \"assistant\",\n },\n ];\n const abortController = new AbortController();\n abortControllerRef.current = abortController;\n\n setMessages([...messages, ...newMessages]);\n // add threadId and runId to the body if it exists\n const copilotConfigBody = options.copilotConfig.body || {};\n if (threadIdRef.current) {\n copilotConfigBody.threadId = threadIdRef.current;\n }\n if (runIdRef.current) {\n copilotConfigBody.runId = runIdRef.current;\n }\n\n const messagesWithContext = [...(options.initialMessages || []), ...messages];\n const response = await fetchAndDecodeChatCompletion({\n copilotConfig: { ...options.copilotConfig, body: copilotConfigBody },\n messages: messagesWithContext,\n tools: options.tools,\n headers: headers,\n signal: abortController.signal,\n });\n\n if (response.headers.get(\"threadid\")) {\n threadIdRef.current = response.headers.get(\"threadid\");\n }\n\n if (response.headers.get(\"runid\")) {\n runIdRef.current = response.headers.get(\"runid\");\n }\n\n if (!response.events) {\n setMessages([\n ...messages,\n {\n id: nanoid(),\n createdAt: new Date(),\n content: response.statusText,\n role: \"assistant\",\n },\n ]);\n setIsLoading(false);\n throw new Error(\"Failed to fetch chat completion\");\n }\n\n const reader = response.events.getReader();\n\n // Whether to feed back the new messages to GPT\n let feedback = false;\n\n try {\n while (true) {\n const { done, value } = await reader.read();\n\n if (done) {\n break;\n }\n\n let currentMessage = Object.assign({}, newMessages[newMessages.length - 1]);\n\n if (value.type === \"content\") {\n if (currentMessage.function_call || currentMessage.role === \"function\") {\n // Create a new message if the previous one is a function call or result\n currentMessage = {\n id: nanoid(),\n createdAt: new Date(),\n content: \"\",\n role: \"assistant\",\n };\n newMessages.push(currentMessage);\n }\n currentMessage.content += value.content;\n newMessages[newMessages.length - 1] = currentMessage;\n setMessages([...messages, ...newMessages]);\n } else if (value.type === \"result\") {\n // When we get a result message, it is already complete\n currentMessage = {\n id: nanoid(),\n role: \"function\",\n content: value.content,\n name: value.name,\n };\n newMessages.push(currentMessage);\n setMessages([...messages, ...newMessages]);\n\n // After receiving a result, feed back the new messages to GPT\n feedback = true;\n } else if (value.type === \"function\" || value.type === \"partial\") {\n // Create a new message if the previous one is not empty\n if (\n currentMessage.content != \"\" ||\n currentMessage.function_call ||\n currentMessage.role == \"function\"\n ) {\n currentMessage = {\n id: nanoid(),\n createdAt: new Date(),\n content: \"\",\n role: \"assistant\",\n };\n newMessages.push(currentMessage);\n }\n if (value.type === \"function\") {\n currentMessage.function_call = {\n name: value.name,\n arguments: JSON.stringify(value.arguments),\n scope: value.scope,\n };\n } else if (value.type === \"partial\") {\n let partialArguments: any = {};\n try {\n partialArguments = JSON.parse(untruncateJson(value.arguments));\n } catch (e) {}\n\n currentMessage.partialFunctionCall = {\n name: value.name,\n arguments: partialArguments,\n };\n }\n\n newMessages[newMessages.length - 1] = currentMessage;\n setMessages([...messages, ...newMessages]);\n\n if (value.type === \"function\") {\n // Execute the function call\n try {\n if (options.onFunctionCall && value.scope === \"client\") {\n const result = await options.onFunctionCall(\n messages,\n currentMessage.function_call as FunctionCall,\n );\n\n currentMessage = {\n id: nanoid(),\n role: \"function\",\n content: encodeResult(result),\n name: (currentMessage.function_call! as FunctionCall).name!,\n };\n newMessages.push(currentMessage);\n setMessages([...messages, ...newMessages]);\n\n // After a function call, feed back the new messages to GPT\n feedback = true;\n }\n } catch (error) {\n console.error(\"Failed to execute function call\", error);\n // TODO: Handle error\n // this should go to the message itself\n }\n }\n }\n }\n\n // If we want feedback, run the completion again and return the results\n if (feedback) {\n return await runChatCompletion([...messages, ...newMessages]);\n }\n // otherwise, return the new messages\n else {\n return newMessages.slice();\n }\n } finally {\n setIsLoading(false);\n }\n };\n\n const runChatCompletionAndHandleFunctionCall = async (messages: Message[]): Promise<void> => {\n await runChatCompletion(messages);\n };\n\n const append = async (message: Message): Promise<void> => {\n if (isLoading) {\n return;\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.role === \"assistant\") {\n newMessages = newMessages.slice(0, -1);\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 isLoading,\n input,\n setInput,\n };\n}\n"],"mappings":";;;;;;;;;;AAAA,SAAS,QAAQ,gBAAuC;AAExD;AAAA,EAIE;AAAA,EAEA;AAAA,OACK;AAEP,SAAS,cAAc;AAGvB,OAAO,oBAAoB;AAoFpB,SAAS,QAAQ,SAA0D;AAChF,QAAM,EAAE,UAAU,YAAY,IAAI;AAClC,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAS,EAAE;AACrC,QAAM,CAAC,WAAW,YAAY,IAAI,SAAS,KAAK;AAChD,QAAM,qBAAqB,OAAwB;AACnD,QAAM,cAAc,OAAsB,IAAI;AAC9C,QAAM,WAAW,OAAsB,IAAI;AAC3C,QAAM,eAAe,QAAQ,cAAc;AAC3C,QAAM,UAAU,kCACV,QAAQ,WAAW,CAAC,IACpB,eAAe,EAAE,CAAC,mCAAmC,GAAG,aAAa,IAAI,CAAC;AAGhF,QAAM,oBAAoB,CAAOA,cAA4C;AAC3E,iBAAa,IAAI;AAEjB,UAAM,cAAyB;AAAA,MAC7B;AAAA,QACE,IAAI,OAAO;AAAA,QACX,WAAW,oBAAI,KAAK;AAAA,QACpB,SAAS;AAAA,QACT,MAAM;AAAA,MACR;AAAA,IACF;AACA,UAAM,kBAAkB,IAAI,gBAAgB;AAC5C,uBAAmB,UAAU;AAE7B,gBAAY,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAEzC,UAAM,oBAAoB,QAAQ,cAAc,QAAQ,CAAC;AACzD,QAAI,YAAY,SAAS;AACvB,wBAAkB,WAAW,YAAY;AAAA,IAC3C;AACA,QAAI,SAAS,SAAS;AACpB,wBAAkB,QAAQ,SAAS;AAAA,IACrC;AAEA,UAAM,sBAAsB,CAAC,GAAI,QAAQ,mBAAmB,CAAC,GAAI,GAAGA,SAAQ;AAC5E,UAAM,WAAW,MAAM,6BAA6B;AAAA,MAClD,eAAe,iCAAK,QAAQ,gBAAb,EAA4B,MAAM,kBAAkB;AAAA,MACnE,UAAU;AAAA,MACV,OAAO,QAAQ;AAAA,MACf;AAAA,MACA,QAAQ,gBAAgB;AAAA,IAC1B,CAAC;AAED,QAAI,SAAS,QAAQ,IAAI,UAAU,GAAG;AACpC,kBAAY,UAAU,SAAS,QAAQ,IAAI,UAAU;AAAA,IACvD;AAEA,QAAI,SAAS,QAAQ,IAAI,OAAO,GAAG;AACjC,eAAS,UAAU,SAAS,QAAQ,IAAI,OAAO;AAAA,IACjD;AAEA,QAAI,CAAC,SAAS,QAAQ;AACpB,kBAAY;AAAA,QACV,GAAGA;AAAA,QACH;AAAA,UACE,IAAI,OAAO;AAAA,UACX,WAAW,oBAAI,KAAK;AAAA,UACpB,SAAS,SAAS;AAAA,UAClB,MAAM;AAAA,QACR;AAAA,MACF,CAAC;AACD,mBAAa,KAAK;AAClB,YAAM,IAAI,MAAM,iCAAiC;AAAA,IACnD;AAEA,UAAM,SAAS,SAAS,OAAO,UAAU;AAGzC,QAAI,WAAW;AAEf,QAAI;AACF,aAAO,MAAM;AACX,cAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK;AAE1C,YAAI,MAAM;AACR;AAAA,QACF;AAEA,YAAI,iBAAiB,OAAO,OAAO,CAAC,GAAG,YAAY,YAAY,SAAS,CAAC,CAAC;AAE1E,YAAI,MAAM,SAAS,WAAW;AAC5B,cAAI,eAAe,iBAAiB,eAAe,SAAS,YAAY;AAEtE,6BAAiB;AAAA,cACf,IAAI,OAAO;AAAA,cACX,WAAW,oBAAI,KAAK;AAAA,cACpB,SAAS;AAAA,cACT,MAAM;AAAA,YACR;AACA,wBAAY,KAAK,cAAc;AAAA,UACjC;AACA,yBAAe,WAAW,MAAM;AAChC,sBAAY,YAAY,SAAS,CAAC,IAAI;AACtC,sBAAY,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAAA,QAC3C,WAAW,MAAM,SAAS,UAAU;AAElC,2BAAiB;AAAA,YACf,IAAI,OAAO;AAAA,YACX,MAAM;AAAA,YACN,SAAS,MAAM;AAAA,YACf,MAAM,MAAM;AAAA,UACd;AACA,sBAAY,KAAK,cAAc;AAC/B,sBAAY,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAGzC,qBAAW;AAAA,QACb,WAAW,MAAM,SAAS,cAAc,MAAM,SAAS,WAAW;AAEhE,cACE,eAAe,WAAW,MAC1B,eAAe,iBACf,eAAe,QAAQ,YACvB;AACA,6BAAiB;AAAA,cACf,IAAI,OAAO;AAAA,cACX,WAAW,oBAAI,KAAK;AAAA,cACpB,SAAS;AAAA,cACT,MAAM;AAAA,YACR;AACA,wBAAY,KAAK,cAAc;AAAA,UACjC;AACA,cAAI,MAAM,SAAS,YAAY;AAC7B,2BAAe,gBAAgB;AAAA,cAC7B,MAAM,MAAM;AAAA,cACZ,WAAW,KAAK,UAAU,MAAM,SAAS;AAAA,cACzC,OAAO,MAAM;AAAA,YACf;AAAA,UACF,WAAW,MAAM,SAAS,WAAW;AACnC,gBAAI,mBAAwB,CAAC;AAC7B,gBAAI;AACF,iCAAmB,KAAK,MAAM,eAAe,MAAM,SAAS,CAAC;AAAA,YAC/D,SAAS,GAAP;AAAA,YAAW;AAEb,2BAAe,sBAAsB;AAAA,cACnC,MAAM,MAAM;AAAA,cACZ,WAAW;AAAA,YACb;AAAA,UACF;AAEA,sBAAY,YAAY,SAAS,CAAC,IAAI;AACtC,sBAAY,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAEzC,cAAI,MAAM,SAAS,YAAY;AAE7B,gBAAI;AACF,kBAAI,QAAQ,kBAAkB,MAAM,UAAU,UAAU;AACtD,sBAAM,SAAS,MAAM,QAAQ;AAAA,kBAC3BA;AAAA,kBACA,eAAe;AAAA,gBACjB;AAEA,iCAAiB;AAAA,kBACf,IAAI,OAAO;AAAA,kBACX,MAAM;AAAA,kBACN,SAAS,aAAa,MAAM;AAAA,kBAC5B,MAAO,eAAe,cAAgC;AAAA,gBACxD;AACA,4BAAY,KAAK,cAAc;AAC/B,4BAAY,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAGzC,2BAAW;AAAA,cACb;AAAA,YACF,SAAS,OAAP;AACA,sBAAQ,MAAM,mCAAmC,KAAK;AAAA,YAGxD;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAGA,UAAI,UAAU;AACZ,eAAO,MAAM,kBAAkB,CAAC,GAAGA,WAAU,GAAG,WAAW,CAAC;AAAA,MAC9D,OAEK;AACH,eAAO,YAAY,MAAM;AAAA,MAC3B;AAAA,IACF,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF;AAEA,QAAM,yCAAyC,CAAOA,cAAuC;AAC3F,UAAM,kBAAkBA,SAAQ;AAAA,EAClC;AAEA,QAAM,SAAS,CAAO,YAAoC;AACxD,QAAI,WAAW;AACb;AAAA,IACF;AACA,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,SAAS,aAAa;AACpC,oBAAc,YAAY,MAAM,GAAG,EAAE;AAAA,IACvC;AACA,gBAAY,WAAW;AAEvB,WAAO,uCAAuC,WAAW;AAAA,EAC3D;AAEA,QAAM,OAAO,MAAY;AA3T3B;AA4TI,6BAAmB,YAAnB,mBAA4B;AAAA,EAC9B;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":["messages"]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/utils/fetch-chat-completion.ts"],"sourcesContent":["import {\n Message,\n ToolDefinition,\n ChatCompletionEvent,\n decodeChatCompletion,\n parseChatCompletion,\n decodeChatCompletionAsText,\n EXCLUDE_FROM_FORWARD_PROPS_KEYS,\n} from \"@copilotkit/shared\";\nimport { CopilotApiConfig } from \"../context\";\n\nexport interface FetchChatCompletionParams {\n copilotConfig: CopilotApiConfig;\n model?: string;\n messages: Message[];\n tools?: ToolDefinition[];\n temperature?: number;\n maxTokens?: number;\n headers?: Record<string, string> | Headers;\n body?: object;\n signal?: AbortSignal;\n toolChoice?: string | { type: \"function\"; function: { name: string } };\n}\n\nexport async function fetchChatCompletion({\n copilotConfig,\n model,\n messages,\n tools,\n temperature,\n headers,\n body,\n signal,\n toolChoice,\n}: FetchChatCompletionParams): Promise<Response> {\n temperature ||= 0.5;\n tools ||= [];\n\n // clean up any extra properties from messages\n const cleanedMessages = messages.map((message) => {\n const { content, role, name, function_call } = message;\n return { content, role, name, function_call };\n });\n\n toolChoice ||= \"auto\";\n\n const response = await fetch(copilotConfig.chatApiEndpoint, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n ...copilotConfig.headers,\n ...(headers ? { ...headers } : {}),\n },\n body: JSON.stringify({\n model,\n messages: cleanedMessages,\n stream: true,\n ...(tools.length ? { tools } : {}),\n ...(temperature ? { temperature } : {}),\n ...(tools.length != 0 ? { tool_choice: toolChoice } : {}),\n ...copilotConfig.body,\n ...copilotConfig.backendOnlyProps,\n ...excludeBackendOnlyProps(copilotConfig),\n ...(body ? { ...body } : {}),\n ...(copilotConfig.cloud ? { cloud: copilotConfig.cloud } : {}),\n }),\n signal,\n });\n\n return response;\n}\n\nfunction excludeBackendOnlyProps(copilotConfig: any) {\n const backendOnlyProps = copilotConfig.backendOnlyProps ?? {};\n if (Object.keys(backendOnlyProps).length > 0) {\n return {\n [EXCLUDE_FROM_FORWARD_PROPS_KEYS]: Object.keys(backendOnlyProps),\n };\n } else {\n return {};\n }\n}\n\nexport interface DecodedChatCompletionResponse extends Response {\n events: ReadableStream<ChatCompletionEvent> | null;\n}\n\nexport async function fetchAndDecodeChatCompletion(\n params: FetchChatCompletionParams,\n): Promise<DecodedChatCompletionResponse> {\n const response = await fetchChatCompletion(params);\n if (!response.ok || !response.body) {\n (response as any).events = null;\n } else {\n const events = await decodeChatCompletion(parseChatCompletion(response.body));\n (response as any).events = events;\n }\n return response as any;\n}\n\nexport interface DecodedChatCompletionResponseAsText extends Response {\n events: ReadableStream<string> | null;\n}\n\nexport async function fetchAndDecodeChatCompletionAsText(\n params: FetchChatCompletionParams,\n): Promise<DecodedChatCompletionResponseAsText> {\n const response = await fetchChatCompletion(params);\n if (!response.ok || !response.body) {\n (response as any).events = null;\n } else {\n const events = await decodeChatCompletionAsText(\n decodeChatCompletion(parseChatCompletion(response.body)),\n );\n (response as any).events = events;\n }\n\n return response as any;\n}\n"],"mappings":";;;;;;AAAA;AAAA,EAIE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAgBP,SAAsB,oBAAoB,IAUO;AAAA,6CAVP;AAAA,IACxC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAiD;AAC/C,kCAAgB;AAChB,sBAAU,CAAC;AAGX,UAAM,kBAAkB,SAAS,IAAI,CAAC,YAAY;AAChD,YAAM,EAAE,SAAS,MAAM,MAAM,cAAc,IAAI;AAC/C,aAAO,EAAE,SAAS,MAAM,MAAM,cAAc;AAAA,IAC9C,CAAC;AAED,gCAAe;AAEf,UAAM,WAAW,MAAM,MAAM,cAAc,iBAAiB;AAAA,MAC1D,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,SACb,cAAc,UACb,UAAU,mBAAK,WAAY,CAAC;AAAA,MAElC,MAAM,KAAK,UAAU;AAAA,QACnB;AAAA,QACA,UAAU;AAAA,QACV,QAAQ;AAAA,SACJ,MAAM,SAAS,EAAE,MAAM,IAAI,CAAC,IAC5B,cAAc,EAAE,YAAY,IAAI,CAAC,IACjC,MAAM,UAAU,IAAI,EAAE,aAAa,WAAW,IAAI,CAAC,IACpD,cAAc,OACd,cAAc,mBACd,wBAAwB,aAAa,IACpC,OAAO,mBAAK,QAAS,CAAC,IACtB,cAAc,QAAQ,EAAE,OAAO,cAAc,MAAM,IAAI,CAAC,EAC7D;AAAA,MACD;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAEA,SAAS,wBAAwB,eAAoB;AAxErD;AAyEE,QAAM,oBAAmB,mBAAc,qBAAd,YAAkC,CAAC;AAC5D,MAAI,OAAO,KAAK,gBAAgB,EAAE,SAAS,GAAG;AAC5C,WAAO;AAAA,MACL,CAAC,+BAA+B,GAAG,OAAO,KAAK,gBAAgB;AAAA,IACjE;AAAA,EACF,OAAO;AACL,WAAO,CAAC;AAAA,EACV;AACF;AAMA,SAAsB,6BACpB,QACwC;AAAA;AACxC,UAAM,WAAW,MAAM,oBAAoB,MAAM;AACjD,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,MAAC,SAAiB,SAAS;AAAA,IAC7B,OAAO;AACL,YAAM,SAAS,MAAM,qBAAqB,oBAAoB,SAAS,IAAI,CAAC;AAC5E,MAAC,SAAiB,SAAS;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAAA;AAMA,SAAsB,mCACpB,QAC8C;AAAA;AAC9C,UAAM,WAAW,MAAM,oBAAoB,MAAM;AACjD,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,MAAC,SAAiB,SAAS;AAAA,IAC7B,OAAO;AACL,YAAM,SAAS,MAAM;AAAA,QACnB,qBAAqB,oBAAoB,SAAS,IAAI,CAAC;AAAA,MACzD;AACA,MAAC,SAAiB,SAAS;AAAA,IAC7B;AAEA,WAAO;AAAA,EACT;AAAA;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/components/copilot-provider/copilotkit.tsx"],"sourcesContent":["/**\n * Provides the Copilot context to its children.\n * \n * <img\n * referrerPolicy=\"no-referrer-when-downgrade\"\n * src=\"https://static.scarf.sh/a.png?x-pxid=a9b290bb-38f9-4518-ac3b-8f54fdbf43be\"\n * />\n * \n * This component provides the Copilot context to its children.\n * It can be configured either with a chat API endpoint or a `CopilotApiConfig`.\n * \n * <Note>\n * The backend can use OpenAI, or you can bring your own LLM. For examples of the\n * backend api implementation, see `examples/next-openai` or the [runtime\n * docs](https://docs.copilotkit.ai/getting-started/quickstart-runtime).\n * </Note>\n * \n * <RequestExample>\n * ```jsx CopilotKit Example\n * import { CopilotKit } from \"@copilotkit/react-core\";\n * \n * <CopilotKit \n * runtimeUrl=\"https://your.copilotkit.api\">\n * <YourApp/>\n * </CopilotKit>\n * ```\n * </RequestExample>\n * \n * ## Example usage\n * \n * ```jsx\n * <CopilotKit publicApiKey=\"the api key or self host (see below)\">\n * <App />\n * </CopilotKit>\n```\n */\nimport { Ref, useCallback, useRef, useState } from \"react\";\nimport {\n CopilotContext,\n CopilotApiConfig,\n InChatRenderFunction,\n} from \"../../context/copilot-context\";\nimport useTree from \"../../hooks/use-tree\";\nimport { CopilotChatSuggestionConfiguration, DocumentPointer } from \"../../types\";\n\nimport {\n COPILOT_CLOUD_CHAT_URL,\n CopilotCloudConfig,\n FunctionCallHandler,\n Message,\n actionToChatCompletionFunction,\n} from \"@copilotkit/shared\";\n\nimport { FrontendAction } from \"../../types/frontend-action\";\nimport useFlatCategoryStore from \"../../hooks/use-flat-category-store\";\nimport { CopilotKitProps } from \"./copilotkit-props\";\nimport { ToolDefinition } from \"@copilotkit/shared\";\n\nexport function CopilotKit({ children, ...props }: CopilotKitProps) {\n // Compute all the functions and properties that we need to pass\n // to the CopilotContext.\n\n if (!props.runtimeUrl && !props.url && !props.publicApiKey) {\n throw new Error(\"Please provide either a url or a publicApiKey to the CopilotKit component.\");\n }\n\n const chatApiEndpoint = props.runtimeUrl || props.url || COPILOT_CLOUD_CHAT_URL;\n\n const [entryPoints, setEntryPoints] = useState<Record<string, FrontendAction<any>>>({});\n const chatComponentsCache = useRef<Record<string, InChatRenderFunction | string>>({});\n const { addElement, removeElement, printTree } = useTree();\n const [messages, setMessages] = useState<Message[]>([]);\n\n const {\n addElement: addDocument,\n removeElement: removeDocument,\n allElements: allDocuments,\n } = useFlatCategoryStore<DocumentPointer>();\n\n const setEntryPoint = useCallback((id: string, entryPoint: FrontendAction<any>) => {\n setEntryPoints((prevPoints) => {\n return {\n ...prevPoints,\n [id]: entryPoint,\n };\n });\n }, []);\n\n const removeEntryPoint = useCallback((id: string) => {\n setEntryPoints((prevPoints) => {\n const newPoints = { ...prevPoints };\n delete newPoints[id];\n return newPoints;\n });\n }, []);\n\n const getContextString = useCallback(\n (documents: DocumentPointer[], categories: string[]) => {\n const documentsString = documents\n .map((document) => {\n return `${document.name} (${document.sourceApplication}):\\n${document.getContents()}`;\n })\n .join(\"\\n\\n\");\n\n const nonDocumentStrings = printTree(categories);\n\n return `${documentsString}\\n\\n${nonDocumentStrings}`;\n },\n [printTree],\n );\n\n const addContext = useCallback(\n (\n context: string,\n parentId?: string,\n categories: string[] = defaultCopilotContextCategories,\n ) => {\n return addElement(context, categories, parentId);\n },\n [addElement],\n );\n\n const removeContext = useCallback(\n (id: string) => {\n removeElement(id);\n },\n [removeElement],\n );\n\n const getChatCompletionFunctionDescriptions = useCallback(\n (customEntryPoints?: Record<string, FrontendAction<any>>) => {\n return entryPointsToChatCompletionFunctions(Object.values(customEntryPoints || entryPoints));\n },\n [entryPoints],\n );\n\n const getFunctionCallHandler = useCallback(\n (customEntryPoints?: Record<string, FrontendAction<any>>) => {\n return entryPointsToFunctionCallHandler(Object.values(customEntryPoints || entryPoints));\n },\n [entryPoints],\n );\n\n const getDocumentsContext = useCallback(\n (categories: string[]) => {\n return allDocuments(categories);\n },\n [allDocuments],\n );\n\n const addDocumentContext = useCallback(\n (documentPointer: DocumentPointer, categories: string[] = defaultCopilotContextCategories) => {\n return addDocument(documentPointer, categories);\n },\n [addDocument],\n );\n\n const removeDocumentContext = useCallback(\n (documentId: string) => {\n removeDocument(documentId);\n },\n [removeDocument],\n );\n\n if (!props.publicApiKey) {\n if (props.cloudRestrictToTopic) {\n throw new Error(\n \"To use the cloudRestrictToTopic feature, please sign up at https://copilotkit.ai and provide a publicApiKey.\",\n );\n }\n }\n\n let cloud: CopilotCloudConfig | undefined = undefined;\n if (props.publicApiKey) {\n cloud = {\n guardrails: {\n input: {\n restrictToTopic: {\n enabled: props.cloudRestrictToTopic ? true : false,\n validTopics: props.cloudRestrictToTopic?.validTopics || [],\n invalidTopics: props.cloudRestrictToTopic?.invalidTopics || [],\n },\n },\n },\n };\n }\n\n // get the appropriate CopilotApiConfig from the props\n const copilotApiConfig: CopilotApiConfig = {\n publicApiKey: props.publicApiKey,\n ...(cloud ? { cloud } : {}),\n chatApiEndpoint: chatApiEndpoint,\n chatApiEndpointV2: `${props.url}/v2`,\n headers: props.headers || {},\n body: {\n ...props.body,\n ...props.backendOnlyProps,\n },\n transcribeAudioUrl: props.transcribeAudioUrl,\n textToSpeechUrl: props.textToSpeechUrl,\n };\n\n const [chatSuggestionConfiguration, setChatSuggestionConfiguration] = useState<{\n [key: string]: CopilotChatSuggestionConfiguration;\n }>({});\n\n const addChatSuggestionConfiguration = (\n id: string,\n suggestion: CopilotChatSuggestionConfiguration,\n ) => {\n setChatSuggestionConfiguration((prev) => ({ ...prev, [id]: suggestion }));\n };\n\n const removeChatSuggestionConfiguration = (id: string) => {\n setChatSuggestionConfiguration((prev) => {\n const { [id]: _, ...rest } = prev;\n return rest;\n });\n };\n\n return (\n <CopilotContext.Provider\n value={{\n entryPoints,\n chatComponentsCache,\n getChatCompletionFunctionDescriptions,\n getFunctionCallHandler,\n setEntryPoint,\n removeEntryPoint,\n getContextString,\n addContext,\n removeContext,\n getDocumentsContext,\n addDocumentContext,\n removeDocumentContext,\n copilotApiConfig: copilotApiConfig,\n messages,\n setMessages,\n chatSuggestionConfiguration,\n addChatSuggestionConfiguration,\n removeChatSuggestionConfiguration,\n }}\n >\n {children}\n </CopilotContext.Provider>\n );\n}\n\nexport const defaultCopilotContextCategories = [\"global\"];\n\nfunction entryPointsToChatCompletionFunctions(actions: FrontendAction<any>[]): ToolDefinition[] {\n return actions.map(actionToChatCompletionFunction);\n}\n\nfunction entryPointsToFunctionCallHandler(actions: FrontendAction<any>[]): FunctionCallHandler {\n return async (chatMessages, functionCall) => {\n let actionsByFunctionName: Record<string, FrontendAction<any>> = {};\n for (let action of actions) {\n actionsByFunctionName[action.name] = action;\n }\n\n const action = actionsByFunctionName[functionCall.name || \"\"];\n if (action) {\n let functionCallArguments: Record<string, any>[] = [];\n if (functionCall.arguments) {\n functionCallArguments = JSON.parse(functionCall.arguments);\n }\n return await action.handler(functionCallArguments);\n }\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAoCA,SAAc,aAAa,QAAQ,gBAAgB;AASnD;AAAA,EACE;AAAA,EAIA;AAAA,OACK;AA0KH;AAnKG,SAAS,WAAW,IAAyC;AAAzC,eAAE,WA1D7B,IA0D2B,IAAe,kBAAf,IAAe,CAAb;AA1D7B,MAAAA,KAAAC;AA8DE,MAAI,CAAC,MAAM,cAAc,CAAC,MAAM,OAAO,CAAC,MAAM,cAAc;AAC1D,UAAM,IAAI,MAAM,4EAA4E;AAAA,EAC9F;AAEA,QAAM,kBAAkB,MAAM,cAAc,MAAM,OAAO;AAEzD,QAAM,CAAC,aAAa,cAAc,IAAI,SAA8C,CAAC,CAAC;AACtF,QAAM,sBAAsB,OAAsD,CAAC,CAAC;AACpF,QAAM,EAAE,YAAY,eAAe,UAAU,IAAI,iBAAQ;AACzD,QAAM,CAAC,UAAU,WAAW,IAAI,SAAoB,CAAC,CAAC;AAEtD,QAAM;AAAA,IACJ,YAAY;AAAA,IACZ,eAAe;AAAA,IACf,aAAa;AAAA,EACf,IAAI,gCAAsC;AAE1C,QAAM,gBAAgB,YAAY,CAAC,IAAY,eAAoC;AACjF,mBAAe,CAAC,eAAe;AAC7B,aAAO,iCACF,aADE;AAAA,QAEL,CAAC,EAAE,GAAG;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmB,YAAY,CAAC,OAAe;AACnD,mBAAe,CAAC,eAAe;AAC7B,YAAM,YAAY,mBAAK;AACvB,aAAO,UAAU,EAAE;AACnB,aAAO;AAAA,IACT,CAAC;AAAA,EACH,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmB;AAAA,IACvB,CAAC,WAA8B,eAAyB;AACtD,YAAM,kBAAkB,UACrB,IAAI,CAAC,aAAa;AACjB,eAAO,GAAG,SAAS,SAAS,SAAS;AAAA,EAAwB,SAAS,YAAY;AAAA,MACpF,CAAC,EACA,KAAK,MAAM;AAEd,YAAM,qBAAqB,UAAU,UAAU;AAE/C,aAAO,GAAG;AAAA;AAAA,EAAsB;AAAA,IAClC;AAAA,IACA,CAAC,SAAS;AAAA,EACZ;AAEA,QAAM,aAAa;AAAA,IACjB,CACE,SACA,UACA,aAAuB,oCACpB;AACH,aAAO,WAAW,SAAS,YAAY,QAAQ;AAAA,IACjD;AAAA,IACA,CAAC,UAAU;AAAA,EACb;AAEA,QAAM,gBAAgB;AAAA,IACpB,CAAC,OAAe;AACd,oBAAc,EAAE;AAAA,IAClB;AAAA,IACA,CAAC,aAAa;AAAA,EAChB;AAEA,QAAM,wCAAwC;AAAA,IAC5C,CAAC,sBAA4D;AAC3D,aAAO,qCAAqC,OAAO,OAAO,qBAAqB,WAAW,CAAC;AAAA,IAC7F;AAAA,IACA,CAAC,WAAW;AAAA,EACd;AAEA,QAAM,yBAAyB;AAAA,IAC7B,CAAC,sBAA4D;AAC3D,aAAO,iCAAiC,OAAO,OAAO,qBAAqB,WAAW,CAAC;AAAA,IACzF;AAAA,IACA,CAAC,WAAW;AAAA,EACd;AAEA,QAAM,sBAAsB;AAAA,IAC1B,CAAC,eAAyB;AACxB,aAAO,aAAa,UAAU;AAAA,IAChC;AAAA,IACA,CAAC,YAAY;AAAA,EACf;AAEA,QAAM,qBAAqB;AAAA,IACzB,CAAC,iBAAkC,aAAuB,oCAAoC;AAC5F,aAAO,YAAY,iBAAiB,UAAU;AAAA,IAChD;AAAA,IACA,CAAC,WAAW;AAAA,EACd;AAEA,QAAM,wBAAwB;AAAA,IAC5B,CAAC,eAAuB;AACtB,qBAAe,UAAU;AAAA,IAC3B;AAAA,IACA,CAAC,cAAc;AAAA,EACjB;AAEA,MAAI,CAAC,MAAM,cAAc;AACvB,QAAI,MAAM,sBAAsB;AAC9B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,QAAwC;AAC5C,MAAI,MAAM,cAAc;AACtB,YAAQ;AAAA,MACN,YAAY;AAAA,QACV,OAAO;AAAA,UACL,iBAAiB;AAAA,YACf,SAAS,MAAM,uBAAuB,OAAO;AAAA,YAC7C,eAAaD,MAAA,MAAM,yBAAN,gBAAAA,IAA4B,gBAAe,CAAC;AAAA,YACzD,iBAAeC,MAAA,MAAM,yBAAN,gBAAAA,IAA4B,kBAAiB,CAAC;AAAA,UAC/D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAGA,QAAM,mBAAqC;AAAA,IACzC,cAAc,MAAM;AAAA,KAChB,QAAQ,EAAE,MAAM,IAAI,CAAC,IAFgB;AAAA,IAGzC;AAAA,IACA,mBAAmB,GAAG,MAAM;AAAA,IAC5B,SAAS,MAAM,WAAW,CAAC;AAAA,IAC3B,MAAM,kCACD,MAAM,OACN,MAAM;AAAA,IAEX,oBAAoB,MAAM;AAAA,IAC1B,iBAAiB,MAAM;AAAA,EACzB;AAEA,QAAM,CAAC,6BAA6B,8BAA8B,IAAI,SAEnE,CAAC,CAAC;AAEL,QAAM,iCAAiC,CACrC,IACA,eACG;AACH,mCAA+B,CAAC,SAAU,iCAAK,OAAL,EAAW,CAAC,EAAE,GAAG,WAAW,EAAE;AAAA,EAC1E;AAEA,QAAM,oCAAoC,CAAC,OAAe;AACxD,mCAA+B,CAAC,SAAS;AACvC,YAA6BD,MAAA,MAApB,EAvNf,CAuNe,KAAK,EAvNpB,IAuNmCA,KAAT,iBAASA,KAAT,CAAX;AACT,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAEA,SACE;AAAA,IAAC,eAAe;AAAA,IAAf;AAAA,MACC,OAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MAEC;AAAA;AAAA,EACH;AAEJ;AAEO,IAAM,kCAAkC,CAAC,QAAQ;AAExD,SAAS,qCAAqC,SAAkD;AAC9F,SAAO,QAAQ,IAAI,8BAA8B;AACnD;AAEA,SAAS,iCAAiC,SAAqD;AAC7F,SAAO,CAAO,cAAc,iBAAiB;AAC3C,QAAI,wBAA6D,CAAC;AAClE,aAASE,WAAU,SAAS;AAC1B,4BAAsBA,QAAO,IAAI,IAAIA;AAAA,IACvC;AAEA,UAAM,SAAS,sBAAsB,aAAa,QAAQ,EAAE;AAC5D,QAAI,QAAQ;AACV,UAAI,wBAA+C,CAAC;AACpD,UAAI,aAAa,WAAW;AAC1B,gCAAwB,KAAK,MAAM,aAAa,SAAS;AAAA,MAC3D;AACA,aAAO,MAAM,OAAO,QAAQ,qBAAqB;AAAA,IACnD;AAAA,EACF;AACF;","names":["_a","_b","action"]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/hooks/use-copilot-chat.ts"],"sourcesContent":["import { useMemo, useContext } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport { Message, ToolDefinition } from \"@copilotkit/shared\";\nimport { SystemMessageFunction } from \"../types\";\nimport { UseChatOptions, useChat } from \"./use-chat\";\nimport { defaultCopilotContextCategories } from \"../components\";\n\nexport interface UseCopilotChatOptions extends UseChatOptions {\n makeSystemMessage?: SystemMessageFunction;\n additionalInstructions?: string;\n}\n\nexport interface UseCopilotChatReturn {\n visibleMessages: Message[];\n append: (message: Message) => Promise<void>;\n reload: () => Promise<void>;\n stop: () => void;\n isLoading: boolean;\n input: string;\n setInput: React.Dispatch<React.SetStateAction<string>>;\n}\n\nexport function useCopilotChat({\n makeSystemMessage,\n additionalInstructions,\n ...options\n}: UseCopilotChatOptions): UseCopilotChatReturn {\n const {\n getContextString,\n getChatCompletionFunctionDescriptions,\n getFunctionCallHandler,\n copilotApiConfig,\n messages,\n setMessages,\n } = useContext(CopilotContext);\n\n const systemMessage: Message = useMemo(() => {\n const systemMessageMaker = makeSystemMessage || defaultSystemMessage;\n const contextString = getContextString([], defaultCopilotContextCategories); // TODO: make the context categories configurable\n\n return {\n id: \"system\",\n content: systemMessageMaker(contextString, additionalInstructions),\n role: \"system\",\n };\n }, [getContextString, makeSystemMessage, additionalInstructions]);\n\n const functionDescriptions: ToolDefinition[] = useMemo(() => {\n return getChatCompletionFunctionDescriptions();\n }, [getChatCompletionFunctionDescriptions]);\n\n const { append, reload, stop, isLoading, input, setInput } = useChat({\n ...options,\n copilotConfig: copilotApiConfig,\n id: options.id,\n initialMessages: [systemMessage].concat(options.initialMessages || []),\n tools: functionDescriptions,\n onFunctionCall: getFunctionCallHandler(),\n headers: { ...options.headers },\n body: {\n ...options.body,\n },\n messages,\n setMessages,\n });\n\n const visibleMessages = messages.filter(\n (message) =>\n message.role === \"user\" || message.role === \"assistant\" || message.role === \"function\",\n );\n\n return {\n visibleMessages,\n append,\n reload,\n stop,\n isLoading,\n input,\n setInput,\n };\n}\n\nexport function defaultSystemMessage(\n contextString: string,\n additionalInstructions?: string,\n): string {\n return (\n `\nPlease act as an efficient, competent, conscientious, and industrious professional assistant.\n\nHelp the user achieve their goals, and you do so in a way that is as efficient as possible, without unnecessary fluff, but also without sacrificing professionalism.\nAlways be polite and respectful, and prefer brevity over verbosity.\n\nThe user has provided you with the following context:\n\\`\\`\\`\n${contextString}\n\\`\\`\\`\n\nThey have also provided you with functions you can call to initiate actions on their behalf, or functions you can call to receive more information.\n\nPlease assist them as best you can.\n\nYou can ask them for clarifying questions if needed, but don't be annoying about it. If you can reasonably 'fill in the blanks' yourself, do so.\n\nIf you would like to call a function, call it without saying anything else.\n` + (additionalInstructions ? `\\n\\n${additionalInstructions}` : \"\")\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA,SAAS,SAAS,kBAAkB;AAsB7B,SAAS,eAAe,IAIiB;AAJjB,eAC7B;AAAA;AAAA,IACA;AAAA,EAxBF,IAsB+B,IAG1B,oBAH0B,IAG1B;AAAA,IAFH;AAAA,IACA;AAAA;AAGA,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,WAAW,cAAc;AAE7B,QAAM,gBAAyB,QAAQ,MAAM;AAC3C,UAAM,qBAAqB,qBAAqB;AAChD,UAAM,gBAAgB,iBAAiB,CAAC,GAAG,+BAA+B;AAE1E,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS,mBAAmB,eAAe,sBAAsB;AAAA,MACjE,MAAM;AAAA,IACR;AAAA,EACF,GAAG,CAAC,kBAAkB,mBAAmB,sBAAsB,CAAC;AAEhE,QAAM,uBAAyC,QAAQ,MAAM;AAC3D,WAAO,sCAAsC;AAAA,EAC/C,GAAG,CAAC,qCAAqC,CAAC;AAE1C,QAAM,EAAE,QAAQ,QAAQ,MAAM,WAAW,OAAO,SAAS,IAAI,QAAQ,iCAChE,UADgE;AAAA,IAEnE,eAAe;AAAA,IACf,IAAI,QAAQ;AAAA,IACZ,iBAAiB,CAAC,aAAa,EAAE,OAAO,QAAQ,mBAAmB,CAAC,CAAC;AAAA,IACrE,OAAO;AAAA,IACP,gBAAgB,uBAAuB;AAAA,IACvC,SAAS,mBAAK,QAAQ;AAAA,IACtB,MAAM,mBACD,QAAQ;AAAA,IAEb;AAAA,IACA;AAAA,EACF,EAAC;AAED,QAAM,kBAAkB,SAAS;AAAA,IAC/B,CAAC,YACC,QAAQ,SAAS,UAAU,QAAQ,SAAS,eAAe,QAAQ,SAAS;AAAA,EAChF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,qBACd,eACA,wBACQ;AACR,SACE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,KAUG,yBAAyB;AAAA;AAAA,EAAO,2BAA2B;AAEhE;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/context/copilot-context.tsx"],"sourcesContent":["import {\n CopilotCloudConfig,\n FunctionCallHandler,\n Message,\n ToolDefinition,\n} from \"@copilotkit/shared\";\nimport { ActionRenderProps, FrontendAction } from \"../types/frontend-action\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { DocumentPointer } from \"../types\";\nimport { CopilotChatSuggestionConfiguration } from \"../types/chat-suggestion-configuration\";\n\n/**\n * Interface for the configuration of the Copilot API.\n */\nexport interface CopilotApiConfig {\n /**\n * The public API key for Copilot Cloud.\n */\n publicApiKey?: string;\n\n /**\n * The configuration for Copilot Cloud.\n */\n cloud?: CopilotCloudConfig;\n\n /**\n * The endpoint for the chat API.\n */\n chatApiEndpoint: string;\n\n /**\n * The endpoint for the Copilot transcribe audio service.\n */\n transcribeAudioUrl?: string;\n\n /**\n * The endpoint for the Copilot text to speech service.\n */\n textToSpeechUrl?: string;\n\n /**\n * The endpoint for the chat API v2.\n */\n chatApiEndpointV2: string;\n\n /**\n * additional headers to be sent with the request\n * @default {}\n * @example\n * ```\n * {\n * 'Authorization': 'Bearer your_token_here'\n * }\n * ```\n */\n headers: Record<string, string>;\n\n /**\n * Additional body params to be sent with the request\n * @default {}\n * @example\n * ```\n * {\n * 'message': 'Hello, world!'\n * }\n * ```\n */\n body: Record<string, any>;\n\n /**\n * Backend only props that will be combined to body params to be sent with the request\n * @default {}\n * @example\n * ```\n * {\n * 'user_id': 'user_id'\n * }\n * ```\n */\n backendOnlyProps?: Record<string, any>;\n}\n\nexport type InChatRenderFunction = (props: ActionRenderProps<any>) => string | JSX.Element;\n\nexport interface CopilotContextParams {\n // function-calling\n entryPoints: Record<string, FrontendAction<any>>;\n setEntryPoint: (id: string, entryPoint: FrontendAction<any>) => void;\n removeEntryPoint: (id: string) => void;\n chatComponentsCache: React.RefObject<Record<string, InChatRenderFunction | string>>;\n getChatCompletionFunctionDescriptions: (\n customEntryPoints?: Record<string, FrontendAction<any>>,\n ) => ToolDefinition[];\n getFunctionCallHandler: (\n customEntryPoints?: Record<string, FrontendAction<any>>,\n ) => FunctionCallHandler;\n\n messages: Message[];\n setMessages: React.Dispatch<React.SetStateAction<Message[]>>;\n\n // text context\n addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;\n removeContext: (id: TreeNodeId) => void;\n getContextString: (documents: DocumentPointer[], categories: string[]) => string;\n\n // document context\n addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;\n removeDocumentContext: (documentId: string) => void;\n getDocumentsContext: (categories: string[]) => DocumentPointer[];\n\n // suggestions configuration\n chatSuggestionConfiguration: { [key: string]: CopilotChatSuggestionConfiguration };\n addChatSuggestionConfiguration: (\n id: string,\n suggestion: CopilotChatSuggestionConfiguration,\n ) => void;\n removeChatSuggestionConfiguration: (id: string) => void;\n\n // api endpoints\n copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n entryPoints: {},\n setEntryPoint: () => {},\n removeEntryPoint: () => {},\n getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n chatComponentsCache: { current: {} },\n getContextString: (documents: DocumentPointer[], categories: string[]) =>\n returnAndThrowInDebug(\"\"),\n addContext: () => \"\",\n removeContext: () => {},\n messages: [],\n setMessages: () => returnAndThrowInDebug([]),\n\n getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),\n addDocumentContext: () => returnAndThrowInDebug(\"\"),\n removeDocumentContext: () => {},\n\n copilotApiConfig: new (class implements CopilotApiConfig {\n get chatApiEndpoint(): string {\n throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n }\n get chatApiEndpointV2(): string {\n throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n }\n get headers(): Record<string, string> {\n return {};\n }\n get body(): Record<string, any> {\n return {};\n }\n })(),\n\n chatSuggestionConfiguration: {},\n addChatSuggestionConfiguration: () => {},\n removeChatSuggestionConfiguration: () => {},\n};\n\nexport const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nexport function useCopilotContext(): CopilotContextParams {\n return React.useContext(CopilotContext);\n}\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n return value;\n}\n"],"mappings":";;;;;AAOA,OAAO,WAAW;AAoHlB,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAClE,qBAAqB,EAAE,SAAS,CAAC,EAAE;AAAA,EACnC,kBAAkB,CAAC,WAA8B,eAC/C,sBAAsB,EAAE;AAAA,EAC1B,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,CAAC;AAAA,EACX,aAAa,MAAM,sBAAsB,CAAC,CAAC;AAAA,EAE3C,qBAAqB,CAAC,eAAyB,sBAAsB,CAAC,CAAC;AAAA,EACvE,oBAAoB,MAAM,sBAAsB,EAAE;AAAA,EAClD,uBAAuB,MAAM;AAAA,EAAC;AAAA,EAE9B,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,oBAA4B;AAC9B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,UAAkC;AACpC,aAAO,CAAC;AAAA,IACV;AAAA,IACA,IAAI,OAA4B;AAC9B,aAAO,CAAC;AAAA,IACV;AAAA,EACF,EAAG;AAAA,EAEH,6BAA6B,CAAC;AAAA,EAC9B,gCAAgC,MAAM;AAAA,EAAC;AAAA,EACvC,mCAAmC,MAAM;AAAA,EAAC;AAC5C;AAEO,IAAM,iBAAiB,MAAM,cAAoC,mBAAmB;AAEpF,SAAS,oBAA0C;AACxD,SAAO,MAAM,WAAW,cAAc;AACxC;AAEA,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI,MAAM,uEAAuE;AACvF,SAAO;AACT;","names":[]}