通过SendChatMessage发送或取消指定会话的消息-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

向指定会话发送用户消息或取消会话。

接口说明

请求说明

agent_id 和 session_id 是必填字段。
message_type 默认为 primary，当需要追加信息或取消会话时，请设置为 additional 或 cancel。
reply_to 字段用于表示这条消息是对哪条 Agent 消息的响应，默认值为 0。
当 message_type 为 additional 时，question 字段是必须的。
quoted_message 可以用来引用用户之前的消息内容。
data_source, dms_user, db_metadata, session_config 等字段均为可选，但提供了更详细的上下文信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:SendChatMessage

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DMSUnit	string	否	您当前所在的 DMS 单元。若您选择分析数据库，该信息将用于后续通过 DMS 正确连接到您的 DMS 实例。您可前往 DMS 控制台查看您当前所在的 DMS 单元，若您是阿里云中国站用户，可以直接填入 cn-hangzhou。	cn-hangzhou
SessionId	string	否	会话 ID，必须字段。您可以通过 CreateAgentSession 获取 SessionId。	sess_***
AgentId	string	否	AgentId，必填。您可通过 CreateAgentSession 接口的返回值获取当前的 AgentID。Agent 资源存在生命周期，因此您每次请求需要填入的 AgentID 可能变化。	agent_***
Message	string	是	本次向 Agent 发送的消息内容	what can you do?
MessageType	string	否	消息类型，默认为 `[primary]`。常规情况下，和 Agent 交互，消息类型为 `[primary]` 当该消息为响应 Agent 的 Human-in-Loop 问题时，类型应当是`[additional]` 当该消息是要触发一次报告绘制时，类型应当是 `[report]` 当该消息是要取消当前会话时，类型应当是`[cancel]`。	primary
ReplyTo	string	否	重要当本消息是回复 Agent 消息（如：Agent 通过 ASK_HUMAN 进行问题澄清），则 reply_to 应当精确传入这条 Agent 消息携带的 Checkpoint 序号。若本消息无针对性的回复，如分析完成后要求 Agent 进一步深度分析，则 reply_to 可不填入或者填入"0"。该字段会影响 Agent 决策如何处理该消息，若传递错误可能导致分析效果不及预期。	0
QuotedMessage	string	否	传入当前引用内容，通常在与 Agent 交互时使用。	{"version":"v0"}
Question	string	否	当消息类型为`additional`时为必须字段，传入 Agent 通过 Human-in-Loop 向用户提问的具体问题。	请提供计算GMV的口径。
DataSource	object	否	数据源信息，可为空。此参数仅能传入一个数据源，建议更换为 DataSources 参数。	null
DataSourceType	string	否	数据源类型。可取值`[remote_data_center, database]`，分别表示本次分析是文件或者数据库。	remote_data_center
DataSourceId	string	否	已废弃，无需填入	123
Location	string	否	已废弃，无需填入	localhost
Database	string	否	已废弃，无需填入	test_db
Engine	string	否	数据库类型	mysql
Tables	array	否	需要分析的表名称的列表
	string	否	需要分析的表名	my_table
FileId	string	否	文件 ID	35****
RegionId	string	否	地域 ID。	cn-hangzhou
DbName	string	否	数据库名称。	******
DmsInstanceId	string	否	实例在 DMS 的 ID	12******
DmsDatabaseId	string	否	数据库在 DMS 的 ID	23******
SessionConfig	object	否	本次会话的特殊配置。同一个 Session 只有第一次 SendMessage 的时候带下来的配置才会生效。
Language	string	否	当前只支持中英文，默认是中文，只支持大写	ENGLISH
CustomAgentId	string	否	已废弃，以 CreateAgentSession 入参为准	null
CustomAgentStage	string	否	已废弃，以 CreateAgentSession 入参为准	null
ReportWaterMark	string	否	可填入 64 字符以内的文本，会用于在生成的 PDF 格式的报告中添加水印。	示例水印
Mode	string	否	模式： ASK_DATA 问数模式 ANALYSIS 分析模式 INSIGHT 洞察模式	ANALYSIS
SkipPlan	boolean	否	是否跳过计划确认步骤	True
SkipSqlConfirm	boolean	否	是否跳过所有 SQL 确认	False
SkipWebReportConfirm	boolean	否	是否跳过绘制网页报告确认	True
SkipAskHuman	boolean	否	是否禁止过程中用户询问	True
EnableSearch	string	否	是否开启联网搜索。	false
KbUuidList	string	否	知识库 ID 列表	dasd***cc211
McpServerIds	string	否	会话配置中的 MCP 服务器 ID	2q1tu90**********6uttu2nw
PlanMode	string	否	是否开启计划，可选[disable, enable, force]，默认值是 enable	disable
ParentSessionId	string	否	主会话 id	20qrliuoo7p2vlsfg*****
DataSources	array<object>	否	数据源信息详细，可为空
	object	否	数据源信息详细，可为空
DataSourceType	string	否	数据源类型。可取值[remote_data_center, database]，分别表示本次分析是文件或者数据库。	remote_data_center
DataSourceId	string	否	已废弃，无需填入	123
Location	string	否	已废弃，无需填入	localhost
Database	string	否	已废弃，无需填入	test_db
Engine	string	否	数据库类型	mysql
Tables	array	否	需要分析的表名称的列表
	string	否	需要分析的表名	my_table
FileId	string	否	文件 ID	f-4w*******
RegionId	string	否	地域 ID。	cn-shenzhen
DbName	string	否	数据库名称。	mydatabase
DmsInstanceId	string	否	实例在 DMS 的 ID	248*****
DmsDatabaseId	string	否	数据库在 DMS 的 ID	123****
TaskConfig	object	否	仅影响本次任务的配置项。
ReportConfig	object	否	报告规则的配置。仅当 MesageType 是 REPORT 时，会根据本次配置，执行一个报告任务。
ReportType	string	否	服务类型。可填入 TextReport 和 WebReport，表示本次任务是要生成一个文字报告或者网页报告。当前只支持 WebReport 类型。	WebReport
ReportTheme	string	否	报告主题。当前支持[default,journal,legacy,neobrutalism]	default
ReportPrompt	string	否	本次报告需要遵循的 prompt	generate a report
WorkspaceId	string	否	工作空间 ID。	c1p71ne***baexrt3o
UserOssBucket	string	否	用户 OSS 的 Bucket，若不填，分析过程将安全存储在内置存储中。	my-bucket

返回参数

名称	类型	描述	示例值
	object	Jarvis Web 应用收到请求并缓存之后，会直接响应 200。
RequestId	string	请求 ID	FE65CE1F-**---****
ErrorCode	string	错误码	Success
ErrorMessage	string	错误信息	""
Data	object	响应数据
Message	string	Message	success
SessionId	string	SessionId	6zbqbho********
AgentId	string	AgentId	3jqqdiuxun******
MessageId	string	消息 ID。	922d7fd2-77fb-4549-9091-d51da225d47f
Success	string	Success	true

示例

正常返回示例

JSON格式

{
  "RequestId": "FE65CE1F-****-****-****-******",
  "ErrorCode": "Success",
  "ErrorMessage": "\"\"",
  "Data": {
    "Message": "success",
    "SessionId": "6zbqbho********",
    "AgentId": "3jqqdiuxun******",
    "MessageId": "922d7fd2-77fb-4549-9091-d51da225d47f"
  },
  "Success": "true"
}

错误码

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

变更历史

更多信息，参考变更详情。