# 中断当前对话 - InvokeChatInterrupt #### 功能介绍 该接口用于中断指定会话正在进行的流式请求。 **适用场景：** 用户主动停止正在执行的 Agent 任务。 **接口约束：** 仅对正在进行的流式请求有效。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI POST /runtimes/{runtime_name}/invocations/v1/chat/interrupt 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | runtime_name | 是 | String | **参数解释**： Managed Agent对应的运行时名称。格式为managed-{Agent名称} Agent名称获取方式： 1. 进入AgentArts平台，在左侧导航栏选择"Managed Agents"。 2. 在智能体列表中"智能体名称/ID"处获取智能体名称。 **约束限制**: 不涉及。 **取值范围**： 以小写字母开头，以小写字母或数字结尾，可以包含小写字母、数字和中划线，长度为2-48个字符。 **默认取值**: 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Hw-Agentarts-Session-Id | 是 | String | **参数解释**： 会话ID，每个会话的唯一标识符。用户可将会话ID设置为任意符合下述字符集要求的字符串，例如"123e4567e89b12d3a456426614174000"，无需在其他地方获取。 **约束限制**: 不涉及。 **取值范围**： 由英文字母，数字，"-"，"_"组成，不超过64个字符。 **默认取值**: 不涉及。 | | X-Hw-Agentgateway-User-Id | 否 | String | **参数解释**： 本次智能体运行时调用对应的用户唯一ID，用于标识此次调用的用户身份，用户可自行设置用户ID，需符合取值范围的字符要求，例如"123e4567e89b12d3a456426614174000"，无需在其他地方获取。 **约束限制**: 不涉及。 **取值范围**： 由英文字母，数字，"-"，"_"组成，不超过128个字符。 **默认取值**: 不涉及。 | | Authorization | 是 | String | **参数解释**： 本次智能体运行时调用对应的身份认证凭据。需要根据实际的智能体运行时的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见[认证鉴权](https://support.huaweicloud.com/api-agentarts/agentarts_07_0005.html)。 **约束限制**: 不涉及。 **取值范围**： 不超过4096个字符。 **默认取值**: 不涉及。 | | X-Sdk-Content-Sha256 | 否 | String | **参数解释**： 如果智能体运行时的入站认证类型为IAM认证时，需要指定该Header头为UNSIGNED-PAYLOAD。 **约束限制**: 不涉及。 **取值范围**： UNSIGNED-PAYLOAD：表示请求体不参与签名校验，适用于IAM认证场景下跳过请求体的SHA256校验 **默认取值**: 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | intent | 否 | String | **参数解释**： 中断意图，决定如何处理当前正在执行的流式任务。 - cancel：取消当前任务，清除 Todo，原 SSE 流关闭 - supplement：取消当前任务但保留 Todo，原 SSE 流关闭 - pause：暂停 ReAct 循环，原 SSE 流保持打开 - resume：恢复被 pause 暂停的 ReAct 循环，原 SSE 流继续推送 **约束限制**： 无。 **取值范围**： - cancel - supplement - pause - resume **默认取值**： cancel。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**: 请求ID。 **取值范围**: 1 - 128个字符 | | ok | Boolean | **参数解释**： 是否成功。 - true: 中断成功 - false: 中断失败 **取值范围**： - true - false | | data | [CancelChatResponseData] object | **参数解释**： 中断结果详情。 **取值范围**： 不涉及。 | 表5CancelChatResponseData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [CancelChatResult] object | **参数解释**： 中断结果详情。 **取值范围**： 不涉及。 | 表6CancelChatResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | intent | String | **参数解释**： 中断意图，与请求中的 intent 一致（未传时为默认值 cancel）。 - cancel: 取消当前任务，清除 Todo，原 SSE 流关闭 - supplement: 取消当前任务但保留 Todo，原 SSE 流关闭 - pause: 暂停 ReAct 循环，原 SSE 流保持打开 - resume: 恢复被 pause 暂停的 ReAct 循环，原 SSE 流继续推送 **取值范围**： - cancel - supplement - pause - resume | | event_type | String | **参数解释**： 事件类型，固定为 chat.interrupt_result。 **取值范围**： - chat.interrupt_result | | success | Boolean | **参数解释**： 中断操作是否成功执行。 - true: 中断操作已成功执行 - false: 中断操作执行失败（如会话未找到、任务已结束） **取值范围**： - true - false | | message | String | **参数解释**： 中断结果描述信息。 **取值范围**： 0 - 512个字符。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释**: 异常错误码。 **取值范围**: 不涉及。 | | message | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为 1 - 512 个字符。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释**: 异常错误码。 **取值范围**: 不涉及。 | | message | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为 1 - 512 个字符。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释**: 异常错误码。 **取值范围**: 不涉及。 | | message | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为 1 - 512 个字符。 | #### 请求示例 取消Agent对话, gateway_domain为运行时的访问域名，可以在智能体运行时的运行时详情页面中获取 ``` POST https://{gateway_domain}/runtimes/{runtime_name}/invocations/v1/chat/interrupt { "intent" : "cancel" } ``` #### 响应示例 **状态码：200** ``` { "request_id" : "req-001", "ok" : true, "data" : { "result" : { "intent" : "cancel", "event_type" : "chat.interrupt_result", "success" : true, "message" : "任务已取消" } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 中断成功 | | 401 | 未授权（认证令牌缺失、无效或已过期）。 | | 404 | 运行时资源不存在。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。