[Rust Frontend] Accept custom chat roles for HF templates (#58311)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Bugen Zhao <i@bugenzhao.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
a5603f21ae
commit
a1b6763df6
@@ -317,6 +317,9 @@ pub(crate) fn convert_message(message: ChatMessage) -> Result<VllmChatMessage, A
|
||||
convert_content(content)?,
|
||||
convert_message_tools(tools)?,
|
||||
)),
|
||||
ChatMessage::Custom { role, content } => {
|
||||
Ok(VllmChatMessage::custom(role, convert_content(content)?))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -442,6 +445,7 @@ mod tests {
|
||||
use expect_test::expect;
|
||||
use llm_multimodal::ImageDetail;
|
||||
use serde_json::json;
|
||||
use thiserror_ext::AsReport as _;
|
||||
use validator::Validate;
|
||||
use vllm_chat::{
|
||||
AssistantContentBlock, AssistantToolCall, ChatContentPart, ChatMessage as VllmChatMessage,
|
||||
@@ -1047,6 +1051,43 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn prepare_chat_request_accepts_custom_role_messages() {
|
||||
let request: ChatCompletionRequest = serde_json::from_value(json!({
|
||||
"messages": [
|
||||
{"role": "root", "content": "Custom identity."},
|
||||
{"role": "user", "content": "hello"},
|
||||
],
|
||||
}))
|
||||
.expect("parse custom role message");
|
||||
|
||||
let prepared = prepare_chat_request(
|
||||
request,
|
||||
&served(&["Qwen/Qwen1.5-0.5B-Chat"]),
|
||||
ResolvedRequestContext::default(),
|
||||
)
|
||||
.expect("request is valid");
|
||||
|
||||
assert_eq!(
|
||||
prepared.chat_request.messages,
|
||||
vec![
|
||||
VllmChatMessage::custom("root", "Custom identity."),
|
||||
VllmChatMessage::user("hello"),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chat_http_message_keeps_standard_role_errors() {
|
||||
let error = serde_json::from_value::<ChatMessage>(json!({
|
||||
"role": "tool",
|
||||
"content": "Sunny",
|
||||
}))
|
||||
.unwrap_err();
|
||||
|
||||
expect!["missing field `tool_call_id`"].assert_eq(&error.to_report_string());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn prepare_chat_request_maps_image_url_content_parts() {
|
||||
let request = ChatCompletionRequest {
|
||||
|
||||
@@ -410,9 +410,17 @@ impl ToolReference {
|
||||
// Chat Messages
|
||||
// ============================================================================
|
||||
|
||||
/// One chat message, tagged by `role`.
|
||||
///
|
||||
/// The derived serde impls use `remote = "Self"` and cover only the standard
|
||||
/// roles; the trait impls below dispatch on the role tag and handle
|
||||
/// [`ChatMessage::Custom`] separately. A `#[serde(untagged)]` fallback variant
|
||||
/// would also accept malformed standard messages, such as a `tool` message
|
||||
/// without `tool_call_id`, and replace their field errors with serde's generic
|
||||
/// untagged-enum error.
|
||||
#[serde_with::skip_serializing_none]
|
||||
#[derive(Debug, Clone, Deserialize, Serialize)]
|
||||
#[serde(tag = "role")]
|
||||
#[serde(tag = "role", remote = "Self")]
|
||||
pub enum ChatMessage {
|
||||
#[serde(rename = "system")]
|
||||
System {
|
||||
@@ -447,6 +455,67 @@ pub enum ChatMessage {
|
||||
tools: Option<Vec<Tool>>,
|
||||
name: Option<String>,
|
||||
},
|
||||
/// Message with a role outside the OpenAI set, such as `root`. Chat
|
||||
/// templates receive the role string unchanged.
|
||||
#[serde(skip)]
|
||||
Custom {
|
||||
role: String,
|
||||
content: MessageContent,
|
||||
},
|
||||
}
|
||||
|
||||
/// Role tags of the standard [`ChatMessage`] variants.
|
||||
const STANDARD_CHAT_ROLES: &[&str] = &[
|
||||
"system",
|
||||
"user",
|
||||
"assistant",
|
||||
"tool",
|
||||
"function",
|
||||
"developer",
|
||||
];
|
||||
|
||||
/// Wire shape of [`ChatMessage::Custom`].
|
||||
#[derive(Deserialize, Serialize)]
|
||||
struct CustomChatMessage<R, C> {
|
||||
role: R,
|
||||
content: C,
|
||||
}
|
||||
|
||||
impl Serialize for ChatMessage {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: serde::Serializer,
|
||||
{
|
||||
match self {
|
||||
Self::Custom { role, content } => {
|
||||
CustomChatMessage { role, content }.serialize(serializer)
|
||||
}
|
||||
_ => Self::serialize(self, serializer),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for ChatMessage {
|
||||
/// Dispatch on the role tag: standard roles keep their derived errors,
|
||||
/// and any other string role becomes [`ChatMessage::Custom`].
|
||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||
where
|
||||
D: Deserializer<'de>,
|
||||
{
|
||||
let value = Value::deserialize(deserializer)?;
|
||||
let is_custom = value
|
||||
.get("role")
|
||||
.and_then(Value::as_str)
|
||||
.is_some_and(|role| !STANDARD_CHAT_ROLES.contains(&role));
|
||||
|
||||
if is_custom {
|
||||
let CustomChatMessage { role, content } =
|
||||
CustomChatMessage::deserialize(value).map_err(serde::de::Error::custom)?;
|
||||
Ok(Self::Custom { role, content })
|
||||
} else {
|
||||
Self::deserialize(value).map_err(serde::de::Error::custom)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
|
||||
|
||||
@@ -555,7 +555,8 @@ fn render_fake_message_content(
|
||||
ChatMessage::System { content }
|
||||
| ChatMessage::Developer { content, .. }
|
||||
| ChatMessage::User { content }
|
||||
| ChatMessage::ToolResponse { content, .. } => render_fake_content(content, placeholder),
|
||||
| ChatMessage::ToolResponse { content, .. }
|
||||
| ChatMessage::Custom { content, .. } => render_fake_content(content, placeholder),
|
||||
ChatMessage::Assistant { .. } => message.text_content(),
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user