docs: conv and user_id (#21004)

This commit is contained in:
Alter-xyz
2025-06-13 21:07:30 +08:00
committed by GitHub
parent f4df759ba6
commit f6641c0f41
12 changed files with 33 additions and 31 deletions

View File

@@ -57,8 +57,8 @@ The text generation application offers non-session support and is ideal for tran
<i>Due to Cloudflare restrictions, the request will be interrupted without a return after 100 seconds.</i> <i>Due to Cloudflare restrictions, the request will be interrupted without a return after 100 seconds.</i>
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
User identifier, used to define the identity of the end-user for retrieval and statistics. User identifier, used to define the identity of the end-user, convenient for retrieval and statistics.
Should be uniquely defined by the developer within the application. The rules are defined by the developer and need to ensure that the user identifier is unique within the application. The Service API does not share conversations created by the WebApp.
</Property> </Property>
<Property name='files' type='array[object]' key='files'> <Property name='files' type='array[object]' key='files'>
File list, suitable for inputting files (images) combined with text understanding and answering questions, available only when the model supports Vision capability. File list, suitable for inputting files (images) combined with text understanding and answering questions, available only when the model supports Vision capability.
@@ -220,7 +220,7 @@ The text generation application offers non-session support and is ideal for tran
- `file` (File) Required - `file` (File) Required
The file to be uploaded. The file to be uploaded.
- `user` (string) Required - `user` (string) Required
User identifier, defined by the developer's rules, must be unique within the application. User identifier, defined by the developer's rules, must be unique within the application. The Service API does not share conversations created by the WebApp.
### Response ### Response
After a successful upload, the server will return the file's ID and related information. After a successful upload, the server will return the file's ID and related information.
@@ -290,7 +290,7 @@ The text generation application offers non-session support and is ideal for tran
- `task_id` (string) Task ID, can be obtained from the streaming chunk return - `task_id` (string) Task ID, can be obtained from the streaming chunk return
Request Body Request Body
- `user` (string) Required - `user` (string) Required
User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface. User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface. The Service API does not share conversations created by the WebApp.
### Response ### Response
- `result` (string) Always returns "success" - `result` (string) Always returns "success"
</Col> </Col>

View File

@@ -220,7 +220,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `file` (File) 必須 - `file` (File) 必須
アップロードするファイル。 アップロードするファイル。
- `user` (string) 必須 - `user` (string) 必須
開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。 開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。サービス API は WebApp によって作成された会話を共有しません。
### レスポンス ### レスポンス
アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。 アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。
@@ -289,7 +289,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `task_id` (string) タスク ID、ストリーミングチャンクの返信から取得可能 - `task_id` (string) タスク ID、ストリーミングチャンクの返信から取得可能
リクエストボディ リクエストボディ
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子。エンドユーザーの身元を定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。 ユーザー識別子。エンドユーザーの身元を定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。サービス API は WebApp によって作成された会話を共有しません。
### レスポンス ### レスポンス
- `result` (string) 常に"success"を返します - `result` (string) 常に"success"を返します
</Col> </Col>

View File

@@ -266,7 +266,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。
### Response ### Response
- `result` (string) 固定返回 success - `result` (string) 固定返回 success
</Col> </Col>

View File

@@ -59,7 +59,7 @@ Chat applications support session persistence, allowing previous chat history to
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
User identifier, used to define the identity of the end-user for retrieval and statistics. User identifier, used to define the identity of the end-user for retrieval and statistics.
Should be uniquely defined by the developer within the application. Should be uniquely defined by the developer within the application. The Service API does not share conversations created by the WebApp.
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
Conversation ID, to continue the conversation based on previous chat records, it is necessary to pass the previous message's conversation_id. Conversation ID, to continue the conversation based on previous chat records, it is necessary to pass the previous message's conversation_id.
@@ -324,7 +324,7 @@ Chat applications support session persistence, allowing previous chat history to
- `file` (File) Required - `file` (File) Required
The file to be uploaded. The file to be uploaded.
- `user` (string) Required - `user` (string) Required
User identifier, defined by the developer's rules, must be unique within the application. User identifier, defined by the developer's rules, must be unique within the application. The Service API does not share conversations created by the WebApp.
### Response ### Response
After a successful upload, the server will return the file's ID and related information. After a successful upload, the server will return the file's ID and related information.
@@ -394,7 +394,7 @@ Chat applications support session persistence, allowing previous chat history to
- `task_id` (string) Task ID, can be obtained from the streaming chunk return - `task_id` (string) Task ID, can be obtained from the streaming chunk return
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface. User identifier, used to define the identity of the end-user, must be consistent with the user passed in the message sending interface. The Service API does not share conversations created by the WebApp.
### Response ### Response
- `result` (string) Always returns "success" - `result` (string) Always returns "success"
</Col> </Col>
@@ -448,7 +448,7 @@ Chat applications support session persistence, allowing previous chat history to
Upvote as `like`, downvote as `dislike`, revoke upvote as `null` Upvote as `like`, downvote as `dislike`, revoke upvote as `null`
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application. User identifier, defined by the developer's rules, must be unique within the application. The Service API does not share conversations created by the WebApp.
</Property> </Property>
<Property name='content' type='string' key='content'> <Property name='content' type='string' key='content'>
The specific content of message feedback. The specific content of message feedback.

View File

@@ -59,7 +59,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。 ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。
アプリケーション内で開発者によって一意に定義されるべきです。 アプリケーション内で開発者によって一意に定義されるべきです。サービス API は WebApp によって作成された会話を共有しません。
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
会話ID、以前のチャット記録に基づいて会話を続けるには、以前のメッセージのconversation_idを渡す必要があります。 会話ID、以前のチャット記録に基づいて会話を続けるには、以前のメッセージのconversation_idを渡す必要があります。
@@ -324,7 +324,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `file` (File) 必須 - `file` (File) 必須
アップロードするファイル。 アップロードするファイル。
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。 アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。
@@ -394,7 +394,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得できます - `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得できます
### リクエストボディ ### リクエストボディ
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、エンドユーザーの身元を定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。 ユーザー識別子、エンドユーザーの身元を定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
- `result` (string) 常に"success"を返します - `result` (string) 常に"success"を返します
</Col> </Col>

View File

@@ -56,7 +56,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,用于定义终端用户的身份,方便检索、统计。 用户标识,用于定义终端用户的身份,方便检索、统计。
由开发者定义规则,需保证用户标识在应用内唯一。 由开发者定义规则,需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
(选填)会话 ID需要基于之前的聊天记录继续对话必须传之前消息的 conversation_id。 (选填)会话 ID需要基于之前的聊天记录继续对话必须传之前消息的 conversation_id。
@@ -402,7 +402,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。
### Response ### Response
- `result` (string) 固定返回 success - `result` (string) 固定返回 success
</Col> </Col>

View File

@@ -287,7 +287,7 @@ Chat applications support session persistence, allowing previous chat history to
- `file` (File) Required - `file` (File) Required
The file to be uploaded. The file to be uploaded.
- `user` (string) Required - `user` (string) Required
User identifier, defined by the developer's rules, must be unique within the application. User identifier, defined by the developer's rules, must be unique within the application. The Service API does not share conversations created by the WebApp.
### Response ### Response
After a successful upload, the server will return the file's ID and related information. After a successful upload, the server will return the file's ID and related information.
@@ -357,7 +357,7 @@ Chat applications support session persistence, allowing previous chat history to
- `task_id` (string) Task ID, can be obtained from the streaming chunk return - `task_id` (string) Task ID, can be obtained from the streaming chunk return
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface. User identifier, used to define the identity of the end-user, must be consistent with the user passed in the message sending interface. The Service API does not share conversations created by the WebApp.
### Response ### Response
- `result` (string) Always returns "success" - `result` (string) Always returns "success"
</Col> </Col>

View File

@@ -287,7 +287,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `file` (File) 必須 - `file` (File) 必須
アップロードするファイル。 アップロードするファイル。
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。 アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。
@@ -357,7 +357,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得できます - `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得できます
### リクエストボディ ### リクエストボディ
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。 ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
- `result` (string) 常に"success"を返します - `result` (string) 常に"success"を返します
</Col> </Col>

View File

@@ -56,7 +56,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,用于定义终端用户的身份,方便检索、统计。 用户标识,用于定义终端用户的身份,方便检索、统计。
由开发者定义规则,需保证用户标识在应用内唯一。 由开发者定义规则,需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。
</Property> </Property>
<Property name='conversation_id' type='string' key='conversation_id'> <Property name='conversation_id' type='string' key='conversation_id'>
(选填)会话 ID需要基于之前的聊天记录继续对话必须传之前消息的 conversation_id。 (选填)会话 ID需要基于之前的聊天记录继续对话必须传之前消息的 conversation_id。
@@ -306,7 +306,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
要上传的文件。 要上传的文件。
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。
</Property> </Property>
</Properties> </Properties>
@@ -373,7 +373,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。
### Response ### Response
- `result` (string) 固定返回 success - `result` (string) 固定返回 success
</Col> </Col>
@@ -425,7 +425,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
点赞 like, 点踩 dislike, 撤销点赞 null 点赞 like, 点踩 dislike, 撤销点赞 null
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,由开发者定义规则,需保证用户标识在应用内唯一。 用户标识,由开发者定义规则,需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。
</Property> </Property>
<Property name='content' type='string' key='content'> <Property name='content' type='string' key='content'>
消息反馈的具体信息。 消息反馈的具体信息。

View File

@@ -64,6 +64,8 @@ Workflow applications offers non-session support and is ideal for translation, a
- `user` (string) Required - `user` (string) Required
User identifier, used to define the identity of the end-user for retrieval and statistics. User identifier, used to define the identity of the end-user for retrieval and statistics.
Should be uniquely defined by the developer within the application. Should be uniquely defined by the developer within the application.
<br/>
<i>The user identifier should be consistent with the user passed in the message sending interface. The Service API does not share conversations created by the WebApp.</i>
### Response ### Response
When `response_mode` is `blocking`, return a CompletionResponse object. When `response_mode` is `blocking`, return a CompletionResponse object.
@@ -401,7 +403,7 @@ Workflow applications offers non-session support and is ideal for translation, a
- `task_id` (string) Task ID, can be obtained from the streaming chunk return - `task_id` (string) Task ID, can be obtained from the streaming chunk return
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface. User identifier, used to define the identity of the end-user, must be consistent with the user passed in the message sending interface. The Service API does not share conversations created by the WebApp.
### Response ### Response
- `result` (string) Always returns "success" - `result` (string) Always returns "success"
</Col> </Col>
@@ -448,7 +450,7 @@ Workflow applications offers non-session support and is ideal for translation, a
- `file` (File) Required - `file` (File) Required
The file to be uploaded. The file to be uploaded.
- `user` (string) Required - `user` (string) Required
User identifier, defined by the developer's rules, must be unique within the application. User identifier, defined by the developer's rules, must be unique within the application. The Service API does not share conversations created by the WebApp.
### Response ### Response
After a successful upload, the server will return the file's ID and related information. After a successful upload, the server will return the file's ID and related information.

View File

@@ -404,7 +404,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得可能 - `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得可能
### リクエストボディ ### リクエストボディ
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。 ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
- `result` (string) 常に"success"を返します - `result` (string) 常に"success"を返します
</Col> </Col>
@@ -451,7 +451,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `file` (File) 必須 - `file` (File) 必須
アップロードするファイル。 アップロードするファイル。
- `user` (string) 必須 - `user` (string) 必須
ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。サービス API は WebApp によって作成された会話を共有しません。
### 応答 ### 応答
アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。 アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。

View File

@@ -59,7 +59,7 @@ Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等
<i>由于 Cloudflare 限制,请求会在 100 秒超时无返回后中断。</i> <i>由于 Cloudflare 限制,请求会在 100 秒超时无返回后中断。</i>
- `user` (string) Required - `user` (string) Required
用户标识,用于定义终端用户的身份,方便检索、统计。 用户标识,用于定义终端用户的身份,方便检索、统计。
由开发者定义规则,需保证用户标识在应用内唯一。 由开发者定义规则,需保证用户标识在应用内唯一。API 无法访问 WebApp 创建的会话。
### Response ### Response
@@ -394,7 +394,7 @@ Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等
- `task_id` (string) 任务 ID可在流式返回 Chunk 中获取 - `task_id` (string) 任务 ID可在流式返回 Chunk 中获取
### Request Body ### Request Body
- `user` (string) Required - `user` (string) Required
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。
### Response ### Response
- `result` (string) 固定返回 "success" - `result` (string) 固定返回 "success"
</Col> </Col>
@@ -443,7 +443,7 @@ Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等
要上传的文件。 要上传的文件。
</Property> </Property>
<Property name='user' type='string' key='user'> <Property name='user' type='string' key='user'>
用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。 用户标识,用于定义终端用户的身份,必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。
</Property> </Property>
</Properties> </Properties>