get_openai_messages

torchtune.data.get_openai_messages(sample: Mapping[str, Any], train_on_input: bool = False) → List[Message]

警告

此类已弃用，将在将来的版本中删除。请改用 OpenAIToMessages。以下是等效项

# Deprecated
transformed_sample = get_openai_messages(sample, train_on_input=True)

# New
transformed_sample = OpenAIToMessages(train_on_input=True)(sample)

将符合 OpenAI API json 结构的聊天示例转换为 torchtune 的 Message 结构。

OpenAI API 标准聊天格式 遵循

{
    # key could be "messages" OR "conversations"
    "messages": [
        {
            "role": <system|user|assistant>,
            "content": <message>,
        },
        ...
    ]
}

Message 遵循

[
    {
        "role": <system|user|assistant>,
        "content": <message>,
    },
    ...
]

参数：

• sample (Mapping[str, Any]) – 具有“conversations”字段指向字典消息列表的单个数据样本。

• train_on_input (bool) – 提示是否应保持未掩码。默认值：False

引发：

ValueError – 如果样本不包含“messages”或“conversations”键。

返回：

具有“role”和“content”字段的消息列表。

返回类型：

List[Message]