杭小忆系列大模型接口

hangxiaoyi.md

chat请求, messages信息兼容openai chat completions输入

• 基础使用样例

curl --location 'https://api.aiyou178.com/dispatcher/hangxiaoyi/hangxiaoyi/chat/completions' \
--header 'Authorization: YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "messages": [
        {
            "role": "user",
            "content": "ahahaha"
        }
    ],
    "model": "YOUR_MODEL_ID",
    "user": "带设备id方便以后做聊天记录",
    "session_id": "带唯一对话管理id, 如果想交由服务器管理对话历史",
    "request_id": "请求id, 方便排查, 每次请求唯一, 不能重复",
    "lng": 120.001,
    "lat": 30.22,
    "coordinate_system": "WGS84"
}'

• 图文混合输入

{
    "messages": [
        {
          "role": "user",
          "content": [
            {"type": "text", "text": "What's in this image?"},
            // 直接发链接, 需要能公开访问, 注意提前压缩不能太大
            {
                "type": "image_url",
                "image_url": {
                    "url": "https://example.com/image.jpg"
                }
            },
            // 图片转base64直发, 注意提前压缩不能太大
            {
                "type": "image_url",
                "image_url": {
                    "url": "data:image/jpeg;base64,/9j/4AAQSk..."
                }
            }
          ]
        }
    ],
    "model": "YOUR_MODEL_ID",
    "user": "带设备id方便以后做聊天记录",
    "session_id": "带唯一对话管理id, 如果想交由服务器管理对话历史",
    "request_id": "请求id, 方便排查, 每次请求唯一, 不能重复",
    "lng": 120.001,
    "lat": 30.22,
    "coordinate_system": "WGS84"
}

参数说明

• model: 使用哪一个模型(包含了预设的prompt, agentic flow), 具体咨询相关售前合作
• messages:
  • 可以传入system, 会被过滤并忽略
  • 只有效支持user和assistant两种
  • 去除多余的system后, 必须包含至少一个user的信息
  • 如果启用session_id, 只会使用最后一个message, 所以启用的情况下, 可以如样例只传一个user
  • 支持图片
• user: 记录请求方的用户, 方便后续排查问题, 最长64个字符
• request_id: 记录请求方的请求id, 方便后续排查问题, 只支持英文, 数字, -, _, 最长64个字符
• session_id: 管理对话历史, 请求方使用唯一id区分, 例如uuid, 最长64个字符
• lng / lat: 带上后会启用地理能力, 回答会和地理相关, 更精准
• coordinate_system: lng/lat对应的地理格式, 默认"WGS84", 同时支持"GCJ02", "BD09", 调用方可以根据自身获取坐标配置, 不用自行转换, 减少精度损失

返回格式

采用openai兼容的/chat/completions流式返回, 可以参阅openai的文档

可用模型请求

curl --location 'https://api.aiyou178.com/dispatcher/hangxiaoyi/hangxiaoyi/models' \
--header 'Authorization: YOUR_TOKEN' \
--header 'Content-Type: application/json'

额外的提示词

假如需要加入额外的动态提示词, 可以以工具形式添加(并不是真正的工具调用, 只是作为提示词嵌入), 使用kv键值对传入, key/value均为字符串. 位置是"config"->"tools"下, 对应信息回按k: v格式拼接到提示词后面

curl --location 'https://api.aiyou178.com/dispatcher/hangxiaoyi/hangxiaoyi/chat/completions' \
--header 'Authorization: YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "messages": [
        {
            "role": "user",
            "content": "ahahaha"
        }
    ],
    "model": "ptalk-voice",
    "user": "带设备id方便以后做聊天记录",
    "session_id": "带唯一对话管理id, 如果想交由服务器管理对话历史",
    "request_id": "请求id, 方便排查",
    "lng": 120.001,
    "lat": 30.22,
    "config": {
        "tools": {
            "speaker": "Alan",
            "actions": "['action1', 'action2']"
        }
    }
}'

支付宝百宝箱流式调用兼容

如果想将配置好的模型用于支付宝百宝箱(企业版, 社区版没测试, 理论可用), 将/chat/completions替换为/tbox

• https://api.aiyou178.com/dispatcher/hangxiaoyi/hangxiaoyi/tbox