API 目录

PDF 支持

POST
/v1/messages

PDF 支持

Vortap 支持在消息请求中提交 PDF 文档,并让模型基于文档内容进行理解、摘要、问答或信息抽取。

接口地址

POST https://www.vortapapi.com/v1/messages

接口说明

向模型发送包含文本、PDF 等内容的消息后,Vortap 会返回模型生成的回复结果。该接口可用于让模型读取 PDF 文件内容,并结合用户问题生成回答。

请求头

名称必填说明
Content-Type请求体类型,通常为 application/json
Accept期望的响应类型,通常为 application/json
AuthorizationAPI Key 鉴权信息,格式通常为 Bearer sk-***

请求示例

curl https://www.vortapapi.com/v1/messages \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer sk-***" \
  -d '{
    "model": "your-model-name",
    "messages": [
      {
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": "请总结这份 PDF 的主要内容。"
          },
          {
            "type": "file",
            "file": {
              "filename": "document.pdf",
              "file_data": "base64-encoded-pdf-data"
            }
          }
        ]
      }
    ]
  }'

响应示例

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

字段说明

字段说明
id本次生成结果的唯一标识
object返回对象类型
created响应创建时间,Unix 时间戳
choices模型生成的候选回复列表
choices[].index当前候选回复的序号
choices[].message.role消息角色,通常为 assistant
choices[].message.content模型生成的文本内容
choices[].finish_reason生成结束原因,例如 stop
usage.prompt_tokens输入内容消耗的 token 数
usage.completion_tokens输出内容消耗的 token 数
usage.total_tokens本次请求总 token 数