Chat with PDF 与 PDF 聊天
POST
/v1/chats/message使用源 ID 将聊天消息发送到 PDF 文件。
提出一个问题:提出后续问题:您最多可以在一个请求中包含 6 条消息。如果这些消息中的 OpenAI 令牌总数超过 2,500,则较旧的消息将被忽略,直到不再超出该限制。
参考来源
- ChatPDF 可以包含对生成响应所用的 PDF 页面的引用。为此,请在请求正文中包含
referenceSources: true
字段:
{
"referenceSources": true,
"sourceId": "src_xxxxxx",
"messages": [
{
"role": "user",
"content": "how much is the world?"
}
]
}
ChatPDF 可以包含对用于生成响应的 PDF 页面的引用。为此,请在请求正文中包含 referenceSources: true
字段:响应将包含 [P] 形式的内联引用,例如[P2]、[P234] 和附加字段参考:
{
"content": "The world is 10 dollars [P2] and can be bought at the supermarket [P5].",
"references": [
{ "pageNumber": 2 },
{ "pageNumber": 5 }
]
}
流响应
您可以选择逐字流式传输响应。为此,请在请求正文中包含 stream: true
字段:
{
"stream": true,
"sourceId": "src_xxxxxx",
"messages": [
{
"role": "user",
"content": "how much is the world?"
}
]
}
请求参数
Header 参数
x-api-key
string
必需
示例值:
sec_xxxxxx
Content-Type
string
必需
示例值:
application/json
Body 参数application/json
sourceId
string
必需
messages
array [object {2}]
必需
role
string
可选
content
string
可选
示例
{
"sourceId": "src_xxxxxx",
"messages": [
{
"role": "user",
"content": "Who wrote the consitution?"
}
]
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
content
string
必需
示例
{
"content": "The world is 10 dollars."
}
最后修改时间: 1 年前