Chat - DAS Agent 交互接口

更新时间:
复制为 MD 格式

DAS大模型能力异步逻辑接口

接口说明

前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 仅开通了 DAS 企业版的数据库实例支持创建离线任务。DAS 企业版各个版本支持的数据库和地域请参见 DAS 产品系列及支持的功能

更多使用 Chat 接口与 DAS Agent 进行交互的方法和示例,请参考 DAS Agent 交互最佳实践(集成 Chat API)

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:Chat

get

*全部资源

*

请求语法

POST /chat HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Message

string

消息

{"id":"68fe0321-37fe-4c75-a118-b61b33156f6a","role":"user","content":[{"type":"text","text":"hello"}]}

SessionId

string

可选,会话 ID,格式为 UUID 字符串。如未指定默认创建新的会话。上下文对话需保持同一个会话 ID。

123e4567-e89b-12d3-a456-xxxxxxxxxxxx

AgentId

string

可选,用于服务的 Agent ID。可指定为开启 DAS Agent 后生成的 Agent 或主动创建的 Agent。如未指定则使用默认 Agent 进行服务。

ag-472T0DxtmjIxxxxx

Summary

string

是否输出摘要信息

false

返回参数

名称

类型

描述

示例值

object

Schema of Response

Type

string

事件类型

TEXT_MESSAGE_CONTENT

MessageId

string

消息 ID

61820b594664275c4429****

Role

string

对话角色 ID

assistant

Delta

string

是否增量内容

hello

ActivityType

string

心跳

waiting_for_agent_thinking

ToolCallId

string

工具调用 ID

call_edf9cdb69e0e4c9796a6a5a6

ToolCallName

string

工具名称

das_api

Content

string

回答内容

I see you have several PolarDB instances, and I will query them for you shortly

ParentMessageId

string

父消息 ID

76bee207-31ee-4707-8851-6b9d4da033aa

ThreadId

string

线程 ID

8e481be1-21d5-4a92-a2fb-fb54be0ab4f6

StepName

string

执行步骤名称

sub_agent_performance_diagnose_mysql

RunId

string

运行 ID

ed7cb7b1-ddc8-45d7-9ff3-b315726cb5f7

TaskTrackerId

string

回调工具类

das_api

Name

string

扩展 Key

summary

Value

any

扩展 Value

{"CharCount":393,"End":1777428785996,"RequestId":"BE59AED5-D831-5811-BBAD-590B917B2089","SessionId":"123e4567-e89b-12d3-a456-xxxxxxxxxxxx","Start":1777428707927}

示例

正常返回示例

JSON格式

{
  "Type": "TEXT_MESSAGE_CONTENT",
  "MessageId": "61820b594664275c4429****",
  "Role": "assistant",
  "Delta": "hello",
  "ActivityType": "waiting_for_agent_thinking",
  "ToolCallId": "call_edf9cdb69e0e4c9796a6a5a6",
  "ToolCallName": "das_api",
  "Content": "I see you have several PolarDB instances, and I will query them for you shortly",
  "ParentMessageId": "76bee207-31ee-4707-8851-6b9d4da033aa",
  "ThreadId": "8e481be1-21d5-4a92-a2fb-fb54be0ab4f6",
  "StepName": "sub_agent_performance_diagnose_mysql",
  "RunId": "ed7cb7b1-ddc8-45d7-9ff3-b315726cb5f7",
  "TaskTrackerId": "das_api",
  "Name": "summary",
  "Value": "{\"CharCount\":393,\"End\":1777428785996,\"RequestId\":\"BE59AED5-D831-5811-BBAD-590B917B2089\",\"SessionId\":\"123e4567-e89b-12d3-a456-xxxxxxxxxxxx\",\"Start\":1777428707927}"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
500 Timeout The request processing has failed due to timeout. 由于超时请求处理失败。
403 NoPermission You are not authorized to do this action. 没有权限执行该操作
404 InstanceNotFound Requested instance not found. 对应实例id无法找到

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情