For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/open/business/updateModelContext.md.

updateModelContext

向 Agent 捐赠上下文。

扫码预览

扫码预览 updateModelContext

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

前置条件

  • Android:未传 taskId 时需传 entityId;两者都不传时仅可在卡片环境调用,以便客户端补充必要信息
  • iOS:未传 taskId 时需传 entityId;两者都不传时仅可在卡片环境调用,以便客户端补充必要信息

使用说明

taskId 可以为空,此时客户端会尝试使用 entityId 填充;entityId 可以为空, 此时如果处于卡片环境,客户端会尝试使用卡片的 entityId 填充。

  • 用于在任务或实体维度补充模型可理解的上下文,请在业务状态变化后按需调用,避免高频重复捐赠相同内容。

调用方式

异步 API

updateModelContext(params: UpdateModelContextParams): Promise<object>

入参

名称类型必填默认值约束说明
contentstring是--上下文内容,格式无约束,可以与 MCP 服务下发的上下文格式保持一致。
entityIdstring否--上下文所属的 entityId,业务侧管理。为空且处于卡片环境时,客户端会尝试使用卡片的 entityId 填充。
taskIdstring否--上下文所属任务 ID,业务侧定义。为空时客户端会尝试使用 entityId 填充。

调用示例

import { updateModelContext } from '@doubao-dev/framework/api';

await updateModelContext({
  taskId: 'task-id',
  entityId: 'entity-id',
  content: '用户选择了标准配送'
});

成功返回

无返回字段。

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 305,
  "errMsg": "network failure"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid当前容器类型不受支持,无法归类为页面、卡片或 Worker 来源请在支持的容器(页面、卡片或 Worker)环境中调用。
112invalid resultAndroid捐赠上下文的远端响应无法解析稍后重试;持续失败时反馈服务端响应异常。
301network request cancellediOS捐赠上下文的网络请求被取消确认应用与网络状态后重试。
302connection timed outAndroid、iOS捐赠上下文的网络连接超时检查网络连接后重试。
303no network connectionAndroid、iOS当前无可用网络连接恢复网络连接后重试。
305network failureAndroid、iOS捐赠上下文时发生其他网络错误检查网络连接,稍后重试。

通用错误码

errNoerrMsg说明平台
100unknown error未知错误Android
102internal error内部错误Android

平台差异

  • Android:网络失败细分为连接超时 302、无网络 303、其他网络错误 305;远端响应无法解析返回 112;当前容器类型不受支持返回 103;其他失败统一返回 102,未归类的远端业务错误返回 100。
  • iOS:依据网络错误细分:请求取消 301、连接超时 302、无网络 303、其他 305;不支持的调用来源仅回退处理、不作为失败。