FAQ¶

如何使用聊天 API 中上传文档¶

请注意：当前只有 Claude 3 支持文档上传。

上传文档的 API 声明如下：

POST /v1/chat/completions
Content-Type: application/json
Authorization: Bearer br_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{
  "messages":[{
    "role":"user",
    "content":[
      {"type":"text","text":"Summary this doc"},
      {
        "type":"doc",
        "doc":{
          "name":"4147b64a76039b4b75264726ebf6143f9e132b1e",
          "format":"pdf","size":59368,
          "source":{
            "bytes":{
              "0":37,"1":80,"2":68,"3":70,"4":45,"5":49,...,"59367":70
            }
          }
        }
      }
    ]
  }],
  "stream":true,
  "model":"claude-sonnet-3",
  "temperature":0.5,
  "presence_penalty":0,
  "frequency_penalty":0,
  "top_p":1,
  "max_tokens":4000
}

需要使用 Javascript 将本地的文档转化成 bytes json 的形式。

如何配置默认模型支持？¶

您只要创建一个新的模型，名称为 default 即可。

可以画图吗？¶

可以，配置并使用 painter 或者 nova-canvas 为提供器的模型即可。

模型通配¶

现在你可以配置一个自定义模型，并且在 API 的调用中的模型名字中使用斜杠。

如下的 API 调用示例。

POST  {{hostLcoal}}/chat/completions
Authorization: Bearer {{key}}
Content-Type: application/json

{
    "model":"bedrock/us.amazon.nova-micro-v1:0",
    "messages": [
        {
            "role": "user",
            "content": "来一个只有程序员能听懂的笑话"
        }
    ],
    "max_tokens": 5120,
    "stream": true
}

要使用上述方法，你必须：

需要你在后台定一个 model name 为 bedrock 的自定义模型。
斜杠后面的模型名字可以自定义，必须与原厂商的模型名字一致。
Provider 会首选考虑斜杠后面的模型名字，然后考虑后台配置中的模型名字，最后会考虑原样传输。

当前有支持这个用法的 Provider 有：bedrock_converse, openai_compatiable