This commit is contained in:
Alter-xyz
2025-06-13 18:12:46 +08:00
parent ecd851501e
commit 9d659d0924
13 changed files with 45 additions and 34 deletions

View File

@@ -76,6 +76,8 @@ print(response.text)
Conversational applications facilitate ongoing dialogue with users through a question-and-answer format. To initiate a conversation, you will call the `chat-messages` API. A `conversation_id` is generated for each session and must be included in subsequent API calls to maintain the conversation flow.
> **Important Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.
#### Key Considerations for `conversation_id`:
- **Generating the `conversation_id`:** When starting a new conversation, leave the `conversation_id` field empty. The system will generate and return a new `conversation_id`, which you will use in future interactions to continue the dialogue.

View File

@@ -48,6 +48,7 @@ Send a request to the chat application.
- **user** (string) Required
- User identifier for retrieval and statistics
- Should be uniquely defined within the application
- **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.
- **conversation_id** (string) Optional
- Conversation ID to continue based on previous chat records
@@ -172,6 +173,8 @@ Submit user feedback on messages.
Returns historical chat records in reverse chronological order.
> **Note**: The Service API does not share conversations created by the WebApp. This endpoint only returns conversations created through the API.
#### Query Parameters
- `conversation_id` (string) Required
- `user` (string) Required
@@ -220,6 +223,8 @@ interface ConversationHistory {
Retrieve conversation list for current user.
> **Note**: The Service API does not share conversations created by the WebApp. Only conversations created through the API are accessible via this endpoint.
#### Query Parameters
- `user` (string) Required
- `last_id` (string) Optional

View File

@@ -60,7 +60,7 @@ Chatflow type application provides the following system variables:
<tr>
<td><code>sys.user_id</code></td>
<td>String</td>
<td>A unique ID is assigned for each application user to distinguish different conversation users.</td>
<td>A unique ID is assigned for each application user to distinguish different conversation users. <br /><br /><strong>Note</strong>: The Service API does not share conversations created by the WebApp. This means users with the same ID will have separate conversation histories between API and WebApp interfaces.</td>
<td></td>
</tr>
<tr>

View File

@@ -178,7 +178,7 @@
},
"user": {
"type": "string",
"description": "User identifier, defined by the developer's rules, must be unique within the application."
"description": "User identifier, defined by the developer's rules, must be unique within the application. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
}
}
}
@@ -231,7 +231,7 @@
"properties": {
"user": {
"type": "string",
"description": "User identifier, must be consistent with the user passed in the send message interface."
"description": "User identifier, must be consistent with the user passed in the send message interface. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
}
}
},
@@ -344,7 +344,7 @@
"name": "user",
"in": "query",
"required": true,
"description": "User identifier.",
"description": "User identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.",
"schema": {
"type": "string"
}
@@ -382,7 +382,7 @@
"name": "user",
"in": "query",
"required": true,
"description": "User identifier.",
"description": "User identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.",
"schema": { "type": "string" }
},
{
@@ -425,7 +425,7 @@
"name": "user",
"in": "query",
"required": true,
"description": "User identifier.",
"description": "User identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.",
"schema": { "type": "string" }
},
{
@@ -493,7 +493,7 @@
"properties": {
"user": {
"type": "string",
"description": "The user identifier."
"description": "The user identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
}
}
}
@@ -1003,7 +1003,7 @@
},
"user": {
"type": "string",
"description": "User identifier, unique within the application."
"description": "User identifier, unique within the application. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
},
"conversation_id": {
"type": "string",

View File

@@ -111,7 +111,7 @@
},
"user": {
"type": "string",
"description": "User identifier, unique within the application."
"description": "User identifier, unique within the application. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
}
}
}
@@ -162,7 +162,7 @@
"properties": {
"user": {
"type": "string",
"description": "User identifier, consistent with the send message call."
"description": "User identifier, consistent with the send message call. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface."
}
}
}
@@ -322,7 +322,7 @@
"type": "object",
"required": ["user"],
"properties": {
"user": { "type": "string", "description": "The user identifier." }
"user": { "type": "string", "description": "The user identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface." }
}
}
}
@@ -619,7 +619,7 @@
"LimitQueryParam": { "name": "limit", "in": "query", "description": "Number of items per page.", "schema": { "type": "integer" } },
"LimitQueryParamDefault20": { "name": "limit", "in": "query", "description": "Number of items per page.", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Max100": { "name": "limit", "in": "query", "description": "Number of items per page (Default 20, Max 100).", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } },
"UserQueryParam": { "name": "user", "in": "query", "required": true, "description": "User identifier.", "schema": { "type": "string" } },
"UserQueryParam": { "name": "user", "in": "query", "required": true, "description": "User identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface.", "schema": { "type": "string" } },
"ConversationIdQueryParam": { "name": "conversation_id", "in": "query", "required": true, "description": "Conversation ID.", "schema": { "type": "string" } },
"LastIdQueryParam": { "name": "last_id", "in": "query", "description": "ID of the last record for pagination.", "schema": { "type": "string" } },
"SortByQueryParam": { "name": "sort_by", "in": "query", "description": "Sorting field (e.g., -updated_at).", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } },
@@ -659,7 +659,7 @@
"default": {}
},
"response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "Response mode. Cloudflare timeout is 100s for blocking." },
"user": { "type": "string", "description": "User identifier." },
"user": { "type": "string", "description": "User identifier. **Note**: The Service API does not share conversations created by the WebApp. Conversations created through the API are isolated from those created in the WebApp interface." },
"conversation_id": { "type": "string", "description": "Conversation ID to continue." },
"files": {
"type": "array",

View File

@@ -76,6 +76,8 @@ print(response.text)
大部分のシーンで使用できる会話型アプリケーションは、一問一答形式でユーザーと継続的に会話します。会話を開始するにはchat-messagesエンドポイントを呼び出し、返されたconversation\_idを引き続き提供することで会話を継続することができます。
> **重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。
#### `conversation_id` に関する重要事項:
- **`conversation_id` の生成:** 新しい会話を開始するときは、`conversation_id` フィールドを空のままにしておきます。システムは新しい `conversation_id` を生成して返します。この新しい `conversation_id` は、今後のやり取りで使用して会話を続行します。

View File

@@ -103,7 +103,7 @@ version: '日本語'
<tr>
<td><code>sys.user_id</code></td>
<td>String</td>
<td>各アプリユーザーに割り当てられた一意の識別子で、異なる対話ユーザーを区別するために使用されます。</td>
<td>各アプリユーザーに割り当てられた一意の識別子で、異なる対話ユーザーを区別するために使用されます。<br /><br /><strong>注意</strong>Service API は WebApp で作成された対話を共有しません。つまり、同じ ID を持つユーザーでも、API と WebApp インターフェース間では独立した対話履歴を持ちます。</td>
<td></td>
</tr>
<tr>

View File

@@ -100,7 +100,7 @@
"required": ["file", "user"],
"properties": {
"file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" },
"user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" }
"user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" }
}
}
}
@@ -124,7 +124,7 @@
"operationId": "stopBasicChatMessageGenerationJa",
"tags": ["チャットメッセージ"],
"parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", "schema": { "type": "string", "format": "uuid" } } ],
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" } } } } } },
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } },
"responses": { "200": { "$ref": "#/components/responses/SuccessResultJa" } }
}
},
@@ -186,7 +186,7 @@
"operationId": "deleteBasicChatConversationJa",
"tags": ["会話管理"],
"parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" } ],
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。" } } } } } },
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } },
"responses": { "204": { "description": "会話の削除に成功しました。コンテンツはありません。" } }
}
},
@@ -276,7 +276,7 @@
"LimitQueryParamJa": { "name": "limit", "in": "query", "description": "任意1ページあたりの件数。デフォルト値20。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Max100Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } },
"UserQueryParamJa": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。", "schema": { "type": "string" } },
"UserQueryParamJa": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } },
"ConversationIdQueryParamJa": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } },
"LastIdQueryParamJa": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後のレコードのID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } },
"SortByQueryParamJa": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト:-updated_at更新時間で降順にソート。利用可能な値created_at, -created_at, updated_at, -updated_at。フィールドの前の記号「-」は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } },
@@ -300,7 +300,7 @@
"query": { "type": "string", "description": "ユーザー入力/質問内容。" },
"inputs": { "type": "object", "description": "アプリで定義されたさまざまな変数値の入力を許可します。デフォルトは`{}`。", "additionalProperties": true, "default": {} },
"response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming推奨はSSEベース。blockingは実行完了後に結果を返しますCloudflareの100秒タイムアウト制限ありエージェントアシスタントモードではサポートされていません。" },
"user": { "type": "string", "description": "ユーザー識別子、アプリケーション内で一意である必要があります。" },
"user": { "type": "string", "description": "ユーザー識別子、アプリケーション内で一意である必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" },
"conversation_id": { "type": "string", "format": "uuid", "description": "会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。" },
"files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectJa" }, "description": "アップロードされたファイルリスト。現在は画像タイプのみサポート。" },
"auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成します。デフォルトは`true`です。" }

View File

@@ -106,7 +106,7 @@
},
"user": {
"type": "string",
"description": "ユーザー識別子。開発者のルールによって定義され、アプリケーション内で一意でなければなりません。"
"description": "ユーザー識別子。開発者のルールによって定義され、アプリケーション内で一意でなければなりません。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。"
}
}
}
@@ -317,7 +317,7 @@
"application/json": {
"schema": {
"type": "object", "required": ["user"],
"properties": { "user": { "type": "string", "description": "ユーザー識別子。" } }
"properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } }
}
}
}
@@ -439,7 +439,7 @@
"LimitQueryParamJp": { "name": "limit", "in": "query", "description": "任意1ページあたりの件数。デフォルト値20。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Max100Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } },
"UserQueryParamJp": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。", "schema": { "type": "string" } },
"UserQueryParamJp": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } },
"ConversationIdQueryParamJp": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } },
"LastIdQueryParamJp": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後の記録のID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } },
"SortByQueryParamJp": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト:-updated_at更新時間で降順にソート。利用可能な値created_at, -created_at, updated_at, -updated_at。'-'は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } },
@@ -471,7 +471,7 @@
"default": {}
},
"response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming (推奨) はSSEを使用。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" },
"user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意であるべきです。" },
"user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意であるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" },
"conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。以前のチャット記録に基づいて会話を続ける場合に必要です。" },
"files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectJp" }, "description": "ファイルリスト。モデルがビジョン機能をサポートしている場合に利用可能です。" },
"auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成。デフォルトはtrue。" }

