@doubao-apps/create 0.0.25 → 0.0.26

package/dist/template-starter/.ai/reference/open-api/08-open-/344/270/232/345/212/241/350/203/275/345/212/233.md

@@ -0,0 +1,477 @@
+# Open API: Open / 业务能力
+
+开放业务能力、支付、隐私设置、上下文和外部应用打开。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
+| --- | --- | --- | --- | --- | --- |
+| [`getOrderPayment`](#getorderpayment) | `getOrderPayment(params): Promise<GetOrderPaymentResult>` | 查询订单支付结果 | `params: GetOrderPaymentParams` | `Promise<GetOrderPaymentResult>` | - |
+| [`postLoginResult`](#postloginresult) | `postLoginResult(params): Promise<object>` | 回传 MCP 授权登录凭证 | `params: PostLoginResultRequest` | `Promise<object>` | - |
+| [`getPrivacySetting`](#getprivacysetting) | `getPrivacySetting(params?): Promise<PrivacySettingResult>` | 获取隐私设置状态 | `params?` | `Promise<PrivacySettingResult>` | - |
+| [`requestOrder`](#requestorder) | `requestOrder(params): Promise<RequestOrderResult>` | 发起订单支付流程 | `params: RequestOrderParams` | `Promise<RequestOrderResult>` | - |
+| [`loginWithDoubaoWidget`](#loginwithdoubaowidget) | `loginWithDoubaoWidget(params): Promise<LoginWithWidgetResult>` | 发起豆包 Widget 登录 | `params: LoginWithWidgetRequest` | `Promise<LoginWithWidgetResult>` | - |
+| [`sendQueryMessage`](#sendquerymessage) | `sendQueryMessage(params): void` | 以用户身份发送一条消息 | `params: SendQueryMessageParams` | `void` | 返回 void，不是 Promise |
+| [`updateModelContext`](#updatemodelcontext) | `updateModelContext(params?): Promise<object>` | 向 Agent 捐赠上下文 | `params?: UpdateModelContextParams` | `Promise<object>` | - |
+| [`setAdditionalContext`](#setadditionalcontext) | `setAdditionalContext(params): Promise<object>` | 设置全局上下文供大模型理解 | `params: SetAdditionalContextParams` | `Promise<object>` | 设置全局上下文 |
+| [`dispatchActionDirective`](#dispatchactiondirective) | `dispatchActionDirective(params): Promise<object>` | 描述用户行为，约束模型行为及指定执行路径 | `params: DispatchActionDirectiveParams` | `Promise<object>` | - |
+| [`updateWidget`](#updatewidget) | `updateWidget(params): Promise<object>` | 更新指定卡片 | `params: UpdateWidgetParams` | `Promise<object>` | - |
+| [`openApp`](#openapp) | `openApp(params): Promise<OpenAppResult>` | 通过 deep link 等方式打开外部应用 | `params: OpenAppRequest` | `Promise<OpenAppResult>` | - |
+
+## API 详情
+
+<a id="getorderpayment"></a>
+### getOrderPayment()
+
+> **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+查询订单支付结果。
+
+#### Parameters
+
+• **params**: [`GetOrderPaymentParams`](#getorderpaymentparams)
+
+订单支付查询参数。
+
+#### Returns
+
+`Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+返回订单支付结果。
+
+<a id="postloginresult"></a>
+### postLoginResult()
+
+> **postLoginResult**(`params`): `Promise`\<`object`\>
+
+回传 MCP 授权登录凭证。
+
+#### Parameters
+
+• **params**: [`PostLoginResultRequest`](#postloginresultrequest)
+
+登录结果回传参数。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回回传完成的 Promise。
+
+<a id="getprivacysetting"></a>
+### getPrivacySetting()
+
+> **getPrivacySetting**(`params`?): `Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
+
+获取隐私设置状态。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
+
+返回隐私设置状态。
+
+<a id="requestorder"></a>
+### requestOrder()
+
+> **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](#requestorderresult)\>
+
+发起订单支付流程。
+
+#### Parameters
+
+• **params**: [`RequestOrderParams`](#requestorderparams)
+
+订单支付请求参数。
+
+#### Returns
+
+`Promise`\<[`RequestOrderResult`](#requestorderresult)\>
+
+返回订单支付请求结果。
+
+<a id="loginwithdoubaowidget"></a>
+### loginWithDoubaoWidget()
+
+> **loginWithDoubaoWidget**(`params`): `Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
+
+发起豆包 Widget 登录。
+
+#### Parameters
+
+• **params**: [`LoginWithWidgetRequest`](#loginwithwidgetrequest)
+
+Widget 登录参数。
+
+#### Returns
+
+`Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
+
+返回登录结果。
+
+<a id="sendquerymessage"></a>
+### sendQueryMessage()
+
+> **sendQueryMessage**(`params`): `void`
+
+以用户身份发送一条消息
+
+由于会自动获取页面上下文来确定向哪个 bot 发送消息，因此只能在卡片或页面中调用
+
+#### Parameters
+
+• **params**: [`SendQueryMessageParams`](#sendquerymessageparams)
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+await sendQueryMessage({ content: '订阅消息', type: 'text' })
+```
+
+<a id="updatemodelcontext"></a>
+### updateModelContext()
+
+> **updateModelContext**(`params`?): `Promise`\<`object`\>
+
+向 Agent 捐赠上下文
+
+#### Parameters
+
+• **params?**: [`UpdateModelContextParams`](#updatemodelcontextparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="setadditionalcontext"></a>
+### setAdditionalContext()
+
+> **setAdditionalContext**(`params`): `Promise`\<`object`\>
+
+设置全局上下文供大模型理解
+
+#### Parameters
+
+• **params**: [`SetAdditionalContextParams`](#setadditionalcontextparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+设置全局上下文。
+
+<a id="dispatchactiondirective"></a>
+### dispatchActionDirective()
+
+> **dispatchActionDirective**(`params`): `Promise`\<`object`\>
+
+描述用户行为，约束模型行为及指定执行路径
+
+#### Parameters
+
+• **params**: [`DispatchActionDirectiveParams`](#dispatchactiondirectiveparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="updatewidget"></a>
+### updateWidget()
+
+> **updateWidget**(`params`): `Promise`\<`object`\>
+
+更新指定卡片
+
+#### Parameters
+
+• **params**: [`UpdateWidgetParams`](#updatewidgetparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="openapp"></a>
+### openApp()
+
+> **openApp**(`params`): `Promise`\<[`OpenAppResult`](#openappresult)\>
+
+通过 deep link 等方式打开外部应用。
+
+#### Parameters
+
+• **params**: [`OpenAppRequest`](#openapprequest)
+
+外部应用打开参数。
+
+#### Returns
+
+`Promise`\<[`OpenAppResult`](#openappresult)\>
+
+返回外部应用打开结果。
+
+## 相关类型
+
+<a id="getorderpaymentparams"></a>
+### GetOrderPaymentParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+<a id="getorderpaymentresult"></a>
+### GetOrderPaymentResult
+
+#### Properties
+
+##### logId
+
+> **logId**: `string`
+
+##### orderId
+
+> **orderId**: `string`
+
+<a id="postloginresultrequest"></a>
+### PostLoginResultRequest
+
+#### Properties
+
+##### code?
+
+> `optional` **code**: `string`
+
+Authorization login credential, valid when login result is true
+
+##### result
+
+> **result**: `boolean`
+
+Login result, true means success, false means failure
+
+<a id="privacysettingresult"></a>
+### PrivacySettingResult
+
+#### Properties
+
+##### needAuthorization
+
+> **needAuthorization**: `boolean`
+
+Whether user authorization for privacy agreement is required
+
+<a id="requestorderparams"></a>
+### RequestOrderParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+##### dbAuthorization
+
+> **dbAuthorization**: `string`
+
+<a id="requestorderresult"></a>
+### RequestOrderResult
+
+#### Properties
+
+##### logId
+
+> **logId**: `string`
+
+##### orderId
+
+> **orderId**: `string`
+
+<a id="loginwithwidgetrequest"></a>
+### LoginWithWidgetRequest
+
+#### Properties
+
+##### loginType
+
+> **loginType**: [`LoginType`](#logintype-1)
+
+Login type identifier
+
+<a id="loginwithwidgetresult"></a>
+### LoginWithWidgetResult
+
+#### Properties
+
+##### result
+
+> **result**: `boolean`
+
+Whether the login is successful
+
+<a id="logintype-1"></a>
+<a id="logintype"></a>
+### LoginType
+
+> **LoginType**: `0` \| `1` \| `2` \| `3`
+
+Widget 登录类型。
+
+- `0`: 隐私协议登录
+- `1`: 仅登录
+- `2`: 先登录再隐私协议，两次弹窗
+- `3`: 登录和隐私协议合并，一次弹窗
+
+<a id="sendquerymessageparams"></a>
+### SendQueryMessageParams
+
+#### Properties
+
+##### content
+
+> **content**: `string`
+
+要发送的消息。根据类型不同，序列化方式可能不同
+
+##### type
+
+> **type**: `"text"`
+
+消息类型，目前仅支持 text
+
+<a id="updatemodelcontextparams"></a>
+### UpdateModelContextParams
+
+#### Properties
+
+##### content?
+
+> `optional` **content**: `string`
+
+上下文内容，格式无约束，可以与 MCP 服务下发的上下文格式保持一致
+
+##### entityId?
+
+> `optional` **entityId**: `string`
+
+上下文所属的 entityID，业务侧管理
+
+##### taskId?
+
+> `optional` **taskId**: `string`
+
+上下文所属任务 ID，业务侧定义
+
+<a id="setadditionalcontextparams"></a>
+### SetAdditionalContextParams
+
+#### Properties
+
+##### additionalContext
+
+> **additionalContext**: `string`
+
+上下文内容
+
+##### botId?
+
+> `optional` **botId**: `string`
+
+指定 bot id
+
+<a id="dispatchactiondirectiveparams"></a>
+### DispatchActionDirectiveParams
+
+#### Properties
+
+##### actionDescribe
+
+> **actionDescribe**: `string`
+
+自然语言描述，例如：用户点击支付按钮并完成话费支付
+
+##### actionType
+
+> **actionType**: [`ActionDirectiveType`](#actiondirectivetype)
+
+动作类型，参见 [ActionDirectiveType](#actiondirectivetype)
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+会话消息关联的卡片ID
+
+<a id="updatewidgetparams"></a>
+### UpdateWidgetParams
+
+#### Properties
+
+##### widgetData
+
+> **widgetData**: `string`
+
+卡片渲染的数据
+
+##### widgetId?
+
+> `optional` **widgetId**: `string`
+
+卡片更新的为新的widgetId
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+需要更新的widget 实例 ID
+
+<a id="openapprequest"></a>
+### OpenAppRequest
+
+#### Properties
+
+##### fallbackUrl?
+
+> `optional` **fallbackUrl**: `string`
+
+Optional fallback URL when deep link fails
+
+##### targetPackage?
+
+> `optional` **targetPackage**: `string`
+
+Optional target package name for Android
+
+##### uri
+
+> **uri**: `string`
+
+Target URI to open, e.g. scheme://path?query
+
+<a id="openappresult"></a>
+### OpenAppResult
+
+#### Properties
+
+##### status
+
+> **status**: [`OpenAppStatus`](#openappstatus)
+
+Execution status from client
+
+<a id="openappstatus"></a>
+### OpenAppStatus
+
+> **OpenAppStatus**: `"deep_link"` \| `"market"` \| `"browser"`