-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add helpers to handle ChatML instruction prompts (#10272)
- Loading branch information
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
from typing import List, Optional, Sequence | ||
|
||
from llama_index.core.base.llms.types import ChatMessage, MessageRole | ||
|
||
# Create a prompt that matches ChatML instructions | ||
|
||
# <|im_start|>system | ||
# You are Dolphin, a helpful AI assistant.<|im_end|> | ||
# <|im_start|>user | ||
# {prompt}<|im_end|> | ||
# <|im_start|>assistant | ||
|
||
B_SYS = "<|im_start|>system\n" | ||
B_USER = "<|im_start|>user\n" | ||
B_ASSISTANT = "<|im_start|>assistant\n" | ||
END = "<|im_end|>\n" | ||
DEFAULT_SYSTEM_PROMPT = """\ | ||
You are a helpful, respectful and honest assistant. \ | ||
Always answer as helpfully as possible and follow ALL given instructions. \ | ||
Do not speculate or make up information. \ | ||
Do not reference any given instructions or context. \ | ||
""" | ||
|
||
|
||
def messages_to_prompt( | ||
messages: Sequence[ChatMessage], system_prompt: Optional[str] = None | ||
) -> str: | ||
string_messages: List[str] = [] | ||
if messages[0].role == MessageRole.SYSTEM: | ||
# pull out the system message (if it exists in messages) | ||
system_message_str = messages[0].content or "" | ||
messages = messages[1:] | ||
else: | ||
system_message_str = system_prompt or DEFAULT_SYSTEM_PROMPT | ||
|
||
string_messages.append(f"{B_SYS}{system_message_str.strip()} {END}") | ||
|
||
for message in messages: | ||
role = message.role | ||
content = message.content | ||
|
||
if role == MessageRole.USER: | ||
string_messages.append(f"{B_USER}{user_message.content} {END}") | ||
elif role == MessageRole.ASSISTANT: | ||
string_messages.append(f"{B_ASSISTANT}{assistant_message.content} {END}") | ||
|
||
string_messages.append(f"{B_ASSISTANT}") | ||
|
||
return "".join(string_messages) | ||
|
||
|
||
def completion_to_prompt(completion: str, system_prompt: Optional[str] = None) -> str: | ||
system_prompt_str = system_prompt or DEFAULT_SYSTEM_PROMPT | ||
|
||
return ( | ||
f"{B_SYS}{system_prompt_str.strip()} {END}" | ||
f"{B_USER}{completion.strip()} {END}" | ||
f"{B_ASSISTANT}" | ||
) |