View File

@@ -72,6 +72,8 @@ print(response.text)
可用于大部分场景的对话型应用,采用一问一答模式与用户持续对话。要开始一个对话请调用 `chat-messages` 接口,每次对话开始都会产生出新的 `conversation\_id`,通过该`conversation\_id` 传回接口就可继续保持该会话。
> **重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。
#### `conversation_id` 的注意事项:
- **生成 `conversation_id`** 开始新对话时,请将 `conversation_id` 字段留空。系统将生成并返回一个新的 `conversation_id`,未来的交互中会使用该 `conversation_id` 继续对话。

View File

@@ -101,7 +101,7 @@ Chatflow 类型应用提供以下系统变量:
<tr>
<td><code>sys.user_id</code></td>
<td>String</td>
<td>分配给每个应用用户的唯一标识符,用以区分不同的对话用户</td>
<td>分配给每个应用用户的唯一标识符,用以区分不同的对话用户<br /><br /><strong>注意</strong>Service API 不共享 WebApp 创建的对话。这意味着具有相同 ID 的用户在 API 和 WebApp 界面之间会有独立的对话历史。</td>
<td></td>
</tr>
<tr>

View File

@@ -106,7 +106,7 @@
},
"user": {
"type": "string",
"description": "用户标识,必须和发送消息接口传入 user 保持一致。"
"description": "用户标识,必须和发送消息接口传入 user 保持一致。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。"
}
}
}
@@ -161,7 +161,7 @@
"properties": {
"user": {
"type": "string",
"description": "用户标识,必须和发送消息接口传入 user 保持一致。"
"description": "用户标识,必须和发送消息接口传入 user 保持一致。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。"
}
}
}
@@ -317,7 +317,7 @@
"application/json": {
"schema": {
"type": "object", "required": ["user"],
"properties": { "user": { "type": "string", "description": "用户标识。" } }
"properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } }
}
}
}
@@ -441,7 +441,7 @@
"LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量选填默认值20。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录,默认 20 条。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录,默认 20 条,最大 100 条,最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } },
"UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识,由开发者定义规则,需保证用户标识在应用内唯一。", "schema": { "type": "string" } },
"UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识,由开发者定义规则,需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } },
"ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } },
"LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "(选填)当前页最后面一条记录的 ID默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } },
"SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "(选填)排序字段,默认 -updated_at (按更新时间倒序排列)。可选值created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } },
@@ -471,7 +471,7 @@
"default": {}
},
"response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSEblocking 等待执行完毕后返回 (Cloudflare 100秒超时限制Agent模式下不允许)。" },
"user": { "type": "string", "description": "用户标识,应用内唯一。" },
"user": { "type": "string", "description": "用户标识,应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" },
"conversation_id": { "type": "string", "format": "uuid", "description": "(选填)会话 ID用于继续之前的对话。" },
"files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectCn" }, "description": "(选填)上传的文件列表 (目前仅支持图片)。" },
"auto_generate_name": { "type": "boolean", "default": true, "description": "(选填)自动生成会话标题,默认 true。" }

