1. 接口描述
接口请求域名: dataagent.tencentcloudapi.com 。
提供DataAgent 产品服务API
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ChatAI。 |
| Version | 是 | String | 公共参数,本接口取值:2025-05-13。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| SessionId | 否 | String | 会话ID 示例值:e5b6a2e4-3b9b-4d41-8f6a-5b6d5a8 |
| InstanceId | 否 | String | 实例ID 示例值:da-e5b6a2e4 |
| Question | 否 | String | 问题内容 示例值:hello |
| Context | 否 | String | 上下文 示例值:{"k":"v"} |
| Model | 否 | String | 模型 示例值:deepseek |
| DeepThinking | 否 | Boolean | 是否深度思考 示例值:false |
| DataSourceIds.N | 否 | Array of String | 数据源id 示例值:e5b6a2e4 |
| AgentType | 否 | String | agent类型 示例值:Analysis |
| OldRecordId | 否 | String | 需要重新生成答案的记录ID 示例值:e5b6a2e4-3b9b-4d41 |
| KnowledgeBaseIds.N | 否 | Array of String | 知识库id列表 示例值:["id1","id2"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: dataagent.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChatAI
<公共请求参数>
{
"SessionId": "403f-839b-f4fca186eb66",
"InstanceId": "dataagent-haBKQxLt",
"Question": "hello"
}
输出示例
{
"v": "c55d9637-7206-456b-8488-577e14fe3ac1"
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |