@leaflow/sdk 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/dist/generated/assistant/index.d.ts +8 -7
  2. package/dist/generated/assistant/index.js +6 -5
  3. package/dist/generated/assistant/models/bindingCodeResponseBody.d.ts +34 -0
  4. package/dist/generated/assistant/models/bindingCodeResponseBody.js +31 -0
  5. package/dist/generated/assistant/models/bindingResource.d.ts +4 -1
  6. package/dist/generated/assistant/models/bindingResourceConnState.d.ts +37 -0
  7. package/dist/generated/assistant/models/bindingResourceConnState.js +37 -0
  8. package/dist/generated/assistant/models/bindingResourceStatus.d.ts +36 -0
  9. package/dist/generated/assistant/models/bindingResourceStatus.js +36 -0
  10. package/dist/generated/assistant/models/channelResource.d.ts +10 -2
  11. package/dist/generated/assistant/models/channelResourceConnState.d.ts +40 -0
  12. package/dist/generated/assistant/models/channelResourceConnState.js +37 -0
  13. package/dist/generated/assistant/models/channelResourceRuntimeState.d.ts +38 -0
  14. package/dist/generated/assistant/models/channelResourceRuntimeState.js +35 -0
  15. package/dist/generated/assistant/models/channelResourceSenderPolicy.d.ts +35 -0
  16. package/dist/generated/assistant/models/channelResourceSenderPolicy.js +35 -0
  17. package/dist/generated/assistant/models/channelResourceStatus.d.ts +36 -0
  18. package/dist/generated/assistant/models/channelResourceStatus.js +36 -0
  19. package/dist/generated/assistant/models/channelWithSecretResponseBody.d.ts +57 -0
  20. package/dist/generated/assistant/models/channelWithSecretResponseBody.js +1 -0
  21. package/dist/generated/assistant/models/channelWithSecretResponseBodyAllowFrom.d.ts +31 -0
  22. package/dist/generated/assistant/models/channelWithSecretResponseBodyAllowFrom.js +31 -0
  23. package/dist/generated/assistant/models/channelWithSecretResponseBodyConnState.d.ts +40 -0
  24. package/dist/generated/assistant/models/channelWithSecretResponseBodyConnState.js +37 -0
  25. package/dist/generated/assistant/models/channelWithSecretResponseBodyRuntimeState.d.ts +38 -0
  26. package/dist/generated/assistant/models/channelWithSecretResponseBodyRuntimeState.js +35 -0
  27. package/dist/generated/assistant/models/channelWithSecretResponseBodySenderPolicy.d.ts +35 -0
  28. package/dist/generated/assistant/models/channelWithSecretResponseBodySenderPolicy.js +35 -0
  29. package/dist/generated/assistant/models/channelWithSecretResponseBodyStatus.d.ts +36 -0
  30. package/dist/generated/assistant/models/channelWithSecretResponseBodyStatus.js +36 -0
  31. package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookSecret.d.ts +34 -0
  32. package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookSecret.js +31 -0
  33. package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookUrl.d.ts +34 -0
  34. package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookUrl.js +31 -0
  35. package/dist/generated/assistant/models/createChannelRequestBody.d.ts +3 -2
  36. package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.d.ts +35 -0
  37. package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.js +35 -0
  38. package/dist/generated/assistant/models/index.d.ts +17 -1
  39. package/dist/generated/assistant/models/index.js +17 -1
  40. package/dist/generated/assistant/models/itemResourceStatus.d.ts +1 -1
  41. package/dist/generated/assistant/models/itemResourceStatus.js +1 -1
  42. package/dist/generated/assistant/models/itemResourceType.d.ts +1 -0
  43. package/dist/generated/assistant/models/itemResourceType.js +1 -0
  44. package/dist/generated/assistant/models/loginResource.d.ts +5 -2
  45. package/dist/generated/assistant/models/loginResource.js +0 -30
  46. package/dist/generated/assistant/models/loginResourceStatus.d.ts +39 -0
  47. package/dist/generated/assistant/models/loginResourceStatus.js +39 -0
  48. package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.d.ts +2 -2
  49. package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.js +2 -2
  50. package/dist/generated/tunnel/index.d.ts +142 -0
  51. package/dist/generated/tunnel/index.js +149 -0
  52. package/dist/generated/tunnel/models/actOnTunnelRequestBody.d.ts +28 -0
  53. package/dist/generated/tunnel/models/actOnTunnelRequestBody.js +1 -0
  54. package/dist/generated/tunnel/models/actOnTunnelRequestBodyAction.d.ts +29 -0
  55. package/dist/generated/tunnel/models/actOnTunnelRequestBodyAction.js +29 -0
  56. package/dist/generated/tunnel/models/changeTunnelPlanRequestBody.d.ts +27 -0
  57. package/dist/generated/tunnel/models/changeTunnelPlanRequestBody.js +25 -0
  58. package/dist/generated/tunnel/models/error.d.ts +31 -0
  59. package/dist/generated/tunnel/models/error.js +1 -0
  60. package/dist/generated/tunnel/models/errorMeta.d.ts +27 -0
  61. package/dist/generated/tunnel/models/errorMeta.js +25 -0
  62. package/dist/generated/tunnel/models/index.d.ts +54 -0
  63. package/dist/generated/tunnel/models/index.js +54 -0
  64. package/dist/generated/tunnel/models/lengthAwarePageOperationLogResource.d.ts +35 -0
  65. package/dist/generated/tunnel/models/lengthAwarePageOperationLogResource.js +1 -0
  66. package/dist/generated/tunnel/models/listTunnelOperationLogsParams.d.ts +43 -0
  67. package/dist/generated/tunnel/models/listTunnelOperationLogsParams.js +25 -0
  68. package/dist/generated/tunnel/models/listTunnelUsageSeriesParams.d.ts +32 -0
  69. package/dist/generated/tunnel/models/listTunnelUsageSeriesParams.js +25 -0
  70. package/dist/generated/tunnel/models/openTunnelRequestBody.d.ts +38 -0
  71. package/dist/generated/tunnel/models/openTunnelRequestBody.js +25 -0
  72. package/dist/generated/tunnel/models/operationLogResource.d.ts +38 -0
  73. package/dist/generated/tunnel/models/operationLogResource.js +1 -0
  74. package/dist/generated/tunnel/models/operationLogResourceActor.d.ts +28 -0
  75. package/dist/generated/tunnel/models/operationLogResourceActor.js +25 -0
  76. package/dist/generated/tunnel/models/operationLogResourcePayload.d.ts +27 -0
  77. package/dist/generated/tunnel/models/operationLogResourcePayload.js +25 -0
  78. package/dist/generated/tunnel/models/subscriptionResource.d.ts +33 -0
  79. package/dist/generated/tunnel/models/subscriptionResource.js +1 -0
  80. package/dist/generated/tunnel/models/subscriptionResourceStatus.d.ts +32 -0
  81. package/dist/generated/tunnel/models/subscriptionResourceStatus.js +29 -0
  82. package/dist/generated/tunnel/models/tunnelPlanListResponseBody.d.ts +28 -0
  83. package/dist/generated/tunnel/models/tunnelPlanListResponseBody.js +1 -0
  84. package/dist/generated/tunnel/models/tunnelPlanResource.d.ts +33 -0
  85. package/dist/generated/tunnel/models/tunnelPlanResource.js +25 -0
  86. package/dist/generated/tunnel/models/tunnelResource.d.ts +54 -0
  87. package/dist/generated/tunnel/models/tunnelResource.js +1 -0
  88. package/dist/generated/tunnel/models/tunnelResourceEmail.d.ts +28 -0
  89. package/dist/generated/tunnel/models/tunnelResourceEmail.js +25 -0
  90. package/dist/generated/tunnel/models/tunnelResourceFailure.d.ts +28 -0
  91. package/dist/generated/tunnel/models/tunnelResourceFailure.js +25 -0
  92. package/dist/generated/tunnel/models/tunnelResourceStatus.d.ts +32 -0
  93. package/dist/generated/tunnel/models/tunnelResourceStatus.js +29 -0
  94. package/dist/generated/tunnel/models/tunnelResourceSubscriptionStatus.d.ts +32 -0
  95. package/dist/generated/tunnel/models/tunnelResourceSubscriptionStatus.js +29 -0
  96. package/dist/generated/tunnel/models/tunnelResourceSuspendedAt.d.ts +28 -0
  97. package/dist/generated/tunnel/models/tunnelResourceSuspendedAt.js +25 -0
  98. package/dist/generated/tunnel/models/tunnelUsageSnapshot.d.ts +38 -0
  99. package/dist/generated/tunnel/models/tunnelUsageSnapshot.js +1 -0
  100. package/dist/generated/tunnel/models/tunnelUsageSnapshotSyncedAt.d.ts +28 -0
  101. package/dist/generated/tunnel/models/tunnelUsageSnapshotSyncedAt.js +25 -0
  102. package/dist/generated/tunnel/models/updateTunnelProfileRequestBody.d.ts +34 -0
  103. package/dist/generated/tunnel/models/updateTunnelProfileRequestBody.js +1 -0
  104. package/dist/generated/tunnel/models/updateTunnelProfileRequestBodyEmail.d.ts +29 -0
  105. package/dist/generated/tunnel/models/updateTunnelProfileRequestBodyEmail.js +25 -0
  106. package/dist/generated/tunnel/models/usageDayResource.d.ts +30 -0
  107. package/dist/generated/tunnel/models/usageDayResource.js +25 -0
  108. package/dist/generated/tunnel/models/usageResource.d.ts +43 -0
  109. package/dist/generated/tunnel/models/usageResource.js +1 -0
  110. package/dist/generated/tunnel/models/usageResourceQuotaExceededAt.d.ts +28 -0
  111. package/dist/generated/tunnel/models/usageResourceQuotaExceededAt.js +25 -0
  112. package/dist/generated/tunnel/models/usageSeriesResource.d.ts +30 -0
  113. package/dist/generated/tunnel/models/usageSeriesResource.js +1 -0
  114. package/dist/index.d.ts +14 -0
  115. package/dist/index.js +18 -3
  116. package/openapi/assistant.version +1 -1
  117. package/openapi/assistant.yaml +147 -25
  118. package/openapi/compute.version +1 -1
  119. package/openapi/monitoring.version +1 -1
  120. package/openapi/tunnel.version +1 -0
  121. package/openapi/tunnel.yaml +773 -0
  122. package/package.json +1 -1
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
32
+ export const ChannelResourceStatus = {
33
+ active: 'active',
34
+ suspended: 'suspended',
35
+ disabled: 'disabled',
36
+ };
@@ -0,0 +1,57 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ import type { ChannelWithSecretResponseBodyAllowFrom } from './channelWithSecretResponseBodyAllowFrom.js';
32
+ import type { ChannelWithSecretResponseBodyConnState } from './channelWithSecretResponseBodyConnState.js';
33
+ import type { ChannelWithSecretResponseBodyRuntimeState } from './channelWithSecretResponseBodyRuntimeState.js';
34
+ import type { ChannelWithSecretResponseBodySenderPolicy } from './channelWithSecretResponseBodySenderPolicy.js';
35
+ import type { ChannelWithSecretResponseBodyStatus } from './channelWithSecretResponseBodyStatus.js';
36
+ import type { ChannelWithSecretResponseBodyWebhookSecret } from './channelWithSecretResponseBodyWebhookSecret.js';
37
+ import type { ChannelWithSecretResponseBodyWebhookUrl } from './channelWithSecretResponseBodyWebhookUrl.js';
38
+ export interface ChannelWithSecretResponseBody {
39
+ allowFrom: ChannelWithSecretResponseBodyAllowFrom;
40
+ /** 平台接入状态。只有 online 才收得到消息、也才签得出绑定码 */
41
+ connState: ChannelWithSecretResponseBodyConnState;
42
+ createdAt: string;
43
+ id: string;
44
+ name: string;
45
+ platform: string;
46
+ /** 常驻连接此刻的状态。回调型平台恒为 stopped */
47
+ runtimeState: ChannelWithSecretResponseBodyRuntimeState;
48
+ senderPolicy: ChannelWithSecretResponseBodySenderPolicy;
49
+ status: ChannelWithSecretResponseBodyStatus;
50
+ updatedAt: string;
51
+ /** 回调路径,网关配置和排查时用 */
52
+ webhookPath: string;
53
+ /** 我们生成的那把回调密钥,拿去粘到平台后台。**之后无法再次取回**,只能轮换出新的一把。密钥由平台生成(secretSource=supplied)或该平台不走回调时为 null */
54
+ webhookSecret: ChannelWithSecretResponseBodyWebhookSecret;
55
+ /** 填到平台后台的回调地址。部署未声明公网入口时为 null */
56
+ webhookUrl: ChannelWithSecretResponseBodyWebhookUrl;
57
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export type ChannelWithSecretResponseBodyAllowFrom = string[] | null;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export {};
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ /**
32
+ * 平台接入状态。只有 online 才收得到消息、也才签得出绑定码
33
+ */
34
+ export type ChannelWithSecretResponseBodyConnState = typeof ChannelWithSecretResponseBodyConnState[keyof typeof ChannelWithSecretResponseBodyConnState];
35
+ export declare const ChannelWithSecretResponseBodyConnState: {
36
+ readonly logged_out: "logged_out";
37
+ readonly qr_pending: "qr_pending";
38
+ readonly online: "online";
39
+ readonly expired: "expired";
40
+ };
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
32
+ export const ChannelWithSecretResponseBodyConnState = {
33
+ logged_out: 'logged_out',
34
+ qr_pending: 'qr_pending',
35
+ online: 'online',
36
+ expired: 'expired',
37
+ };
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ /**
32
+ * 常驻连接此刻的状态。回调型平台恒为 stopped
33
+ */
34
+ export type ChannelWithSecretResponseBodyRuntimeState = typeof ChannelWithSecretResponseBodyRuntimeState[keyof typeof ChannelWithSecretResponseBodyRuntimeState];
35
+ export declare const ChannelWithSecretResponseBodyRuntimeState: {
36
+ readonly stopped: "stopped";
37
+ readonly running: "running";
38
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
32
+ export const ChannelWithSecretResponseBodyRuntimeState = {
33
+ stopped: 'stopped',
34
+ running: 'running',
35
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export type ChannelWithSecretResponseBodySenderPolicy = typeof ChannelWithSecretResponseBodySenderPolicy[keyof typeof ChannelWithSecretResponseBodySenderPolicy];
32
+ export declare const ChannelWithSecretResponseBodySenderPolicy: {
33
+ readonly bound_only: "bound_only";
34
+ readonly open: "open";
35
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
32
+ export const ChannelWithSecretResponseBodySenderPolicy = {
33
+ bound_only: 'bound_only',
34
+ open: 'open',
35
+ };
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export type ChannelWithSecretResponseBodyStatus = typeof ChannelWithSecretResponseBodyStatus[keyof typeof ChannelWithSecretResponseBodyStatus];
32
+ export declare const ChannelWithSecretResponseBodyStatus: {
33
+ readonly active: "active";
34
+ readonly suspended: "suspended";
35
+ readonly disabled: "disabled";
36
+ };
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
32
+ export const ChannelWithSecretResponseBodyStatus = {
33
+ active: 'active',
34
+ suspended: 'suspended',
35
+ disabled: 'disabled',
36
+ };
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ /**
32
+ * 我们生成的那把回调密钥,拿去粘到平台后台。**之后无法再次取回**,只能轮换出新的一把。密钥由平台生成(secretSource=supplied)或该平台不走回调时为 null
33
+ */
34
+ export type ChannelWithSecretResponseBodyWebhookSecret = string | null;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export {};
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ /**
32
+ * 填到平台后台的回调地址。部署未声明公网入口时为 null
33
+ */
34
+ export type ChannelWithSecretResponseBodyWebhookUrl = string | null;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Generated by orval v7.21.0 🍺
3
+ * Do not edit manually.
4
+ * Leaflow Assistant 用户 API
5
+ * 控制台里的 AI 助手:对话、消息、工具调用与审批、附件,以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
6
+
7
+ ## 一次对话
8
+
9
+ 1. `POST /v1/threads` 创建对话;
10
+ 2. `POST /v1/threads/{thread}/messages` 发送消息,立即返回 `turnId`,助手的执行在后台进行;
11
+ 3. `GET /v1/threads/{thread}` 取回对话文档用于渲染,并按其中的 `stream` 连上实时输出;
12
+ 4. 助手需要用户参与时,文档中的 `wait` 会说明是哪一种:审批一批工具调用(`POST /v1/threads/{thread}/approvals/{batch}`),或回答几个问题(`POST /v1/threads/{thread}/questions/{item}`)。处理完成后助手自动继续。
13
+
14
+ 发送图片分两步:先 `POST /v1/attachments` 上传拿到 id,发送消息时放进 `attachmentIds`。
15
+
16
+ ## 实时输出
17
+
18
+ ```
19
+ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
20
+ ```
21
+
22
+ 这是一条 Server-Sent Events 流,因此不在下方的接口列表中。
23
+
24
+ - `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径,按取回文档的地址解析;
25
+ - `cursor` 是起始位置,取自对话文档的 `cursor`。不传则从可用范围的开头开始;
26
+ - 推送的每一条都是对那份对话文档的一次增量编辑,套用同一套渲染逻辑即可;
27
+ - 连接有生存期,到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传,无需额外处理;
28
+ - 三种结束事件:`done` 本次 turn 完成(附带最终状态)、`paused` 助手在等待用户处理(重新取回对话文档读 `wait`)、`stalled` 执行已中断且不会恢复,不要重连。
29
+ * OpenAPI spec version: 1.0.0
30
+ */
31
+ export {};
@@ -30,6 +30,7 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
30
30
  */
31
31
  import type { CreateChannelRequestBodyAllowFrom } from './createChannelRequestBodyAllowFrom.js';
32
32
  import type { CreateChannelRequestBodyCredentials } from './createChannelRequestBodyCredentials.js';
33
+ import type { CreateChannelRequestBodySenderPolicy } from './createChannelRequestBodySenderPolicy.js';
33
34
  export interface CreateChannelRequestBody {
34
35
  allowFrom?: CreateChannelRequestBodyAllowFrom;
35
36
  /** 平台侧凭据。只写不读,创建后无法取回 */
@@ -37,7 +38,7 @@ export interface CreateChannelRequestBody {
37
38
  /** @maxLength 128 */
38
39
  name: string;
39
40
  platform: string;
40
- senderPolicy?: string;
41
- /** 不提供则自动生成。仅在本次响应中返回一次 */
41
+ senderPolicy?: CreateChannelRequestBodySenderPolicy;
42
+ /** 平台生成密钥的平台(secretSource=supplied)必须传;我们生成的(generated)不能传,那把会在本次响应的 webhookSecret 里返回一次 */
42
43
  webhookSecret?: string;
43
44
  }