View File

@@ -106,7 +106,7 @@
},
"user": {
"type": "string",
"description": "用户标识,必须和发送消息接口传入 user 保持一致。"
"description": "用户标识,必须和发送消息接口传入 user 保持一致。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。"
}
}
}
@@ -161,7 +161,7 @@
"properties": {
"user": {
"type": "string",
"description": "用户标识,必须和发送消息接口传入 user 保持一致。"
"description": "用户标识,必须和发送消息接口传入 user 保持一致。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。"
}
}
}
@@ -317,7 +317,7 @@
"application/json": {
"schema": {
"type": "object", "required": ["user"],
"properties": { "user": { "type": "string", "description": "用户标识。" } }
"properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } }
}
}
}
@@ -498,7 +498,7 @@
"LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量选填默认值20。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录,默认 20 条。", "schema": { "type": "integer", "default": 20 } },
"LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录,默认 20 条,最大 100 条,最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } },
"UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识,由开发者定义规则,需保证用户标识在应用内唯一。", "schema": { "type": "string" } },
"UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识,由开发者定义规则,需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } },
"ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } },
"LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "(选填)当前页最后面一条记录的 ID默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } },
"SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "(选填)排序字段,默认 -updated_at (按更新时间倒序排列)。可选值created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } },
@@ -533,7 +533,7 @@
"default": {}
},
"response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSEblocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" },
"user": { "type": "string", "description": "用户标识,应用内唯一。" },
"user": { "type": "string", "description": "用户标识,应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" },
"conversation_id": { "type": "string", "format": "uuid", "description": "(选填)会话 ID用于继续之前的对话。" },
"files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectCn" }, "description": "(选填)文件列表,仅当模型支持 Vision 能力时可用。" },
"auto_generate_name": { "type": "boolean", "default": true, "description": "(选填)自动生成会话标题,默认 true。" }