Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified examples/server/public/index.html.gz
Binary file not shown.
25 changes: 25 additions & 0 deletions examples/server/webui/src/components/ChatMessage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,31 @@ export default function ChatMessage({
</div>
</details>
)}

{msg.extra && msg.extra.length > 0 && (
<details
className={classNames({
'collapse collapse-arrow mb-4 bg-base-200': true,
'bg-opacity-10': msg.role !== 'assistant',
})}
>
<summary className="collapse-title">
Extra content
</summary>
<div className="collapse-content">
{msg.extra.map(
(extra) =>
extra.type === 'textFile' ? (
<div key={extra.name}>
<b>{extra.name}</b>
<pre>{extra.content}</pre>
</div>
) : null // TODO: support other extra types
)}
</div>
</details>
)}

<MarkdownDisplay
content={content}
isGenerating={isPending}
Expand Down
26 changes: 24 additions & 2 deletions examples/server/webui/src/components/ChatScreen.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { useEffect, useMemo, useState } from 'react';
import { useEffect, useMemo, useRef, useState } from 'react';
import { CallbackGeneratedChunk, useAppContext } from '../utils/app.context';
import ChatMessage from './ChatMessage';
import { CanvasType, Message, PendingMessage } from '../utils/types';
import { classNames, throttle } from '../utils/misc';
import CanvasPyInterpreter from './CanvasPyInterpreter';
import StorageUtils from '../utils/storage';
import { useVSCodeContext } from '../utils/llama-vscode';

/**
* A message display is a message node with additional information for rendering.
Expand Down Expand Up @@ -81,6 +82,14 @@ export default function ChatScreen() {
replaceMessageAndGenerate,
} = useAppContext();
const [inputMsg, setInputMsg] = useState('');
const inputRef = useRef<HTMLTextAreaElement>(null);

const { extraContext, clearExtraContext } = useVSCodeContext(
inputRef,
setInputMsg
);
// TODO: improve this when we have "upload file" feature
const currExtra: Message['extra'] = extraContext ? [extraContext] : undefined;

// keep track of leaf node for rendering
const [currNodeId, setCurrNodeId] = useState<number>(-1);
Expand Down Expand Up @@ -115,10 +124,20 @@ export default function ChatScreen() {
setCurrNodeId(-1);
// get the last message node
const lastMsgNodeId = messages.at(-1)?.msg.id ?? null;
if (!(await sendMessage(currConvId, lastMsgNodeId, inputMsg, onChunk))) {
if (
!(await sendMessage(
currConvId,
lastMsgNodeId,
inputMsg,
currExtra,
onChunk
))
) {
// restore the input message if failed
setInputMsg(lastInpMsg);
}
// OK
clearExtraContext();
};

const handleEditMessage = async (msg: Message, content: string) => {
Expand All @@ -129,6 +148,7 @@ export default function ChatScreen() {
viewingChat.conv.id,
msg.parent,
content,
msg.extra,
onChunk
);
setCurrNodeId(-1);
Expand All @@ -143,6 +163,7 @@ export default function ChatScreen() {
viewingChat.conv.id,
msg.parent,
null,
msg.extra,
onChunk
);
setCurrNodeId(-1);
Expand Down Expand Up @@ -203,6 +224,7 @@ export default function ChatScreen() {
<textarea
className="textarea textarea-bordered w-full"
placeholder="Type a message (Shift+Enter to add a new line)"
ref={inputRef}
value={inputMsg}
onChange={(e) => setInputMsg(e.target.value)}
onKeyDown={(e) => {
Expand Down
6 changes: 6 additions & 0 deletions examples/server/webui/src/utils/app.context.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ interface AppContextValue {
convId: string | null,
leafNodeId: Message['id'] | null,
content: string,
extra: Message['extra'],
onChunk: CallbackGeneratedChunk
) => Promise<boolean>;
stopGenerating: (convId: string) => void;
replaceMessageAndGenerate: (
convId: string,
parentNodeId: Message['id'], // the parent node of the message to be replaced
content: string | null,
extra: Message['extra'],
onChunk: CallbackGeneratedChunk
) => Promise<void>;

Expand Down Expand Up @@ -274,6 +276,7 @@ export const AppContextProvider = ({
convId: string | null,
leafNodeId: Message['id'] | null,
content: string,
extra: Message['extra'],
onChunk: CallbackGeneratedChunk
): Promise<boolean> => {
if (isGenerating(convId ?? '') || content.trim().length === 0) return false;
Expand All @@ -298,6 +301,7 @@ export const AppContextProvider = ({
convId,
role: 'user',
content,
extra,
parent: leafNodeId,
children: [],
},
Expand All @@ -324,6 +328,7 @@ export const AppContextProvider = ({
convId: string,
parentNodeId: Message['id'], // the parent node of the message to be replaced
content: string | null,
extra: Message['extra'],
onChunk: CallbackGeneratedChunk
) => {
if (isGenerating(convId)) return;
Expand All @@ -339,6 +344,7 @@ export const AppContextProvider = ({
convId,
role: 'user',
content,
extra,
parent: parentNodeId,
children: [],
},
Expand Down
62 changes: 62 additions & 0 deletions examples/server/webui/src/utils/llama-vscode.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { useEffect, useState } from 'react';
import { MessageExtraTextFile } from './types';

// Extra context when using llama.cpp WebUI from llama-vscode, inside an iframe
// Ref: https://github.com/ggml-org/llama.cpp/pull/11940

interface SetTextEvData {
text: string;
context: string;
}

/**
* To test it:
* window.postMessage({ command: 'setText', text: 'Spot the syntax error', context: 'def test()\n return 123' }, '*');
*/

