AI助手的问答API,用于生成对话中的问答内容,能够根据上下文提供相关的回答。
接口说明
注意事项
-
请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。
-
调用该接口前,请确保您已通过绑定方式( CreateBinding )或者主动索引( IndexFileMeta 或者 BatchIndexFileMeta )方式将文件索引到数据集(Dataset)中。
-
返回结果仅为示例,根据工作流模板配置不同,获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问,请使用钉钉搜索钉钉群号 21714099 加入钉钉群进行反馈。
使用限制
-
历史对话长度最长限制为 100,包括用户消息和助手消息。
-
每条消息长度不超过 1000 个汉字。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
imm:ContextualAnswer |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectName |
string |
是 |
项目名称,获取方式请参见创建项目。 |
test-project |
| Messages |
array |
是 |
是 对话历史以及工具调用历史。最新的消息在最尾(index 为 n-1),最旧的消息在最头(index 为 0)。 限制必须是 user-assistant 成对的形式,条数为 2*n+1 条,并且最新的提问的长度不超过 1000 个字符长度。 历史对话长度限制在 100 以内。 |
|
| ContextualMessage |
否 |
会话消息的列表 |
||
| Files |
array |
否 |
当前问答涉及到的文件内容,推荐使用 ContextualRetrieval 接口的返回作为入参。 |
|
| ContextualFile |
否 |
问答涉及的文件列表 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
当次请求的 Request ID。 |
22F081FB-90D7-525A-BFE4-D28DC906A28F |
| Answer | Answer |
大模型回答的内容。 |
|
| Code |
string |
错误码。 |
ResourceNotFound |
| Message |
string |
错误消息 |
The specified resource project is not found. |
示例
正常返回示例
JSON格式
{
"RequestId": "22F081FB-90D7-525A-BFE4-D28DC906A28F",
"Answer": {
"Content": "你好",
"References": [
{
"ProjectName": "test-project",
"DatasetName": "test-dataset",
"ObjectId": "75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7",
"URI": "oss://test-bucket/test-object.jpg"
}
]
},
"Code": "ResourceNotFound",
"Message": "The specified resource project is not found."
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。