export const useVSCodeContext = (
inputRef: React.RefObject<HTMLTextAreaElement>,
setInputMsg: (text: string) => void
) => {
const [extraContext, setExtraContext] = useState<MessageExtraTextFile | null>(
null
);
console.log({ extraContext });

// Accept setText message from a parent window and set inputMsg and extraContext
useEffect(() => {
const handleMessage = (event: MessageEvent) => {
if (event.data?.command === 'setText') {
const data: SetTextEvData = event.data;
setInputMsg(data?.text);
setExtraContext({
type: 'textFile',
name: '(context)', // TODO: set filename
content: data?.context ?? '(no context)',
});
inputRef.current?.focus();
}
};

window.addEventListener('message', handleMessage);
return () => window.removeEventListener('message', handleMessage);
}, []);

Check warning on line 43 in examples/server/webui/src/utils/llama-vscode.ts

View workflow job for this annotation

GitHub Actions / server (ADDRESS, RelWithDebInfo)

React Hook useEffect has missing dependencies: 'inputRef' and 'setInputMsg'. Either include them or remove the dependency array. If 'setInputMsg' changes too often, find the parent component that defines it and wrap that definition in useCallback

Check warning on line 43 in examples/server/webui/src/utils/llama-vscode.ts

View workflow job for this annotation

GitHub Actions / server (UNDEFINED, RelWithDebInfo)

React Hook useEffect has missing dependencies: 'inputRef' and 'setInputMsg'. Either include them or remove the dependency array. If 'setInputMsg' changes too often, find the parent component that defines it and wrap that definition in useCallback

Check warning on line 43 in examples/server/webui/src/utils/llama-vscode.ts

View workflow job for this annotation

GitHub Actions / server (Release)

React Hook useEffect has missing dependencies: 'inputRef' and 'setInputMsg'. Either include them or remove the dependency array. If 'setInputMsg' changes too often, find the parent component that defines it and wrap that definition in useCallback

// Add a keydown listener that sends the "escapePressed" message to the parent window
useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
if (event.key === 'Escape') {
window.parent.postMessage({ command: 'escapePressed' }, '*');
}
};

window.addEventListener('keydown', handleKeyDown);
return () => window.removeEventListener('keydown', handleKeyDown);
}, []);

return {
extraContext,
// call once the user message is sent, to clear the extra context
clearExtraContext: () => setExtraContext(null),
};
};
14 changes: 13 additions & 1 deletion examples/server/webui/src/utils/misc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,24 @@ export const copyStr = (textToCopy: string) => {

/**
* filter out redundant fields upon sending to API
* also format extra into text
*/
export function normalizeMsgsForAPI(messages: Readonly<Message[]>) {
return messages.map((msg) => {
let newContent = '';

for (const extra of msg.extra ?? []) {
if (extra.type === 'textFile') {
// TODO: allow user to customize this via Settings
newContent += `\n===\nExtra file: ${extra.name}\n${extra.content}\n\n===\n`;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The extraContext is not one file, but a combination of many:
image

"Extra file: " could confuse the model. I would suggest to remove it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 4bbd48d

}
}

newContent += msg.content;

return {
role: msg.role,
content: msg.content,
content: newContent,
};
}) as APIMessage[];
}
Expand Down
9 changes: 9 additions & 0 deletions examples/server/webui/src/utils/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,20 @@ export interface Message {
role: 'user' | 'assistant' | 'system';
content: string;
timings?: TimingReport;
extra?: MessageExtra[];
// node based system for branching
parent: Message['id'];
children: Message['id'][];
}

type MessageExtra = MessageExtraTextFile; // TODO: will add more in the future

export interface MessageExtraTextFile {
type: 'textFile';
name: string;
content: string;
}

export type APIMessage = Pick<Message, 'role' | 'content'>;

export interface Conversation {
Expand Down