diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 98513f516..02017f547 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "チャットアプリAPI", - "description": "チャットアプリケーションはセッションの永続化をサポートしており、以前のチャット履歴をレスポンスのコンテキストとして使用できます。チャットボットやカスタマーサービス AI などに適用できます。", + "title": "チャットアプリ API", + "description": "チャットアプリケーションはセッションの永続性をサポートしており、以前のチャット履歴を応答のコンテキストとして使用できます。これはチャットボット、カスタマーサービス AI などに適用できます。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "チャットアプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。", + "description": "チャットアプリ API のベース URL。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -27,9 +27,9 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendBasicChatMessageJa", + "operationId": "sendChatMessage", "tags": [ - "チャットメッセージ" + "Chats" ], "requestBody": { "description": "チャットメッセージを送信するためのリクエストボディ。", @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "リクエスト成功。コンテンツタイプと構造はリクエストの `response_mode` パラメータに依存します。\n\n- `response_mode` が `blocking` の場合、 `application/json` で `ChatCompletionResponse` オブジェクトを返します。\n- `response_mode` が `streaming` の場合、 `text/event-stream` で `ChunkChatEvent` オブジェクトのストリームを返します。", + "description": "成功レスポンス。コンテンツタイプと構造は、リクエストの `response_mode` パラメータによって異なります。\n- `response_mode` が `blocking` の場合、`ChatCompletionResponse` オブジェクトを含む `application/json` を返します。\n- `response_mode` が `streaming` の場合、`ChunkChatEvent` オブジェクトのストリームを含む `text/event-stream` を返します。", "content": { "application/json": { "schema": { @@ -128,15 +128,15 @@ "text/event-stream": { "schema": { "type": "string", - "description": "サーバー送信イベント (SSE) のストリームです。各イベントは `data: ` プレフィックス付きの JSON オブジェクトで、2 つの改行で終了します。\n\n**SSE パースガイド：**各イベントは `data: ` プレフィックス付きの JSON オブジェクトの行で、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを除去してください。JSON 内の `event` フィールドがイベントタイプを決定します。終了イベント（`message_end`、`workflow_finished`、`error` など）を受信するとストリームは終了します。`ping` イベント（10 秒ごとに接続維持のために送信）は無視してください。ストリーム内でエラーイベントが発生しても HTTP ステータスコードは常に `200` です。" + "description": "Server-Sent Events（SSE）のストリーム。各イベントは `data: ` で始まり、2つの改行で終了する JSON オブジェクトです。可能なイベント構造については `ChunkChatEvent` を参照してください。\n**SSE パースガイド:** 各イベントは `data: ` で始まり、その後に JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを削除してください。JSON 内の `event` フィールドがイベントタイプを決定します。`message_end` イベントを受信するとストリームは終了します。`ping` イベント（接続を維持するために10秒ごとに送信される）は無視してください。ストリーム中に `error` イベントを受信した場合、ストリームは終了します — 詳細についてはエラーオブジェクトをパースしてください。ストリーム内でエラーイベントが発生しても、HTTP ステータスコードは常に `200` であることに注意してください。" }, "examples": { "streamingResponseBasic": { - "summary": "Response Example - Streaming (Basic)", + "summary": "レスポンス例 - ストリーミング（基本）", "value": "data: {\"event\": \"message\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"answer\": \" I\", \"created_at\": 1679586595} data: {\"event\": \"message_end\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"metadata\": {\"usage\": {\"total_tokens\": 10, \"latency\": 1.0}}}" }, "streamingResponseAgent": { - "summary": "Response Example - Streaming (Agent)", + "summary": "レスポンス例 - ストリーミング（Agent）", "value": "data: {\"event\": \"agent_thought\", \"id\": \"agent_thought_id_1\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"position\": 1, \"thought\": \"Thinking about calling a tool...\", \"tool\": \"dalle3\", \"tool_input\": \"{\\\"dalle3\\\": {\\\"prompt\\\": \\\"a cute cat\\\"}}\", \"created_at\": 1705395332} data: {\"event\": \"message_file\", \"id\": \"file_id_1\", \"type\": \"image\", \"belongs_to\": \"assistant\", \"url\": \"https://example.com/cat.png\", \"conversation_id\": \"conv123\"} data: {\"event\": \"agent_message\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"answer\": \"Here is the image: \", \"created_at\": 1705395333} data: {\"event\": \"message_end\", \"task_id\":\"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"metadata\": {\"usage\": {\"total_tokens\": 50, \"latency\": 2.5}}}" } } @@ -144,7 +144,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `not_chat_app` : App mode does not match the API route.\n- `conversation_completed` : The conversation has ended.\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。", + "description": "- `app_unavailable` : アプリが利用不可または設定が不正です。\n- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `conversation_completed` : 会話は終了しました。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い果たされました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。", "content": { "application/json": { "examples": { @@ -226,7 +226,7 @@ } }, "429": { - "description": "- `too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームのモデルプロバイダーのレート制限を超えました。", + "description": "- `too_many_requests` : このアプリに対する同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームモデルプロバイダーのレート制限を超えました。", "content": { "application/json": { "examples": { @@ -272,18 +272,18 @@ }, "/chat-messages/{task_id}/stop": { "post": { - "summary": "生成を停止", + "summary": "チャットメッセージ生成を停止", "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされます。", - "operationId": "stopBasicChatMessageGenerationJa", + "operationId": "stopChatMessageGeneration", "tags": [ - "チャットメッセージ" + "Chats" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "タスク ID です。[チャットメッセージを送信](/api-reference/チャットメッセージ/チャットメッセージを送信) API のストリーミングチャンクレスポンスから取得できます。", + "description": "タスク ID、[チャットメッセージを送信](/api-reference/chats/send-chat-message) API のストリーミングチャンクの戻り値から取得できます。", "schema": { "type": "string" } @@ -301,7 +301,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡された user と一致する必要があります。" + "description": "ユーザー識別子、メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" } } }, @@ -344,9 +344,9 @@ "get": { "summary": "次の推奨質問を取得", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getBasicChatSuggestedQuestionsJa", + "operationId": "getSuggestedQuestions", "tags": [ - "チャットメッセージ" + "Chats" ], "parameters": [ { @@ -370,7 +370,7 @@ ], "responses": { "200": { - "description": "提案された質問の取得に成功しました。", + "description": "推奨質問の取得に成功しました。", "content": { "application/json": { "schema": { @@ -393,7 +393,7 @@ } }, "400": { - "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 推奨質問機能が無効です。", + "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 推奨質問機能が無効になっています。", "content": { "application/json": { "examples": { @@ -457,13 +457,13 @@ "/files/upload": { "post": { "summary": "ファイルをアップロード", - "description": "メッセージ送信時に使用するファイルをアップロードします。画像、ドキュメント、音声、動画のマルチモーダル理解が可能です。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", - "operationId": "uploadBasicChatFileJa", + "description": "メッセージ送信時に使用するファイルをアップロードし、画像、ドキュメント、音声、動画のマルチモーダル理解を可能にします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", + "operationId": "uploadChatFile", "tags": [ - "ファイル操作" + "Files" ], "requestBody": { - "description": "ファイルアップロードリクエスト。multipart/form-data 形式が必要です。", + "description": "ファイルアップロードリクエスト。multipart/form-data が必要です。", "required": true, "content": { "multipart/form-data": { @@ -476,11 +476,11 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイル。サポートされるタイプには画像、ドキュメント、音声、動画が含まれます。" + "description": "アップロードするファイル。サポートされるタイプには、画像、ドキュメント、音声、動画が含まれます。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。" + "description": "ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意である必要があります。" } } } @@ -489,7 +489,7 @@ }, "responses": { "201": { - "description": "ファイルが正常にアップロードされました。", + "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { @@ -520,7 +520,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : リクエストにファイルが提供されていません。\n- `too_many_files` : 1 回のリクエストにつき 1 ファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", + "description": "- `no_file_uploaded` : リクエストにファイルが提供されていません。\n- `too_many_files` : リクエストごとに1つのファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", "content": { "application/json": { "examples": { @@ -553,7 +553,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズが制限を超えています。", "content": { "application/json": { "examples": { @@ -570,7 +570,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプが許可されていません。", "content": { "application/json": { "examples": { @@ -592,17 +592,17 @@ "/files/{file_id}/preview": { "get": { "summary": "ファイルをダウンロード", - "description": "以前[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", - "operationId": "previewBasicChatFileJa", + "description": "[ファイルをアップロード](/api-reference/files/upload-file) API を介して以前にアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエストアプリケーション内のメッセージに属している場合にのみアクセスできます。", + "operationId": "previewChatFile", "tags": [ - "ファイル操作" + "Files" ], "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "プレビューするファイルの一意の識別子です。[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API のレスポンスから取得します。", + "description": "プレビューするファイルの一意の識別子、[ファイルをアップロード](/api-reference/files/upload-file) API レスポンスから取得します。", "schema": { "type": "string", "format": "uuid" @@ -612,7 +612,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "`true` の場合、ブラウザでプレビューする代わりにファイルを添付ファイルとして強制ダウンロードします。", + "description": "`true` の場合、ブラウザでプレビューする代わりに添付ファイルとしてダウンロードを強制します。", "schema": { "type": "boolean", "default": false @@ -622,7 +622,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子。エンドユーザーのコンテキストに使用されます。", + "description": "ユーザー識別子、エンドユーザーコンテキストに使用されます。", "schema": { "type": "string" } @@ -630,7 +630,7 @@ ], "responses": { "200": { - "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` としてダウンロード形式で返されます。", + "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` 付きでダウンロードとして返されます。", "content": { "application/octet-stream": { "schema": { @@ -679,11 +679,11 @@ }, "/end-users/{end_user_id}": { "get": { - "summary": "エンドユーザー取得", - "description": "ID を指定してエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード)の `created_by`）に便利です。", - "operationId": "getEndUserChatJa", + "summary": "エンドユーザー情報を取得", + "description": "ID でエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合に便利です（例：[ファイルをアップロード](/api-reference/files/upload-file) の `created_by`）。", + "operationId": "getEndUserChat", "tags": [ - "エンドユーザー" + "End Users" ], "parameters": [ { @@ -699,7 +699,7 @@ ], "responses": { "200": { - "description": "エンドユーザーを正常に取得しました。", + "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { "schema": { @@ -748,10 +748,10 @@ "/messages/{message_id}/feedbacks": { "post": { "summary": "メッセージフィードバックを送信", - "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` で評価でき、任意でテキストフィードバックを提供できます。`rating` に `null` を渡すと、以前送信したフィードバックを取り消せます。", - "operationId": "postBasicChatMessageFeedbackJa", + "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` と評価でき、オプションでテキストフィードバックを提供できます。以前に送信したフィードバックを取り消すには、`rating` に `null` を渡します。", + "operationId": "postChatMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -810,17 +810,17 @@ }, "/app/feedbacks": { "get": { - "summary": "アプリのフィードバック一覧を取得", - "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者のフィードバックの両方が含まれます。", - "operationId": "getBasicChatAppFeedbacksJa", + "summary": "アプリフィードバック一覧", + "description": "このアプリケーションのメッセージに送信されたすべてのフィードバックのページ分割されたリストを取得します。エンドユーザーと管理者の両方のフィードバックが含まれます。", + "operationId": "getChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページ分割のページ番号。", "required": false, "schema": { "type": "integer", @@ -892,11 +892,11 @@ }, "/conversations": { "get": { - "summary": "会話一覧を取得", - "description": "現在のユーザーの会話リストを、最近アクティブな順に取得します。", - "operationId": "getBasicChatConversationsListJa", + "summary": "会話一覧", + "description": "現在のユーザーの会話リストを取得します。最近アクティブな順に並べられます。", + "operationId": "getConversationsList", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -912,7 +912,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページ分割用）。", "schema": { "type": "string" } @@ -921,7 +921,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -933,7 +933,7 @@ "name": "sort_by", "in": "query", "required": false, - "description": "ソートフィールドです。降順にするには '-' プレフィックスを使用します。", + "description": "ソートフィールド。降順の場合は '-' プレフィックスを使用します。", "schema": { "type": "string", "enum": [ @@ -997,7 +997,7 @@ } }, "404": { - "description": "`not_found` : 前の会話が存在しません（無効な `last_id`）。", + "description": "`not_found` : 最後の会話が存在しません（無効な `last_id`）。", "content": { "application/json": { "examples": { @@ -1018,11 +1018,11 @@ }, "/messages": { "get": { - "summary": "会話履歴メッセージ一覧を取得", - "description": "スクロール読み込み形式で過去のチャット記録を返します。最初のページは最新の `limit` 件のメッセージを返します（時系列の逆順）。", - "operationId": "getBasicChatConversationHistoryJa", + "summary": "会話メッセージ一覧", + "description": "スクロールロード形式で過去のチャット記録を返します。最初のページは最新の `limit` メッセージを返します。つまり、逆順です。", + "operationId": "getConversationHistory", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1047,7 +1047,7 @@ "name": "first_id", "in": "query", "required": false, - "description": "現在のページの最初のチャット記録の ID です。デフォルトは `null`（最新のメッセージを取得）です。次のページを取得するには、現在のリストの最初のメッセージの ID を使用して、より古いメッセージを取得します。", + "description": "現在のページの最初のチャットレコードの ID。デフォルトは `null`（最新のメッセージを取得）。後続のページでは、現在のリストの最初のメッセージの ID を使用して、より古いメッセージを取得します。", "schema": { "type": "string" } @@ -1056,7 +1056,7 @@ "name": "limit", "in": "query", "required": false, - "description": "リクエストごとに返すチャット履歴メッセージの数です。", + "description": "リクエストごとに返すチャット履歴メッセージの数。", "schema": { "type": "integer", "default": 20, @@ -1154,11 +1154,11 @@ }, "/conversations/{conversation_id}/variables": { "get": { - "summary": "会話変数の取得", + "summary": "会話変数一覧", "description": "特定の会話から変数を取得します。", - "operationId": "getBasicChatConversationVariablesJa", + "operationId": "getConversationVariables", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1174,7 +1174,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子です。", + "description": "ユーザー識別子。", "schema": { "type": "string" } @@ -1183,7 +1183,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページ分割用）。", "schema": { "type": "string" } @@ -1192,7 +1192,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -1204,7 +1204,7 @@ "name": "variable_name", "in": "query", "required": false, - "description": "指定した名前で変数をフィルタリングします。", + "description": "特定の名前で変数をフィルタリングします。", "schema": { "type": "string", "minLength": 1, @@ -1282,11 +1282,11 @@ }, "/conversations/{conversation_id}/name": { "post": { - "summary": "会話の名前を変更", - "description": "会話の名前を変更するか、自動的に生成します。会話名は複数の会話をサポートするクライアントでの表示に使用されます。", - "operationId": "renameBasicChatConversationJa", + "summary": "会話名を変更", + "description": "会話の名前を変更するか、自動的に名前を生成します。会話名は、複数の会話をサポートするクライアントでの表示に使用されます。", + "operationId": "renameConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1320,7 +1320,7 @@ }, "responses": { "200": { - "description": "会話が正常に名前変更されました。", + "description": "会話名の変更に成功しました。", "content": { "application/json": { "schema": { @@ -1385,10 +1385,10 @@ "/conversations/{conversation_id}/variables/{variable_id}": { "put": { "summary": "会話変数を更新", - "description": "特定の会話変数の値を更新します。値は期待される型と一致する必要があります。", - "operationId": "updateChatConversationVariableJa", + "description": "特定の会話変数の値を更新します。値は期待されるタイプと一致する必要があります。", + "operationId": "updateChatConversationVariable", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1405,7 +1405,7 @@ "name": "variable_id", "in": "path", "required": true, - "description": "Variable ID.", + "description": "変数 ID。", "schema": { "type": "string", "format": "uuid" @@ -1433,7 +1433,7 @@ }, "responses": { "200": { - "description": "変数が正常に更新されました。", + "description": "変数の更新に成功しました。", "content": { "application/json": { "schema": { @@ -1457,7 +1457,7 @@ } }, "400": { - "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 変数値の型が一致しません。", + "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 変数値のタイプが一致しません。", "content": { "application/json": { "examples": { @@ -1513,9 +1513,9 @@ "delete": { "summary": "会話を削除", "description": "会話を削除します。", - "operationId": "deleteBasicChatConversationJa", + "operationId": "deleteConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1537,7 +1537,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -1554,7 +1554,7 @@ }, "responses": { "204": { - "description": "会話が正常に削除されました。" + "description": "会話の削除に成功しました。" }, "400": { "description": "`not_chat_app` : アプリモードが API ルートと一致しません。", @@ -1596,10 +1596,10 @@ "/audio-to-text": { "post": { "summary": "音声をテキストに変換", - "description": "音声ファイルをテキストに変換します。サポートされる形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズの上限は `30 MB` です。", - "operationId": "basicChatAudioToTextJa", + "description": "音声ファイルをテキストに変換します。サポートされる形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズ制限は `30 MB` です。", + "operationId": "audioToText", "tags": [ - "音声・テキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -1631,7 +1631,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用不可または設定が不正です。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーは音声からテキストへの変換をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い果たされました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -1696,7 +1696,7 @@ } }, "413": { - "description": "`audio_too_large` : 音声ファイルサイズが上限を超えています。", + "description": "`audio_too_large` : 音声ファイルサイズが制限を超えています。", "content": { "application/json": { "examples": { @@ -1713,7 +1713,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 許可されていない音声タイプです。", + "description": "`unsupported_audio_type` : 音声タイプが許可されていません。", "content": { "application/json": { "examples": { @@ -1753,9 +1753,9 @@ "post": { "summary": "テキストを音声に変換", "description": "テキストを音声に変換します。", - "operationId": "basicChatTextToAudioJa", + "operationId": "textToAudioChat", "tags": [ - "音声・テキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -1780,7 +1780,7 @@ }, "responses": { "200": { - "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声の MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", + "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声の MIME タイプに設定されます（例：`audio/wav`、`audio/mp3`）。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", "content": { "audio/mpeg": { "schema": { @@ -1791,7 +1791,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用不可または設定が不正です。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い果たされました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキストから音声への変換リクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -1861,11 +1861,11 @@ }, "/info": { "get": { - "summary": "アプリケーションの基本情報を取得", - "description": "このアプリケーションの基本情報（名前、説明、タグ、モード）を取得します。", - "operationId": "getBasicChatAppInfoJa", + "summary": "アプリ情報を取得", + "description": "このアプリケーションの基本情報を取得します。名前、説明、タグ、モードが含まれます。", + "operationId": "getChatAppInfo", "tags": [ - "アプリケーション設定" + "Applications" ], "responses": { "200": { @@ -1880,7 +1880,7 @@ "summary": "レスポンス例", "value": { "name": "My Chat App", - "description": "便利なカスタマーサービスチャットボット。", + "description": "役立つカスタマーサービスチャットボット。", "tags": [ "customer-service", "chatbot" @@ -1898,11 +1898,11 @@ }, "/parameters": { "get": { - "summary": "アプリケーションのパラメータ情報を取得", - "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。", - "operationId": "getBasicChatAppParametersJa", + "summary": "アプリパラメータを取得", + "description": "アプリケーションの入力フォーム設定を取得します。機能スイッチ、入力パラメータの名前、タイプ、デフォルト値が含まれます。", + "operationId": "getChatAppParameters", "tags": [ - "アプリケーション設定" + "Applications" ], "responses": { "200": { @@ -1980,7 +1980,7 @@ } }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用不可または設定が不正です。", "content": { "application/json": { "examples": { @@ -2001,15 +2001,15 @@ }, "/meta": { "get": { - "summary": "アプリケーションのメタ情報を取得", - "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細）を取得します。", - "operationId": "getBasicChatAppMetaJa", + "summary": "アプリメタを取得", + "description": "このアプリケーションに関するメタデータを取得します。ツールアイコンやその他の設定詳細が含まれます。", + "operationId": "getChatAppMeta", "tags": [ - "アプリケーション設定" + "Applications" ], "responses": { "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", + "description": "アプリケーションメタ情報の取得に成功しました。", "content": { "application/json": { "schema": { @@ -2037,11 +2037,11 @@ }, "/site": { "get": { - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", - "operationId": "getBasicChatWebAppSettingsJa", + "summary": "アプリ WebApp 設定を取得", + "description": "このアプリケーションの WebApp 設定を取得します。サイト設定、テーマ、カスタマイズオプションが含まれます。", + "operationId": "getChatWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], "responses": { "200": { @@ -2055,14 +2055,14 @@ "webAppSettings": { "summary": "レスポンス例", "value": { - "title": "My Chat App", + "title": "マイチャットアプリ", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", "icon": "🤖", "icon_background": "#FFFFFF", "icon_url": null, - "description": "便利なカスタマーサービスチャットボット。", + "description": "役立つカスタマーサービスチャットボット。", "copyright": "2025 Dify", "privacy_policy": "https://example.com/privacy", "custom_disclaimer": "", @@ -2098,10 +2098,10 @@ "/apps/annotations": { "post": { "summary": "アノテーションを作成", - "description": "新しいアノテーションを作成します。アノテーションは、アプリがレスポンスを生成する代わりに直接マッチして返すことができる、事前定義された質問と回答のペアを提供します。", - "operationId": "createChatAnnotationJa", + "description": "新しいアノテーションを作成します。アノテーションは、アプリが応答を生成する代わりに直接マッチして返すことができる事前定義された質問と回答のペアを提供します。", + "operationId": "createAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "requestBody": { "required": true, @@ -2124,7 +2124,7 @@ }, "responses": { "201": { - "description": "アノテーションが正常に作成されました。", + "description": "アノテーションの作成に成功しました。", "content": { "application/json": { "schema": { @@ -2148,17 +2148,17 @@ } }, "get": { - "summary": "アノテーションリストを取得", - "description": "アプリケーションのアノテーションをページネーションリストで取得します。キーワード検索によるフィルタリングをサポートしています。", - "operationId": "listChatAnnotationsJa", + "summary": "アノテーション一覧", + "description": "アプリケーションのアノテーションのページ分割されたリストを取得します。キーワード検索フィルタリングをサポートします。", + "operationId": "getAnnotationList", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページ分割のページ番号。", "required": false, "schema": { "type": "integer", @@ -2168,7 +2168,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "1ページあたりのアイテム数。", "required": false, "schema": { "type": "integer", @@ -2178,7 +2178,7 @@ { "name": "keyword", "in": "query", - "description": "質問または回答の内容でアノテーションをフィルタリングするためのキーワードです。", + "description": "質問または回答の内容でアノテーションをフィルタリングするキーワード。", "required": false, "schema": { "type": "string" @@ -2223,16 +2223,16 @@ "put": { "summary": "アノテーションを更新", "description": "既存のアノテーションの質問と回答を更新します。", - "operationId": "updateChatAnnotationJa", + "operationId": "updateAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "annotation_id", "in": "path", "required": true, - "description": "更新するアノテーションの一意の識別子です。", + "description": "更新するアノテーションの一意の識別子。", "schema": { "type": "string", "format": "uuid" @@ -2260,7 +2260,7 @@ }, "responses": { "200": { - "description": "アノテーションが正常に更新されました。", + "description": "アノテーションの更新に成功しました。", "content": { "application/json": { "schema": { @@ -2282,7 +2282,7 @@ } }, "403": { - "description": "`forbidden` : アノテーションを編集する権限がありません。", + "description": "`forbidden` : アノテーションを編集する権限が不足しています。", "content": { "application/json": { "examples": { @@ -2320,16 +2320,16 @@ "delete": { "summary": "アノテーションを削除", "description": "アノテーションとその関連するヒット履歴を削除します。", - "operationId": "deleteChatAnnotationJa", + "operationId": "deleteAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "annotation_id", "in": "path", "required": true, - "description": "削除するアノテーションの一意の識別子です。", + "description": "削除するアノテーションの一意の識別子。", "schema": { "type": "string", "format": "uuid" @@ -2338,10 +2338,10 @@ ], "responses": { "204": { - "description": "アノテーションが正常に削除されました。" + "description": "アノテーションの削除に成功しました。" }, "403": { - "description": "`forbidden` : アノテーションを編集する権限がありません。", + "description": "`forbidden` : アノテーションを編集する権限が不足しています。", "content": { "application/json": { "examples": { @@ -2380,17 +2380,17 @@ "/apps/annotation-reply/{action}": { "post": { "summary": "アノテーション返信を設定", - "description": "アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) で進捗を追跡します。", - "operationId": "setChatAnnotationReplyJa", + "description": "アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます — [アノテーション返信ジョブステータスを取得](/api-reference/annotations/get-annotation-reply-job-status) を使用して進捗を追跡してください。", + "operationId": "initialAnnotationReplySettings", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "実行するアクションです。", + "description": "実行するアクション。", "schema": { "type": "string", "enum": [ @@ -2445,18 +2445,18 @@ }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { - "summary": "アノテーション返信の初期設定タスクステータスを取得", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) で開始された非同期アノテーション返信設定ジョブのステータスを取得します。", - "operationId": "getChatAnnotationReplyStatusJa", + "summary": "アノテーション返信ジョブステータスを取得", + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) によって開始された非同期アノテーション返信設定ジョブのステータスを取得します。", + "operationId": "getInitialAnnotationReplySettingsStatus", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "アクションタイプです。[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) の呼び出しと一致する必要があります。", + "description": "アクションタイプ、[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) の呼び出しと一致する必要があります。", "schema": { "type": "string", "enum": [ @@ -2469,7 +2469,7 @@ "name": "job_id", "in": "path", "required": true, - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) から返されたジョブ ID です。", + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) によって返されたジョブ ID。", "schema": { "type": "string", "format": "uuid" @@ -2498,7 +2498,7 @@ } }, "400": { - "description": "`invalid_param` : 指定されたジョブが存在しません。", + "description": "`invalid_param` : 指定されたジョブは存在しません。", "content": { "application/json": { "examples": { @@ -2524,7 +2524,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 認証です。すべての API リクエストにおいて、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けた API Key を含めてください。例：`Authorization: Bearer {API_KEY}`。**API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。**" + "description": "API キー認証。すべての API リクエストで、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けて API キーを含めてください。例：`Authorization: Bearer {API_KEY}`。**API キーはサーバーサイドに保存し、クライアントサイドで共有または保存しないことを強くお勧めします。これにより、重大な結果につながる可能性のある API キーの漏洩を防ぐことができます。**" } }, "responses": { @@ -2564,11 +2564,11 @@ "properties": { "query": { "type": "string", - "description": "ユーザーの入力/質問内容です。" + "description": "ユーザー入力/質問内容。" }, "inputs": { "type": "object", - "description": "アプリで定義されたさまざまな変数の値を入力できます。キーと値のペアを含みます。アプリが期待する変数名と型については、[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) レスポンスの `user_input_form` フィールドを参照してください。", + "description": "アプリで定義されたさまざまな変数値の入力を許可します。キー/値のペアを含みます。[アプリパラメータを取得](/api-reference/applications/get-app-parameters) レスポンスの `user_input_form` フィールドを参照して、アプリが期待する変数名とタイプを確認してください。", "additionalProperties": true }, "response_mode": { @@ -2577,19 +2577,19 @@ "streaming", "blocking" ], - "description": "レスポンスの返却モードです。`streaming`（推奨）は SSE を使用します。`blocking` は完了後に返します（長時間の処理では中断される場合があります。エージェントアシスタントモードではサポートされていません）。Cloudflare のタイムアウトは `100 s` です。省略した場合、デフォルトはブロッキング動作になります。" + "description": "レスポンス返却モード。`streaming`（推奨）は SSE を使用します。`blocking` は完了後に返します（長いプロセスでは中断される可能性があります。Agent アシスタントモードではサポートされていません）。Cloudflare タイムアウトは `100 秒` です。省略した場合、デフォルトでブロッキング動作になります。" }, "user": { "type": "string", - "description": "アプリケーション内で一意のユーザー識別子です。この識別子はデータアクセスの範囲を限定します——会話、メッセージ、ファイルは同じ `user` 値でクエリした場合にのみ表示されます。" + "description": "ユーザー識別子、アプリケーション内で一意です。この識別子はデータアクセスをスコープします — 会話、メッセージ、ファイルは同じ `user` 値でクエリした場合にのみ表示されます。" }, "conversation_id": { "type": "string", - "description": "会話を継続するための会話 ID です。前のメッセージの `conversation_id` を渡します。新しい会話を開始するには、このフィールドを省略するか空文字列を渡します。レスポンスで `conversation_id` が返されます——以降のメッセージでこの値を渡すとその会話を継続できます。" + "description": "会話を継続するための会話 ID。前のメッセージの `conversation_id` を渡します。新しい会話を開始するには、このフィールドを省略するか空の文字列を渡します。レスポンスは `conversation_id` を返します — その会話を継続するには、後続のメッセージでそれを渡してください。" }, "files": { "type": "array", - "description": "マルチモーダル理解用のファイルリストです。画像、ドキュメント、音声、動画を含みます。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` で使用します。", + "description": "マルチモーダル理解のためのファイルリスト。画像、ドキュメント、音声、動画が含まれます。ローカルファイルを添付するには、まず[ファイルをアップロード](/api-reference/files/upload-file)経由でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` と共に使用します。", "items": { "type": "object", "required": [ @@ -2614,23 +2614,23 @@ "remote_url", "local_file" ], - "description": "転送方法です。ファイル URL の場合は `remote_url`、アップロードファイルの場合は `local_file` です。" + "description": "転送方法：ファイル URL の場合は `remote_url`、アップロードされたファイルの場合は `local_file`。" }, "url": { "type": "string", "format": "url", - "description": "ファイル URL（`transfer_method` が `remote_url` の場合は必須）です。" + "description": "ファイル URL（`transfer_method` が `remote_url` の場合に必要）。" }, "upload_file_id": { "type": "string", - "description": "[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API から取得したアップロード済みファイル ID です（`transfer_method` が `local_file` の場合は必須）。" + "description": "[ファイルをアップロード](/api-reference/files/upload-file) API から取得したアップロードファイル ID（`transfer_method` が `local_file` の場合に必要）。" } } } }, "auto_generate_name": { "type": "boolean", - "description": "会話タイトルを自動生成します。`false` の場合、[会話の名前を変更](/api-reference/会話管理/会話の名前を変更) API で `auto_generate: true` を設定して非同期でタイトルを生成します。", + "description": "会話タイトルを自動生成します。`false` の場合、[会話名を変更](/api-reference/conversations/rename-conversation) API で `auto_generate: true` を使用して非同期でタイトルを生成します。", "default": true } } @@ -2640,22 +2640,22 @@ "properties": { "event": { "type": "string", - "description": "イベントタイプ。`message` に固定されています。" + "description": "イベントタイプ、`message` に固定されています。" }, "task_id": { "type": "string", "format": "uuid", - "description": "リクエスト追跡およびレスポンス停止 API 用のタスク ID です。" + "description": "リクエスト追跡と停止レスポンス API 用のタスク ID。" }, "id": { "type": "string", "format": "uuid", - "description": "このレスポンスイベントの一意 ID です。" + "description": "このレスポンスイベントの一意の ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に `message_id` パラメータとして使用します。" + "description": "一意のメッセージ ID。フィードバックや推奨質問エンドポイントを呼び出す際に `message_id` パラメータとしてこれを使用します。" }, "conversation_id": { "type": "string", @@ -2664,11 +2664,11 @@ }, "mode": { "type": "string", - "description": "アプリモード、`chat` 固定です。" + "description": "アプリモード、`chat` に固定されています。" }, "answer": { "type": "string", - "description": "完全なレスポンスコンテンツ。" + "description": "完全なレスポンス内容。" }, "metadata": { "type": "object", @@ -2695,11 +2695,11 @@ }, "ChunkChatEvent": { "type": "object", - "description": "ストリーミングモードにおける Server-Sent Event チャンクのベーススキーマです。", + "description": "ストリーミングモードの Server-Sent Event チャンクの基本スキーマ。", "properties": { "event": { "type": "string", - "description": "イベントの種類です。", + "description": "イベントのタイプ。", "enum": [ "message", "agent_message", @@ -2732,7 +2732,7 @@ }, "StreamEventBase": { "type": "object", - "description": "ストリームイベントの基本プロパティです。", + "description": "ストリームイベントの基本プロパティ。", "properties": { "task_id": { "type": "string", @@ -2769,7 +2769,7 @@ "properties": { "answer": { "type": "string", - "description": "LLM が返したテキストチャンクです。" + "description": "LLM が返したテキストチャンク。" } } } @@ -2788,7 +2788,7 @@ "properties": { "answer": { "type": "string", - "description": "LLM が返したテキストチャンク（エージェントモード）です。" + "description": "LLM が返したテキストチャンク（Agent モード）。" } } } @@ -2804,12 +2804,12 @@ }, { "type": "object", - "description": "TTS 音声ストリームイベント（base64 エンコードの Mp3）です。自動再生が有効な場合に利用できます。", + "description": "TTS 音声ストリームイベント（base64 エンコードされた Mp3）。自動再生が有効な場合に利用可能です。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 エンコードされた MP3 音声チャンク。すべてのチャンクを順番にデコードして連結すると、完全な音声ファイルが生成されます。" + "description": "Base64 エンコードされた MP3 音声チャンク。完全な音声ファイルを生成するには、すべてのチャンクを順番にデコードして連結します。" } } } @@ -2845,32 +2845,32 @@ }, { "type": "object", - "description": "エージェントの思考、LLM の推論、ツール呼び出しの詳細（エージェントモード）です。", + "description": "Agent の思考、LLM の思考、ツール呼び出しの詳細（Agent モード）。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "エージェント思考 ID です。" + "description": "Agent 思考 ID。" }, "position": { "type": "integer", - "description": "メッセージ内のシーケンスにおけるこの思考の位置です。" + "description": "メッセージ内のシーケンスにおけるこの思考の位置。" }, "thought": { "type": "string", - "description": "LLM が思考している内容です。" + "description": "LLM が考えていること。" }, "observation": { "type": "string", - "description": "ツール呼び出しからのレスポンスです。" + "description": "ツール呼び出しからのレスポンス。" }, "tool": { "type": "string", - "description": "呼び出されたツールのリスト（`;` で区切り）です。" + "description": "呼び出されたツールのリスト、`;` で区切られています。" }, "tool_input": { "type": "string", - "description": "ツールの入力（JSON 形式）です。" + "description": "JSON 形式のツール入力。" }, "message_files": { "type": "array", @@ -2878,7 +2878,7 @@ "type": "string", "format": "uuid" }, - "description": "この思考に関連するファイルのファイル ID です。" + "description": "この思考に関連するファイルのファイル ID。" } } } @@ -2891,7 +2891,7 @@ }, { "type": "object", - "description": "メッセージファイルイベント。ツールによって作成された新しいファイルです。", + "description": "メッセージファイルイベント、ツールによって作成された新しいファイル。", "properties": { "id": { "type": "string", @@ -2900,11 +2900,11 @@ }, "type": { "type": "string", - "description": "ファイルタイプ（例：`image`）。" + "description": "ファイルタイプ、例：`image`。" }, "belongs_to": { "type": "string", - "description": "このファイルの所有者です。ツールが生成したファイルの場合は常に `assistant` です。" + "description": "このファイルの所有者。ツールで生成されたファイルは常に `assistant`。" }, "url": { "type": "string", @@ -2935,7 +2935,7 @@ "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージ ID。" }, "metadata": { "type": "object", @@ -2967,15 +2967,15 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージ内容置換イベント（例：コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", - "description": "置換コンテンツ。" + "description": "置換内容。" }, "reason": { "type": "string", - "description": "コンテンツ置換の理由。" + "description": "内容置換の理由。" } } } @@ -3022,58 +3022,58 @@ }, "Usage": { "type": "object", - "description": "モデルの使用情報です。", + "description": "モデル使用量情報。", "properties": { "prompt_tokens": { "type": "integer", - "description": "プロンプト内のトークン数。" + "description": "プロンプト内の token 数。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンあたりの単価。" + "description": "プロンプト token あたりの単価。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの価格単位。" + "description": "プロンプト token の価格単位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの合計価格。" + "description": "プロンプト token の合計価格。" }, "completion_tokens": { "type": "integer", - "description": "補完のトークン数。" + "description": "補完内の token 数。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "補完トークンあたりの単価。" + "description": "補完 token あたりの単価。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "補完トークンの価格単位。" + "description": "補完 token の価格単位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "補完トークンの合計価格。" + "description": "補完 token の合計価格。" }, "total_tokens": { "type": "integer", - "description": "使用されたトークンの合計数。" + "description": "使用された合計 token 数。" }, "total_price": { "type": "string", "format": "decimal", - "description": "すべてのトークンの合計価格。" + "description": "すべての token の合計価格。" }, "currency": { "type": "string", - "description": "課金通貨。" + "description": "価格の通貨。" }, "latency": { "type": "number", @@ -3084,7 +3084,7 @@ }, "RetrieverResource": { "type": "object", - "description": "検索リソースの引用および帰属情報です。", + "description": "検索リソースの引用と帰属情報。", "properties": { "id": { "type": "string", @@ -3103,20 +3103,20 @@ "dataset_id": { "type": "string", "format": "uuid", - "description": "ナレッジベース ID。" + "description": "ナレッジベースの ID。" }, "dataset_name": { "type": "string", - "description": "ナレッジベース名。" + "description": "ナレッジベースの名前。" }, "document_id": { "type": "string", "format": "uuid", - "description": "ドキュメント ID。" + "description": "ドキュメントの ID。" }, "document_name": { "type": "string", - "description": "ドキュメント名。" + "description": "ドキュメントの名前。" }, "data_source_type": { "type": "string", @@ -3130,7 +3130,7 @@ "score": { "type": "number", "format": "float", - "description": "リソースの関連性スコア。" + "description": "リソースの類似度スコア。" }, "hit_count": { "type": "integer", @@ -3262,12 +3262,12 @@ }, "type": { "type": "string", - "description": "エンドユーザーのタイプ。Service API ユーザーの場合は常に `service_api` です。" + "description": "エンドユーザータイプ。サービス API ユーザーの場合は常に `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API リクエストで提供された `user` 識別子です（例：[チャットメッセージを送信](/api-reference/チャットメッセージ/チャットメッセージを送信) の `user` フィールド）。" + "description": "API リクエストで提供された `user` 識別子（例：[チャットメッセージを送信](/api-reference/chats/send-chat-message) の `user` フィールド）。" }, "name": { "type": "string", @@ -3276,11 +3276,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "ユーザーが匿名かどうかを示します。元の API リクエストで `user` 識別子が提供されなかった場合、`true` になります。" + "description": "ユーザーが匿名かどうか。元の API リクエストで `user` 識別子が提供されなかった場合は `true`。" }, "session_id": { "type": "string", - "description": "セッション識別子。デフォルトは `external_user_id` の値です。" + "description": "セッション識別子。デフォルトは `external_user_id` の値。" }, "created_at": { "type": "string", @@ -3309,15 +3309,15 @@ null ], "nullable": true, - "description": "フィードバック評価。以前送信したフィードバックを取り消すには `null` に設定します。" + "description": "フィードバック評価。以前に送信したフィードバックを取り消すには `null` に設定します。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者が定義し、アプリケーション内での一意性を確保する必要があります。" + "description": "ユーザー識別子、開発者が定義し、アプリケーション内で一意性を確保する必要があります。" }, "content": { "type": "string", - "description": "追加の詳細を提供する任意のテキストフィードバック。" + "description": "追加の詳細を提供するオプションのテキストフィードバック。" } } }, @@ -3326,7 +3326,7 @@ "properties": { "data": { "type": "array", - "description": "フィードバック項目のリスト。", + "description": "フィードバックアイテムのリスト。", "items": { "$ref": "#/components/schemas/FeedbackItem" } @@ -3335,7 +3335,7 @@ }, "FeedbackItem": { "type": "object", - "description": "単一のフィードバック項目。", + "description": "単一のフィードバックアイテム。", "properties": { "id": { "type": "string", @@ -3364,11 +3364,11 @@ "content": { "type": "string", "nullable": true, - "description": "任意のテキストフィードバック。" + "description": "オプションのテキストフィードバック。" }, "from_source": { "type": "string", - "description": "フィードバックのソース。API 経由でエンドユーザーが送信したフィードバックの場合は `user`、コンソールから送信されたフィードバックの場合は `admin`。" + "description": "フィードバックソース。API 経由で送信されたエンドユーザーフィードバックの場合は `user`、コンソールから送信されたフィードバックの場合は `admin`。" }, "from_end_user_id": { "type": "string", @@ -3406,7 +3406,7 @@ "items": { "type": "string" }, - "description": "提案された質問のリストです。" + "description": "推奨質問のリスト。" } } }, @@ -3415,15 +3415,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "さらにメッセージがあるかどうかです。" + "description": "さらにメッセージがあるかどうか。" }, "data": { "type": "array", - "description": "メッセージのリストです。", + "description": "メッセージのリスト。", "items": { "$ref": "#/components/schemas/ConversationMessageItem" } @@ -3432,7 +3432,7 @@ }, "ConversationMessageItem": { "type": "object", - "description": "会話内の単一メッセージです。", + "description": "会話内の単一のメッセージ。", "properties": { "id": { "type": "string", @@ -3448,33 +3448,33 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "スレッド会話の親メッセージ ID です。" + "description": "スレッド会話の親メッセージ ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "このメッセージの入力変数です。" + "description": "このメッセージの入力変数。" }, "query": { "type": "string", - "description": "ユーザークエリテキストです。" + "description": "ユーザークエリテキスト。" }, "answer": { "type": "string", - "description": "アシスタントの回答テキストです。" + "description": "アシスタントの回答テキスト。" }, "status": { "type": "string", - "description": "メッセージステータスです。成功したメッセージの場合は `normal`、生成に失敗した場合は `error` です。" + "description": "メッセージステータス。成功したメッセージの場合は `normal`、生成に失敗した場合は `error`。" }, "error": { "type": "string", "nullable": true, - "description": "`status` が `error` の場合のエラーメッセージです。" + "description": "`status` が `error` の場合のエラーメッセージ。" }, "message_files": { "type": "array", - "description": "このメッセージに添付されたファイルです。", + "description": "このメッセージに添付されたファイル。", "items": { "$ref": "#/components/schemas/MessageFileItem" } @@ -3482,7 +3482,7 @@ "feedback": { "type": "object", "nullable": true, - "description": "このメッセージのユーザーフィードバックです。", + "description": "このメッセージに対するユーザーフィードバック。", "properties": { "rating": { "type": "string", @@ -3492,14 +3492,14 @@ }, "retriever_resources": { "type": "array", - "description": "このメッセージに使用された検索リソースです。", + "description": "このメッセージに使用された検索リソース。", "items": { "$ref": "#/components/schemas/RetrieverResource" } }, "agent_thoughts": { "type": "array", - "description": "このメッセージのエージェント思考です。", + "description": "このメッセージの Agent の思考。", "items": { "$ref": "#/components/schemas/AgentThoughtItem" } @@ -3511,7 +3511,7 @@ }, "extra_contents": { "type": "array", - "description": "このメッセージに関連する追加の実行コンテンツです（人間の入力フォームデータなど）。", + "description": "このメッセージに関連付けられた追加の実行コンテンツ（人間の入力フォームデータなど）。", "items": { "type": "object", "additionalProperties": true @@ -3521,20 +3521,20 @@ }, "MessageFileItem": { "type": "object", - "description": "メッセージに添付されたファイルです。", + "description": "メッセージに添付されたファイル。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "File ID." + "description": "ファイル ID。" }, "filename": { "type": "string", - "description": "元のファイル名です。" + "description": "元のファイル名。" }, "type": { "type": "string", - "description": "ファイルの種類（例: `image`）です。" + "description": "ファイルタイプ、例：`image`。" }, "url": { "type": "string", @@ -3554,72 +3554,72 @@ }, "transfer_method": { "type": "string", - "description": "使用された転送方法です。`remote_url` は URL ベースのファイル、`local_file` はアップロード済みファイル、`tool_file` はツール生成ファイルを示します。" + "description": "使用された転送方法。URL ベースのファイルの場合は `remote_url`、アップロードされたファイルの場合は `local_file`、ツールで生成されたファイルの場合は `tool_file`。" }, "belongs_to": { "type": "string", "nullable": true, - "description": "このファイルの所有者です。ユーザーがアップロードしたファイルの場合は `user`、アシスタントが生成したファイルの場合は `assistant` です。" + "description": "このファイルの所有者。ユーザーがアップロードしたファイルの場合は `user`、アシスタントが生成したファイルの場合は `assistant`。" }, "upload_file_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "`local_file` で転送された場合のアップロードファイル ID です。" + "description": "`local_file` 経由で転送された場合のアップロードファイル ID。" } } }, "AgentThoughtItem": { "type": "object", - "description": "メッセージ内のエージェント思考ステップです。", + "description": "メッセージ内の Agent 思考ステップ。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "エージェント思考 ID です。" + "description": "Agent 思考 ID。" }, "chain_id": { "type": "string", "nullable": true, - "description": "この思考のチェーン ID です。" + "description": "この思考のチェーン ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "この思考が属する一意のメッセージ ID です。" + "description": "この思考が属する一意のメッセージ ID。" }, "position": { "type": "integer", - "description": "この思考の位置です。" + "description": "この思考の位置。" }, "thought": { "type": "string", - "description": "LLM が思考している内容です。" + "description": "LLM が考えていること。" }, "tool": { "type": "string", - "description": "呼び出されたツール（`;` で区切り）です。" + "description": "呼び出されたツール、`;` で区切られています。" }, "tool_labels": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "使用されたツールのラベルです。" + "description": "使用されたツールのラベル。" }, "tool_input": { "type": "string", - "description": "ツールの入力（JSON 形式）です。" + "description": "JSON 形式のツール入力。" }, "observation": { "type": "string", - "description": "ツール呼び出しからのレスポンスです。" + "description": "ツール呼び出しからのレスポンス。" }, "files": { "type": "array", "items": { "type": "string" }, - "description": "この思考に関連するファイル ID です。" + "description": "この思考に関連するファイル ID。" }, "created_at": { "type": "integer", @@ -3633,15 +3633,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "さらに会話があるかどうかです。" + "description": "さらに会話があるかどうか。" }, "data": { "type": "array", - "description": "会話のリストです。", + "description": "会話のリスト。", "items": { "$ref": "#/components/schemas/ConversationListItem" } @@ -3658,20 +3658,20 @@ }, "name": { "type": "string", - "description": "会話名です。" + "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "会話の入力変数です。" + "description": "会話の入力変数。" }, "status": { "type": "string", - "description": "会話ステータスです。アクティブな会話の場合は `normal` です。" + "description": "会話ステータス。アクティブな会話の場合は `normal`。" }, "introduction": { "type": "string", - "description": "会話の紹介文です。" + "description": "会話の紹介。" }, "created_at": { "type": "integer", @@ -3687,20 +3687,20 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "会話の名前変更用リクエストボディです。", + "description": "会話名を変更するためのリクエストボディ。", "properties": { "name": { "type": "string", - "description": "会話の名前です。`auto_generate` が `false` の場合は必須です。" + "description": "会話の名前。`auto_generate` が `false` の場合に必要です。" }, "auto_generate": { "type": "boolean", "default": false, - "description": "会話名を自動生成します。`true` の場合、`name` フィールドは無視されます。" + "description": "会話名を自動的に生成します。`true` の場合、`name` フィールドは無視されます。" }, "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -3709,15 +3709,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "次のページがあるかどうかです。" + "description": "次のページがあるかどうか。" }, "data": { "type": "array", - "description": "会話変数のリストです。", + "description": "会話変数のリスト。", "items": { "$ref": "#/components/schemas/ConversationVariableItem" } @@ -3730,23 +3730,23 @@ "id": { "type": "string", "format": "uuid", - "description": "Variable ID." + "description": "変数 ID。" }, "name": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "value_type": { "type": "string", - "description": "変数の値の型です。指定可能な値：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" + "description": "変数値のタイプ。可能な値：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" }, "value": { "type": "string", - "description": "変数値（複雑な型の場合は JSON 文字列）。" + "description": "変数値（複雑なタイプの場合は JSON 文字列になる場合があります）。" }, "description": { "type": "string", - "description": "変数の説明です。" + "description": "変数の説明。" }, "created_at": { "type": "integer", @@ -3762,13 +3762,13 @@ }, "ConversationVariableUpdateRequest": { "type": "object", - "description": "会話変数を更新するためのリクエストボディです。", + "description": "会話変数を更新するためのリクエストボディ。", "required": [ "value" ], "properties": { "value": { - "description": "変数の新しい値。変数の期待される型と一致する必要があります。" + "description": "変数の新しい値。変数の期待されるタイプと一致する必要があります。" }, "user": { "type": "string", @@ -3778,7 +3778,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "音声からテキストへの変換のリクエストボディ。", + "description": "音声からテキストへの変換のためのリクエストボディ。", "required": [ "file" ], @@ -3786,7 +3786,7 @@ "file": { "type": "string", "format": "binary", - "description": "音声ファイルです。対応形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。上限：`30 MB`。" + "description": "音声ファイル。サポート：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。制限：`30 MB`。" }, "user": { "type": "string", @@ -3805,12 +3805,12 @@ }, "TextToAudioRequest": { "type": "object", - "description": "テキストから音声への変換のリクエストボディ。`message_id` または `text` のいずれかを指定してください。", + "description": "テキストから音声への変換のためのリクエストボディ。`message_id` または `text` のいずれかを指定してください。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "メッセージ ID です。両方が指定された場合、`text` よりも優先されます。" + "description": "メッセージ ID。両方が指定された場合は `text` より優先されます。" }, "text": { "type": "string", @@ -3822,7 +3822,7 @@ }, "voice": { "type": "string", - "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) → `text_to_speech.voice` の `voice` 値を使用してください。" + "description": "テキストから音声への変換に使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには [アプリパラメータを取得](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` の `voice` 値を使用してください。" }, "streaming": { "type": "boolean", @@ -3850,7 +3850,7 @@ }, "mode": { "type": "string", - "description": "アプリケーションモードです。`chat` は基本チャットアプリ、`agent-chat` はエージェントベースのアプリ、`advanced-chat` は chatflow アプリを示します。" + "description": "アプリケーションモード。基本チャットアプリの場合は `chat`、Agent ベースのアプリの場合は `agent-chat`、チャットフローアプリの場合は `advanced-chat`。" }, "author_name": { "type": "string", @@ -3863,14 +3863,14 @@ "properties": { "opening_statement": { "type": "string", - "description": "会話開始時に表示されるオープニングメッセージです。" + "description": "会話開始時に表示されるオープニングステートメント。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, - "description": "推奨される初期質問のリスト。" + "description": "推奨されるスターター質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", @@ -3902,21 +3902,21 @@ }, "voice": { "type": "string", - "description": "TTS の音声識別子。" + "description": "TTS 用の音声識別子。" }, "language": { "type": "string", - "description": "TTS の言語。" + "description": "TTS 用の言語。" }, "autoPlay": { "type": "string", - "description": "自動再生設定です。音声を自動再生するには `enabled`、手動再生を要求するには `disabled` を指定します。" + "description": "自動再生設定。音声を自動再生する場合は `enabled`、手動再生を要求する場合は `disabled`。" } } }, "retriever_resource": { "type": "object", - "description": "検索リソースの設定。", + "description": "検索リソース設定。", "properties": { "enabled": { "type": "boolean", @@ -3926,7 +3926,7 @@ }, "annotation_reply": { "type": "object", - "description": "アノテーション返信の設定。", + "description": "アノテーション返信設定。", "properties": { "enabled": { "type": "boolean", @@ -3936,7 +3936,7 @@ }, "more_like_this": { "type": "object", - "description": "類似コンテンツの設定。", + "description": "類似項目の設定。", "properties": { "enabled": { "type": "boolean", @@ -3946,7 +3946,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "センシティブワードフィルタリングの設定。", + "description": "センシティブワード回避設定。", "properties": { "enabled": { "type": "boolean", @@ -3963,11 +3963,11 @@ }, "file_upload": { "type": "object", - "description": "ファイルアップロードの設定。", + "description": "ファイルアップロード設定。", "properties": { "image": { "type": "object", - "description": "画像アップロードの設定。", + "description": "画像アップロード設定。", "properties": { "enabled": { "type": "boolean", @@ -4035,7 +4035,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "テキスト入力", "type": "object", "properties": { "text-input": { @@ -4044,7 +4044,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -4053,7 +4053,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "選択", "type": "object", "properties": { "select": { @@ -4063,67 +4063,67 @@ }, "TextInputControl": { "type": "object", - "description": "テキスト入力フォームコントロールです。", + "description": "テキスト入力フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "入力が必須かどうかです。" + "description": "入力が必須かどうか。" }, "default": { "type": "string", - "description": "デフォルト値です。" + "description": "デフォルト値。" } } }, "ParagraphControl": { "type": "object", - "description": "段落（複数行テキスト）フォームコントロールです。", + "description": "段落（複数行テキスト）フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "入力が必須かどうかです。" + "description": "入力が必須かどうか。" }, "default": { "type": "string", - "description": "デフォルト値です。" + "description": "デフォルト値。" } } }, "SelectControl": { "type": "object", - "description": "セレクト（ドロップダウン）フォームコントロールです。", + "description": "選択（ドロップダウン）フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "選択が必須かどうかです。" + "description": "選択が必須かどうか。" }, "default": { "type": "string", - "description": "デフォルトで選択される値。" + "description": "デフォルトの選択値。" }, "options": { "type": "array", @@ -4142,7 +4142,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコン URL", "type": "string", "format": "url", "description": "アイコンの URL。" @@ -4157,17 +4157,17 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "絵文字アイコン", "type": "object", "description": "絵文字を使用したツールアイコンの詳細。", "properties": { "background": { "type": "string", - "description": "16進数形式の背景色。" + "description": "16進形式の背景色。" }, "content": { "type": "string", - "description": "Emoji コンテンツ。" + "description": "絵文字コンテンツ。" } } }, @@ -4184,15 +4184,15 @@ }, "chat_color_theme_inverted": { "type": "boolean", - "description": "チャットカラーテーマが反転しているかどうか。" + "description": "チャットカラーテーマが反転されているかどうか。" }, "icon_type": { "type": "string", - "description": "使用されるアイコンのタイプ。`emoji` は絵文字アイコン、`image` はアップロードされた画像アイコンです。" + "description": "使用されるアイコンのタイプ。絵文字アイコンの場合は `emoji`、アップロードされた画像アイコンの場合は `image`。" }, "icon": { "type": "string", - "description": "アイコンのコンテンツ（絵文字または画像 ID）。" + "description": "アイコンコンテンツ（絵文字または画像 ID）。" }, "icon_background": { "type": "string", @@ -4242,23 +4242,23 @@ "items": { "$ref": "#/components/schemas/AnnotationItem" }, - "description": "現在のページのアノテーション項目のリストです。" + "description": "現在のページのアノテーションアイテムのリスト。" }, "has_more": { "type": "boolean", - "description": "現在の結果セットの後にさらにページがある場合は `true` です。" + "description": "現在の結果セットを超えてさらにページがある場合は `true`。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1ページあたりのアイテム数。" }, "total": { "type": "integer", - "description": "クエリに一致するアノテーションの合計数です。" + "description": "クエリに一致するアノテーションの合計数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" } } }, @@ -4268,22 +4268,22 @@ "id": { "type": "string", "format": "uuid", - "description": "アノテーションの一意識別子です。" + "description": "一意のアノテーション識別子。" }, "question": { "type": "string", "nullable": true, - "description": "このアノテーションをトリガーする質問テキストです。" + "description": "このアノテーションをトリガーする質問テキスト。" }, "answer": { "type": "string", "nullable": true, - "description": "アノテーションがマッチした際に返される定義済みの回答です。" + "description": "アノテーションが一致した場合に返される事前定義された回答。" }, "hit_count": { "type": "integer", "nullable": true, - "description": "このアノテーションがマッチして返信として返された回数です。" + "description": "このアノテーションが一致して返信として返された回数。" }, "created_at": { "type": "integer", @@ -4295,7 +4295,7 @@ }, "CreateAnnotationRequest": { "type": "object", - "description": "新しいアノテーションを作成するためのリクエストボディです。", + "description": "新しいアノテーションを作成するためのリクエストボディ。", "required": [ "question", "answer" @@ -4303,17 +4303,17 @@ "properties": { "question": { "type": "string", - "description": "アノテーションの質問です。" + "description": "アノテーションの質問。" }, "answer": { "type": "string", - "description": "アノテーションの回答です。" + "description": "アノテーションの回答。" } } }, "UpdateAnnotationRequest": { "type": "object", - "description": "アノテーション更新のリクエストボディです。", + "description": "アノテーションを更新するためのリクエストボディ。", "required": [ "question", "answer" @@ -4321,17 +4321,17 @@ "properties": { "question": { "type": "string", - "description": "更新されたアノテーションの質問です。" + "description": "更新されたアノテーションの質問。" }, "answer": { "type": "string", - "description": "更新されたアノテーションの回答です。" + "description": "更新されたアノテーションの回答。" } } }, "InitialAnnotationReplySettingsRequest": { "type": "object", - "description": "アノテーション返信設定を構成するためのリクエストボディです。", + "description": "アノテーション返信設定を構成するためのリクエストボディ。", "required": [ "score_threshold", "embedding_provider_name", @@ -4340,16 +4340,16 @@ "properties": { "embedding_provider_name": { "type": "string", - "description": "埋め込みモデルプロバイダーの名前（例：`openai`、`cohere`）です。" + "description": "埋め込みモデルプロバイダーの名前（例：`openai`、`cohere`）。" }, "embedding_model_name": { "type": "string", - "description": "アノテーションマッチングに使用する埋め込みモデルの名前です（例：`text-embedding-3-small`）。" + "description": "アノテーションマッチングに使用する埋め込みモデルの名前（例：`text-embedding-3-small`）。" }, "score_threshold": { "type": "number", "format": "float", - "description": "アノテーションがマッチとみなされるための最低類似度スコアです。値が高いほど、より正確なマッチが必要になります。", + "description": "アノテーションがマッチと見なされるための最小類似度スコア。値が高いほど、より近いマッチが必要です。", "minimum": 0, "maximum": 1 } @@ -4361,11 +4361,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "非同期ジョブ ID です。[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) と組み合わせて進捗を追跡します。" + "description": "非同期ジョブ ID。進捗を追跡するには [アノテーション返信ジョブステータスを取得](/api-reference/annotations/get-annotation-reply-job-status) と一緒に使用してください。" }, "job_status": { "type": "string", - "description": "現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed` は完了、`error` は失敗を示します。" + "description": "現在のジョブステータス。キュー中は `waiting`、進行中は `processing`、完了時は `completed`、失敗した場合は `error`。" } } }, @@ -4375,15 +4375,15 @@ "job_id": { "type": "string", "format": "uuid", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) 呼び出しから取得したジョブ ID です。" + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) 呼び出しからのジョブ ID。" }, "job_status": { "type": "string", - "description": "現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed` は完了、`error` は失敗を示します。" + "description": "現在のジョブステータス。キュー中は `waiting`、進行中は `processing`、完了時は `completed`、失敗した場合は `error`。" }, "error_msg": { "type": "string", - "description": "ジョブが失敗した理由を説明するエラーメッセージです。`job_status` が `error` でない場合は空文字列です。" + "description": "ジョブが失敗した理由を説明するエラーメッセージ。`job_status` が `error` でない場合は空の文字列。" } } } @@ -4391,36 +4391,36 @@ }, "tags": [ { - "name": "チャットメッセージ", - "description": "チャットメッセージとインタラクションに関連する操作です。" + "name": "Chats", + "description": "チャットメッセージとインタラクションに関連する操作。" }, { - "name": "ファイル操作", - "description": "ファイルのアップロードとプレビューの操作です。" + "name": "Files", + "description": "ファイルのアップロードとプレビュー操作。" }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作です。" + "name": "End Users", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "メッセージフィードバック", - "description": "ユーザーフィードバックの操作です。" + "name": "Feedback", + "description": "ユーザーフィードバック操作。" }, { - "name": "会話管理", - "description": "会話管理に関連する操作です。" + "name": "Conversations", + "description": "会話の管理に関連する操作。" }, { - "name": "音声・テキスト変換", - "description": "テキスト読み上げと音声認識の操作です。" + "name": "TTS", + "description": "テキストから音声および音声からテキストへの変換操作。" }, { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報を取得する操作です。" + "name": "Applications", + "description": "アプリケーション設定と情報を取得する操作。" }, { - "name": "アノテーション管理", - "description": "ダイレクト返信用のアノテーション管理に関連する操作です。" + "name": "Annotations", + "description": "直接返信のためのアノテーション管理に関連する操作。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index cf1c85557..96a2f1a80 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "高度なチャットアプリAPI (Chatflow API)", - "description": "Chatflow アプリケーションはセッションの永続化をサポートし、過去のチャット履歴をレスポンスのコンテキストとして使用できます。Chatflow アプリは `advanced-chat` モードを使用し、ノードの開始・完了、イテレーション、ワークフローのライフサイクルを含む詳細な実行追跡のためのワークフローレベルのストリーミングイベントを提供します。", + "title": "チャットフロー アプリ API", + "description": "チャットフローアプリケーションはセッションの永続化をサポートし、以前のチャット履歴を応答のコンテキストとして使用できます。チャットフローアプリは `advanced-chat` モードを使用し、ノードの開始、終了、イテレーション、ワークフローライフサイクルを含む詳細な実行追跡のためのワークフローレベルのストリーミングイベントを提供します。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "Chatflow アプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。", + "description": "チャットフロー アプリ API のベース URL。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -27,9 +27,9 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendChatflowMessageJp", + "operationId": "sendAdvancedChatMessage", "tags": [ - "チャットフロー" + "Chatflows" ], "requestBody": { "description": "チャットメッセージを送信するためのリクエストボディ。", @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "リクエスト成功。コンテンツタイプと構造はリクエストの `response_mode` パラメータに依存します。\n\n- `response_mode` が `blocking` の場合、 `application/json` で `ChatCompletionResponse` オブジェクトを返します。\n- `response_mode` が `streaming` の場合、 `text/event-stream` で `ChunkChatEvent` オブジェクトのストリームを返します。", + "description": "成功レスポンス。コンテンツタイプと構造は、リクエストの `response_mode` パラメータによって異なります。\n- `response_mode` が `blocking` の場合、`ChatCompletionResponse` オブジェクトを含む `application/json` を返します。\n- `response_mode` が `streaming` の場合、`ChunkChatEvent` オブジェクトのストリームを含む `text/event-stream` を返します。", "content": { "application/json": { "schema": { @@ -128,19 +128,19 @@ "text/event-stream": { "schema": { "type": "string", - "description": "Server-Sent Events (SSE) のストリーム。\n\n**パース**：各行は `data: ` で始まり JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを除去し、`event` フィールドを読み取ってイベントタイプを判定してください。`ping` イベント（接続維持のため 10 秒ごとに送信）は無視してください。\n\n**ストリームライフサイクル**：`message_end` はチャットメッセージの終了を示しますが、ストリームはワークフローライフサイクルイベントを送信し続けます。`workflow_finished`、`workflow_paused`、または `error` を受信するとストリームが閉じます。エラーはストリーム内の `error` イベントとして HTTP ステータス `200` で配信されます。ステータスコードではなくイベントペイロードを確認して詳細を取得してください。\n\n**人間の入力イベント**：\n- `human_input_required`：ワークフローが人間の入力ノードに到達した際に `workflow_paused` と同時に発行されます。ペイロードの `form_token` を使用して、[人間の入力 API](/api-reference/人間の入力/人間の入力フォームを取得) でフォーム処理を進めます。\n- `human_input_form_filled`：受信者がフォームを送信し、ワークフロー実行が再開されます。\n- `human_input_form_timeout`：応答がないままフォームが期限切れ。タイムアウトのフォールバックエッジが定義されている場合、ワークフローはそのエッジを通って実行されます。" + "description": "Server-Sent Events (SSE) のストリーム。\n**パース方法**: 各行は `data: ` で始まり、その後に JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを削除し、`event` フィールドを読み取ってイベントタイプを判断します。接続を維持するために 10 秒ごとに発火する `ping` イベントは無視してください。\n**ストリームライフサイクル**: `message_end` はチャットメッセージの終了を示しますが、ストリームはワークフローライフサイクルイベントで継続します。`workflow_finished`、`workflow_paused`、または `error` を受信するとストリームが閉じます。エラーは HTTP ステータス `200` でストリーム内に配信されます。ステータスコードに依存せず、イベントペイロードで詳細を確認してください。\n**Human Input イベント**:\n- `human_input_required`: ワークフローが人間の入力ノードに到達すると `workflow_paused` と一緒に発火します。ペイロードの `form_token` を使用して [Human Input API](/api-reference/human-input/get-human-input-form) 経由でフォーム処理フローを進めてください。\n- `human_input_form_filled`: 受信者がフォームを送信しました。ワークフローの実行が再開されます。\n- `human_input_form_timeout`: フォームが応答なしで期限切れになりました。タイムアウトフォールバックエッジが定義されている場合、ワークフローはそれに従います。" }, "examples": { "streamingResponseBasic": { - "summary": "Response Example - Streaming (Basic)", + "summary": "レスポンス例 - ストリーミング（基本）", "value": "data: {\"event\": \"message\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"answer\": \" I\", \"created_at\": 1679586595} data: {\"event\": \"message_end\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"metadata\": {\"usage\": {\"total_tokens\": 10, \"latency\": 1.0}}}" }, "streamingResponseWorkflow": { - "summary": "Response Example - Streaming (Workflow)", + "summary": "レスポンス例 - ストリーミング（ワークフロー）", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"wfr_abc123\", \"workflow_id\": \"wf_def456\", \"inputs\": {\"city\": \"San Francisco\"}, \"created_at\": 1705395332}} data: {\"event\": \"node_started\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"ne_001\", \"node_id\": \"node_llm_1\", \"node_type\": \"llm\", \"title\": \"LLM\", \"index\": 1, \"created_at\": 1705395332}} data: {\"event\": \"message\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"answer\": \" I\", \"created_at\": 1705395333} data: {\"event\": \"node_finished\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"ne_001\", \"node_id\": \"node_llm_1\", \"node_type\": \"llm\", \"title\": \"LLM\", \"index\": 1, \"status\": \"succeeded\", \"elapsed_time\": 1.5, \"created_at\": 1705395332, \"finished_at\": 1705395334}} data: {\"event\": \"message_end\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"metadata\": {\"usage\": {\"total_tokens\": 50, \"latency\": 2.5}}} data: {\"event\": \"workflow_finished\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"wfr_abc123\", \"workflow_id\": \"wf_def456\", \"status\": \"succeeded\", \"elapsed_time\": 2.5, \"total_tokens\": 50, \"total_steps\": 2, \"created_at\": 1705395332, \"finished_at\": 1705395335}}" }, "humanInputPause": { - "summary": "レスポンス例 - 人間の入力での一時停止", + "summary": "レスポンス例 - 人間の入力一時停止", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"inputs\": {\"draft\": \"Hello\"}, \"created_at\": 1705407629, \"reason\": \"initial\"}} data: {\"event\": \"human_input_required\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"form_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"form_token\": \"tok_abc123\", \"node_id\": \"approval_node\", \"node_title\": \"Approval\", \"form_content\": \"Please review the draft.\", \"inputs\": [{\"type\": \"text_input\", \"output_variable_name\": \"comment\", \"default\": null}], \"actions\": [{\"id\": \"approve\", \"title\": \"Approve\", \"button_style\": \"primary\"}], \"display_in_ui\": false, \"resolved_default_values\": {\"comment\": \"\"}, \"expiration_time\": 1705494029}} data: {\"event\": \"workflow_paused\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"status\": \"paused\", \"created_at\": 1705407629, \"elapsed_time\": 0.5}}" } } @@ -148,7 +148,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `not_chat_app` : App mode does not match the API route.\n- `conversation_completed` : The conversation has ended.\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。\n- `bad_request` : Cannot use draft workflow version.\n- `bad_request` : Invalid `workflow_id` format.", + "description": "- `app_unavailable` : アプリが利用不可または設定ミスです。\n- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `conversation_completed` : 会話が終了しました。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルが利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。\n- `bad_request` : ドラフトワークフローバージョンは使用できません。\n- `bad_request` : `workflow_id` の形式が無効です。", "content": { "application/json": { "examples": { @@ -254,7 +254,7 @@ } }, "429": { - "description": "- `too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームのモデルプロバイダーのレート制限を超えました。", + "description": "- `too_many_requests` : このアプリへの同時リクエストが多すぎます。\n- `rate_limit_error` : 上流のモデルプロバイダーのレート制限を超過しました。", "content": { "application/json": { "examples": { @@ -300,18 +300,18 @@ }, "/chat-messages/{task_id}/stop": { "post": { - "summary": "生成を停止", - "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされます。", - "operationId": "stopChatflowMessageGenerationJp", + "summary": "チャットメッセージ生成を停止", + "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされています。", + "operationId": "stopAdvancedChatMessageGeneration", "tags": [ - "チャットフロー" + "Chatflows" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "タスク ID です。[チャットメッセージを送信](/api-reference/チャットフロー/チャットメッセージを送信) API のストリーミングチャンクレスポンスから取得できます。", + "description": "タスク ID。[チャットメッセージを送信](/api-reference/chatflows/send-chat-message) API のストリーミングチャンクレスポンスから取得できます。", "schema": { "type": "string" } @@ -329,7 +329,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡された user と一致する必要があります。" + "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" } } }, @@ -370,11 +370,11 @@ }, "/messages/{message_id}/suggested": { "get": { - "summary": "次の推奨質問を取得", + "summary": "次の提案質問を取得", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getChatflowSuggestedQuestionsJp", + "operationId": "getAdvancedSuggestedQuestions", "tags": [ - "チャットフロー" + "Chatflows" ], "parameters": [ { @@ -398,7 +398,7 @@ ], "responses": { "200": { - "description": "提案された質問の取得に成功しました。", + "description": "提案質問の取得に成功しました。", "content": { "application/json": { "schema": { @@ -421,7 +421,7 @@ } }, "400": { - "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 推奨質問機能が無効です。", + "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 提案質問機能が無効になっています。", "content": { "application/json": { "examples": { @@ -484,14 +484,14 @@ }, "/files/upload": { "post": { - "operationId": "uploadChatflowFileJp", + "operationId": "uploadAdvancedChatFile", "tags": [ - "ファイル操作" + "Files" ], "summary": "ファイルをアップロード", - "description": "メッセージ送信時に使用するファイルをアップロードします。画像、ドキュメント、音声、動画のマルチモーダル理解が可能です。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", + "description": "メッセージ送信時に使用するファイルをアップロードし、画像、ドキュメント、音声、ビデオのマルチモーダル理解を可能にします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "requestBody": { - "description": "ファイルアップロードリクエスト。multipart/form-data 形式が必要です。", + "description": "ファイルアップロードリクエスト。multipart/form-data が必要です。", "required": true, "content": { "multipart/form-data": { @@ -504,7 +504,7 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイル。サポートされるタイプには画像、ドキュメント、音声、動画が含まれます。" + "description": "アップロードするファイル。サポートされているタイプには、画像、ドキュメント、音声、ビデオが含まれます。" }, "user": { "type": "string", @@ -517,7 +517,7 @@ }, "responses": { "201": { - "description": "ファイルが正常にアップロードされました。", + "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { @@ -548,7 +548,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : リクエストにファイルが提供されていません。\n- `too_many_files` : 1 回のリクエストにつき 1 ファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", + "description": "- `no_file_uploaded` : リクエストにファイルが含まれていません。\n- `too_many_files` : リクエストごとに 1 つのファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", "content": { "application/json": { "examples": { @@ -581,7 +581,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズを超過しました。", "content": { "application/json": { "examples": { @@ -598,7 +598,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプが許可されていません。", "content": { "application/json": { "examples": { @@ -619,18 +619,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "previewChatflowFileJp", + "operationId": "previewChatFlowFile", "tags": [ - "ファイル操作" + "Files" ], "summary": "ファイルをダウンロード", - "description": "以前[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", + "description": "[ファイルをアップロード](/api-reference/files/upload-file) API 経由で以前アップロードしたファイルをプレビューまたはダウンロードします。ファイルは、リクエストするアプリケーション内のメッセージに属している場合にのみアクセスできます。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "プレビューするファイルの一意の識別子です。[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API のレスポンスから取得します。", + "description": "プレビューするファイルの一意の識別子。[ファイルをアップロード](/api-reference/files/upload-file) API レスポンスから取得します。", "schema": { "type": "string", "format": "uuid" @@ -640,7 +640,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "`true` の場合、ブラウザでプレビューする代わりにファイルを添付ファイルとして強制ダウンロードします。", + "description": "`true` の場合、ブラウザでプレビューする代わりに添付ファイルとして強制的にダウンロードします。", "schema": { "type": "boolean", "default": false @@ -650,7 +650,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子。エンドユーザーのコンテキストに使用されます。", + "description": "ユーザー識別子。エンドユーザーコンテキストに使用されます。", "schema": { "type": "string" } @@ -658,7 +658,7 @@ ], "responses": { "200": { - "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` としてダウンロード形式で返されます。", + "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` でダウンロードとして返されます。", "content": { "application/octet-stream": { "schema": { @@ -686,7 +686,7 @@ } }, "404": { - "description": "`file_not_found` : リクエストされたファイルが見つかりません。", + "description": "`file_not_found` : リクエストされたファイルが見つかりませんでした。", "content": { "application/json": { "examples": { @@ -707,12 +707,12 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserChatflowJp", + "operationId": "getEndUserChatflow", "tags": [ - "エンドユーザー" + "End Users" ], - "summary": "エンドユーザー取得", - "description": "ID を指定してエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード)の `created_by`）に便利です。", + "summary": "エンドユーザー情報を取得", + "description": "ID でエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合に便利です（例：[ファイルをアップロード](/api-reference/files/upload-file) の `created_by`）。", "parameters": [ { "name": "end_user_id", @@ -727,7 +727,7 @@ ], "responses": { "200": { - "description": "エンドユーザーを正常に取得しました。", + "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { "schema": { @@ -775,12 +775,12 @@ }, "/messages/{message_id}/feedbacks": { "post": { - "operationId": "postChatflowMessageFeedbackJp", + "operationId": "postAdvancedChatMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "summary": "メッセージフィードバックを送信", - "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` で評価でき、任意でテキストフィードバックを提供できます。`rating` に `null` を渡すと、以前送信したフィードバックを取り消せます。", + "description": "メッセージのフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` として評価でき、オプションでテキストフィードバックを提供できます。以前に送信したフィードバックを取り消すには、`rating` に `null` を渡します。", "parameters": [ { "name": "message_id", @@ -838,12 +838,12 @@ }, "/app/feedbacks": { "get": { - "operationId": "getChatflowAppFeedbacksJp", + "operationId": "getAdvancedChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], - "summary": "アプリのフィードバック一覧を取得", - "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者のフィードバックの両方が含まれます。", + "summary": "アプリフィードバック一覧", + "description": "このアプリケーションのメッセージに送信されたすべてのフィードバックのページネーションされたリストを取得します。エンドユーザーと管理者の両方のフィードバックが含まれます。", "parameters": [ { "name": "page", @@ -859,7 +859,7 @@ { "name": "limit", "in": "query", - "description": "1ページあたりのレコード数。", + "description": "ページあたりのレコード数。", "required": false, "schema": { "type": "integer", @@ -920,11 +920,11 @@ }, "/conversations": { "get": { - "summary": "会話一覧を取得", + "summary": "会話一覧", "description": "現在のユーザーの会話リストを、最近アクティブな順に取得します。", - "operationId": "getChatflowConversationsListJp", + "operationId": "getAdvancedConversationsList", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -940,7 +940,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページネーション用）。", "schema": { "type": "string" } @@ -949,7 +949,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -961,7 +961,7 @@ "name": "sort_by", "in": "query", "required": false, - "description": "ソートフィールドです。降順にするには '-' プレフィックスを使用します。", + "description": "ソートフィールド。降順には '-' プレフィックスを使用します。", "schema": { "type": "string", "enum": [ @@ -1025,7 +1025,7 @@ } }, "404": { - "description": "`not_found` : 前の会話が存在しません（無効な `last_id`）。", + "description": "`not_found` : 最後の会話が存在しません（無効な `last_id`）。", "content": { "application/json": { "examples": { @@ -1046,11 +1046,11 @@ }, "/messages": { "get": { - "summary": "会話履歴メッセージ一覧を取得", - "description": "スクロール読み込み形式で過去のチャット記録を返します。最初のページは最新の `limit` 件のメッセージを返します（時系列の逆順）。", - "operationId": "getChatflowConversationHistoryJp", + "summary": "会話メッセージ一覧", + "description": "スクロールロード形式でチャット履歴を返します。最初のページは最新の `limit` 件のメッセージを返します。つまり、逆順です。", + "operationId": "getAdvancedConversationHistory", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1075,7 +1075,7 @@ "name": "first_id", "in": "query", "required": false, - "description": "現在のページの最初のチャット記録の ID です。デフォルトは `null`（最新のメッセージを取得）です。次のページを取得するには、現在のリストの最初のメッセージの ID を使用して、より古いメッセージを取得します。", + "description": "現在のページの最初のチャットレコードの ID。デフォルトは `null`（最新のメッセージを取得）。以降のページでは、現在のリストの最初のメッセージの ID を使用して古いメッセージを取得します。", "schema": { "type": "string" } @@ -1084,7 +1084,7 @@ "name": "limit", "in": "query", "required": false, - "description": "リクエストごとに返すチャット履歴メッセージの数です。", + "description": "リクエストごとに返すチャット履歴メッセージの数。", "schema": { "type": "integer", "default": 20, @@ -1181,11 +1181,11 @@ }, "/conversations/{conversation_id}/variables": { "get": { - "summary": "会話変数の取得", + "summary": "会話変数一覧", "description": "特定の会話から変数を取得します。", - "operationId": "getChatflowConversationVariablesJp", + "operationId": "getAdvancedConversationVariables", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1201,7 +1201,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子です。", + "description": "ユーザー識別子。", "schema": { "type": "string" } @@ -1210,7 +1210,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページネーション用）。", "schema": { "type": "string" } @@ -1219,7 +1219,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -1231,7 +1231,7 @@ "name": "variable_name", "in": "query", "required": false, - "description": "指定した名前で変数をフィルタリングします。", + "description": "特定の名前で変数をフィルタリングします。", "schema": { "type": "string", "minLength": 1, @@ -1310,10 +1310,10 @@ "/conversations/{conversation_id}/name": { "post": { "summary": "会話の名前を変更", - "description": "会話の名前を変更するか、自動的に生成します。会話名は複数の会話をサポートするクライアントでの表示に使用されます。", - "operationId": "renameChatflowConversationJp", + "description": "会話の名前を変更するか、名前を自動生成します。会話名は、複数の会話をサポートするクライアントでの表示に使用されます。", + "operationId": "renameAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1347,7 +1347,7 @@ }, "responses": { "200": { - "description": "会話が正常に名前変更されました。", + "description": "会話名の変更に成功しました。", "content": { "application/json": { "schema": { @@ -1413,9 +1413,9 @@ "put": { "summary": "会話変数を更新", "description": "特定の会話変数の値を更新します。値は期待される型と一致する必要があります。", - "operationId": "updateChatflowConversationVariableJa", + "operationId": "updateChatflowConversationVariable", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1432,7 +1432,7 @@ "name": "variable_id", "in": "path", "required": true, - "description": "Variable ID.", + "description": "変数 ID。", "schema": { "type": "string", "format": "uuid" @@ -1460,7 +1460,7 @@ }, "responses": { "200": { - "description": "変数が正常に更新されました。", + "description": "変数の更新に成功しました。", "content": { "application/json": { "schema": { @@ -1540,9 +1540,9 @@ "delete": { "summary": "会話を削除", "description": "会話を削除します。", - "operationId": "deleteChatflowConversationJp", + "operationId": "deleteAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1564,7 +1564,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -1622,12 +1622,12 @@ }, "/audio-to-text": { "post": { - "operationId": "chatflowAudioToTextJp", + "operationId": "advancedAudioToText", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "音声をテキストに変換", - "description": "音声ファイルをテキストに変換します。サポートされる形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズの上限は `30 MB` です。", + "description": "音声ファイルをテキストに変換します。サポートされている形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズ制限は `30 MB` です。", "requestBody": { "required": true, "content": { @@ -1658,7 +1658,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用不可または設定ミスです。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルがこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -1723,7 +1723,7 @@ } }, "413": { - "description": "`audio_too_large` : 音声ファイルサイズが上限を超えています。", + "description": "`audio_too_large` : 音声ファイルサイズが制限を超えました。", "content": { "application/json": { "examples": { @@ -1740,7 +1740,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 許可されていない音声タイプです。", + "description": "`unsupported_audio_type` : 音声タイプが許可されていません。", "content": { "application/json": { "examples": { @@ -1778,9 +1778,9 @@ }, "/text-to-audio": { "post": { - "operationId": "chatflowTextToAudioJp", + "operationId": "advancedTextToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "テキストを音声に変換", "description": "テキストを音声に変換します。", @@ -1807,7 +1807,7 @@ }, "responses": { "200": { - "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声の MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", + "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声 MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", "content": { "audio/mpeg": { "schema": { @@ -1818,7 +1818,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用不可または設定ミスです。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルがこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -1888,12 +1888,12 @@ }, "/info": { "get": { - "operationId": "getChatflowAppInfoJp", + "operationId": "getAdvancedChatAppInfo", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションの基本情報を取得", - "description": "このアプリケーションの基本情報（名前、説明、タグ、モード）を取得します。", + "summary": "アプリ情報を取得", + "description": "このアプリケーションの基本情報（名前、説明、タグ、モードを含む）を取得します。", "responses": { "200": { "description": "アプリケーションの基本情報。", @@ -1925,12 +1925,12 @@ }, "/parameters": { "get": { - "operationId": "getChatflowAppParametersJp", + "operationId": "getAdvancedChatAppParameters", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのパラメータ情報を取得", - "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。", + "summary": "アプリパラメータを取得", + "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、型、デフォルト値を含む）を取得します。", "responses": { "200": { "description": "アプリケーションパラメータ情報。", @@ -2007,7 +2007,7 @@ } }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用不可または設定ミスです。", "content": { "application/json": { "examples": { @@ -2028,15 +2028,15 @@ }, "/meta": { "get": { - "operationId": "getChatflowAppMetaJp", + "operationId": "getAdvancedChatAppMeta", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのメタ情報を取得", - "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細）を取得します。", + "summary": "アプリメタを取得", + "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細を含む）を取得します。", "responses": { "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", + "description": "アプリケーションメタ情報の取得に成功しました。", "content": { "application/json": { "schema": { @@ -2064,12 +2064,12 @@ }, "/site": { "get": { - "operationId": "getChatflowWebAppSettingsJp", + "operationId": "getAdvancedChatWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", + "summary": "アプリ WebApp 設定を取得", + "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプションを含む）を取得します。", "responses": { "200": { "description": "アプリケーションの WebApp 設定。", @@ -2125,10 +2125,10 @@ "/apps/annotations": { "post": { "summary": "アノテーションを作成", - "description": "新しいアノテーションを作成します。アノテーションは、アプリがレスポンスを生成する代わりに直接マッチして返すことができる、事前定義された質問と回答のペアを提供します。", - "operationId": "createChatflowAnnotationJa", + "description": "新しいアノテーションを作成します。アノテーションは、アプリがマッチして応答を生成する代わりに直接返すことができる定義済みの質問と回答のペアを提供します。", + "operationId": "createAdvancedAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "requestBody": { "required": true, @@ -2151,7 +2151,7 @@ }, "responses": { "201": { - "description": "アノテーションが正常に作成されました。", + "description": "アノテーションの作成に成功しました。", "content": { "application/json": { "schema": { @@ -2175,11 +2175,11 @@ } }, "get": { - "summary": "アノテーションリストを取得", - "description": "アプリケーションのアノテーションをページネーションリストで取得します。キーワード検索によるフィルタリングをサポートしています。", - "operationId": "listChatflowAnnotationsJa", + "summary": "アノテーション一覧", + "description": "アプリケーションのアノテーションのページネーションされたリストを取得します。キーワード検索フィルタリングをサポートしています。", + "operationId": "getAdvancedAnnotationList", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { @@ -2195,7 +2195,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "ページあたりのアイテム数。", "required": false, "schema": { "type": "integer", @@ -2205,7 +2205,7 @@ { "name": "keyword", "in": "query", - "description": "質問または回答の内容でアノテーションをフィルタリングするためのキーワードです。", + "description": "質問または回答の内容でアノテーションをフィルタリングするキーワード。", "required": false, "schema": { "type": "string" @@ -2250,16 +2250,16 @@ "put": { "summary": "アノテーションを更新", "description": "既存のアノテーションの質問と回答を更新します。", - "operationId": "updateChatflowAnnotationJa", + "operationId": "updateAdvancedAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "annotation_id", "in": "path", "required": true, - "description": "更新するアノテーションの一意の識別子です。", + "description": "更新するアノテーションの一意の識別子。", "schema": { "type": "string", "format": "uuid" @@ -2287,7 +2287,7 @@ }, "responses": { "200": { - "description": "アノテーションが正常に更新されました。", + "description": "アノテーションの更新に成功しました。", "content": { "application/json": { "schema": { @@ -2309,7 +2309,7 @@ } }, "403": { - "description": "`forbidden` : アノテーションを編集する権限がありません。", + "description": "`forbidden` : アノテーションを編集する権限が不足しています。", "content": { "application/json": { "examples": { @@ -2346,17 +2346,17 @@ }, "delete": { "summary": "アノテーションを削除", - "description": "アノテーションとその関連するヒット履歴を削除します。", - "operationId": "deleteChatflowAnnotationJa", + "description": "アノテーションとその関連ヒット履歴を削除します。", + "operationId": "deleteAdvancedAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "annotation_id", "in": "path", "required": true, - "description": "削除するアノテーションの一意の識別子です。", + "description": "削除するアノテーションの一意の識別子。", "schema": { "type": "string", "format": "uuid" @@ -2365,10 +2365,10 @@ ], "responses": { "204": { - "description": "アノテーションが正常に削除されました。" + "description": "アノテーションの削除に成功しました。" }, "403": { - "description": "`forbidden` : アノテーションを編集する権限がありません。", + "description": "`forbidden` : アノテーションを編集する権限が不足しています。", "content": { "application/json": { "examples": { @@ -2407,17 +2407,17 @@ "/apps/annotation-reply/{action}": { "post": { "summary": "アノテーション返信を設定", - "description": "アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) で進捗を追跡します。", - "operationId": "setChatflowAnnotationReplyJa", + "description": "アノテーション返信機能を有効または無効にします。有効にする際は埋め込みモデルの設定が必要です。非同期で実行されます。進行状況を追跡するには [アノテーション返信ジョブステータスを取得](/api-reference/annotations/get-annotation-reply-job-status) を使用してください。", + "operationId": "initialAdvancedAnnotationReplySettings", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "実行するアクションです。", + "description": "実行するアクション。", "schema": { "type": "string", "enum": [ @@ -2472,18 +2472,18 @@ }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { - "summary": "アノテーション返信の初期設定タスクステータスを取得", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) で開始された非同期アノテーション返信設定ジョブのステータスを取得します。", - "operationId": "getChatflowAnnotationReplyStatusJa", + "summary": "アノテーション返信ジョブステータスを取得", + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) で開始された非同期アノテーション返信設定ジョブのステータスを取得します。", + "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "アクションタイプです。[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) の呼び出しと一致する必要があります。", + "description": "アクションタイプ。[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) 呼び出しと一致する必要があります。", "schema": { "type": "string", "enum": [ @@ -2496,7 +2496,7 @@ "name": "job_id", "in": "path", "required": true, - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) から返されたジョブ ID です。", + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) から返されたジョブ ID。", "schema": { "type": "string", "format": "uuid" @@ -2547,17 +2547,17 @@ "/workflows/run/{workflow_run_id}": { "get": { "summary": "ワークフロー実行詳細を取得", - "description": "ワークフロー実行 ID に基づいて、ワークフロータスクの現在の実行結果を取得します。", - "operationId": "getChatflowWorkflowRunDetailJa", + "description": "ワークフロー実行 ID に基づいてワークフロータスクの現在の実行結果を取得します。", + "operationId": "getChatflowWorkflowRunDetail", "tags": [ - "チャットフロー" + "Chatflows" ], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, - "description": "ワークフロー実行 ID です。ストリーミングイベントまたはメッセージメタデータから取得できます。", + "description": "ワークフロー実行 ID。ストリーミングイベントまたはメッセージメタデータから取得できます。", "schema": { "type": "string" } @@ -2565,7 +2565,7 @@ ], "responses": { "200": { - "description": "ワークフロー実行の詳細の取得に成功しました。", + "description": "ワークフロー実行詳細の取得に成功しました。", "content": { "application/json": { "schema": { @@ -2614,7 +2614,7 @@ } }, "404": { - "description": "`not_found` : ワークフロー実行記録が見つかりません。", + "description": "`not_found` : ワークフロー実行が見つかりません。", "content": { "application/json": { "examples": { @@ -2635,17 +2635,17 @@ }, "/workflows/logs": { "get": { - "summary": "ワークフローログ一覧を取得", - "description": "フィルタリングオプション付きでワークフロー実行ログをページネーションで取得します。", - "operationId": "listChatflowWorkflowLogsJa", + "summary": "ワークフローログ一覧", + "description": "フィルタリングオプション付きでページネーションされたワークフロー実行ログを取得します。", + "operationId": "listChatflowWorkflowLogs", "tags": [ - "チャットフロー" + "Chatflows" ], "parameters": [ { "name": "keyword", "in": "query", - "description": "ログ内を検索するキーワードです。", + "description": "ログ内を検索するキーワード。", "schema": { "type": "string" } @@ -2653,7 +2653,7 @@ { "name": "status", "in": "query", - "description": "実行ステータスでフィルタリングします。", + "description": "実行ステータスでフィルタリング。", "schema": { "type": "string", "enum": [ @@ -2677,7 +2677,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "ページあたりのアイテム数。", "schema": { "type": "integer", "default": 20, @@ -2688,7 +2688,7 @@ { "name": "created_at__before", "in": "query", - "description": "この ISO 8601 タイムスタンプ以前に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより前に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -2697,7 +2697,7 @@ { "name": "created_at__after", "in": "query", - "description": "この ISO 8601 タイムスタンプ以降に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより後に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -2706,7 +2706,7 @@ { "name": "created_by_end_user_session_id", "in": "query", - "description": "エンドユーザーセッション ID でフィルタリングします。", + "description": "エンドユーザーセッション ID でフィルタリング。", "schema": { "type": "string" } @@ -2714,7 +2714,7 @@ { "name": "created_by_account", "in": "query", - "description": "アカウント ID でフィルタリングします。", + "description": "アカウント ID でフィルタリング。", "schema": { "type": "string" } @@ -2775,10 +2775,10 @@ "/form/human_input/{form_token}": { "get": { "tags": [ - "人間の入力" + "Human Input" ], "summary": "人間の入力フォームを取得", - "description": "`human_input_required` イベントの `form_token` を用いて、一時停止中の人間の入力フォームの内容を取得します。**WebApp** 配信が必要です。", + "description": "`human_input_required` イベントからの `form_token` を使用して、一時停止中の人間の入力フォームの内容を取得します。**WebApp** 配信が必要です。", "operationId": "getChatflowHumanInputForm", "parameters": [ { @@ -2788,7 +2788,7 @@ "schema": { "type": "string" }, - "description": "一時停止フォームのアクセストークン。ストリーミングモードで [チャットメッセージを送信](/api-reference/チャットフロー/チャットメッセージを送信) が返す `human_input_required` イベントから取得します。" + "description": "一時停止中のフォームのアクセストークン。ストリーミングモードの [チャットメッセージを送信](/api-reference/chatflows/send-chat-message) からの `human_input_required` イベントで返されます。" } ], "responses": { @@ -2801,7 +2801,7 @@ "properties": { "form_content": { "type": "string", - "description": "ワークフロー変数が置換された、事前レンダリング済みのフォーム本文。" + "description": "ワークフロー変数が代入された事前レンダリングされたフォーム本文。" }, "inputs": { "type": "array", @@ -2810,27 +2810,27 @@ "properties": { "type": { "type": "string", - "description": "フォーム入力コントロールの種類。使用可能な値：`text_input`（単一行テキスト）と `paragraph`（複数行テキスト）。" + "description": "フォーム入力コントロールタイプ。利用可能な値：`text_input`（単一行テキストフィールド）および `paragraph`（複数行テキストエリア）。" }, "output_variable_name": { "type": "string", - "description": "この入力の送信値をワークフロー内で参照する変数名。送信時の `inputs` オブジェクトのキーに対応します。" + "description": "ワークフロー内でこの入力の送信値を参照するために使用される変数名。送信 `inputs` オブジェクトのキーに対応します。" }, "default": { "type": "object", "nullable": true, - "description": "ワークフローコンテキストから解決されるデフォルト値。デフォルトが設定されていない場合は `null`。", + "description": "ワークフローコンテキストから解決されたデフォルト値。デフォルトが設定されていない場合は `null`。", "properties": { "type": { "type": "string", - "description": "デフォルト値のソース。`constant` は `value` をリテラル文字列として使用します。`variable` は `selector` がワークフロー変数を指します。" + "description": "デフォルトのソース。`constant` は `value` がリテラル文字列として使用されることを意味します。`variable` は `selector` がワークフロー変数を指していることを意味します。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 要素を含みます。" + "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 つの要素を含む必要があります。" }, "value": { "type": "string", @@ -2847,7 +2847,7 @@ "additionalProperties": { "type": "string" }, - "description": "事前入力デフォルト値。入力の `output_variable_name` をキーとします。すべての値は文字列化されます。" + "description": "入力 `output_variable_name` をキーとする事前入力されたデフォルト値。すべての値は文字列化されています。" }, "user_actions": { "type": "array", @@ -2858,16 +2858,16 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "アクションボタンの識別子。受信者がこのボタンを選択したら、`action` として [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡します。" + "description": "アクションボタンの識別子。受信者がこのボタンを選択した場合、[人間の入力フォームを送信](/api-reference/human-input/submit-human-input-form) で `action` として渡します。" }, "title": { "type": "string", "maxLength": 100, - "description": "受信者に表示されるボタンのラベル。" + "description": "受信者に表示されるボタンラベル。" }, "button_style": { "type": "string", - "description": "ボタンの視覚スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" + "description": "ボタンの視覚的スタイル。利用可能な値：`primary`、`default`、`accent`、`ghost`。" } } }, @@ -2876,7 +2876,7 @@ "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。これを過ぎるとフォームは送信できなくなります。" + "description": "このフォームが送信できなくなる Unix タイムスタンプ（秒）。" } } }, @@ -2902,12 +2902,12 @@ "user_actions": [ { "id": "approve", - "title": "Approve", + "title": "承認", "button_style": "primary" }, { "id": "reject", - "title": "Request changes", + "title": "変更をリクエスト", "button_style": "default" } ], @@ -2919,7 +2919,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found` : フォームが見つかりません。", "content": { "application/json": { "examples": { @@ -2936,7 +2936,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted` : フォームは既に送信されています。フォームは一回限りです。どのユーザーが送信しても最初のレスポンスが優先されます。\n- `human_input_form_expired` : 送信前にフォームの有効期限が切れました。", "content": { "application/json": { "examples": { @@ -2964,10 +2964,10 @@ }, "post": { "tags": [ - "人間の入力" + "Human Input" ], "summary": "人間の入力フォームを送信", - "description": "一時停止中の人間の入力フォームに対する受信者の応答を送信します。フォームが受理されるとワークフローが再開するため、後続のイベントは [ワークフローイベントをストリーム](/api-reference/チャットフロー/ワークフローイベントをストリーム) で受信してください。**WebApp** 配信が必要です。", + "description": "一時停止中の人間の入力フォームに対する受信者のレスポンスを送信します。受け入れられるとワークフローが再開されます。後続のイベントを追跡するには [ワークフローイベントをストリーム](/api-reference/chatflows/stream-workflow-events) を使用してください。**WebApp** 配信が必要です。", "operationId": "submitChatflowHumanInputForm", "parameters": [ { @@ -2977,7 +2977,7 @@ "schema": { "type": "string" }, - "description": "一時停止フォームのアクセストークン。ストリーミングモードで [チャットメッセージを送信](/api-reference/チャットフロー/チャットメッセージを送信) が返す `human_input_required` イベントから取得します。" + "description": "一時停止中のフォームのアクセストークン。ストリーミングモードの [チャットメッセージを送信](/api-reference/chatflows/send-chat-message) からの `human_input_required` イベントで返されます。" } ], "requestBody": { @@ -2995,11 +2995,11 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "受信者が提供した値。入力の `output_variable_name` をキーとします。" + "description": "入力 `output_variable_name` をキーとする受信者が提供した値。" }, "action": { "type": "string", - "description": "受信者が選択したアクションボタンの ID。[人間の入力フォームを取得](/api-reference/人間の入力/人間の入力フォームを取得) で返される `user_actions` リストに含まれるいずれかの `id` 値と一致する必要があります。", + "description": "受信者が選択したアクションボタンの ID。フォームの `user_actions` リスト（[人間の入力フォームを取得](/api-reference/human-input/get-human-input-form) から返される）の `id` 値のいずれかと一致する必要があります。", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, @@ -3026,7 +3026,7 @@ }, "responses": { "200": { - "description": "フォームの送信に成功しました。レスポンスボディは空オブジェクトです。", + "description": "フォームの送信に成功しました。レスポンスボディは空のオブジェクトです。", "content": { "application/json": { "schema": { @@ -3042,7 +3042,7 @@ } }, "400": { - "description": "- `bad_request` : Form recipient type is invalid.\n- `invalid_form_data` : Submission failed validation against the form definition.", + "description": "- `bad_request` : フォーム受信者タイプが無効です。\n- `invalid_form_data` : 送信がフォーム定義の検証に失敗しました。", "content": { "application/json": { "examples": { @@ -3067,7 +3067,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found` : フォームが見つかりません。", "content": { "application/json": { "examples": { @@ -3084,7 +3084,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted` : フォームは既に送信されています。フォームは一回限りです。どのユーザーが送信しても最初のレスポンスが優先されます。\n- `human_input_form_expired` : 送信前にフォームの有効期限が切れました。", "content": { "application/json": { "examples": { @@ -3114,10 +3114,10 @@ "/workflow/{task_id}/events": { "get": { "tags": [ - "チャットフロー" + "Chatflows" ], "summary": "ワークフローイベントをストリーム", - "description": "一時停止後または元の SSE 接続が切断された後にワークフロー実行の Server-Sent Events ストリームを再開します。すでに完了している実行に対しては、`workflow_finished` イベントを 1 つ送信してストリームを閉じます。", + "description": "一時停止または SSE 接続が切断された後のワークフロー実行の Server-Sent Events ストリームを再開します。既に完了した実行の場合、ストリームは単一の `workflow_finished` イベントを発行して閉じます。", "operationId": "streamChatflowEvents", "parameters": [ { @@ -3128,7 +3128,7 @@ "type": "string", "format": "uuid" }, - "description": "元の [チャットメッセージを送信](/api-reference/チャットフロー/チャットメッセージを送信) リクエストで返されたワークフロー実行 ID。" + "description": "元の [チャットメッセージを送信](/api-reference/chatflows/send-chat-message) リクエストから返されたワークフロー実行 ID。" }, { "name": "user", @@ -3137,7 +3137,7 @@ "schema": { "type": "string" }, - "description": "チャットメッセージを送信したエンドユーザー識別子。ワークフロー実行の作成者と一致している必要があります。" + "description": "チャットメッセージを送信したエンドユーザー識別子。ワークフロー実行の作成者と一致する必要があります。" }, { "name": "include_state_snapshot", @@ -3147,7 +3147,7 @@ "type": "boolean", "default": false }, - "description": "`true` の場合、永続化された状態スナップショットからリプレイし、新しいイベントのストリーミング開始前に実行済みノードのステータスサマリーを含めます。" + "description": "`true` の場合、永続化された状態スナップショットからリプレイして、新しいイベントをストリーミングする前に既に実行されたノードのステータスサマリーを含めます。" }, { "name": "continue_on_pause", @@ -3157,7 +3157,7 @@ "type": "boolean", "default": false }, - "description": "`true` に設定すると、複数の `workflow_paused` イベントを跨いでストリームを開いたままにします（ワークフローに複数の人間の入力ノードが連続する場合に有用）。デフォルトでは最初の一時停止で閉じます。" + "description": "`true` に設定すると、複数の `workflow_paused` イベントにわたってストリームを開いたままにします（ワークフローに複数の人間の入力ノードが連続している場合に便利です）。デフォルトでは最初の一時停止後にストリームを閉じます。" } ], "responses": { @@ -3173,7 +3173,7 @@ } }, "400": { - "description": "`not_workflow_app` : Please check if your app mode matches the right API route.", + "description": "`not_workflow_app` : アプリモードが正しい API ルートと一致しているか確認してください。", "content": { "application/json": { "examples": { @@ -3190,7 +3190,7 @@ } }, "404": { - "description": "`not_found` : Workflow run not found.", + "description": "`not_found` : ワークフロー実行が見つかりません。", "content": { "application/json": { "examples": { @@ -3216,12 +3216,12 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 認証です。すべての API リクエストにおいて、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けた API Key を含めてください。例：`Authorization: Bearer {API_KEY}`。**API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。**" + "description": "API キー認証。すべての API リクエストで、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けて API キーを含めてください。例：`Authorization: Bearer {API_KEY}`。**API キーの漏洩による深刻な結果を避けるため、API キーはサーバーサイドに保存し、クライアントサイドで共有または保存しないことを強く推奨します。**" } }, "responses": { "SuccessResult": { - "description": "操作が成功しました。", + "description": "操作成功。", "content": { "application/json": { "schema": { @@ -3256,11 +3256,11 @@ "properties": { "query": { "type": "string", - "description": "ユーザーの入力/質問内容です。" + "description": "ユーザー入力/質問の内容。" }, "inputs": { "type": "object", - "description": "アプリで定義されたさまざまな変数の値を入力できます。キーと値のペアを含みます。アプリが期待する変数名と型については、[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) レスポンスの `user_input_form` フィールドを参照してください。", + "description": "アプリで定義されたさまざまな変数値の入力を許可します。キー/値のペアを含みます。アプリが期待する変数名と型を発見するには、[アプリパラメータを取得](/api-reference/applications/get-app-parameters) レスポンスの `user_input_form` フィールドを参照してください。", "additionalProperties": true }, "response_mode": { @@ -3269,19 +3269,19 @@ "streaming", "blocking" ], - "description": "レスポンスの返却モード。`streaming`（推奨）は SSE を使用します。`blocking` は完了後に返却します（長時間の処理では中断される場合があります）。Cloudflare のタイムアウトは `100 s` です。省略した場合、デフォルトでブロッキングモードになります。" + "description": "レスポンス返却のモード。`streaming`（推奨）は SSE を使用します。`blocking` は完了後に返します（長いプロセスでは中断される可能性があります）。Cloudflare タイムアウトは `100 秒` です。省略した場合、デフォルトでブロッキング動作になります。" }, "user": { "type": "string", - "description": "アプリケーション内で一意のユーザー識別子です。この識別子はデータアクセスの範囲を限定します——会話、メッセージ、ファイルは同じ `user` 値でクエリした場合にのみ表示されます。" + "description": "ユーザー識別子。アプリケーション内で一意です。この識別子はデータアクセスのスコープを設定します。会話、メッセージ、ファイルは同じ `user` 値でクエリした場合にのみ表示されます。" }, "conversation_id": { "type": "string", - "description": "会話を継続するための会話 ID です。前のメッセージの `conversation_id` を渡します。新しい会話を開始するには、このフィールドを省略するか空文字列を渡します。レスポンスで `conversation_id` が返されます——以降のメッセージでこの値を渡すとその会話を継続できます。" + "description": "会話を続けるための会話 ID。前のメッセージの `conversation_id` を渡します。新しい会話を開始するには、このフィールドを省略するか空の文字列を渡します。レスポンスは `conversation_id` を返します。その会話を続けるには、以降のメッセージでそれを渡してください。" }, "files": { "type": "array", - "description": "マルチモーダル理解用のファイルリストです。画像、ドキュメント、音声、動画を含みます。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` で使用します。", + "description": "画像、ドキュメント、音声、ビデオを含むマルチモーダル理解のためのファイルリスト。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/files/upload-file) 経由でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` で使用してください。", "items": { "type": "object", "required": [ @@ -3306,28 +3306,28 @@ "remote_url", "local_file" ], - "description": "転送方法です。ファイル URL の場合は `remote_url`、アップロードファイルの場合は `local_file` です。" + "description": "転送方法：ファイル URL の場合は `remote_url`、アップロードファイルの場合は `local_file`。" }, "url": { "type": "string", "format": "url", - "description": "ファイル URL（`transfer_method` が `remote_url` の場合は必須）です。" + "description": "ファイル URL（`transfer_method` が `remote_url` の場合に必須）。" }, "upload_file_id": { "type": "string", - "description": "[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API から取得したアップロード済みファイル ID です（`transfer_method` が `local_file` の場合は必須）。" + "description": "[ファイルをアップロード](/api-reference/files/upload-file) API から取得したアップロードファイル ID（`transfer_method` が `local_file` の場合に必須）。" } } } }, "auto_generate_name": { "type": "boolean", - "description": "会話タイトルを自動生成します。`false` の場合、[会話の名前を変更](/api-reference/会話管理/会話の名前を変更) API で `auto_generate: true` を設定して非同期でタイトルを生成します。", + "description": "会話タイトルを自動生成。`false` の場合、非同期タイトル生成には [会話の名前を変更](/api-reference/conversations/rename-conversation) API を `auto_generate: true` で使用してください。", "default": true }, "workflow_id": { "type": "string", - "description": "実行する公開済みワークフローバージョンの ID を指定します。指定しない場合、最新の公開バージョンが使用されます。" + "description": "実行する公開済みワークフローバージョン ID を指定します。提供されない場合、最新の公開バージョンが使用されます。" } } }, @@ -3336,22 +3336,22 @@ "properties": { "event": { "type": "string", - "description": "イベントタイプ。`message` に固定されています。" + "description": "イベントタイプ。`message` に固定。" }, "task_id": { "type": "string", "format": "uuid", - "description": "リクエスト追跡およびレスポンス停止 API 用のタスク ID です。" + "description": "リクエスト追跡と停止レスポンス API のタスク ID。" }, "id": { "type": "string", "format": "uuid", - "description": "このレスポンスイベントの一意 ID です。" + "description": "このレスポンスイベントの一意の ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に `message_id` パラメータとして使用します。" + "description": "一意のメッセージ ID。フィードバックや提案質問エンドポイントを呼び出す際に `message_id` パラメータとして使用してください。" }, "conversation_id": { "type": "string", @@ -3360,22 +3360,22 @@ }, "mode": { "type": "string", - "description": "アプリモード、`advanced-chat` 固定です。" + "description": "アプリモード。`advanced-chat` に固定。" }, "answer": { "type": "string", - "description": "完全なレスポンスコンテンツ。" + "description": "完全なレスポンス内容。" }, "metadata": { "type": "object", - "description": "使用量と検索リソースを含むメタデータ。", + "description": "使用量とリトリーバーリソースを含むメタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" }, "retriever_resources": { "type": "array", - "description": "使用された検索リソースのリスト。", + "description": "使用されたリトリーバーリソースのリスト。", "items": { "$ref": "#/components/schemas/RetrieverResource" } @@ -3391,11 +3391,11 @@ }, "ChunkChatEvent": { "type": "object", - "description": "ストリーミングモードにおける Server-Sent Event チャンクのベーススキーマです。", + "description": "ストリーミングモードの Server-Sent Event チャンクの基本スキーマ。", "properties": { "event": { "type": "string", - "description": "イベントの種類です。", + "description": "イベントのタイプ。", "enum": [ "message", "tts_message", @@ -3460,7 +3460,7 @@ }, "StreamEventBase": { "type": "object", - "description": "ストリームイベントの基本プロパティです。", + "description": "ストリームイベントの基本プロパティ。", "properties": { "task_id": { "type": "string", @@ -3497,7 +3497,7 @@ "properties": { "answer": { "type": "string", - "description": "LLM が返したテキストチャンクです。" + "description": "LLM が返したテキストチャンク。" } } } @@ -3513,12 +3513,12 @@ }, { "type": "object", - "description": "TTS 音声ストリームイベント（base64 エンコードの Mp3）です。自動再生が有効な場合に利用できます。", + "description": "TTS 音声ストリームイベント（base64 エンコードされた Mp3）。自動再生が有効な場合に利用可能。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 エンコードされた MP3 音声チャンク。すべてのチャンクを順番にデコードして連結すると、完全な音声ファイルが生成されます。" + "description": "Base64 エンコードされた MP3 音声チャンク。完全な音声ファイルを生成するには、すべてのチャンクを順番にデコードして連結してください。" } } } @@ -3551,23 +3551,23 @@ }, { "type": "object", - "description": "メッセージファイルイベント。ツールによって作成された新しいファイルです。", + "description": "メッセージファイルイベント。ツールによって作成された新しいファイル。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "ファイルの一意の ID。" + "description": "ファイル一意 ID。" }, "type": { "type": "string", - "description": "ファイルタイプ（例：`image`）。" + "description": "ファイルタイプ。例：`image`。" }, "belongs_to": { "type": "string", "enum": [ "assistant" ], - "description": "このファイルの所有者。ここでは常に `assistant` です。" + "description": "このファイルが属するユーザー。ここでは常に `assistant`。" }, "url": { "type": "string", @@ -3593,23 +3593,23 @@ }, { "type": "object", - "description": "メッセージ終了イベント、ストリーミングが終了しました。", + "description": "メッセージ終了イベント。ストリーミングが終了しました。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージ ID。" }, "metadata": { "type": "object", - "description": "使用量と検索リソースを含むメタデータ。", + "description": "使用量とリトリーバーリソースを含むメタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" }, "retriever_resources": { "type": "array", - "description": "使用された検索リソースのリスト。", + "description": "使用されたリトリーバーリソースのリスト。", "items": { "$ref": "#/components/schemas/RetrieverResource" } @@ -3630,11 +3630,11 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージ内容置換イベント（例：コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", - "description": "置換コンテンツ。" + "description": "置換内容。" }, "reason": { "type": "string", @@ -3685,58 +3685,58 @@ }, "Usage": { "type": "object", - "description": "モデルの使用情報です。", + "description": "モデル使用量情報。", "properties": { "prompt_tokens": { "type": "integer", - "description": "プロンプト内のトークン数。" + "description": "プロンプト内の token 数。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンあたりの単価。" + "description": "プロンプト token あたりの単価。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの価格単位。" + "description": "プロンプト token の価格単位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの合計価格。" + "description": "プロンプト token の合計価格。" }, "completion_tokens": { "type": "integer", - "description": "補完のトークン数。" + "description": "補完内の token 数。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "補完トークンあたりの単価。" + "description": "補完 token あたりの単価。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "補完トークンの価格単位。" + "description": "補完 token の価格単位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "補完トークンの合計価格。" + "description": "補完 token の合計価格。" }, "total_tokens": { "type": "integer", - "description": "使用されたトークンの合計数。" + "description": "使用された token の合計数。" }, "total_price": { "type": "string", "format": "decimal", - "description": "すべてのトークンの合計価格。" + "description": "すべての token の合計価格。" }, "currency": { "type": "string", - "description": "課金通貨。" + "description": "価格設定の通貨。" }, "latency": { "type": "number", @@ -3747,12 +3747,12 @@ }, "RetrieverResource": { "type": "object", - "description": "検索リソースの引用および帰属情報です。", + "description": "リトリーバーリソースの引用と帰属情報。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "検索リソースの一意の ID。" + "description": "リトリーバーリソースの一意の ID。" }, "message_id": { "type": "string", @@ -3766,20 +3766,20 @@ "dataset_id": { "type": "string", "format": "uuid", - "description": "ナレッジベース ID。" + "description": "ナレッジベースの ID。" }, "dataset_name": { "type": "string", - "description": "ナレッジベース名。" + "description": "ナレッジベースの名前。" }, "document_id": { "type": "string", "format": "uuid", - "description": "ドキュメント ID。" + "description": "ドキュメントの ID。" }, "document_name": { "type": "string", - "description": "ドキュメント名。" + "description": "ドキュメントの名前。" }, "data_source_type": { "type": "string", @@ -3793,7 +3793,7 @@ "score": { "type": "number", "format": "float", - "description": "リソースの関連性スコア。" + "description": "リソースの類似度スコア。" }, "hit_count": { "type": "integer", @@ -3818,7 +3818,7 @@ "summary": { "type": "string", "nullable": true, - "description": "チャンクコンテンツの要約。" + "description": "チャンク内容の要約。" }, "created_at": { "type": "integer", @@ -3883,19 +3883,19 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられたユーザーの ID。" + "description": "関連ユーザーの ID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられたテナントの ID。" + "description": "関連テナントの ID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられた会話の ID。" + "description": "関連会話の ID。" }, "file_key": { "type": "string", @@ -3925,12 +3925,12 @@ }, "type": { "type": "string", - "description": "エンドユーザーのタイプ。Service API ユーザーの場合は常に `service_api` です。" + "description": "エンドユーザータイプ。Service API ユーザーの場合は常に `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API リクエストで提供された `user` 識別子です（例：[チャットメッセージを送信](/api-reference/チャットフロー/チャットメッセージを送信) の `user` フィールド）。" + "description": "API リクエストで提供された `user` 識別子（例：[チャットメッセージを送信](/api-reference/chatflows/send-chat-message) の `user` フィールド）。" }, "name": { "type": "string", @@ -3939,11 +3939,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "ユーザーが匿名かどうかを示します。元の API リクエストで `user` 識別子が提供されなかった場合、`true` になります。" + "description": "ユーザーが匿名かどうか。元の API リクエストで `user` 識別子が提供されなかった場合は `true`。" }, "session_id": { "type": "string", - "description": "セッション識別子。デフォルトは `external_user_id` の値です。" + "description": "セッション識別子。デフォルトは `external_user_id` 値。" }, "created_at": { "type": "string", @@ -3972,15 +3972,15 @@ null ], "nullable": true, - "description": "フィードバック評価。以前送信したフィードバックを取り消すには `null` に設定します。" + "description": "フィードバック評価。以前に送信したフィードバックを取り消すには `null` に設定します。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者が定義し、アプリケーション内での一意性を確保する必要があります。" + "description": "ユーザー識別子。開発者が定義し、アプリケーション内で一意性を確保する必要があります。" }, "content": { "type": "string", - "description": "追加の詳細を提供する任意のテキストフィードバック。" + "description": "追加の詳細を提供するオプションのテキストフィードバック。" } } }, @@ -3989,7 +3989,7 @@ "properties": { "data": { "type": "array", - "description": "フィードバック項目のリスト。", + "description": "フィードバックアイテムのリスト。", "items": { "$ref": "#/components/schemas/FeedbackItem" } @@ -3998,7 +3998,7 @@ }, "FeedbackItem": { "type": "object", - "description": "単一のフィードバック項目。", + "description": "単一のフィードバックアイテム。", "properties": { "id": { "type": "string", @@ -4022,16 +4022,16 @@ }, "rating": { "type": "string", - "description": "フィードバック評価。肯定的な場合は `like`、否定的な場合は `dislike`。" + "description": "フィードバック評価。`like` は肯定的、`dislike` は否定的。" }, "content": { "type": "string", "nullable": true, - "description": "任意のテキストフィードバック。" + "description": "オプションのテキストフィードバック。" }, "from_source": { "type": "string", - "description": "フィードバックのソース。API 経由でエンドユーザーが送信したフィードバックの場合は `user`、コンソールから送信されたフィードバックの場合は `admin`。" + "description": "フィードバックソース。`user` は API 経由で送信されたエンドユーザーフィードバック、`admin` はコンソールから送信されたフィードバック。" }, "from_end_user_id": { "type": "string", @@ -4069,7 +4069,7 @@ "items": { "type": "string" }, - "description": "提案された質問のリストです。" + "description": "提案質問のリスト。" } } }, @@ -4078,15 +4078,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "さらにメッセージがあるかどうかです。" + "description": "さらにメッセージがあるかどうか。" }, "data": { "type": "array", - "description": "メッセージのリストです。", + "description": "メッセージのリスト。", "items": { "$ref": "#/components/schemas/ConversationMessageItem" } @@ -4095,7 +4095,7 @@ }, "ConversationMessageItem": { "type": "object", - "description": "会話内の単一メッセージです。", + "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", @@ -4111,33 +4111,33 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "スレッド会話の親メッセージ ID です。" + "description": "スレッド会話の親メッセージ ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "このメッセージの入力変数です。" + "description": "このメッセージの入力変数。" }, "query": { "type": "string", - "description": "ユーザークエリテキストです。" + "description": "ユーザークエリテキスト。" }, "answer": { "type": "string", - "description": "アシスタントの回答テキストです。" + "description": "アシスタント回答テキスト。" }, "status": { "type": "string", - "description": "メッセージステータスです。成功したメッセージの場合は `normal`、生成に失敗した場合は `error` です。" + "description": "メッセージステータス。成功したメッセージの場合は `normal`、生成に失敗した場合は `error`。" }, "error": { "type": "string", "nullable": true, - "description": "`status` が `error` の場合のエラーメッセージです。" + "description": "`status` が `error` の場合のエラーメッセージ。" }, "message_files": { "type": "array", - "description": "このメッセージに添付されたファイルです。", + "description": "このメッセージに添付されたファイル。", "items": { "$ref": "#/components/schemas/MessageFileItem" } @@ -4145,24 +4145,24 @@ "feedback": { "type": "object", "nullable": true, - "description": "このメッセージのユーザーフィードバックです。", + "description": "このメッセージに対するユーザーフィードバック。", "properties": { "rating": { "type": "string", - "description": "フィードバック評価。肯定的な場合は `like`、否定的な場合は `dislike`。" + "description": "フィードバック評価。`like` は肯定的、`dislike` は否定的。" } } }, "retriever_resources": { "type": "array", - "description": "このメッセージに使用された検索リソースです。", + "description": "このメッセージに使用されたリトリーバーリソース。", "items": { "$ref": "#/components/schemas/RetrieverResource" } }, "agent_thoughts": { "type": "array", - "description": "このメッセージのエージェント思考です。", + "description": "このメッセージの Agent の思考。", "items": { "$ref": "#/components/schemas/AgentThoughtItem" } @@ -4174,7 +4174,7 @@ }, "extra_contents": { "type": "array", - "description": "このメッセージに関連する追加の実行コンテンツです。chatflow ワークフローの人間の入力ノードからのフォームデータなどが含まれます。", + "description": "このメッセージに関連する追加の実行コンテンツ。チャットフローワークフローの人間の入力ノードからの人間の入力フォームデータなど。", "items": { "$ref": "#/components/schemas/HumanInputContent" } @@ -4183,20 +4183,20 @@ }, "MessageFileItem": { "type": "object", - "description": "メッセージに添付されたファイルです。", + "description": "メッセージに添付されたファイル。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "File ID." + "description": "ファイル ID。" }, "filename": { "type": "string", - "description": "元のファイル名です。" + "description": "元のファイル名。" }, "type": { "type": "string", - "description": "ファイルの種類（例: `image`）です。" + "description": "ファイルタイプ。例：`image`。" }, "url": { "type": "string", @@ -4216,72 +4216,72 @@ }, "transfer_method": { "type": "string", - "description": "使用された転送方法です。`remote_url` は URL ベースのファイル、`local_file` はアップロード済みファイル、`tool_file` はツール生成ファイルを示します。" + "description": "使用された転送方法。URL ベースのファイルの場合は `remote_url`、アップロードファイルの場合は `local_file`、ツール生成ファイルの場合は `tool_file`。" }, "belongs_to": { "type": "string", "nullable": true, - "description": "このファイルの所有者です。ユーザーがアップロードしたファイルの場合は `user`、アシスタントが生成したファイルの場合は `assistant` です。" + "description": "このファイルが属するユーザー。ユーザーがアップロードしたファイルの場合は `user`、アシスタントが生成したファイルの場合は `assistant`。" }, "upload_file_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "`local_file` で転送された場合のアップロードファイル ID です。" + "description": "`local_file` 経由で転送された場合のアップロードファイル ID。" } } }, "AgentThoughtItem": { "type": "object", - "description": "メッセージ内のエージェント思考ステップです。", + "description": "メッセージ内の Agent の思考ステップ。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "エージェント思考 ID です。" + "description": "Agent 思考 ID。" }, "chain_id": { "type": "string", "nullable": true, - "description": "この思考のチェーン ID です。" + "description": "この思考のチェーン ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "この思考が属する一意のメッセージ ID です。" + "description": "この思考が属する一意のメッセージ ID。" }, "position": { "type": "integer", - "description": "この思考の位置です。" + "description": "この思考の位置。" }, "thought": { "type": "string", - "description": "LLM が思考している内容です。" + "description": "LLM が考えていること。" }, "tool": { "type": "string", - "description": "呼び出されたツール（`;` で区切り）です。" + "description": "呼び出されたツール。`;` で分割。" }, "tool_labels": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "使用されたツールのラベルです。" + "description": "使用されたツールのラベル。" }, "tool_input": { "type": "string", - "description": "ツールの入力（JSON 形式）です。" + "description": "JSON 形式のツール入力。" }, "observation": { "type": "string", - "description": "ツール呼び出しからのレスポンスです。" + "description": "ツール呼び出しからのレスポンス。" }, "files": { "type": "array", "items": { "type": "string" }, - "description": "この思考に関連するファイル ID です。" + "description": "この思考に関連するファイル ID。" }, "created_at": { "type": "integer", @@ -4295,15 +4295,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "さらに会話があるかどうかです。" + "description": "さらに会話があるかどうか。" }, "data": { "type": "array", - "description": "会話のリストです。", + "description": "会話のリスト。", "items": { "$ref": "#/components/schemas/ConversationListItem" } @@ -4320,20 +4320,20 @@ }, "name": { "type": "string", - "description": "会話名です。" + "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "会話の入力変数です。" + "description": "会話の入力変数。" }, "status": { "type": "string", - "description": "会話ステータスです。アクティブな会話の場合は `normal` です。" + "description": "会話ステータス。アクティブな会話の場合は `normal`。" }, "introduction": { "type": "string", - "description": "会話の紹介文です。" + "description": "会話の紹介。" }, "created_at": { "type": "integer", @@ -4349,23 +4349,23 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "会話の名前変更用リクエストボディです。", + "description": "会話の名前を変更するためのリクエストボディ。", "required": [ "user" ], "properties": { "name": { "type": "string", - "description": "会話の名前です。`auto_generate` が `false` の場合は必須です。" + "description": "会話の名前。`auto_generate` が `false` の場合に必須。" }, "auto_generate": { "type": "boolean", "default": false, - "description": "会話名を自動生成します。`true` の場合、`name` フィールドは無視されます。" + "description": "会話名を自動生成。`true` の場合、`name` フィールドは無視されます。" }, "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -4374,15 +4374,15 @@ "properties": { "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "ページあたりのアイテム数。" }, "has_more": { "type": "boolean", - "description": "次のページがあるかどうかです。" + "description": "次のページがあるかどうか。" }, "data": { "type": "array", - "description": "会話変数のリストです。", + "description": "会話変数のリスト。", "items": { "$ref": "#/components/schemas/ConversationVariableItem" } @@ -4395,23 +4395,23 @@ "id": { "type": "string", "format": "uuid", - "description": "Variable ID." + "description": "変数 ID。" }, "name": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "value_type": { "type": "string", - "description": "変数の値の型です。指定可能な値：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" + "description": "変数値の型。可能な値：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" }, "value": { "type": "string", - "description": "変数値（複雑な型の場合は JSON 文字列）。" + "description": "変数値（複雑な型の場合は JSON 文字列の可能性あり）。" }, "description": { "type": "string", - "description": "変数の説明です。" + "description": "変数の説明。" }, "created_at": { "type": "integer", @@ -4427,7 +4427,7 @@ }, "ConversationVariableUpdateRequest": { "type": "object", - "description": "会話変数を更新するためのリクエストボディです。", + "description": "会話変数を更新するためのリクエストボディ。", "required": [ "value" ], @@ -4443,7 +4443,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "音声からテキストへの変換のリクエストボディ。", + "description": "音声からテキストへの変換のためのリクエストボディ。", "required": [ "file" ], @@ -4451,7 +4451,7 @@ "file": { "type": "string", "format": "binary", - "description": "音声ファイルです。対応形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。上限：`30 MB`。" + "description": "音声ファイル。サポート：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。制限：`30 MB`。" }, "user": { "type": "string", @@ -4470,12 +4470,12 @@ }, "TextToAudioRequest": { "type": "object", - "description": "テキストから音声への変換のリクエストボディ。`message_id` または `text` のいずれかを指定してください。", + "description": "テキストから音声への変換のためのリクエストボディ。`message_id` または `text` のいずれかを提供してください。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "メッセージ ID です。両方が指定された場合、`text` よりも優先されます。" + "description": "メッセージ ID。両方が提供された場合、`text` より優先されます。" }, "text": { "type": "string", @@ -4487,7 +4487,7 @@ }, "voice": { "type": "string", - "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) → `text_to_speech.voice` の `voice` 値を使用してください。" + "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには [アプリパラメータを取得](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` の `voice` 値を使用してください。" }, "streaming": { "type": "boolean", @@ -4515,7 +4515,7 @@ }, "mode": { "type": "string", - "description": "アプリケーションモード。`completion` はテキスト生成アプリ、`chat` は基本チャットアプリ、`agent-chat` はエージェントベースのアプリ、`advanced-chat` は Chatflow アプリ、`workflow` はワークフローアプリです。" + "description": "アプリケーションモード。テキストジェネレーターアプリの場合は `completion`、基本チャットアプリの場合は `chat`、Agent ベースアプリの場合は `agent-chat`、チャットフローアプリの場合は `advanced-chat`、ワークフローアプリの場合は `workflow`。" }, "author_name": { "type": "string", @@ -4528,18 +4528,18 @@ "properties": { "opening_statement": { "type": "string", - "description": "会話開始時に表示されるオープニングメッセージです。" + "description": "会話開始時に表示されるオープニングステートメント。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, - "description": "推奨される初期質問のリスト。" + "description": "提案されるスターター質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", - "description": "回答後の推奨質問の設定。", + "description": "回答後の提案質問の設定。", "properties": { "enabled": { "type": "boolean", @@ -4549,7 +4549,7 @@ }, "speech_to_text": { "type": "object", - "description": "音声からテキストへの変換設定。", + "description": "音声からテキストへの設定。", "properties": { "enabled": { "type": "boolean", @@ -4559,7 +4559,7 @@ }, "text_to_speech": { "type": "object", - "description": "テキストから音声への変換設定。", + "description": "テキストから音声への設定。", "properties": { "enabled": { "type": "boolean", @@ -4575,13 +4575,13 @@ }, "autoPlay": { "type": "string", - "description": "自動再生設定です。音声を自動再生するには `enabled`、手動再生を要求するには `disabled` を指定します。" + "description": "自動再生設定。音声を自動再生する場合は `enabled`、手動再生を要求する場合は `disabled`。" } } }, "retriever_resource": { "type": "object", - "description": "検索リソースの設定。", + "description": "リトリーバーリソースの設定。", "properties": { "enabled": { "type": "boolean", @@ -4611,7 +4611,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "センシティブワードフィルタリングの設定。", + "description": "センシティブワード回避の設定。", "properties": { "enabled": { "type": "boolean", @@ -4632,7 +4632,7 @@ "properties": { "image": { "type": "object", - "description": "画像アップロードの設定。", + "description": "画像アップロード設定。", "properties": { "enabled": { "type": "boolean", @@ -4640,7 +4640,7 @@ }, "number_limits": { "type": "integer", - "description": "最大画像数。" + "description": "画像の最大数。" }, "detail": { "type": "string", @@ -4675,7 +4675,7 @@ }, "video_file_size_limit": { "type": "integer", - "description": "最大動画ファイルサイズ（MB）。" + "description": "最大ビデオファイルサイズ（MB）。" }, "workflow_file_upload_limit": { "type": "integer", @@ -4700,7 +4700,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "テキスト入力", "type": "object", "properties": { "text-input": { @@ -4709,7 +4709,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -4718,7 +4718,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "選択", "type": "object", "properties": { "select": { @@ -4728,63 +4728,63 @@ }, "TextInputControl": { "type": "object", - "description": "テキスト入力フォームコントロールです。", + "description": "テキスト入力フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "入力が必須かどうかです。" + "description": "入力が必須かどうか。" }, "default": { "type": "string", - "description": "デフォルト値です。" + "description": "デフォルト値。" } } }, "ParagraphControl": { "type": "object", - "description": "段落（複数行テキスト）フォームコントロールです。", + "description": "段落（複数行テキスト）フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "入力が必須かどうかです。" + "description": "入力が必須かどうか。" }, "default": { "type": "string", - "description": "デフォルト値です。" + "description": "デフォルト値。" } } }, "SelectControl": { "type": "object", - "description": "セレクト（ドロップダウン）フォームコントロールです。", + "description": "選択（ドロップダウン）フォームコントロール。", "properties": { "label": { "type": "string", - "description": "表示ラベルです。" + "description": "表示ラベル。" }, "variable": { "type": "string", - "description": "変数名です。" + "description": "変数名。" }, "required": { "type": "boolean", - "description": "選択が必須かどうかです。" + "description": "選択が必須かどうか。" }, "default": { "type": "string", @@ -4795,7 +4795,7 @@ "items": { "type": "string" }, - "description": "このフォームコントロールの選択可能な値のリスト。" + "description": "このフォームコントロールで選択可能な値のリスト。" } } }, @@ -4807,7 +4807,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコン URL", "type": "string", "format": "url", "description": "アイコンの URL。" @@ -4817,22 +4817,22 @@ } ] }, - "description": "ツールアイコン。キーはツール名です。" + "description": "ツールアイコン。キーはツール名。" } } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "絵文字アイコン", "type": "object", "description": "絵文字を使用したツールアイコンの詳細。", "properties": { "background": { "type": "string", - "description": "16進数形式の背景色。" + "description": "16 進形式の背景色。" }, "content": { "type": "string", - "description": "Emoji コンテンツ。" + "description": "絵文字コンテンツ。" } } }, @@ -4853,15 +4853,15 @@ }, "icon_type": { "type": "string", - "description": "使用されるアイコンのタイプ。`emoji` は絵文字アイコン、`image` はアップロードされた画像アイコンです。" + "description": "使用されるアイコンのタイプ。絵文字アイコンの場合は `emoji`、アップロード画像アイコンの場合は `image`。" }, "icon": { "type": "string", - "description": "アイコンのコンテンツ（絵文字または画像 ID）。" + "description": "アイコンコンテンツ（絵文字または画像 ID）。" }, "icon_background": { "type": "string", - "description": "アイコンの背景色。" + "description": "アイコン背景色。" }, "icon_url": { "type": "string", @@ -4907,23 +4907,23 @@ "items": { "$ref": "#/components/schemas/AnnotationItem" }, - "description": "現在のページのアノテーション項目のリストです。" + "description": "現在のページのアノテーションアイテムのリスト。" }, "has_more": { "type": "boolean", - "description": "現在の結果セットの後にさらにページがある場合は `true` です。" + "description": "現在の結果セットを超えてさらにページが利用可能な場合は `true`。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "ページあたりのアイテム数。" }, "total": { "type": "integer", - "description": "クエリに一致するアノテーションの合計数です。" + "description": "クエリに一致するアノテーションの合計数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" } } }, @@ -4933,22 +4933,22 @@ "id": { "type": "string", "format": "uuid", - "description": "アノテーションの一意識別子です。" + "description": "一意のアノテーション識別子。" }, "question": { "type": "string", "nullable": true, - "description": "このアノテーションをトリガーする質問テキストです。" + "description": "このアノテーションをトリガーする質問テキスト。" }, "answer": { "type": "string", "nullable": true, - "description": "アノテーションがマッチした際に返される定義済みの回答です。" + "description": "アノテーションがマッチした場合に返される定義済みの回答。" }, "hit_count": { "type": "integer", "nullable": true, - "description": "このアノテーションがマッチして返信として返された回数です。" + "description": "このアノテーションがマッチして返信として返された回数。" }, "created_at": { "type": "integer", @@ -4960,7 +4960,7 @@ }, "CreateAnnotationRequest": { "type": "object", - "description": "新しいアノテーションを作成するためのリクエストボディです。", + "description": "新しいアノテーションを作成するためのリクエストボディ。", "required": [ "question", "answer" @@ -4968,17 +4968,17 @@ "properties": { "question": { "type": "string", - "description": "アノテーションの質問です。" + "description": "アノテーションの質問。" }, "answer": { "type": "string", - "description": "アノテーションの回答です。" + "description": "アノテーションの回答。" } } }, "UpdateAnnotationRequest": { "type": "object", - "description": "アノテーション更新のリクエストボディです。", + "description": "アノテーションを更新するためのリクエストボディ。", "required": [ "question", "answer" @@ -4986,17 +4986,17 @@ "properties": { "question": { "type": "string", - "description": "更新されたアノテーションの質問です。" + "description": "更新されたアノテーションの質問。" }, "answer": { "type": "string", - "description": "更新されたアノテーションの回答です。" + "description": "更新されたアノテーションの回答。" } } }, "InitialAnnotationReplySettingsRequest": { "type": "object", - "description": "アノテーション返信設定を構成するためのリクエストボディです。", + "description": "アノテーション返信設定を構成するためのリクエストボディ。", "required": [ "score_threshold", "embedding_provider_name", @@ -5005,16 +5005,16 @@ "properties": { "embedding_provider_name": { "type": "string", - "description": "埋め込みモデルプロバイダーの名前（例：`openai`、`cohere`）です。" + "description": "埋め込みモデルプロバイダーの名前（例：`openai`、`cohere`）。" }, "embedding_model_name": { "type": "string", - "description": "アノテーションマッチングに使用する埋め込みモデルの名前です（例：`text-embedding-3-small`）。" + "description": "アノテーションマッチングに使用する埋め込みモデルの名前（例：`text-embedding-3-small`）。" }, "score_threshold": { "type": "number", "format": "float", - "description": "アノテーションがマッチとみなされるための最低類似度スコアです。値が高いほど、より正確なマッチが必要になります。", + "description": "アノテーションがマッチと見なされるための最小類似度スコア。値が高いほど、より近いマッチが必要です。", "minimum": 0, "maximum": 1 } @@ -5026,11 +5026,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "非同期ジョブ ID です。[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) と組み合わせて進捗を追跡します。" + "description": "非同期ジョブ ID。進行状況を追跡するには [アノテーション返信ジョブステータスを取得](/api-reference/annotations/get-annotation-reply-job-status) と一緒に使用してください。" }, "job_status": { "type": "string", - "description": "現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed` は完了、`error` は失敗を示します。" + "description": "現在のジョブステータス。`waiting` はキュー待ち、`processing` は進行中、`completed` は完了、`error` は失敗。" } } }, @@ -5040,15 +5040,15 @@ "job_id": { "type": "string", "format": "uuid", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) 呼び出しから取得したジョブ ID です。" + "description": "[アノテーション返信を設定](/api-reference/annotations/configure-annotation-reply) 呼び出しからのジョブ ID。" }, "job_status": { "type": "string", - "description": "現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed` は完了、`error` は失敗を示します。" + "description": "現在のジョブステータス。`waiting` はキュー待ち、`processing` は進行中、`completed` は完了、`error` は失敗。" }, "error_msg": { "type": "string", - "description": "ジョブが失敗した理由を説明するエラーメッセージです。`job_status` が `error` でない場合は空文字列です。" + "description": "ジョブが失敗した理由を説明するエラーメッセージ。`job_status` が `error` でない場合は空の文字列。" } } }, @@ -5062,36 +5062,36 @@ }, { "type": "object", - "description": "ワークフローの実行が開始されました。", + "description": "ワークフロー実行が開始されました。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", - "description": "関連するワークフロー ID です。" + "description": "関連するワークフロー ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "このワークフロー実行の入力変数です。" + "description": "このワークフロー実行の入力変数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "reason": { "type": "string", - "description": "ワークフロー開始の理由です。`initial` は初回開始、`resumption` は一時停止後の再開（例：人間の入力後）を示します。" + "description": "ワークフロー開始の理由。`initial` は最初の開始、`resumption` は一時停止後の再開（例：人間の入力後）。" } } } @@ -5109,65 +5109,65 @@ }, { "type": "object", - "description": "ワークフローの実行が完了しました。", + "description": "ワークフロー実行が完了しました。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", - "description": "関連するワークフロー ID です。" + "description": "関連するワークフロー ID。" }, "status": { "type": "string", - "description": "実行ステータスです。`running` は進行中、`succeeded` は成功、`failed` は失敗、`stopped` は手動停止、`partial-succeeded` は部分完了、`paused` は人間の入力待ちを示します。" + "description": "実行ステータス。進行中は `running`、成功時は `succeeded`、失敗時は `failed`、手動で停止された場合は `stopped`、部分的に完了した場合は `partial-succeeded`、人間の入力待ちの場合は `paused`。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ワークフローの出力データです。" + "description": "ワークフロー出力データ。" }, "error": { "type": "string", "nullable": true, - "description": "実行が失敗した場合のエラーメッセージです。" + "description": "実行失敗時のエラーメッセージ。" }, "elapsed_time": { "type": "number", - "description": "合計実行時間（秒）です。" + "description": "合計実行時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行された合計ステップ数です。" + "description": "実行された合計ステップ数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "終了タイムスタンプ（Unix エポック秒）です。" + "description": "終了タイムスタンプ（Unix エポック秒）。" }, "exceptions_count": { "type": "integer", "nullable": true, - "description": "実行中の例外数です。" + "description": "実行中の例外数。" }, "files": { "type": "array", @@ -5176,7 +5176,7 @@ "type": "object", "additionalProperties": true }, - "description": "ワークフロー実行中に生成されたファイルです。" + "description": "ワークフロー実行中に生成されたファイル。" } } } @@ -5194,65 +5194,65 @@ }, { "type": "object", - "description": "ノードの実行が開始されました。", + "description": "ノード実行が開始されました。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "ノードタイプ（例：`llm`、`knowledge-retrieval`、`code`）です。" + "description": "ノードタイプ（例：`llm`、`knowledge-retrieval`、`code`）。" }, "title": { "type": "string", - "description": "Node title." + "description": "ノードタイトル。" }, "index": { "type": "integer", - "description": "実行インデックスです。" + "description": "実行インデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID です。" + "description": "前のノードの ID。" }, "inputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの入力データです。簡略化された API レスポンスでは `null` の場合があります。" + "description": "ノード入力データ。簡略化された API レスポンスでは `null` の場合があります。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "このノードがイテレーション内で実行される場合のイテレーション ID です。" + "description": "このノードがイテレーション内で実行される場合のイテレーション ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "このノードがループ内で実行される場合のループ ID です。" + "description": "このノードがループ内で実行される場合のループ ID。" } } } @@ -5270,86 +5270,86 @@ }, { "type": "object", - "description": "ノードの実行が完了しました。", + "description": "ノード実行が完了しました。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "Node title." + "description": "ノードタイトル。" }, "index": { "type": "integer", - "description": "実行インデックスです。" + "description": "実行インデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID です。" + "description": "前のノードの ID。" }, "inputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの入力データです。簡略化された API レスポンスでは `null` の場合があります。" + "description": "ノード入力データ。簡略化された API レスポンスでは `null` の場合があります。" }, "process_data": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの処理データです。簡略化された API レスポンスでは `null` の場合があります。" + "description": "ノード処理データ。簡略化された API レスポンスでは `null` の場合があります。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの出力データです。簡略化された API レスポンスでは `null` の場合があります。" + "description": "ノード出力データ。簡略化された API レスポンスでは `null` の場合があります。" }, "status": { "type": "string", - "description": "ノードの実行ステータスです。`running` は進行中、`succeeded` は成功、`failed` は失敗、`exception` は例外発生を示します。" + "description": "ノード実行ステータス。進行中は `running`、成功時は `succeeded`、失敗時は `failed`、例外発生時は `exception`。" }, "error": { "type": "string", "nullable": true, - "description": "ノードが失敗した場合のエラーメッセージです。" + "description": "ノード失敗時のエラーメッセージ。" }, "elapsed_time": { "type": "number", - "description": "ノードの実行時間（秒）です。" + "description": "ノード実行時間（秒）。" }, "execution_metadata": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "実行メタデータ（例：トークン使用量、モデル情報）です。簡略化された API レスポンスでは `null` の場合があります。" + "description": "実行メタデータ（例：token 使用量、モデル情報）。簡略化された API レスポンスでは `null` の場合があります。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "finished_at": { "type": "integer", "format": "int64", - "description": "終了タイムスタンプ（Unix エポック秒）です。" + "description": "終了タイムスタンプ（Unix エポック秒）。" }, "files": { "type": "array", @@ -5358,17 +5358,17 @@ "type": "object", "additionalProperties": true }, - "description": "このノードで生成されたファイルです。" + "description": "このノードによって生成されたファイル。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "このノードがイテレーション内で実行される場合のイテレーション ID です。" + "description": "このノードがイテレーション内で実行される場合のイテレーション ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "このノードがループ内で実行される場合のループ ID です。" + "description": "このノードがループ内で実行される場合のループ ID。" } } } @@ -5386,86 +5386,86 @@ }, { "type": "object", - "description": "ノードのリトライ回数です。", + "description": "ノードのリトライ試行。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "Node title." + "description": "ノードタイトル。" }, "index": { "type": "integer", - "description": "実行インデックスです。" + "description": "実行インデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID です。" + "description": "前のノードの ID。" }, "inputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの入力データです。" + "description": "ノード入力データ。" }, "process_data": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの処理データです。" + "description": "ノード処理データ。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ノードの出力データです。" + "description": "ノード出力データ。" }, "status": { "type": "string", - "description": "ノードの実行ステータスです。`running` は進行中、`succeeded` は成功、`failed` は失敗、`exception` は例外発生を示します。" + "description": "ノード実行ステータス。進行中は `running`、成功時は `succeeded`、失敗時は `failed`、例外発生時は `exception`。" }, "error": { "type": "string", "nullable": true, - "description": "このリトライのエラーメッセージです。" + "description": "このリトライ試行のエラーメッセージ。" }, "elapsed_time": { "type": "number", - "description": "この試行の実行時間（秒）です。" + "description": "この試行の実行時間（秒）。" }, "execution_metadata": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "実行メタデータです。" + "description": "実行メタデータ。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "finished_at": { "type": "integer", "format": "int64", - "description": "終了タイムスタンプ（Unix エポック秒）です。" + "description": "終了タイムスタンプ（Unix エポック秒）。" }, "files": { "type": "array", @@ -5474,21 +5474,21 @@ "type": "object", "additionalProperties": true }, - "description": "このリトライ中に生成されたファイルです。" + "description": "このリトライ中に生成されたファイル。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "イテレーション ID（該当する場合）です。" + "description": "該当する場合のイテレーション ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "ループ ID（該当する場合）です。" + "description": "該当する場合のループ ID。" }, "retry_index": { "type": "integer", - "description": "リトライ回数インデックス、`0` から開始します。" + "description": "リトライ試行インデックス。`0` から始まります。" } } } @@ -5510,46 +5510,46 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "イテレーション実行 ID です。" + "description": "イテレーション実行 ID。" }, "node_id": { "type": "string", - "description": "イテレーションノード ID です。" + "description": "イテレーションノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "イテレーションノードのタイトルです。" + "description": "イテレーションノードタイトル。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" }, "metadata": { "type": "object", "additionalProperties": true, - "description": "イテレーションのメタデータです。" + "description": "イテレーションメタデータ。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "イテレーションの入力データです。" + "description": "イテレーション入力データ。" } } } @@ -5567,44 +5567,44 @@ }, { "type": "object", - "description": "イテレーションが次の項目に進みました。", + "description": "イテレーションが次のアイテムに進みました。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "イテレーション実行 ID です。" + "description": "イテレーション実行 ID。" }, "node_id": { "type": "string", - "description": "イテレーションノード ID です。" + "description": "イテレーションノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "イテレーションノードのタイトルです。" + "description": "イテレーションノードタイトル。" }, "index": { "type": "integer", - "description": "現在のイテレーションインデックス（0 始まり）です。" + "description": "現在のイテレーションインデックス（0 ベース）。" }, "created_at": { "type": "integer", "format": "int64", - "description": "タイムスタンプ（Unix エポック秒）です。" + "description": "タイムスタンプ（Unix エポック秒）。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" } } } @@ -5626,63 +5626,63 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "イテレーション実行 ID です。" + "description": "イテレーション実行 ID。" }, "node_id": { "type": "string", - "description": "イテレーションノード ID です。" + "description": "イテレーションノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "イテレーションノードのタイトルです。" + "description": "イテレーションノードタイトル。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "イテレーションの出力データです。" + "description": "イテレーション出力データ。" }, "status": { "type": "string", - "description": "イテレーションの実行ステータスです。`running` は進行中、`succeeded` は成功、`failed` は失敗、`exception` は例外発生を示します。" + "description": "イテレーション実行ステータス。進行中は `running`、成功時は `succeeded`、失敗時は `failed`、例外発生時は `exception`。" }, "error": { "type": "string", "nullable": true, - "description": "イテレーションが失敗した場合のエラーメッセージです。" + "description": "イテレーション失敗時のエラーメッセージ。" }, "elapsed_time": { "type": "number", - "description": "イテレーションの合計時間（秒）です。" + "description": "合計イテレーション時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "すべてのイテレーションで消費されたトークンの合計です。" + "description": "すべてのイテレーションで消費された合計 token 数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "finished_at": { "type": "integer", "format": "int64", - "description": "終了タイムスタンプ（Unix エポック秒）です。" + "description": "終了タイムスタンプ（Unix エポック秒）。" }, "steps": { "type": "integer", - "description": "実行されたイテレーションステップの合計数です。" + "description": "実行されたイテレーションステップの合計数。" } } } @@ -5704,46 +5704,46 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ループ実行 ID です。" + "description": "ループ実行 ID。" }, "node_id": { "type": "string", - "description": "ループノード ID です。" + "description": "ループノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "ループノードのタイトルです。" + "description": "ループノードタイトル。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" }, "metadata": { "type": "object", "additionalProperties": true, - "description": "ループのメタデータです。" + "description": "ループメタデータ。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "ループの入力データです。" + "description": "ループ入力データ。" } } } @@ -5765,43 +5765,43 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ループ実行 ID です。" + "description": "ループ実行 ID。" }, "node_id": { "type": "string", - "description": "ループノード ID です。" + "description": "ループノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "ループノードのタイトルです。" + "description": "ループノードタイトル。" }, "index": { "type": "integer", - "description": "現在のループインデックス（0 始まり）です。" + "description": "現在のループインデックス（0 ベース）。" }, "created_at": { "type": "integer", "format": "int64", - "description": "タイムスタンプ（Unix エポック秒）です。" + "description": "タイムスタンプ（Unix エポック秒）。" }, "pre_loop_output": { - "description": "前回のループイテレーションからの出力です。" + "description": "前のループイテレーションからの出力。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" } } } @@ -5823,63 +5823,63 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "id": { "type": "string", - "description": "ループ実行 ID です。" + "description": "ループ実行 ID。" }, "node_id": { "type": "string", - "description": "ループノード ID です。" + "description": "ループノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "ループノードのタイトルです。" + "description": "ループノードタイトル。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "ループの出力データです。" + "description": "ループ出力データ。" }, "status": { "type": "string", - "description": "ループの実行ステータスです。`running` は進行中、`succeeded` は成功、`failed` は失敗、`exception` は例外発生を示します。" + "description": "ループ実行ステータス。進行中は `running`、成功時は `succeeded`、失敗時は `failed`、例外発生時は `exception`。" }, "error": { "type": "string", "nullable": true, - "description": "ループが失敗した場合のエラーメッセージです。" + "description": "ループ失敗時のエラーメッセージ。" }, "elapsed_time": { "type": "number", - "description": "ループの合計実行時間（秒）です。" + "description": "合計ループ実行時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "すべてのループイテレーションで消費されたトークンの合計です。" + "description": "すべてのループイテレーションで消費された合計 token 数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "開始タイムスタンプ（Unix エポック秒）です。" + "description": "開始タイムスタンプ（Unix エポック秒）。" }, "finished_at": { "type": "integer", "format": "int64", - "description": "終了タイムスタンプ（Unix エポック秒）です。" + "description": "終了タイムスタンプ（Unix エポック秒）。" }, "steps": { "type": "integer", - "description": "実行されたループの合計ステップ数です。" + "description": "実行されたループステップの合計数。" } } } @@ -5900,26 +5900,26 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "form_id": { "type": "string", - "description": "フォームインスタンスの識別子。エラーメッセージやログに含まれます。Service API の呼び出しには `form_token` を使用してください。" + "description": "フォームインスタンスの識別子。エラーメッセージとログに表示されます。Service API 呼び出しには `form_token` を使用してください。" }, "node_id": { "type": "string", - "description": "このフォームを生成した Human Input ノードの ID。" + "description": "このフォームを生成した人間の入力ノードの ID。" }, "node_title": { "type": "string", - "description": "Human Input ノードの表示タイトル。" + "description": "人間の入力ノードの表示タイトル。" }, "form_content": { "type": "string", - "description": "ワークフロー変数が置換された、事前レンダリング済みのフォーム本文。" + "description": "ワークフロー変数が代入された事前レンダリングされたフォーム本文。" }, "inputs": { "type": "array", @@ -5928,27 +5928,27 @@ "properties": { "type": { "type": "string", - "description": "フォーム入力コントロールの種類。使用可能な値：`text_input`（単一行テキスト）と `paragraph`（複数行テキスト）。" + "description": "フォーム入力コントロールタイプ。利用可能な値：`text_input`（単一行テキストフィールド）および `paragraph`（複数行テキストエリア）。" }, "output_variable_name": { "type": "string", - "description": "この入力の送信値をワークフロー内で参照する変数名。送信時の `inputs` オブジェクトのキーに対応します。" + "description": "ワークフロー内でこの入力の送信値を参照するために使用される変数名。送信 `inputs` オブジェクトのキーに対応します。" }, "default": { "type": "object", "nullable": true, - "description": "ワークフローコンテキストから解決されるデフォルト値。デフォルトが設定されていない場合は `null`。", + "description": "ワークフローコンテキストから解決されたデフォルト値。デフォルトが設定されていない場合は `null`。", "properties": { "type": { "type": "string", - "description": "デフォルト値のソース。`constant` は `value` をリテラル文字列として使用します。`variable` は `selector` がワークフロー変数を指します。" + "description": "デフォルトのソース。`constant` は `value` がリテラル文字列として使用されることを意味します。`variable` は `selector` がワークフロー変数を指していることを意味します。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 要素を含みます。" + "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 つの要素を含む必要があります。" }, "value": { "type": "string", @@ -5958,7 +5958,7 @@ } } }, - "description": "受信者が記入するフォーム入力フィールド。" + "description": "受信者が入力するフォーム入力フィールド。" }, "actions": { "type": "array", @@ -5969,20 +5969,20 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "アクションボタンの識別子。受信者がこのボタンを選択したら、`action` として [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡します。" + "description": "アクションボタンの識別子。受信者がこのボタンを選択した場合、[人間の入力フォームを送信](/api-reference/human-input/submit-human-input-form) で `action` として渡します。" }, "title": { "type": "string", "maxLength": 100, - "description": "受信者に表示されるボタンのラベル。" + "description": "受信者に表示されるボタンラベル。" }, "button_style": { "type": "string", - "description": "ボタンの視覚スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" + "description": "ボタンの視覚的スタイル。利用可能な値：`primary`、`default`、`accent`、`ghost`。" } } }, - "description": "送信時に受信者が選択できるアクション（ボタン）。" + "description": "送信時に受信者が選択できる利用可能なユーザーアクション（ボタン）。" }, "display_in_ui": { "type": "boolean", @@ -5991,19 +5991,19 @@ "form_token": { "type": "string", "nullable": true, - "description": "[人間の入力フォームを取得](/api-reference/人間の入力/人間の入力フォームを取得) と [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) のアクセストークン。人間の入力ノードがメール配信またはコンソール配信を使用する場合は `null` になります（Service API は WebApp 配信のフォームのみ操作できます）。" + "description": "[人間の入力フォームを取得](/api-reference/human-input/get-human-input-form) および [人間の入力フォームを送信](/api-reference/human-input/submit-human-input-form) のアクセストークン。人間の入力ノードが Email または Console 配信を使用している場合は `null`（Service API は WebApp 配信のフォームのみ操作できます）。" }, "resolved_default_values": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "入力の `output_variable_name` をキーとする事前入力デフォルト値。すべての値は文字列化されます。" + "description": "入力 `output_variable_name` をキーとするフォーム入力の事前入力されたデフォルト値。すべての値は文字列化されています。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。これを過ぎるとフォームは送信できなくなります。" + "description": "フォームが送信できなくなる Unix タイムスタンプ（秒）。" } } } @@ -6027,19 +6027,19 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "このワークフロー実行記録の永続的な識別子です。[ワークフロー実行詳細を取得](/api-reference/チャットフロー/ワークフロー実行詳細を取得) と組み合わせて、実行後に結果を取得します。" + "description": "このワークフロー実行レコードの永続的な識別子。実行後に結果を取得するには [ワークフロー実行詳細を取得](/api-reference/chatflows/get-workflow-run-detail) と一緒に使用してください。" }, "paused_nodes": { "type": "array", "items": { "type": "string" }, - "description": "一時停止中のノード ID のリストです。" + "description": "一時停止中のノード ID のリスト。" }, "outputs": { "type": "object", "additionalProperties": true, - "description": "一時停止時の部分的な出力です。" + "description": "一時停止時の部分的な出力。" }, "reasons": { "type": "array", @@ -6047,11 +6047,11 @@ "type": "object", "additionalProperties": true }, - "description": "一時停止の理由です。" + "description": "一時停止の理由。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。" + "description": "ワークフロー実行ステータス。" }, "created_at": { "type": "integer", @@ -6061,15 +6061,15 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行された合計ステップ数です。" + "description": "実行された合計ステップ数。" } } } @@ -6090,26 +6090,26 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "node_id": { "type": "string", - "description": "フォームが記入された Human Input ノードの ID。" + "description": "フォームが入力された人間の入力ノードの ID。" }, "node_title": { "type": "string", - "description": "Human Input ノードの表示タイトル。" + "description": "人間の入力ノードの表示タイトル。" }, "rendered_content": { "type": "string", - "description": "受信者の入力値で描画されたフォーム本文（`human_input_required` の `form_content` は未入力のテンプレートです）。" + "description": "受信者の送信値でレンダリングされたフォーム本文（`human_input_required` の `form_content` は未入力テンプレートです）。" }, "action_id": { "type": "string", - "description": "受信者が選択したアクションの識別子（[人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡された `action` の値と一致します）。" + "description": "受信者が選択したアクションの識別子（[人間の入力フォームを送信](/api-reference/human-input/submit-human-input-form) に渡された `action` 値と一致します）。" }, "action_text": { "type": "string", @@ -6134,23 +6134,23 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "node_id": { "type": "string", - "description": "フォームが期限切れとなった Human Input ノードの ID。" + "description": "フォームが期限切れになった人間の入力ノードの ID。" }, "node_title": { "type": "string", - "description": "Human Input ノードの表示タイトル。" + "description": "人間の入力ノードの表示タイトル。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。フォームが期限切れとなった時刻。" + "description": "フォームが期限切れになった Unix タイムスタンプ（秒）。" } } } @@ -6168,50 +6168,50 @@ }, { "type": "object", - "description": "ワークフロー内のエージェントノードからのエージェントログです。", + "description": "ワークフロー内の Agent ノードからの Agent ログ。", "properties": { "data": { "type": "object", "properties": { "node_execution_id": { "type": "string", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "id": { "type": "string", - "description": "ログエントリ ID です。" + "description": "ログエントリ ID。" }, "label": { "type": "string", - "description": "ログエントリのラベルです。" + "description": "ログエントリラベル。" }, "parent_id": { "type": "string", "nullable": true, - "description": "ネストされたエントリの親ログエントリ ID です。" + "description": "ネストされたエントリの親ログエントリ ID。" }, "error": { "type": "string", "nullable": true, - "description": "エラーメッセージ（該当する場合）です。" + "description": "該当する場合のエラーメッセージ。" }, "status": { "type": "string", - "description": "ログエントリのステータスです。" + "description": "ログエントリステータス。" }, "data": { "type": "object", "additionalProperties": true, - "description": "ログエントリのデータです。" + "description": "ログエントリデータ。" }, "metadata": { "type": "object", "additionalProperties": true, - "description": "追加メタデータです。" + "description": "追加メタデータ。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" } } } @@ -6235,7 +6235,7 @@ "properties": { "text": { "type": "string", - "description": "テキスト内容のチャンクです。" + "description": "テキストコンテンツチャンク。" }, "from_variable_selector": { "type": "array", @@ -6243,7 +6243,7 @@ "type": "string" }, "nullable": true, - "description": "ワークフロー内のテキスト変数のソースパスです。" + "description": "ワークフロー内のテキスト変数のソースパス。" } } } @@ -6267,7 +6267,7 @@ "properties": { "text": { "type": "string", - "description": "置換テキスト内容です。" + "description": "置換テキストコンテンツ。" } } } @@ -6281,57 +6281,57 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", - "description": "Workflow ID." + "description": "ワークフロー ID。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。`running` は実行中、`succeeded` は正常完了、`failed` は実行エラー、`stopped` は手動停止、`partial-succeeded` は一部のノードが成功し他が失敗、`paused` は人間の入力待ちを示します。" + "description": "ワークフロー実行ステータス。進行中の実行は `running`、正常に完了した場合は `succeeded`、実行でエラーが発生した場合は `failed`、手動で停止された場合は `stopped`、一部のノードが成功したが他が失敗した場合は `partial-succeeded`、人間の入力待ちの場合は `paused`。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "ワークフロー実行の入力変数です。" + "description": "ワークフロー実行の入力変数。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ワークフローからの出力データです。" + "description": "ワークフローからの出力データ。" }, "error": { "type": "string", "nullable": true, - "description": "ワークフローが失敗した場合のエラーメッセージです。" + "description": "ワークフローが失敗した場合のエラーメッセージ。" }, "total_steps": { "type": "integer", - "description": "実行されたワークフローの合計ステップ数です。" + "description": "実行されたワークフローステップの合計数。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が作成された Unix タイムスタンプです。" + "description": "ワークフロー実行が作成された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "ワークフロー実行が完了した Unix タイムスタンプです。" + "description": "ワークフロー実行が完了した Unix タイムスタンプ。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" } } }, @@ -6340,26 +6340,26 @@ "properties": { "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "ページあたりのアイテム数。" }, "total": { "type": "integer", - "description": "ログエントリの合計数です。" + "description": "ログエントリの合計数。" }, "has_more": { "type": "boolean", - "description": "さらにページがあるかどうかです。" + "description": "さらにページが利用可能かどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItem" }, - "description": "ワークフローログエントリのリストです。" + "description": "ワークフローログエントリのリスト。" } } }, @@ -6369,23 +6369,23 @@ "id": { "type": "string", "format": "uuid", - "description": "ログエントリ ID です。" + "description": "ログエントリ ID。" }, "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummary" }, "created_from": { "type": "string", - "description": "ワークフロー実行のソース（例：`service-api`）です。" + "description": "ワークフロー実行のソース（例：`service-api`）。" }, "created_by_role": { "type": "string", - "description": "作成者のロール（例：`end_user`、`account`）です。" + "description": "作成者のロール（例：`end_user`、`account`）。" }, "created_by_account": { "type": "object", "nullable": true, - "description": "管理者ユーザーが作成した場合のアカウント詳細です。", + "description": "管理者ユーザーによって作成された場合のアカウント詳細。", "properties": { "id": { "type": "string", @@ -6408,13 +6408,13 @@ "created_at": { "type": "integer", "format": "int64", - "description": "ログエントリが作成された Unix タイムスタンプです。" + "description": "ログエントリが作成された Unix タイムスタンプ。" }, "details": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ログエントリの追加詳細です。" + "description": "ログエントリの追加詳細。" } } }, @@ -6424,52 +6424,52 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "version": { "type": "string", - "description": "ワークフローバージョン識別子です。" + "description": "ワークフローバージョン識別子。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。`running` は実行中、`succeeded` は正常完了、`failed` は実行エラー、`stopped` は手動停止、`partial-succeeded` は一部のノードが成功し他が失敗、`paused` は人間の入力待ちを示します。" + "description": "ワークフロー実行ステータス。進行中の実行は `running`、正常に完了した場合は `succeeded`、実行でエラーが発生した場合は `failed`、手動で停止された場合は `stopped`、一部のノードが成功したが他が失敗した場合は `partial-succeeded`、人間の入力待ちの場合は `paused`。" }, "error": { "type": "string", "nullable": true, - "description": "ワークフローが失敗した場合のエラーメッセージです。" + "description": "ワークフローが失敗した場合のエラーメッセージ。" }, "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行されたワークフローの合計ステップ数です。" + "description": "実行されたワークフローステップの合計数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が作成された Unix タイムスタンプです。" + "description": "ワークフロー実行が作成された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "ワークフロー実行が完了した Unix タイムスタンプです。" + "description": "ワークフロー実行が完了した Unix タイムスタンプ。" }, "exceptions_count": { "type": "integer", - "description": "実行中に発生した例外の数です。" + "description": "実行中に発生した例外の数。" }, "triggered_from": { "type": "string", - "description": "ワークフロー実行をトリガーしたソースです。`debugging` はエディタからのテスト実行、`app` は API またはアプリからの実行を示します。" + "description": "ワークフロー実行をトリガーしたソース。エディターからのテスト実行の場合は `debugging`、API またはアプリで開始された実行の場合は `app`。" } } }, @@ -6483,159 +6483,159 @@ }, "type": { "type": "string", - "description": "エンドユーザーの種類です。" + "description": "エンドユーザータイプ。" }, "is_anonymous": { "type": "boolean", - "description": "エンドユーザーが匿名かどうかです。" + "description": "エンドユーザーが匿名かどうか。" }, "session_id": { "type": "string", - "description": "セッション識別子です。" + "description": "セッション識別子。" } } }, "HumanInputContent": { "type": "object", - "description": "人間の入力ノードからの実行コンテンツです。フォーム定義と送信データを含みます。", + "description": "人間の入力ノードからの実行コンテンツ（フォーム定義と送信データを含む）。", "properties": { "workflow_run_id": { "type": "string", - "description": "このコンテンツが属するワークフロー実行の ID です。" + "description": "このコンテンツが属するワークフロー実行の ID。" }, "submitted": { "type": "boolean", - "description": "人間の入力フォームが送信されたかどうかです。" + "description": "人間の入力フォームが送信されたかどうか。" }, "type": { "type": "string", - "description": "`human_input` は人間の入力コンテンツを示します。" + "description": "人間の入力コンテンツの場合は `human_input`。" }, "form_definition": { "nullable": true, - "description": "人間の入力ノードからのフォーム定義です。コンテンツが送信レスポンスを表す場合は `null` です。", + "description": "人間の入力ノードからのフォーム定義。コンテンツが送信レスポンスを表す場合は `null`。", "$ref": "#/components/schemas/HumanInputFormDefinition" }, "form_submission_data": { "nullable": true, - "description": "送信されたフォームデータです。フォームがまだ送信されていない場合は `null` です。", + "description": "送信されたフォームデータ。フォームがまだ送信されていない場合は `null`。", "$ref": "#/components/schemas/HumanInputFormSubmissionData" } } }, "HumanInputFormDefinition": { "type": "object", - "description": "人間の入力ノードによってレンダリングされる人間の入力フォームの定義です。", + "description": "人間の入力ノードによってレンダリングされた人間の入力フォームの定義。", "properties": { "form_id": { "type": "string", - "description": "フォームの一意識別子です。" + "description": "一意のフォーム識別子。" }, "node_id": { "type": "string", - "description": "このフォームを生成した人間の入力ノードの ID です。" + "description": "このフォームを生成した人間の入力ノードの ID。" }, "node_title": { "type": "string", - "description": "人間の入力ノードのタイトルです。" + "description": "人間の入力ノードのタイトル。" }, "form_content": { "type": "string", - "description": "フォームと共に表示される Markdown またはテキストコンテンツです。" + "description": "フォームと一緒に表示される Markdown またはテキストコンテンツ。" }, "inputs": { "type": "array", - "description": "フォーム内の入力フィールドです。", + "description": "フォームの入力フィールド。", "items": { "$ref": "#/components/schemas/FormInput" } }, "actions": { "type": "array", - "description": "フォームで利用可能なアクションボタンです。", + "description": "フォームで利用可能なアクションボタン。", "items": { "$ref": "#/components/schemas/UserAction" } }, "display_in_ui": { "type": "boolean", - "description": "フォームを UI に表示するかどうかです。" + "description": "フォームを UI に表示するかどうか。" }, "form_token": { "type": "string", "nullable": true, - "description": "フォーム送信認証用のトークンです。" + "description": "フォーム送信認証用のトークン。" }, "resolved_default_values": { "type": "object", "additionalProperties": true, - "description": "出力変数名をキーとする、フォーム入力の解決済みデフォルト値です。" + "description": "出力変数名をキーとするフォーム入力の解決されたデフォルト値。" }, "expiration_time": { "type": "integer", - "description": "フォームが期限切れになる Unix タイムスタンプです。" + "description": "フォームが期限切れになる Unix タイムスタンプ。" } } }, "HumanInputFormSubmissionData": { "type": "object", - "description": "送信された人間の入力フォームからのデータです。", + "description": "送信された人間の入力フォームからのデータ。", "properties": { "node_id": { "type": "string", - "description": "人間の入力ノードの ID です。" + "description": "人間の入力ノードの ID。" }, "node_title": { "type": "string", - "description": "人間の入力ノードのタイトルです。" + "description": "人間の入力ノードのタイトル。" }, "rendered_content": { "type": "string", - "description": "フォーム送信のレンダリングされた内容です。" + "description": "フォーム送信のレンダリングされたコンテンツ。" }, "action_id": { "type": "string", - "description": "クリックされたアクションボタンの ID です。" + "description": "クリックされたアクションボタンの ID。" }, "action_text": { "type": "string", - "description": "クリックされたアクションボタンの表示テキストです。" + "description": "クリックされたアクションボタンの表示テキスト。" } } }, "FormInput": { "type": "object", - "description": "フォーム入力フィールドの定義です。", + "description": "フォーム入力フィールドの定義。", "properties": { "type": { "type": "string", - "description": "`text_input` は単一行テキスト、`paragraph` は複数行テキストです。" + "description": "単一行テキストの場合は `text_input`、複数行テキストの場合は `paragraph`。" }, "output_variable_name": { "type": "string", - "description": "入力値が格納される変数名です。" + "description": "入力値が格納される変数名。" }, "default": { "nullable": true, - "description": "この入力のデフォルト値設定です。", + "description": "この入力のデフォルト値設定。", "$ref": "#/components/schemas/FormInputDefault" } } }, "FormInputDefault": { "type": "object", - "description": "フォーム入力のデフォルト値設定です。", + "description": "フォーム入力のデフォルト値設定。", "properties": { "type": { "type": "string", - "description": "`variable` はワークフロー変数からの動的な値、`constant` は静的な値です。" + "description": "ワークフロー変数からの動的値の場合は `variable`、静的値の場合は `constant`。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "`type` が `variable` の場合の変数セレクターパスです。" + "description": "`type` が `variable` の場合の変数セレクターパス。" }, "value": { "type": "string", @@ -6645,19 +6645,19 @@ }, "UserAction": { "type": "object", - "description": "人間の入力フォーム上のアクションボタンです。", + "description": "人間の入力フォームのアクションボタン。", "properties": { "id": { "type": "string", - "description": "アクションの一意識別子です。" + "description": "一意のアクション識別子。" }, "title": { "type": "string", - "description": "ボタンの表示テキストです。" + "description": "ボタン表示テキスト。" }, "button_style": { "type": "string", - "description": "`primary`, `default`, `accent`, or `ghost`." + "description": "`primary`、`default`、`accent`、または `ghost`。" } } } @@ -6665,40 +6665,40 @@ }, "tags": [ { - "name": "チャットフロー", - "description": "チャットフローアプリケーションの操作です（チャットメッセージ、ワークフロー実行詳細、イベントストリーミングを含む）。" + "name": "Chatflows", + "description": "チャットフローアプリの操作。チャットメッセージング、ワークフロー実行詳細、イベントストリーミングを含みます。" }, { - "name": "ファイル操作", - "description": "ファイルのアップロードとプレビューの操作です。" + "name": "Files", + "description": "ファイルアップロードとプレビュー操作。" }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作です。" + "name": "End Users", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "メッセージフィードバック", - "description": "ユーザーフィードバックの操作です。" + "name": "Feedback", + "description": "ユーザーフィードバック操作。" }, { - "name": "会話管理", - "description": "会話管理に関連する操作です。" + "name": "Conversations", + "description": "会話管理に関連する操作。" }, { - "name": "音声・テキスト変換", - "description": "テキスト読み上げと音声認識の操作です。" + "name": "TTS", + "description": "テキスト読み上げと音声認識操作。" }, { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報を取得する操作です。" + "name": "Applications", + "description": "アプリケーション設定と情報を取得する操作。" }, { - "name": "アノテーション管理", - "description": "ダイレクト返信用のアノテーション管理に関連する操作です。" + "name": "Annotations", + "description": "直接返信用のアノテーション管理に関連する操作。" }, { - "name": "人間の入力", - "description": "人間の入力を要する一時停止中のワークフローの再開操作です。" + "name": "Human Input", + "description": "人間の入力を必要とする一時停止中のワークフローを再開するためのエンドポイント。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 05988e331..afbff5b97 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -1,18 +1,18 @@ { "openapi": "3.0.1", "info": { - "title": "Completion アプリ API", - "description": "テキスト生成アプリケーションはセッションなしで動作し、翻訳、記事作成、要約 AI などに最適です。", + "title": "テキスト生成アプリ API", + "description": "テキスト生成アプリケーションは非セッションサポートを提供し、翻訳、記事作成、要約AIなどに最適です。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "テキスト生成アプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。", + "description": "テキスト生成アプリ APIのベースURL。{api_base_url}を、アプリケーションに提供された実際のAPIベースURLに置き換えてください。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", - "description": "API の実際のベース URL" + "description": "APIの実際のベースURL" } } } @@ -25,11 +25,11 @@ "paths": { "/completion-messages": { "post": { - "summary": "完了メッセージを送信", + "summary": "テキスト生成メッセージの送信", "description": "テキスト生成アプリケーションにリクエストを送信します。", - "operationId": "createCompletionMessageJp", + "operationId": "createCompletionMessage", "tags": [ - "完了メッセージ" + "Completions" ], "requestBody": { "description": "テキスト生成メッセージを作成するためのリクエストボディ。", @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "リクエスト成功。コンテンツタイプと構造はリクエストの `response_mode` パラメータに依存します。\n\n- `response_mode` が `blocking` の場合、 `application/json` で `CompletionResponse` オブジェクトを返します。\n- `response_mode` が `streaming` の場合、 `text/event-stream` で `ChunkCompletionEvent` オブジェクトのストリームを返します。", + "description": "成功レスポンス。コンテンツタイプと構造は、リクエストの`response_mode`パラメータによって異なります。\n- `response_mode`が`blocking`の場合、`CompletionResponse`オブジェクトを含む`application/json`を返します。\n- `response_mode`が`streaming`の場合、`ChunkCompletionEvent`オブジェクトのストリームを含む`text/event-stream`を返します。", "content": { "application/json": { "schema": { @@ -115,7 +115,7 @@ "text/event-stream": { "schema": { "type": "string", - "description": "サーバー送信イベント (SSE) のストリームです。各イベントは `data: ` プレフィックス付きの JSON オブジェクトで、2 つの改行で終了します。\n\n**SSE パースガイド：**各イベントは `data: ` プレフィックス付きの JSON オブジェクトの行で、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを除去してください。JSON 内の `event` フィールドがイベントタイプを決定します。終了イベント（`message_end`、`error` など）を受信するとストリームは終了します。`ping` イベント（10 秒ごとに接続維持のために送信）は無視してください。ストリーム内でエラーイベントが発生しても HTTP ステータスコードは常に `200` です。" + "description": "Server-Sent Events（SSE）のストリーム。各イベントは`data: `で始まり、2つの改行で終わるJSONオブジェクトです。可能なイベント構造については`ChunkCompletionEvent`を参照してください。\n**SSE解析ガイド:** 各イベントは`data: `で始まり、JSONオブジェクトが続き、`\\n\\n`で終わる行です。JSON解析前に`data: `プレフィックスを除去してください。JSON内の`event`フィールドがイベントタイプを決定します。`message_end`イベントを受信するとストリームは終了します。`ping`イベント（接続維持のため10秒ごとに送信）は無視してください。ストリーム途中で`error`イベントを受信した場合、ストリームは終了します — 詳細についてはエラーオブジェクトを解析してください。ストリーム内でエラーイベントが発生した場合でも、HTTPステータスコードは常に`200`であることに注意してください。" }, "examples": { "streamingResponse": { @@ -127,7 +127,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。", + "description": "- `app_unavailable` : アプリが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : テキスト生成に失敗しました。", "content": { "application/json": { "examples": { @@ -176,7 +176,7 @@ } }, "429": { - "description": "`too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。", + "description": "`too_many_requests` : このアプリへの同時リクエストが多すぎます。", "content": { "application/json": { "examples": { @@ -214,18 +214,18 @@ }, "/completion-messages/{task_id}/stop": { "post": { - "summary": "生成を停止", - "description": "テキスト生成メッセージ生成タスクを停止します。`streaming` モードでのみサポートされています。", - "operationId": "stopCompletionGenerationJp", + "summary": "テキスト生成メッセージの停止", + "description": "テキスト生成メッセージの生成タスクを停止します。`streaming`モードでのみサポートされています。", + "operationId": "stopGenerate", "tags": [ - "完了メッセージ" + "Completions" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "タスク ID です。[完了メッセージを送信](/api-reference/完了メッセージ/完了メッセージを送信) API のストリーミングチャンクレスポンスから取得できます。", + "description": "タスクID。[テキスト生成メッセージの送信](/api-reference/completions/send-completion-message) APIのストリーミングチャンク返却から取得できます。", "schema": { "type": "string" } @@ -243,7 +243,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡された user と一致する必要があります。" + "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" } } }, @@ -263,7 +263,7 @@ "$ref": "#/components/responses/SuccessResult" }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用できないか、設定が正しくありません。", "content": { "application/json": { "examples": { @@ -284,18 +284,18 @@ }, "/messages/{message_id}/feedbacks": { "post": { - "operationId": "postCompletionMessageFeedbackJp", + "operationId": "postMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], - "summary": "メッセージフィードバックを送信", - "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` で評価でき、任意でテキストフィードバックを提供できます。`rating` に `null` を渡すと、以前送信したフィードバックを取り消せます。", + "summary": "メッセージフィードバックの送信", + "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを`like`または`dislike`で評価でき、オプションでテキストフィードバックを提供できます。以前に送信したフィードバックを取り消すには、`rating`に`null`を渡してください。", "parameters": [ { "name": "message_id", "in": "path", "required": true, - "description": "メッセージ ID。", + "description": "メッセージID。", "schema": { "type": "string" } @@ -347,17 +347,17 @@ }, "/app/feedbacks": { "get": { - "operationId": "getAppFeedbacksCompletionJp", + "operationId": "getAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], - "summary": "アプリのフィードバック一覧を取得", - "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者のフィードバックの両方が含まれます。", + "summary": "アプリフィードバック一覧の取得", + "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者の両方のフィードバックが含まれます。", "parameters": [ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページネーション用のページ番号。", "required": false, "schema": { "type": "integer", @@ -429,14 +429,14 @@ }, "/files/upload": { "post": { - "operationId": "uploadCompletionFileJp", + "operationId": "uploadFile", "tags": [ - "ファイル操作" + "Files" ], - "summary": "ファイルをアップロード", - "description": "メッセージ送信時に使用するファイルをアップロードします。画像、ドキュメント、音声、動画のマルチモーダル理解が可能です。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", + "summary": "ファイルのアップロード", + "description": "メッセージ送信時に使用するファイルをアップロードし、画像、ドキュメント、音声、動画のマルチモーダル理解を可能にします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "requestBody": { - "description": "ファイルアップロードリクエスト。multipart/form-data 形式が必要です。", + "description": "ファイルアップロードリクエスト。multipart/form-dataが必要です。", "required": true, "content": { "multipart/form-data": { @@ -449,7 +449,7 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイル。サポートされるタイプには画像、ドキュメント、音声、動画が含まれます。" + "description": "アップロードするファイル。サポートされているタイプには、画像、ドキュメント、音声、動画が含まれます。" }, "user": { "type": "string", @@ -493,7 +493,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : リクエストにファイルが提供されていません。\n- `too_many_files` : 1 回のリクエストにつき 1 ファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", + "description": "- `no_file_uploaded` : リクエストにファイルが含まれていませんでした。\n- `too_many_files` : リクエストごとに1つのファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", "content": { "application/json": { "examples": { @@ -526,7 +526,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズを超過しました。", "content": { "application/json": { "examples": { @@ -543,7 +543,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプが許可されていません。", "content": { "application/json": { "examples": { @@ -564,18 +564,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "previewCompletionFileJa", + "operationId": "previewCompletionFile", "tags": [ - "ファイル操作" + "Files" ], - "summary": "ファイルをダウンロード", - "description": "以前[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", + "summary": "ファイルのダウンロード", + "description": "[ファイルのアップロード](/api-reference/files/upload-file) APIを通じて以前にアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセスできます。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "プレビューするファイルの一意の識別子です。[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API のレスポンスから取得します。", + "description": "プレビューするファイルの一意の識別子。[ファイルのアップロード](/api-reference/files/upload-file) APIレスポンスから取得できます。", "schema": { "type": "string", "format": "uuid" @@ -585,7 +585,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "`true` の場合、ブラウザでプレビューする代わりにファイルを添付ファイルとして強制ダウンロードします。", + "description": "`true`の場合、ブラウザでのプレビューではなく、添付ファイルとして強制的にダウンロードします。", "schema": { "type": "boolean", "default": false @@ -595,7 +595,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子。エンドユーザーのコンテキストに使用されます。", + "description": "ユーザー識別子。エンドユーザーコンテキストに使用されます。", "schema": { "type": "string" } @@ -603,7 +603,7 @@ ], "responses": { "200": { - "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` としてダウンロード形式で返されます。", + "description": "生のファイルコンテンツを返します。`Content-Type`ヘッダーはファイルのMIMEタイプに設定されます。`as_attachment`が`true`の場合、ファイルは`Content-Disposition: attachment`でダウンロードとして返されます。", "content": { "application/octet-stream": { "schema": { @@ -631,7 +631,7 @@ } }, "404": { - "description": "`file_not_found` : リクエストされたファイルが見つかりません。", + "description": "`file_not_found` : リクエストされたファイルが見つかりませんでした。", "content": { "application/json": { "examples": { @@ -652,18 +652,18 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserCompletionJp", + "operationId": "getEndUserCompletion", "tags": [ - "エンドユーザー" + "End Users" ], - "summary": "エンドユーザー取得", - "description": "ID を指定してエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード)の `created_by`）に便利です。", + "summary": "エンドユーザー情報の取得", + "description": "IDでエンドユーザーを取得します。他のAPIがエンドユーザーIDを返す場合に便利です（例：[ファイルのアップロード](/api-reference/files/upload-file)の`created_by`）。", "parameters": [ { "name": "end_user_id", "in": "path", "required": true, - "description": "エンドユーザー ID。", + "description": "エンドユーザーID。", "schema": { "type": "string", "format": "uuid" @@ -672,7 +672,7 @@ ], "responses": { "200": { - "description": "エンドユーザーを正常に取得しました。", + "description": "エンドユーザーが正常に取得されました。", "content": { "application/json": { "schema": { @@ -720,12 +720,12 @@ }, "/audio-to-text": { "post": { - "operationId": "completionAudioToTextJa", + "operationId": "completionAudioToText", "tags": [ - "音声・テキスト変換" + "TTS" ], - "summary": "音声をテキストに変換", - "description": "音声ファイルをテキストに変換します。サポートされる形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズの上限は `30 MB` です。", + "summary": "音声からテキストへの変換", + "description": "音声ファイルをテキストに変換します。サポートされているフォーマット：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズ制限は`30 MB`です。", "requestBody": { "required": true, "content": { @@ -756,7 +756,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -821,7 +821,7 @@ } }, "413": { - "description": "`audio_too_large` : 音声ファイルサイズが上限を超えています。", + "description": "`audio_too_large` : 音声ファイルサイズが制限を超えました。", "content": { "application/json": { "examples": { @@ -838,7 +838,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 許可されていない音声タイプです。", + "description": "`unsupported_audio_type` : 音声タイプが許可されていません。", "content": { "application/json": { "examples": { @@ -876,11 +876,11 @@ }, "/text-to-audio": { "post": { - "operationId": "textToAudioCompletionJp", + "operationId": "textToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], - "summary": "テキストを音声に変換", + "summary": "テキストから音声への変換", "description": "テキストを音声に変換します。", "requestBody": { "required": true, @@ -905,7 +905,7 @@ }, "responses": { "200": { - "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声の MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", + "description": "生成された音声ファイルを返します。`Content-Type`ヘッダーは音声のMIMEタイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming`が`true`の場合、音声はチャンク転送エンコーディングでストリーミングされます。", "content": { "audio/mpeg": { "schema": { @@ -916,7 +916,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダー認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", "content": { "application/json": { "examples": { @@ -986,12 +986,12 @@ }, "/info": { "get": { - "operationId": "getCompletionAppInfoJp", + "operationId": "getAppInfo", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションの基本情報を取得", - "description": "このアプリケーションの基本情報（名前、説明、タグ、モード）を取得します。", + "summary": "アプリ情報の取得", + "description": "このアプリケーションの基本情報（名前、説明、タグ、モードを含む）を取得します。", "responses": { "200": { "description": "アプリケーションの基本情報。", @@ -1023,12 +1023,12 @@ }, "/parameters": { "get": { - "operationId": "getCompletionAppParametersJp", + "operationId": "getAppParameters", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのパラメータ情報を取得", - "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。", + "summary": "アプリパラメータの取得", + "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値を含む）を取得します。", "responses": { "200": { "description": "アプリケーションパラメータ情報。", @@ -1105,7 +1105,7 @@ } }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用できないか、設定が正しくありません。", "content": { "application/json": { "examples": { @@ -1126,15 +1126,15 @@ }, "/meta": { "get": { - "operationId": "getCompletionAppMetaJa", + "operationId": "getCompletionAppMeta", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのメタ情報を取得", - "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細）を取得します。", + "summary": "アプリメタ情報の取得", + "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細を含む）を取得します。", "responses": { "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", + "description": "アプリケーションメタ情報が正常に取得されました。", "content": { "application/json": { "schema": { @@ -1162,15 +1162,15 @@ }, "/site": { "get": { - "operationId": "getCompletionWebAppSettingsJp", + "operationId": "getWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", + "summary": "アプリWebApp設定の取得", + "description": "このアプリケーションのWebApp設定（サイト設定、テーマ、カスタマイズオプションを含む）を取得します。", "responses": { "200": { - "description": "アプリケーションの WebApp 設定。", + "description": "アプリケーションのWebApp設定。", "content": { "application/json": { "schema": { @@ -1180,7 +1180,7 @@ "webAppSettings": { "summary": "レスポンス例", "value": { - "title": "My Chat App", + "title": "マイチャットアプリ", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", @@ -1227,7 +1227,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 認証です。すべての API リクエストにおいて、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けた API Key を含めてください。例：`Authorization: Bearer {API_KEY}`。**API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。**" + "description": "API Key認証。すべてのAPIリクエストに対して、`Authorization` HTTPヘッダーにAPI Keyを含め、`Bearer `をプレフィックスとして付けてください。例：`Authorization: Bearer {API_KEY}`。**API Keyはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。これにより、深刻な結果につながる可能性のあるAPI Keyの漏洩を防ぐことができます。**" } }, "responses": { @@ -1266,13 +1266,13 @@ "properties": { "inputs": { "type": "object", - "description": "アプリで定義されたさまざまな変数の値を入力できます。キーと値のペアを含み、各キーは特定の変数に対応し、各値はその変数の具体的な値です。アプリが期待する変数名と型については、[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) レスポンスの `user_input_form` フィールドを参照してください。", + "description": "アプリで定義されたさまざまな変数値の入力を許可します。キー/値のペアを含み、各キーは特定の変数に対応し、各値はその変数の具体的な値です。アプリが期待する変数名とタイプを確認するには、[アプリパラメータの取得](/api-reference/applications/get-app-parameters)レスポンスの`user_input_form`フィールドを参照してください。", "additionalProperties": true }, "query": { "type": "string", "default": "", - "description": "処理対象の入力テキストです。これはレガシーパラメータであり、新しいアプリではクエリを `inputs` オブジェクト内で渡す必要があります。" + "description": "処理される入力テキスト。これはレガシーパラメータです。新しいアプリでは、クエリは`inputs`オブジェクト内に渡す必要があります。" }, "response_mode": { "type": "string", @@ -1280,18 +1280,18 @@ "streaming", "blocking" ], - "description": "レスポンスの返却モード。`streaming`（推奨）は SSE を使用します。`blocking` は完了後に返却します（長時間の処理では中断される場合があります）。Cloudflare のタイムアウトは `100 s` です。省略した場合、デフォルトでブロッキングモードになります。" + "description": "レスポンス返却のモード。`streaming`（推奨）はSSEを使用します。`blocking`は完了後に返却します（長いプロセスでは中断される可能性があります）。Cloudflareのタイムアウトは`100 s`です。省略した場合、デフォルトでブロッキング動作になります。" }, "user": { "type": "string", - "description": "ユーザー識別子。アプリケーション内で一意です。この識別子はデータアクセスの範囲を制限します。メッセージとファイルは同じ `user` 値でクエリした場合のみ表示されます。" + "description": "ユーザー識別子。アプリケーション内で一意である必要があります。この識別子はデータアクセスのスコープを定義します — メッセージとファイルは、同じ`user`値でクエリされた場合にのみ表示されます。" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObject" }, - "description": "マルチモーダル理解用のファイルリストです。画像、ドキュメント、音声、動画を含みます。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` で使用します。" + "description": "マルチモーダル理解のためのファイルリスト（画像、ドキュメント、音声、動画を含む）。ローカルファイルを添付するには、まず[ファイルのアップロード](/api-reference/files/upload-file)でアップロードし、返された`id`を`upload_file_id`として`transfer_method: local_file`で使用してください。" } } }, @@ -1319,16 +1319,16 @@ "remote_url", "local_file" ], - "description": "転送方法です。ファイル URL の場合は `remote_url`、アップロードファイルの場合は `local_file` です。" + "description": "転送方法：`remote_url`はファイルURL用、`local_file`はアップロードされたファイル用。" }, "url": { "type": "string", "format": "url", - "description": "ファイル URL（`transfer_method` が `remote_url` の場合）です。" + "description": "ファイルURL（`transfer_method`が`remote_url`の場合）。" }, "upload_file_id": { "type": "string", - "description": "事前に [ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API でアップロードして取得したファイル ID です（`transfer_method` が `local_file` の場合に使用）。" + "description": "アップロードされたファイルID。[ファイルのアップロード](/api-reference/files/upload-file) APIを通じて事前にアップロードして取得します（`transfer_method`が`local_file`の場合）。" } }, "anyOf": [ @@ -1380,26 +1380,26 @@ "properties": { "event": { "type": "string", - "description": "イベントタイプ。`message` に固定されています。" + "description": "イベントタイプ。`message`に固定されています。" }, "task_id": { "type": "string", "format": "uuid", - "description": "リクエスト追跡および [生成を停止](/api-reference/完了メッセージ/生成を停止) API 用のタスク ID です。" + "description": "リクエストトラッキングおよび[テキスト生成メッセージの停止](/api-reference/completions/stop-completion-message-generation) API用のタスクID。" }, "id": { "type": "string", "format": "uuid", - "description": "このレスポンスイベントの一意 ID です。" + "description": "このレスポンスイベントの一意のID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に `message_id` パラメータとして使用します。" + "description": "一意のメッセージID。フィードバックまたは提案された質問エンドポイントを呼び出す際に、`message_id`パラメータとしてこれを使用してください。" }, "mode": { "type": "string", - "description": "アプリモード、`completion` 固定です。" + "description": "アプリモード。`completion`に固定されています。" }, "answer": { "type": "string", @@ -1407,14 +1407,14 @@ }, "metadata": { "type": "object", - "description": "使用量と検索リソースを含むメタデータ。", + "description": "使用状況とリトリーバーリソースを含むメタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" }, "retriever_resources": { "type": "array", - "description": "使用された検索リソースのリスト。", + "description": "使用されたリトリーバーリソースのリスト。", "items": { "$ref": "#/components/schemas/RetrieverResource" } @@ -1424,7 +1424,7 @@ "created_at": { "type": "integer", "format": "int64", - "description": "メッセージ作成タイムスタンプ（Unix エポック秒）。" + "description": "メッセージ作成タイムスタンプ（Unixエポック秒）。" } } }, @@ -1466,12 +1466,12 @@ "task_id": { "type": "string", "format": "uuid", - "description": "タスク ID。" + "description": "タスクID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "一意のメッセージ ID。" + "description": "一意のメッセージID。" }, "created_at": { "type": "integer", @@ -1490,11 +1490,11 @@ }, { "type": "object", - "description": "LLM がテキストチャンクイベントを返します。", + "description": "LLMがテキストチャンクを返すイベント。", "properties": { "answer": { "type": "string", - "description": "LLM が返したテキストチャンクのコンテンツ。" + "description": "LLMが返したテキストチャンクコンテンツ。" } } } @@ -1515,18 +1515,18 @@ "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージID。" }, "metadata": { "type": "object", - "description": "使用量と検索リソースを含むメタデータ。", + "description": "使用状況とリトリーバーリソースを含むメタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" }, "retriever_resources": { "type": "array", - "description": "使用された検索リソースのリスト。", + "description": "使用されたリトリーバーリソースのリスト。", "items": { "$ref": "#/components/schemas/RetrieverResource" } @@ -1547,12 +1547,12 @@ }, { "type": "object", - "description": "TTS 音声ストリームイベント（base64 エンコード MP3）。自動再生が有効な場合に利用できます。", + "description": "TTS音声ストリームイベント（base64エンコードされたMP3）。自動再生が有効な場合に利用可能です。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 エンコードされた MP3 音声チャンク。すべてのチャンクを順番にデコードして連結すると、完全な音声ファイルが生成されます。" + "description": "Base64エンコードされたMP3音声チャンク。完全な音声ファイルを生成するには、すべてのチャンクをデコードして順番に連結してください。" } } } @@ -1568,7 +1568,7 @@ }, { "type": "object", - "description": "TTS 音声ストリーム終了イベント。", + "description": "TTS音声ストリーム終了イベント。", "properties": { "audio": { "type": "string", @@ -1585,12 +1585,12 @@ }, { "type": "object", - "description": "メッセージファイルイベント。ツールによって作成された新しいファイルです。", + "description": "メッセージファイルイベント。ツールによって作成された新しいファイル。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "ファイルの一意の ID。" + "description": "ファイルの一意のID。" }, "type": { "type": "string", @@ -1601,12 +1601,12 @@ "enum": [ "assistant" ], - "description": "このファイルの所有者。ここでは常に `assistant` です。" + "description": "このファイルの所有者。ここでは常に`assistant`です。" }, "url": { "type": "string", "format": "url", - "description": "ファイルのリモート URL。" + "description": "ファイルのリモートURL。" } } } @@ -1622,7 +1622,7 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", @@ -1650,7 +1650,7 @@ "properties": { "status": { "type": "integer", - "description": "HTTP ステータスコード。" + "description": "HTTPステータスコード。" }, "code": { "type": "string", @@ -1671,7 +1671,7 @@ }, { "type": "object", - "description": "接続を維持するための Ping イベント。" + "description": "接続を維持するためのPingイベント。" } ] }, @@ -1680,54 +1680,54 @@ "properties": { "prompt_tokens": { "type": "integer", - "description": "プロンプト内のトークン数。" + "description": "プロンプト内のtoken数。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンあたりの単価。" + "description": "プロンプトtokenあたりの単価。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの価格単位。" + "description": "プロンプトtokenの価格単位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "プロンプトトークンの合計価格。" + "description": "プロンプトtokenの合計価格。" }, "completion_tokens": { "type": "integer", - "description": "補完のトークン数。" + "description": "生成テキスト内のtoken数。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "補完トークンあたりの単価。" + "description": "生成テキストtokenあたりの単価。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "補完トークンの価格単位。" + "description": "生成テキストtokenの価格単位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "補完トークンの合計価格。" + "description": "生成テキストtokenの合計価格。" }, "total_tokens": { "type": "integer", - "description": "使用されたトークンの合計数。" + "description": "使用されたtokenの合計数。" }, "total_price": { "type": "string", "format": "decimal", - "description": "すべてのトークンの合計価格。" + "description": "すべてのtokenの合計価格。" }, "currency": { "type": "string", - "description": "課金通貨。" + "description": "価格の通貨。" }, "latency": { "type": "number", @@ -1742,12 +1742,12 @@ "id": { "type": "string", "format": "uuid", - "description": "検索リソースの一意の ID。" + "description": "リトリーバーリソースの一意のID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "このリソースが属するメッセージの ID。" + "description": "このリソースが属するメッセージのID。" }, "position": { "type": "integer", @@ -1756,20 +1756,20 @@ "dataset_id": { "type": "string", "format": "uuid", - "description": "ナレッジベース ID。" + "description": "ナレッジベースのID。" }, "dataset_name": { "type": "string", - "description": "ナレッジベース名。" + "description": "ナレッジベースの名前。" }, "document_id": { "type": "string", "format": "uuid", - "description": "ドキュメント ID。" + "description": "ドキュメントのID。" }, "document_name": { "type": "string", - "description": "ドキュメント名。" + "description": "ドキュメントの名前。" }, "data_source_type": { "type": "string", @@ -1778,12 +1778,12 @@ "segment_id": { "type": "string", "format": "uuid", - "description": "ドキュメント内の特定のチャンクの ID。" + "description": "ドキュメント内の特定のチャンクのID。" }, "score": { "type": "number", "format": "float", - "description": "リソースの関連性スコア。" + "description": "リソースの類似度スコア。" }, "hit_count": { "type": "integer", @@ -1813,7 +1813,7 @@ "created_at": { "type": "integer", "format": "int64", - "description": "作成タイムスタンプ（Unix エポック秒）。" + "description": "作成タイムスタンプ（Unixエポック秒）。" } } }, @@ -1823,7 +1823,7 @@ "id": { "type": "string", "format": "uuid", - "description": "一意のファイル ID。" + "description": "一意のファイルID。" }, "name": { "type": "string", @@ -1841,51 +1841,51 @@ "mime_type": { "type": "string", "nullable": true, - "description": "ファイルの MIME タイプ。" + "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "nullable": true, - "description": "ファイルをアップロードしたユーザーの ID。" + "description": "ファイルをアップロードしたユーザーのID。" }, "created_at": { "type": "integer", "format": "int64", - "description": "アップロードタイムスタンプ（Unix エポック秒）。" + "description": "アップロードタイムスタンプ（Unixエポック秒）。" }, "preview_url": { "type": "string", "nullable": true, - "description": "ファイルのプレビュー URL。" + "description": "ファイルのプレビューURL。" }, "source_url": { "type": "string", "nullable": true, - "description": "ファイルのソース URL。" + "description": "ファイルのソースURL。" }, "original_url": { "type": "string", "nullable": true, - "description": "ファイルの元の URL。" + "description": "ファイルのオリジナルURL。" }, "user_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられたユーザーの ID。" + "description": "関連付けられたユーザーのID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられたテナントの ID。" + "description": "関連付けられたテナントのID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "関連付けられた会話の ID。" + "description": "関連付けられた会話のID。" }, "file_key": { "type": "string", @@ -1900,27 +1900,27 @@ "id": { "type": "string", "format": "uuid", - "description": "エンドユーザー ID。" + "description": "エンドユーザーID。" }, "tenant_id": { "type": "string", "format": "uuid", - "description": "テナント ID。" + "description": "テナントID。" }, "app_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "アプリケーション ID。" + "description": "アプリケーションID。" }, "type": { "type": "string", - "description": "エンドユーザーのタイプ。Service API ユーザーの場合は常に `service_api` です。" + "description": "エンドユーザータイプ。Service APIユーザーの場合は常に`service_api`です。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API リクエストで提供された `user` 識別子です（例：[完了メッセージを送信](/api-reference/完了メッセージ/完了メッセージを送信) の `user` フィールド）。" + "description": "APIリクエストで提供された`user`識別子（例：[テキスト生成メッセージの送信](/api-reference/completions/send-completion-message)の`user`フィールド）。" }, "name": { "type": "string", @@ -1929,11 +1929,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "ユーザーが匿名かどうかを示します。元の API リクエストで `user` 識別子が提供されなかった場合、`true` になります。" + "description": "ユーザーが匿名かどうか。元のAPIリクエストで`user`識別子が提供されなかった場合に`true`になります。" }, "session_id": { "type": "string", - "description": "セッション識別子。デフォルトは `external_user_id` の値です。" + "description": "セッション識別子。デフォルトは`external_user_id`値です。" }, "created_at": { "type": "string", @@ -1949,7 +1949,7 @@ }, "MessageFeedbackRequest": { "type": "object", - "description": "メッセージフィードバックを送信するためのリクエストボディ。", + "description": "メッセージフィードバック送信用のリクエストボディ。", "required": [ "user" ], @@ -1962,15 +1962,15 @@ null ], "nullable": true, - "description": "フィードバック評価。以前送信したフィードバックを取り消すには `null` に設定します。" + "description": "フィードバック評価。以前に送信したフィードバックを取り消すには`null`に設定してください。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者が定義し、アプリケーション内での一意性を確保する必要があります。" + "description": "ユーザー識別子。開発者によって定義され、アプリケーション内で一意性を確保する必要があります。" }, "content": { "type": "string", - "description": "追加の詳細を提供する任意のテキストフィードバック。" + "description": "追加の詳細を提供するオプションのテキストフィードバック。" } } }, @@ -1979,7 +1979,7 @@ "properties": { "data": { "type": "array", - "description": "フィードバック項目のリスト。", + "description": "フィードバックアイテムのリスト。", "items": { "$ref": "#/components/schemas/FeedbackItem" } @@ -1988,52 +1988,52 @@ }, "FeedbackItem": { "type": "object", - "description": "単一のフィードバック項目。", + "description": "単一のフィードバックアイテム。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "フィードバック ID。" + "description": "フィードバックID。" }, "app_id": { "type": "string", "format": "uuid", - "description": "アプリケーション ID。" + "description": "アプリケーションID。" }, "conversation_id": { "type": "string", "format": "uuid", - "description": "会話 ID。" + "description": "会話ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "メッセージ ID。" + "description": "メッセージID。" }, "rating": { "type": "string", - "description": "フィードバック評価。肯定的な場合は `like`、否定的な場合は `dislike`。" + "description": "フィードバック評価。ポジティブの場合は`like`、ネガティブの場合は`dislike`。" }, "content": { "type": "string", "nullable": true, - "description": "任意のテキストフィードバック。" + "description": "オプションのテキストフィードバック。" }, "from_source": { "type": "string", - "description": "フィードバックのソース。API 経由でエンドユーザーが送信したフィードバックの場合は `user`、コンソールから送信されたフィードバックの場合は `admin`。" + "description": "フィードバックソース。API経由で送信されたエンドユーザーフィードバックの場合は`user`、コンソールから送信されたフィードバックの場合は`admin`。" }, "from_end_user_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "フィードバックを送信したエンドユーザー ID。`from_source` が `user` の場合に存在します。" + "description": "フィードバックを送信したエンドユーザーID。`from_source`が`user`の場合に存在します。" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "フィードバックを送信したアカウント ID。`from_source` が `admin` の場合に存在します。" + "description": "フィードバックを送信したアカウントID。`from_source`が`admin`の場合に存在します。" }, "created_at": { "type": "string", @@ -2049,7 +2049,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "音声からテキストへの変換のリクエストボディ。", + "description": "音声からテキスト変換用のリクエストボディ。", "required": [ "file" ], @@ -2057,7 +2057,7 @@ "file": { "type": "string", "format": "binary", - "description": "音声ファイルです。対応形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。上限：`30 MB`。" + "description": "音声ファイル。サポート：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。制限：`30 MB`。" }, "user": { "type": "string", @@ -2076,12 +2076,12 @@ }, "TextToAudioRequest": { "type": "object", - "description": "テキストから音声への変換のリクエストボディ。`message_id` または `text` のいずれかを指定してください。", + "description": "テキストから音声変換用のリクエストボディ。`message_id`または`text`のいずれかを指定してください。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "メッセージ ID です。両方が指定された場合、`text` よりも優先されます。" + "description": "メッセージID。両方が指定された場合、`text`より優先されます。" }, "text": { "type": "string", @@ -2093,7 +2093,7 @@ }, "voice": { "type": "string", - "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) → `text_to_speech.voice` の `voice` 値を使用してください。" + "description": "テキスト読み上げに使用するボイス。利用可能なボイスは、このアプリに設定されたTTSプロバイダーによって異なります。デフォルトには、[アプリパラメータの取得](/api-reference/applications/get-app-parameters) → `text_to_speech.voice`の`voice`値を使用してください。" }, "streaming": { "type": "boolean", @@ -2121,7 +2121,7 @@ }, "mode": { "type": "string", - "description": "アプリケーションモード。`completion` はテキスト生成アプリ、`chat` は基本チャットアプリ、`agent-chat` はエージェントベースのアプリ、`advanced-chat` は Chatflow アプリ、`workflow` はワークフローアプリです。" + "description": "アプリケーションモード。テキスト生成アプリの場合は`completion`、基本チャットアプリの場合は`chat`、Agentベースのアプリの場合は`agent-chat`、チャットフローアプリの場合は`advanced-chat`、ワークフローアプリの場合は`workflow`。" }, "author_name": { "type": "string", @@ -2141,11 +2141,11 @@ "items": { "type": "string" }, - "description": "推奨される初期質問のリスト。" + "description": "提案されるスターター質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", - "description": "回答後の推奨質問の設定。", + "description": "回答後の提案質問の設定。", "properties": { "enabled": { "type": "boolean", @@ -2155,7 +2155,7 @@ }, "speech_to_text": { "type": "object", - "description": "音声からテキストへの変換設定。", + "description": "音声認識の設定。", "properties": { "enabled": { "type": "boolean", @@ -2165,7 +2165,7 @@ }, "text_to_speech": { "type": "object", - "description": "テキストから音声への変換設定。", + "description": "テキスト読み上げの設定。", "properties": { "enabled": { "type": "boolean", @@ -2173,11 +2173,11 @@ }, "voice": { "type": "string", - "description": "TTS の音声識別子。" + "description": "TTS用のボイス識別子。" }, "language": { "type": "string", - "description": "TTS の言語。" + "description": "TTS用の言語。" }, "autoPlay": { "type": "string", @@ -2191,7 +2191,7 @@ }, "retriever_resource": { "type": "object", - "description": "検索リソースの設定。", + "description": "リトリーバーリソースの設定。", "properties": { "enabled": { "type": "boolean", @@ -2221,7 +2221,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "センシティブワードフィルタリングの設定。", + "description": "センシティブワード回避の設定。", "properties": { "enabled": { "type": "boolean", @@ -2242,7 +2242,7 @@ "properties": { "image": { "type": "object", - "description": "画像アップロードの設定。", + "description": "画像アップロード設定。", "properties": { "enabled": { "type": "boolean", @@ -2250,7 +2250,7 @@ }, "number_limits": { "type": "integer", - "description": "最大画像数。" + "description": "画像の最大数。" }, "detail": { "type": "string", @@ -2265,7 +2265,7 @@ "local_file" ] }, - "description": "許可された転送方法。" + "description": "許可される転送方法。" } } } @@ -2314,7 +2314,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "テキスト入力", "type": "object", "properties": { "text-input": { @@ -2323,7 +2323,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -2332,7 +2332,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "選択", "type": "object", "properties": { "select": { @@ -2349,7 +2349,7 @@ }, "variable": { "type": "string", - "description": "`inputs` オブジェクトのキーとして使用される変数名。" + "description": "`inputs`オブジェクトのキーとして使用される変数名。" }, "required": { "type": "boolean", @@ -2370,7 +2370,7 @@ }, "variable": { "type": "string", - "description": "`inputs` オブジェクトのキーとして使用される変数名。" + "description": "`inputs`オブジェクトのキーとして使用される変数名。" }, "required": { "type": "boolean", @@ -2391,22 +2391,22 @@ }, "variable": { "type": "string", - "description": "`inputs` オブジェクトのキーとして使用される変数名。" + "description": "`inputs`オブジェクトのキーとして使用される変数名。" }, "required": { "type": "boolean", - "description": "送信前に選択を行う必要があるかどうか。" + "description": "送信前に選択する必要があるかどうか。" }, "default": { "type": "string", - "description": "デフォルトで選択される値。" + "description": "デフォルトの選択値。" }, "options": { "type": "array", "items": { "type": "string" }, - "description": "このフォームコントロールの選択可能な値のリスト。" + "description": "このフォームコントロールで選択可能な値のリスト。" } } }, @@ -2418,10 +2418,10 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコンURL", "type": "string", "format": "url", - "description": "アイコンの URL。" + "description": "アイコンのURL。" }, { "$ref": "#/components/schemas/ToolIconDetail" @@ -2433,7 +2433,7 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "絵文字アイコン", "type": "object", "description": "絵文字を使用したツールアイコンの詳細。", "properties": { @@ -2443,7 +2443,7 @@ }, "content": { "type": "string", - "description": "Emoji コンテンツ。" + "description": "絵文字コンテンツ。" } } }, @@ -2452,7 +2452,7 @@ "properties": { "title": { "type": "string", - "description": "WebApp タイトル。" + "description": "WebAppタイトル。" }, "chat_color_theme": { "type": "string", @@ -2464,11 +2464,11 @@ }, "icon_type": { "type": "string", - "description": "使用されるアイコンのタイプ。`emoji` は絵文字アイコン、`image` はアップロードされた画像アイコンです。" + "description": "使用されるアイコンのタイプ。絵文字アイコンの場合は`emoji`、アップロードされた画像アイコンの場合は`image`。" }, "icon": { "type": "string", - "description": "アイコンのコンテンツ（絵文字または画像 ID）。" + "description": "アイコンコンテンツ（絵文字または画像ID）。" }, "icon_background": { "type": "string", @@ -2478,11 +2478,11 @@ "type": "string", "format": "url", "nullable": true, - "description": "アイコン画像の URL。" + "description": "アイコン画像のURL。" }, "description": { "type": "string", - "description": "WebApp の説明。" + "description": "WebAppの説明。" }, "copyright": { "type": "string", @@ -2490,7 +2490,7 @@ }, "privacy_policy": { "type": "string", - "description": "プライバシーポリシー URL。" + "description": "プライバシーポリシーURL。" }, "custom_disclaimer": { "type": "string", @@ -2514,28 +2514,28 @@ }, "tags": [ { - "name": "完了メッセージ", - "description": "テキスト生成に関連する操作です。" + "name": "Completions", + "description": "テキスト生成と補完に関連する操作。" }, { - "name": "ファイル操作", - "description": "ファイル管理に関連する操作です。" + "name": "Files", + "description": "ファイル管理に関連する操作。" }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作です。" + "name": "End Users", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "メッセージフィードバック", - "description": "ユーザーフィードバックに関連する操作です。" + "name": "Feedback", + "description": "ユーザーフィードバックに関連する操作。" }, { - "name": "音声・テキスト変換", - "description": "テキスト読み上げと音声認識に関連する操作です。" + "name": "TTS", + "description": "テキスト読み上げと音声認識に関連する操作。" }, { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報を取得する操作です。" + "name": "Applications", + "description": "アプリケーション設定と情報を取得する操作。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index 65ce4712e..84259a715 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "ワークフローアプリAPI", - "description": "ワークフローアプリケーションはセッションなしの動作をサポートし、翻訳、記事作成、要約 AI などに最適です。", + "title": "ワークフローアプリ API", + "description": "ワークフローアプリケーションは非セッションサポートを提供し、翻訳、記事作成、要約AIなどに最適です。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "Workflow App API のベース URL です。{api_base_url} を実際の API ベース URL に置き換えてください。", + "description": "ワークフローアプリ API のベース URL。{api_base_url} を実際の API ベース URL に置き換えてください。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -26,10 +26,10 @@ "/workflows/run": { "post": { "summary": "ワークフローを実行", - "description": "ワークフローを実行します。公開済みのワークフローがないと実行できません。", - "operationId": "executeWorkflowJp", + "description": "ワークフローを実行します。公開されたワークフローがないと実行できません。", + "operationId": "executeWorkflow", "tags": [ - "ワークフロー" + "Workflows" ], "requestBody": { "required": true, @@ -60,7 +60,7 @@ } }, "with_file_array_variable": { - "summary": "Request Example - File array input", + "summary": "リクエスト例 - ファイル配列入力", "value": { "inputs": { "my_documents": [ @@ -86,7 +86,7 @@ }, "responses": { "200": { - "description": "リクエスト成功。コンテンツタイプと構造はリクエストの `response_mode` パラメータに依存します。\n\n- `response_mode` が `blocking` の場合、 `application/json` で `WorkflowBlockingResponse` オブジェクトを返します。\n- `response_mode` が `streaming` の場合、 `text/event-stream` で `ChunkWorkflowEvent` オブジェクトのストリームを返します。", + "description": "成功レスポンス。コンテンツタイプと構造は、リクエストの `response_mode` パラメータによって異なります。\n- `response_mode` が `blocking` の場合、`WorkflowBlockingResponse` オブジェクトを含む `application/json` を返します。\n- `response_mode` が `streaming` の場合、`ChunkWorkflowEvent` オブジェクトのストリームを含む `text/event-stream` を返します。", "content": { "application/json": { "schema": { @@ -119,7 +119,7 @@ "text/event-stream": { "schema": { "type": "string", - "description": "Server-Sent Events (SSE) のストリーム。\n\n**パース**：各行は `data: ` で始まり JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを除去し、`event` フィールドを読み取ってイベントタイプを判定してください。`ping` イベント（接続維持のため 10 秒ごとに送信）は無視してください。\n\n**ストリームライフサイクル**：`workflow_finished`、`workflow_paused`、または `error` イベントを受信するとストリームが閉じます。エラーはストリーム内の `error` イベントとして HTTP ステータス `200` で配信されます。ステータスコードではなくイベントペイロードを確認して詳細を取得してください。\n\n**人間の入力イベント**：\n- `human_input_required`：ワークフローが人間の入力ノードに到達した際に `workflow_paused` と同時に発行されます。ペイロードの `form_token` を使用して、[人間の入力 API](/api-reference/人間の入力/人間の入力フォームを取得) でフォーム処理を進めます。\n- `human_input_form_filled`：受信者がフォームを送信し、ワークフロー実行が再開されます。\n- `human_input_form_timeout`：応答がないままフォームが期限切れ。タイムアウトのフォールバックエッジが定義されている場合、ワークフローはそのエッジを通って実行されます。" + "description": "Server-Sent Events (SSE) のストリーム。\n**パース方法**: 各行は `data: ` で始まり、その後に JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを削除し、`event` フィールドを読み取ってイベントタイプを判断します。接続を維持するために10秒ごとに発火する `ping` イベントは無視してください。\n**ストリームのライフサイクル**: `workflow_finished`、`workflow_paused`、または `error` イベントを受信するとストリームが閉じられます。エラーは HTTP ステータス `200` でストリーム内に配信されます。ステータスコードに依存せず、イベントペイロードを確認して詳細を取得してください。\n**Human Input イベント**:\n- `human_input_required`: ワークフローが人間の入力ノードに到達すると、`workflow_paused` と共に発火します。ペイロードの `form_token` を使用して、[Human Input API](/api-reference/human-input/get-human-input-form) 経由でフォーム処理フローを実行します。\n- `human_input_form_filled`: 受信者がフォームを送信し、ワークフローの実行が再開されます。\n- `human_input_form_timeout`: 応答なしでフォームの有効期限が切れました。タイムアウトフォールバックエッジが定義されている場合、ワークフローはそれに従います。" }, "examples": { "streamingResponse": { @@ -127,7 +127,7 @@ "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"inputs\": {\"query\": \"Translate this\"}, \"created_at\": 1705407629, \"reason\": \"initial\"}} data: {\"event\": \"node_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"node_exec_1\", \"node_id\": \"node_1\", \"node_type\": \"llm\", \"title\": \"LLM Node\", \"index\": 1, \"created_at\": 1705407629}} data: {\"event\": \"text_chunk\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"text\": \"Bonjour\", \"from_variable_selector\": [\"node_1\", \"text\"]}} data: {\"event\": \"workflow_finished\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"status\": \"succeeded\", \"outputs\": {\"result\": \"Bonjour le monde\"}, \"elapsed_time\": 1.23, \"total_tokens\": 150, \"total_steps\": 3, \"created_at\": 1705407629, \"finished_at\": 1705407630}}" }, "humanInputPause": { - "summary": "レスポンス例 - 人間の入力での一時停止", + "summary": "レスポンス例 - Human Input 一時停止", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"inputs\": {\"draft\": \"Hello\"}, \"created_at\": 1705407629, \"reason\": \"initial\"}} data: {\"event\": \"human_input_required\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"form_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"form_token\": \"tok_abc123\", \"node_id\": \"approval_node\", \"node_title\": \"Approval\", \"form_content\": \"Please review the draft.\", \"inputs\": [{\"type\": \"text_input\", \"output_variable_name\": \"comment\", \"default\": null}], \"actions\": [{\"id\": \"approve\", \"title\": \"Approve\", \"button_style\": \"primary\"}], \"display_in_ui\": false, \"resolved_default_values\": {\"comment\": \"\"}, \"expiration_time\": 1705494029}} data: {\"event\": \"workflow_paused\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"status\": \"paused\", \"created_at\": 1705407629, \"elapsed_time\": 0.5}}" } } @@ -135,7 +135,7 @@ } }, "400": { - "description": "- `not_workflow_app` : App mode does not match the API route.\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : Workflow execution request failed.\n- `invalid_param` : Invalid parameter value.", + "description": "- `not_workflow_app` : アプリモードが API ルートと一致しません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : ワークフロー実行リクエストが失敗しました。\n- `invalid_param` : 無効なパラメータ値です。", "content": { "application/json": { "examples": { @@ -192,7 +192,7 @@ } }, "429": { - "description": "- `too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームのモデルプロバイダーのレート制限を超えました。", + "description": "- `too_many_requests` : このアプリに対する同時リクエストが多すぎます。\n- `rate_limit_error` : 上流モデルプロバイダーのレート制限を超過しました。", "content": { "application/json": { "examples": { @@ -239,17 +239,17 @@ "/workflows/{workflow_id}/run": { "post": { "summary": "ID でワークフローを実行", - "description": "ID で指定された特定のワークフローバージョンを実行します。ワークフローの特定の公開バージョンを実行する場合に便利です。", - "operationId": "runWorkflowByIdJa", + "description": "ID で識別される特定のワークフローバージョンを実行します。ワークフローの特定の公開バージョンを実行する場合に便利です。", + "operationId": "runWorkflowById", "tags": [ - "ワークフロー" + "Workflows" ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, - "description": "実行する特定バージョンのワークフロー ID です。この値は [ワークフローを実行](/api-reference/ワークフロー/ワークフローを実行) のレスポンスおよび [ワークフロー実行詳細を取得](/api-reference/ワークフロー/ワークフロー実行詳細を取得) の `workflow_id` フィールドで返されます。", + "description": "実行する特定バージョンのワークフロー ID。この値は [ワークフローを実行](/api-reference/workflows/run-workflow) レスポンスおよび [ワークフロー実行詳細を取得](/api-reference/workflows/get-workflow-run-detail) の `workflow_id` フィールドで返されます。", "schema": { "type": "string" } @@ -279,7 +279,7 @@ }, "responses": { "200": { - "description": "リクエスト成功。コンテンツタイプと構造はリクエストの `response_mode` パラメータに依存します。\n\n- `response_mode` が `blocking` の場合、 `application/json` で `WorkflowBlockingResponse` オブジェクトを返します。\n- `response_mode` が `streaming` の場合、 `text/event-stream` で `ChunkWorkflowEvent` オブジェクトのストリームを返します。", + "description": "成功レスポンス。コンテンツタイプと構造は、リクエストの `response_mode` パラメータによって異なります。\n- `response_mode` が `blocking` の場合、`WorkflowBlockingResponse` オブジェクトを含む `application/json` を返します。\n- `response_mode` が `streaming` の場合、`ChunkWorkflowEvent` オブジェクトのストリームを含む `text/event-stream` を返します。", "content": { "application/json": { "schema": { @@ -312,11 +312,11 @@ "text/event-stream": { "schema": { "type": "string", - "description": "Server-Sent Events (SSE) のストリーム。\n\n**パース**：各行は `data: ` で始まり JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを除去し、`event` フィールドを読み取ってイベントタイプを判定してください。`ping` イベント（接続維持のため 10 秒ごとに送信）は無視してください。\n\n**ストリームライフサイクル**：`workflow_finished`、`workflow_paused`、または `error` イベントを受信するとストリームが閉じます。エラーはストリーム内の `error` イベントとして HTTP ステータス `200` で配信されます。ステータスコードではなくイベントペイロードを確認して詳細を取得してください。\n\n**人間の入力イベント**：\n- `human_input_required`：ワークフローが人間の入力ノードに到達した際に `workflow_paused` と同時に発行されます。ペイロードの `form_token` を使用して、[人間の入力 API](/api-reference/人間の入力/人間の入力フォームを取得) でフォーム処理を進めます。\n- `human_input_form_filled`：受信者がフォームを送信し、ワークフロー実行が再開されます。\n- `human_input_form_timeout`：応答がないままフォームが期限切れ。タイムアウトのフォールバックエッジが定義されている場合、ワークフローはそのエッジを通って実行されます。" + "description": "Server-Sent Events (SSE) のストリーム。\n**パース方法**: 各行は `data: ` で始まり、その後に JSON オブジェクトが続き、`\\n\\n` で終了します。JSON をパースする前に `data: ` プレフィックスを削除し、`event` フィールドを読み取ってイベントタイプを判断します。接続を維持するために10秒ごとに発火する `ping` イベントは無視してください。\n**ストリームのライフサイクル**: `workflow_finished`、`workflow_paused`、または `error` イベントを受信するとストリームが閉じられます。エラーは HTTP ステータス `200` でストリーム内に配信されます。ステータスコードに依存せず、イベントペイロードを確認して詳細を取得してください。\n**Human Input イベント**:\n- `human_input_required`: ワークフローが人間の入力ノードに到達すると、`workflow_paused` と共に発火します。ペイロードの `form_token` を使用して、[Human Input API](/api-reference/human-input/get-human-input-form) 経由でフォーム処理フローを実行します。\n- `human_input_form_filled`: 受信者がフォームを送信し、ワークフローの実行が再開されます。\n- `human_input_form_timeout`: 応答なしでフォームの有効期限が切れました。タイムアウトフォールバックエッジが定義されている場合、ワークフローはそれに従います。" }, "examples": { "humanInputPause": { - "summary": "レスポンス例 - 人間の入力での一時停止", + "summary": "レスポンス例 - Human Input 一時停止", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"inputs\": {\"draft\": \"Hello\"}, \"created_at\": 1705407629, \"reason\": \"initial\"}} data: {\"event\": \"human_input_required\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"form_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"form_token\": \"tok_abc123\", \"node_id\": \"approval_node\", \"node_title\": \"Approval\", \"form_content\": \"Please review the draft.\", \"inputs\": [{\"type\": \"text_input\", \"output_variable_name\": \"comment\", \"default\": null}], \"actions\": [{\"id\": \"approve\", \"title\": \"Approve\", \"button_style\": \"primary\"}], \"display_in_ui\": false, \"resolved_default_values\": {\"comment\": \"\"}, \"expiration_time\": 1705494029}} data: {\"event\": \"workflow_paused\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"status\": \"paused\", \"created_at\": 1705407629, \"elapsed_time\": 0.5}}" } } @@ -324,7 +324,7 @@ } }, "400": { - "description": "- `not_workflow_app` : App mode does not match the API route.\n- `bad_request` : Workflow is a draft or has an invalid ID format.\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : Workflow execution request failed.\n- `invalid_param` : Required parameter missing or invalid.", + "description": "- `not_workflow_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : ワークフローがドラフトであるか、ID 形式が無効です。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルは利用できません。\n- `completion_request_error` : ワークフロー実行リクエストが失敗しました。\n- `invalid_param` : 必須パラメータが不足しているか無効です。", "content": { "application/json": { "examples": { @@ -406,7 +406,7 @@ } }, "429": { - "description": "- `too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームのモデルプロバイダーのレート制限を超えました。", + "description": "- `too_many_requests` : このアプリに対する同時リクエストが多すぎます。\n- `rate_limit_error` : 上流モデルプロバイダーのレート制限を超過しました。", "content": { "application/json": { "examples": { @@ -454,16 +454,16 @@ "get": { "summary": "ワークフロー実行詳細を取得", "description": "ワークフロー実行 ID に基づいて、ワークフロータスクの現在の実行結果を取得します。", - "operationId": "getWorkflowRunDetailJp", + "operationId": "getWorkflowRunDetail", "tags": [ - "ワークフロー" + "Workflows" ], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, - "description": "ワークフロー実行 ID です。ワークフロー実行レスポンスまたはストリーミングイベントから取得できます。", + "description": "ワークフロー実行 ID。ワークフロー実行レスポンスまたはストリーミングイベントから取得できます。", "schema": { "type": "string" } @@ -471,7 +471,7 @@ ], "responses": { "200": { - "description": "ワークフロー実行の詳細の取得に成功しました。", + "description": "ワークフロー実行詳細の取得に成功しました。", "content": { "application/json": { "schema": { @@ -520,7 +520,7 @@ } }, "404": { - "description": "`not_found` : ワークフロー実行記録が見つかりません。", + "description": "`not_found` : ワークフロー実行が見つかりません。", "content": { "application/json": { "examples": { @@ -541,17 +541,17 @@ }, "/workflows/logs": { "get": { - "summary": "ワークフローログ一覧を取得", - "description": "フィルタリングオプション付きでワークフロー実行ログをページネーションで取得します。", - "operationId": "getWorkflowLogsJp", + "summary": "ワークフローログを一覧表示", + "description": "フィルタリングオプション付きでページ分割されたワークフロー実行ログを取得します。", + "operationId": "getWorkflowLogs", "tags": [ - "ワークフロー" + "Workflows" ], "parameters": [ { "name": "keyword", "in": "query", - "description": "ログ内を検索するキーワードです。", + "description": "ログ内を検索するキーワード。", "schema": { "type": "string" } @@ -559,7 +559,7 @@ { "name": "status", "in": "query", - "description": "実行ステータスでフィルタリングします。", + "description": "実行ステータスでフィルタリング。", "schema": { "type": "string", "enum": [ @@ -572,7 +572,7 @@ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページネーション用のページ番号。", "schema": { "type": "integer", "default": 1, @@ -583,7 +583,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "1ページあたりの項目数。", "schema": { "type": "integer", "default": 20, @@ -594,7 +594,7 @@ { "name": "created_at__before", "in": "query", - "description": "この ISO 8601 タイムスタンプ以前に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより前に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -603,7 +603,7 @@ { "name": "created_at__after", "in": "query", - "description": "この ISO 8601 タイムスタンプ以降に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより後に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -612,7 +612,7 @@ { "name": "created_by_end_user_session_id", "in": "query", - "description": "エンドユーザーセッション ID でフィルタリングします。", + "description": "エンドユーザーセッション ID でフィルタリング。", "schema": { "type": "string" } @@ -620,7 +620,7 @@ { "name": "created_by_account", "in": "query", - "description": "アカウント ID でフィルタリングします。", + "description": "アカウント ID でフィルタリング。", "schema": { "type": "string" } @@ -683,16 +683,16 @@ "post": { "summary": "ワークフロータスクを停止", "description": "実行中のワークフロータスクを停止します。`streaming` モードでのみサポートされます。", - "operationId": "stopWorkflowTaskGenerationJp", + "operationId": "stopWorkflowTaskGeneration", "tags": [ - "ワークフロー" + "Workflows" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "タスク ID です。[ワークフローを実行](/api-reference/ワークフロー/ワークフローを実行) API のストリーミングチャンクレスポンスから取得できます。", + "description": "タスク ID。[ワークフローを実行](/api-reference/workflows/run-workflow) API のストリーミングチャンクレスポンスから取得できます。", "schema": { "type": "string" } @@ -710,7 +710,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子です。[ワークフローを実行](/api-reference/ワークフロー/ワークフローを実行) リクエストで渡したユーザーと一致する必要があります。" + "description": "ユーザー識別子。[ワークフローを実行](/api-reference/workflows/run-workflow) リクエストで渡されたユーザーと一致する必要があります。" } } }, @@ -759,14 +759,14 @@ }, "/files/upload": { "post": { - "operationId": "uploadWorkflowFileJp", + "operationId": "uploadWorkflowFile", "tags": [ - "ファイル操作" + "Files" ], "summary": "ファイルをアップロード", - "description": "メッセージ送信時に使用するファイルをアップロードします。画像、ドキュメント、音声、動画のマルチモーダル理解が可能です。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", + "description": "メッセージ送信時に使用するファイルをアップロードし、画像、ドキュメント、音声、動画のマルチモーダル理解を可能にします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "requestBody": { - "description": "ファイルアップロードリクエスト。multipart/form-data 形式が必要です。", + "description": "ファイルアップロードリクエスト。multipart/form-data が必要です。", "required": true, "content": { "multipart/form-data": { @@ -792,7 +792,7 @@ }, "responses": { "201": { - "description": "ファイルが正常にアップロードされました。", + "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { @@ -823,7 +823,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : リクエストにファイルが提供されていません。\n- `too_many_files` : 1 回のリクエストにつき 1 ファイルのみ許可されています。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", + "description": "- `no_file_uploaded` : リクエストにファイルが含まれていません。\n- `too_many_files` : リクエストごとに1つのファイルのみ許可されます。\n- `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。", "content": { "application/json": { "examples": { @@ -856,7 +856,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズを超過しました。", "content": { "application/json": { "examples": { @@ -873,7 +873,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプが許可されていません。", "content": { "application/json": { "examples": { @@ -894,18 +894,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "downloadWorkflowFileJa", + "operationId": "downloadWorkflowFile", "tags": [ - "ファイル操作" + "Files" ], "summary": "ファイルをダウンロード", - "description": "以前[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", + "description": "以前 [ファイルをアップロード](/api-reference/files/upload-file) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセスできます。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "プレビューするファイルの一意の識別子です。[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API のレスポンスから取得します。", + "description": "プレビューするファイルの一意の識別子。[ファイルをアップロード](/api-reference/files/upload-file) API レスポンスから取得します。", "schema": { "type": "string", "format": "uuid" @@ -915,7 +915,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "`true` の場合、ブラウザでプレビューする代わりにファイルを添付ファイルとして強制ダウンロードします。", + "description": "`true` の場合、ブラウザでプレビューする代わりに添付ファイルとしてダウンロードを強制します。", "schema": { "type": "boolean", "default": false @@ -925,7 +925,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子。エンドユーザーのコンテキストに使用されます。", + "description": "ユーザー識別子。エンドユーザーコンテキストに使用されます。", "schema": { "type": "string" } @@ -933,7 +933,7 @@ ], "responses": { "200": { - "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` としてダウンロード形式で返されます。", + "description": "生のファイルコンテンツを返します。`Content-Type` ヘッダーはファイルの MIME タイプに設定されます。`as_attachment` が `true` の場合、ファイルは `Content-Disposition: attachment` でダウンロードとして返されます。", "content": { "application/octet-stream": { "schema": { @@ -982,12 +982,12 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserWorkflowJp", + "operationId": "getEndUserWorkflow", "tags": [ - "エンドユーザー" + "End Users" ], - "summary": "エンドユーザー取得", - "description": "ID を指定してエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード)の `created_by`）に便利です。", + "summary": "エンドユーザー情報を取得", + "description": "ID でエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：[ファイルをアップロード](/api-reference/files/upload-file) の `created_by`）に便利です。", "parameters": [ { "name": "end_user_id", @@ -1002,7 +1002,7 @@ ], "responses": { "200": { - "description": "エンドユーザーを正常に取得しました。", + "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { "schema": { @@ -1050,12 +1050,12 @@ }, "/audio-to-text": { "post": { - "operationId": "workflowAudioToTextJa", + "operationId": "workflowAudioToText", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "音声をテキストに変換", - "description": "音声ファイルをテキストに変換します。サポートされる形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズの上限は `30 MB` です。", + "description": "音声ファイルをテキストに変換します。サポートされるフォーマット：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。ファイルサイズ制限は `30 MB` です。", "requestBody": { "required": true, "content": { @@ -1086,7 +1086,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声認識をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用できないか、設定が正しくありません。\n- `no_audio_uploaded` : 音声ファイルがアップロードされていません。\n- `provider_not_support_speech_to_text` : モデルプロバイダーが音声テキスト変換をサポートしていません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : 音声認識リクエストが失敗しました。", "content": { "application/json": { "examples": { @@ -1151,7 +1151,7 @@ } }, "413": { - "description": "`audio_too_large` : 音声ファイルサイズが上限を超えています。", + "description": "`audio_too_large` : 音声ファイルサイズが制限を超えました。", "content": { "application/json": { "examples": { @@ -1168,7 +1168,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 許可されていない音声タイプです。", + "description": "`unsupported_audio_type` : 音声タイプが許可されていません。", "content": { "application/json": { "examples": { @@ -1206,9 +1206,9 @@ }, "/text-to-audio": { "post": { - "operationId": "workflowTextToAudioJa", + "operationId": "workflowTextToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "テキストを音声に変換", "description": "テキストを音声に変換します。", @@ -1235,7 +1235,7 @@ }, "responses": { "200": { - "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声の MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", + "description": "生成された音声ファイルを返します。`Content-Type` ヘッダーは音声 MIME タイプ（例：`audio/wav`、`audio/mp3`）に設定されます。`streaming` が `true` の場合、音声はチャンク転送エンコーディングでストリーミングされます。", "content": { "audio/mpeg": { "schema": { @@ -1246,7 +1246,7 @@ } }, "400": { - "description": "- `app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータが使い切られました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト読み上げリクエストに失敗しました。", + "description": "- `app_unavailable` : アプリが利用できないか、設定が正しくありません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。\n- `provider_quota_exceeded` : モデルプロバイダーのクォータを超過しました。\n- `model_currently_not_support` : 現在のモデルはこの操作をサポートしていません。\n- `completion_request_error` : テキスト音声変換リクエストが失敗しました。", "content": { "application/json": { "examples": { @@ -1316,12 +1316,12 @@ }, "/info": { "get": { - "operationId": "getWorkflowAppInfoJp", + "operationId": "getWorkflowAppInfo", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションの基本情報を取得", - "description": "このアプリケーションの基本情報（名前、説明、タグ、モード）を取得します。", + "summary": "アプリ情報を取得", + "description": "このアプリケーションの名前、説明、タグ、モードを含む基本情報を取得します。", "responses": { "200": { "description": "アプリケーションの基本情報。", @@ -1353,12 +1353,12 @@ }, "/parameters": { "get": { - "operationId": "getWorkflowAppParametersJp", + "operationId": "getWorkflowAppParameters", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのパラメータ情報を取得", - "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。", + "summary": "アプリパラメータを取得", + "description": "機能スイッチ、入力パラメータ名、タイプ、デフォルト値を含むアプリケーションの入力フォーム設定を取得します。", "responses": { "200": { "description": "アプリケーションパラメータ情報。", @@ -1435,7 +1435,7 @@ } }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用できないか、設定が正しくありません。", "content": { "application/json": { "examples": { @@ -1456,15 +1456,15 @@ }, "/meta": { "get": { - "operationId": "getWorkflowAppMetaJa", + "operationId": "getWorkflowAppMeta", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのメタ情報を取得", - "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細）を取得します。", + "summary": "アプリメタを取得", + "description": "ツールアイコンやその他の設定詳細を含む、このアプリケーションのメタデータを取得します。", "responses": { "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", + "description": "アプリケーションメタ情報の取得に成功しました。", "content": { "application/json": { "schema": { @@ -1492,12 +1492,12 @@ }, "/site": { "get": { - "operationId": "getWorkflowWebAppSettingsJp", + "operationId": "getWorkflowWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", + "summary": "アプリ WebApp 設定を取得", + "description": "サイト設定、テーマ、カスタマイズオプションを含む、このアプリケーションの WebApp 設定を取得します。", "responses": { "200": { "description": "アプリケーションの WebApp 設定。", @@ -1510,7 +1510,7 @@ "webAppSettings": { "summary": "レスポンス例", "value": { - "title": "My Chat App", + "title": "マイチャットアプリ", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", @@ -1553,10 +1553,10 @@ "/form/human_input/{form_token}": { "get": { "tags": [ - "人間の入力" + "Human Input" ], - "summary": "人間の入力フォームを取得", - "description": "`human_input_required` イベントの `form_token` を用いて、一時停止中の人間の入力フォームの内容を取得します。**WebApp** 配信が必要です。", + "summary": "Human Input フォームを取得", + "description": "`human_input_required` イベントの `form_token` を使用して、一時停止中の Human Input フォームの内容を取得します。**WebApp** 配信が必要です。", "operationId": "getWorkflowHumanInputForm", "parameters": [ { @@ -1566,7 +1566,7 @@ "schema": { "type": "string" }, - "description": "一時停止フォームのアクセストークン。ストリーミングモードで [ワークフローを実行](/api-reference/ワークフロー/ワークフローを実行) が返す `human_input_required` イベントから取得します。" + "description": "一時停止したフォームのアクセストークン。ストリーミングモードの [ワークフローを実行](/api-reference/workflows/run-workflow) からの `human_input_required` イベントで返されます。" } ], "responses": { @@ -1579,7 +1579,7 @@ "properties": { "form_content": { "type": "string", - "description": "ワークフロー変数が置換された、事前レンダリング済みのフォーム本文。" + "description": "ワークフロー変数が置換された事前レンダリングされたフォーム本文。" }, "inputs": { "type": "array", @@ -1588,27 +1588,27 @@ "properties": { "type": { "type": "string", - "description": "フォーム入力コントロールの種類。使用可能な値：`text_input`（単一行テキスト）と `paragraph`（複数行テキスト）。" + "description": "フォーム入力コントロールタイプ。使用可能な値：`text_input`（単一行テキストフィールド）および `paragraph`（複数行テキストエリア）。" }, "output_variable_name": { "type": "string", - "description": "この入力の送信値をワークフロー内で参照する変数名。送信時の `inputs` オブジェクトのキーに対応します。" + "description": "ワークフロー内でこの入力の送信値を参照するために使用される変数名。送信 `inputs` オブジェクトのキーに対応します。" }, "default": { "type": "object", "nullable": true, - "description": "ワークフローコンテキストから解決されるデフォルト値。デフォルトが設定されていない場合は `null`。", + "description": "ワークフローコンテキストから解決されたデフォルト値。デフォルトが設定されていない場合は `null`。", "properties": { "type": { "type": "string", - "description": "デフォルト値のソース。`constant` は `value` をリテラル文字列として使用します。`variable` は `selector` がワークフロー変数を指します。" + "description": "デフォルトのソース。`constant` は `value` がリテラル文字列として使用されることを意味し、`variable` は `selector` がワークフロー変数を指すことを意味します。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 要素を含みます。" + "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも2つの要素を含む必要があります。" }, "value": { "type": "string", @@ -1625,7 +1625,7 @@ "additionalProperties": { "type": "string" }, - "description": "事前入力デフォルト値。入力の `output_variable_name` をキーとします。すべての値は文字列化されます。" + "description": "入力 `output_variable_name` をキーとする事前入力されたデフォルト値。すべての値は文字列化されています。" }, "user_actions": { "type": "array", @@ -1636,16 +1636,16 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "アクションボタンの識別子。受信者がこのボタンを選択したら、`action` として [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡します。" + "description": "アクションボタンの識別子。受信者がこのボタンを選択したときに [Human Input フォームを送信](/api-reference/human-input/submit-human-input-form) で `action` として渡します。" }, "title": { "type": "string", "maxLength": 100, - "description": "受信者に表示されるボタンのラベル。" + "description": "受信者に表示されるボタンラベル。" }, "button_style": { "type": "string", - "description": "ボタンの視覚スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" + "description": "ボタンの視覚的スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" } } }, @@ -1654,7 +1654,7 @@ "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。これを過ぎるとフォームは送信できなくなります。" + "description": "このフォームが送信できなくなる Unix タイムスタンプ（秒）。" } } }, @@ -1680,12 +1680,12 @@ "user_actions": [ { "id": "approve", - "title": "Approve", + "title": "承認", "button_style": "primary" }, { "id": "reject", - "title": "Request changes", + "title": "変更をリクエスト", "button_style": "default" } ], @@ -1697,7 +1697,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found` : フォームが見つかりません。", "content": { "application/json": { "examples": { @@ -1714,7 +1714,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted` : フォームは既に送信されています。フォームは一度限りで、どのユーザーが送信しても最初の応答が優先されます。\n- `human_input_form_expired` : 送信前にフォームの有効期限が切れました。", "content": { "application/json": { "examples": { @@ -1742,10 +1742,10 @@ }, "post": { "tags": [ - "人間の入力" + "Human Input" ], - "summary": "人間の入力フォームを送信", - "description": "一時停止中の人間の入力フォームに対する受信者の応答を送信します。フォームが受理されるとワークフローが再開するため、後続のイベントは [ワークフローイベントをストリーム](/api-reference/ワークフロー/ワークフローイベントをストリーム) で受信してください。**WebApp** 配信が必要です。", + "summary": "Human Input フォームを送信", + "description": "一時停止中の Human Input フォームへの受信者の応答を送信します。承認されるとワークフローが再開されます。後続のイベントを追跡するには [ワークフローイベントをストリーム](/api-reference/workflows/stream-workflow-events) を使用してください。**WebApp** 配信が必要です。", "operationId": "submitWorkflowHumanInputForm", "parameters": [ { @@ -1755,7 +1755,7 @@ "schema": { "type": "string" }, - "description": "一時停止フォームのアクセストークン。ストリーミングモードで [ワークフローを実行](/api-reference/ワークフロー/ワークフローを実行) が返す `human_input_required` イベントから取得します。" + "description": "一時停止したフォームのアクセストークン。ストリーミングモードの [ワークフローを実行](/api-reference/workflows/run-workflow) からの `human_input_required` イベントで返されます。" } ], "requestBody": { @@ -1773,11 +1773,11 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "受信者が提供した値。入力の `output_variable_name` をキーとします。" + "description": "入力 `output_variable_name` をキーとする受信者提供の値。" }, "action": { "type": "string", - "description": "受信者が選択したアクションボタンの ID。[人間の入力フォームを取得](/api-reference/人間の入力/人間の入力フォームを取得) で返される `user_actions` リストに含まれるいずれかの `id` 値と一致する必要があります。", + "description": "受信者が選択したアクションボタンの ID。フォームの `user_actions` リスト（[Human Input フォームを取得](/api-reference/human-input/get-human-input-form) で返される）の `id` 値のいずれかと一致する必要があります。", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, @@ -1804,7 +1804,7 @@ }, "responses": { "200": { - "description": "フォームの送信に成功しました。レスポンスボディは空オブジェクトです。", + "description": "フォームの送信に成功しました。レスポンスボディは空のオブジェクトです。", "content": { "application/json": { "schema": { @@ -1820,7 +1820,7 @@ } }, "400": { - "description": "- `bad_request` : Form recipient type is invalid.\n- `invalid_form_data` : Submission failed validation against the form definition.", + "description": "- `bad_request` : フォーム受信者タイプが無効です。\n- `invalid_form_data` : フォーム定義に対する検証に失敗しました。", "content": { "application/json": { "examples": { @@ -1845,7 +1845,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found` : フォームが見つかりません。", "content": { "application/json": { "examples": { @@ -1862,7 +1862,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted` : フォームは既に送信されています。フォームは一度限りで、どのユーザーが送信しても最初の応答が優先されます。\n- `human_input_form_expired` : 送信前にフォームの有効期限が切れました。", "content": { "application/json": { "examples": { @@ -1892,10 +1892,10 @@ "/workflow/{task_id}/events": { "get": { "tags": [ - "ワークフロー" + "Workflows" ], "summary": "ワークフローイベントをストリーム", - "description": "一時停止後または元の SSE 接続が切断された後にワークフロー実行の Server-Sent Events ストリームを再開します。すでに完了している実行に対しては、`workflow_finished` イベントを 1 つ送信してストリームを閉じます。", + "description": "一時停止または切断された SSE 接続の後にワークフロー実行の Server-Sent Events ストリームを再開します。既に終了した実行の場合、ストリームは単一の `workflow_finished` イベントを発行して閉じます。", "operationId": "streamWorkflowEvents", "parameters": [ { @@ -1915,7 +1915,7 @@ "schema": { "type": "string" }, - "description": "この実行を最初にトリガーしたエンドユーザー識別子。ワークフロー実行の作成者と一致している必要があります。" + "description": "元々実行をトリガーしたエンドユーザー識別子。ワークフロー実行の作成者と一致する必要があります。" }, { "name": "include_state_snapshot", @@ -1925,7 +1925,7 @@ "type": "boolean", "default": false }, - "description": "`true` の場合、永続化された状態スナップショットからリプレイし、新しいイベントのストリーミング開始前に実行済みノードのステータスサマリーを含めます。" + "description": "`true` の場合、永続化された状態スナップショットから再生し、新しいイベントをストリーミングする前に既に実行されたノードのステータスサマリーを含めます。" }, { "name": "continue_on_pause", @@ -1935,7 +1935,7 @@ "type": "boolean", "default": false }, - "description": "`true` に設定すると、複数の `workflow_paused` イベントを跨いでストリームを開いたままにします（ワークフローに複数の人間の入力ノードが連続する場合に有用）。デフォルトでは最初の一時停止で閉じます。" + "description": "`true` に設定すると、複数の `workflow_paused` イベントにわたってストリームを開いたままにします（ワークフローに複数の Human Input ノードが連続している場合に便利）。デフォルトは最初の一時停止後にストリームを閉じます。" } ], "responses": { @@ -1951,7 +1951,7 @@ } }, "400": { - "description": "`not_workflow_app` : Please check if your app mode matches the right API route.", + "description": "`not_workflow_app` : アプリモードが正しい API ルートと一致しているか確認してください。", "content": { "application/json": { "examples": { @@ -1968,7 +1968,7 @@ } }, "404": { - "description": "`not_found` : Workflow run not found.", + "description": "`not_found` : ワークフロー実行が見つかりません。", "content": { "application/json": { "examples": { @@ -1994,7 +1994,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 認証です。すべての API リクエストにおいて、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックスを付けた API Key を含めてください。例：`Authorization: Bearer {API_KEY}`。**API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。**" + "description": "API キー認証。すべての API リクエストで、`Authorization` HTTP ヘッダーに `Bearer ` プレフィックス付きで API キーを含めてください。例：`Authorization: Bearer {API_KEY}`。**API キーはサーバー側に保存し、クライアント側で共有または保存しないことを強く推奨します。API キーの漏洩は深刻な結果を招く可能性があります。**" } }, "responses": { @@ -2010,7 +2010,7 @@ "enum": [ "success" ], - "description": "操作結果です。" + "description": "操作結果。" } } }, @@ -2036,7 +2036,7 @@ "properties": { "inputs": { "type": "object", - "description": "ワークフロー入力変数のキーと値のペアです。ファイル型変数の値は、`type`、`transfer_method`、および `url` または `upload_file_id` を持つファイルオブジェクトの配列である必要があります。アプリが期待する変数名と型については、[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) レスポンスの `user_input_form` フィールドを参照してください。", + "description": "ワークフロー入力変数のキーと値のペア。ファイルタイプ変数の値は、`type`、`transfer_method`、および `url` または `upload_file_id` のいずれかを含むファイルオブジェクトの配列である必要があります。アプリが期待する変数名とタイプを確認するには、[アプリパラメータを取得](/api-reference/applications/get-app-parameters) レスポンスの `user_input_form` フィールドを参照してください。", "additionalProperties": { "oneOf": [ { @@ -2066,11 +2066,11 @@ "streaming", "blocking" ], - "description": "レスポンスモードです。同期レスポンスには `blocking`（Cloudflare タイムアウトは `100 s`）、サーバー送信イベントには `streaming` を使用します。省略した場合、デフォルトはブロッキング動作になります。" + "description": "レスポンスモード。同期レスポンスには `blocking` を使用（Cloudflare タイムアウトは `100 秒`）、Server-Sent Events には `streaming` を使用します。省略した場合、デフォルトでブロッキング動作になります。" }, "user": { "type": "string", - "description": "開発者のルールで定義されるユーザー識別子で、アプリケーション内で一意である必要があります。この識別子はデータアクセスの範囲を限定します——ワークフロー実行とファイルは同じ `user` 値でクエリした場合にのみ表示されます。" + "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。この識別子はデータアクセスのスコープを定め、ワークフロー実行とファイルは同じ `user` 値でクエリした場合のみ表示されます。" }, "files": { "type": "array", @@ -2078,7 +2078,7 @@ "$ref": "#/components/schemas/InputFileObject" }, "nullable": true, - "description": "ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` で使用します。" + "description": "ファイルリスト。ファイルをテキストと組み合わせて入力する必要がある場合に適しています。モデルがビジョン機能をサポートしている場合のみ使用可能です。ローカルファイルを添付するには、まず [ファイルをアップロード](/api-reference/files/upload-file) でアップロードし、返された `id` を `upload_file_id` として `transfer_method: local_file` と共に使用します。" } } }, @@ -2106,16 +2106,16 @@ "remote_url", "local_file" ], - "description": "転送方法です。ファイル URL の場合は `remote_url`、アップロードファイルの場合は `local_file` です。" + "description": "転送方法：ファイル URL の場合は `remote_url`、アップロードされたファイルの場合は `local_file`。" }, "url": { "type": "string", "format": "url", - "description": "ファイル URL（`transfer_method` が `remote_url` の場合）です。" + "description": "ファイル URL（`transfer_method` が `remote_url` の場合）。" }, "upload_file_id": { "type": "string", - "description": "[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API から取得したアップロード済みファイル ID です（`transfer_method` が `local_file` の場合に使用）。" + "description": "[ファイルをアップロード](/api-reference/files/upload-file) API から取得したアップロードファイル ID（`transfer_method` が `local_file` の場合）。" } } }, @@ -2125,12 +2125,12 @@ "task_id": { "type": "string", "format": "uuid", - "description": "進行中の実行のタスク ID です。[ワークフロータスクを停止](/api-reference/ワークフロー/ワークフロータスクを停止) と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。" + "description": "進行中の実行のタスク ID。実行中のワークフローをキャンセルするには [ワークフロータスクを停止](/api-reference/workflows/stop-workflow-task) と共に使用します。実行中のみ有効です。" }, "workflow_run_id": { "type": "string", "format": "uuid", - "description": "このワークフロー実行記録の永続的な識別子です。[ワークフロー実行詳細を取得](/api-reference/ワークフロー/ワークフロー実行詳細を取得) と組み合わせて、実行後に結果を取得します。" + "description": "このワークフロー実行レコードの永続的な識別子。実行後に結果を取得するには [ワークフロー実行詳細を取得](/api-reference/workflows/get-workflow-run-detail) と共に使用します。" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedData" @@ -2145,6 +2145,7 @@ "properties": { "event": { "type": "string", + "description": "ストリーミングイベントのタイプ。", "enum": [ "workflow_started", "node_started", @@ -2168,8 +2169,7 @@ "human_input_form_timeout", "error", "ping" - ], - "description": "ストリーミングイベントの種類。" + ] } }, "discriminator": { @@ -2206,12 +2206,12 @@ "task_id": { "type": "string", "format": "uuid", - "description": "進行中の実行のタスク ID です。[ワークフロータスクを停止](/api-reference/ワークフロー/ワークフロータスクを停止) と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。" + "description": "進行中の実行のタスク ID。実行中のワークフローをキャンセルするには [ワークフロータスクを停止](/api-reference/workflows/stop-workflow-task) と共に使用します。実行中のみ有効です。" }, "workflow_run_id": { "type": "string", "format": "uuid", - "description": "このワークフロー実行記録の永続的な識別子です。[ワークフロー実行詳細を取得](/api-reference/ワークフロー/ワークフロー実行詳細を取得) と組み合わせて、実行後に結果を取得します。" + "description": "このワークフロー実行レコードの永続的な識別子。実行後に結果を取得するには [ワークフロー実行詳細を取得](/api-reference/workflows/get-workflow-run-detail) と共に使用します。" } } }, @@ -2232,26 +2232,26 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", - "description": "Workflow ID." + "description": "ワークフロー ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "このワークフロー実行の入力変数です。" + "description": "このワークフロー実行の入力変数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が開始した Unix タイムスタンプです。" + "description": "ワークフロー実行が開始された Unix タイムスタンプ。" }, "reason": { "type": "string", - "description": "ワークフロー開始の理由です。`initial` は新規実行、`resumption` は一時停止状態からの再開を示します。" + "description": "ワークフロー開始の理由。新規実行の場合は `initial`、一時停止状態から再開する場合は `resumption`。" } } } @@ -2276,58 +2276,58 @@ "id": { "type": "string", "format": "uuid", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "ノードタイプ（例：`llm`、`code`、`template-transform`）です。" + "description": "ノードタイプ（例：`llm`、`code`、`template-transform`）。" }, "title": { "type": "string", - "description": "ノードの表示名です。" + "description": "ノードの表示名。" }, "index": { "type": "integer", - "description": "実行シーケンスインデックスです。" + "description": "実行シーケンスインデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID（存在する場合）です。" + "description": "前のノードの ID（存在する場合）。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "このノードの入力変数です。" + "description": "このノードの入力変数。" }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ノード実行が開始した Unix タイムスタンプです。" + "description": "ノード実行が開始された Unix タイムスタンプ。" }, "extras": { "type": "object", "additionalProperties": true, - "description": "ノード実行の追加メタデータです。" + "description": "ノード実行の追加メタデータ。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "このノードがイテレーション内で実行される場合の親イテレーション ID です。" + "description": "このノードがイテレーション内で実行される場合の親イテレーション ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "このノードがループ内で実行される場合の親ループ ID です。" + "description": "このノードがループ内で実行される場合の親ループ ID。" } } } @@ -2352,105 +2352,105 @@ "id": { "type": "string", "format": "uuid", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "ノードの表示名です。" + "description": "ノードの表示名。" }, "index": { "type": "integer", - "description": "実行シーケンスインデックスです。" + "description": "実行シーケンスインデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID（存在する場合）です。" + "description": "前のノードの ID（存在する場合）。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "このノードの入力変数です。" + "description": "このノードの入力変数。" }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ノード実行中に生成された処理データです。" + "description": "ノード実行中に生成された処理データ。" }, "process_data_truncated": { "type": "boolean", - "description": "`process_data` が切り詰められたかどうかです。" + "description": "`process_data` が切り詰められたかどうか。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ノードからの出力データです。" + "description": "ノードからの出力データ。" }, "outputs_truncated": { "type": "boolean", - "description": "`outputs` データが切り詰められたかどうかです。" + "description": "`outputs` データが切り詰められたかどうか。" }, "status": { "type": "string", - "description": "ノードの実行ステータスです。`running` は進行中、`succeeded` は完了、`failed` はエラー、`stopped` は手動停止、`exception` は予期しない障害を示します。" + "description": "ノード実行ステータス。`running` は進行中、`succeeded` は完了、`failed` はエラー時、`stopped` は手動停止時、`exception` は予期しない失敗時。" }, "error": { "type": "string", "nullable": true, - "description": "ノードが失敗した場合のエラーメッセージです。" + "description": "ノードが失敗した場合のエラーメッセージ。" }, "elapsed_time": { "type": "number", "format": "float", - "description": "経過時間（秒）です。" + "description": "経過時間（秒）。" }, "execution_metadata": { "type": "object", "nullable": true, - "description": "トークン使用量を含む実行メタデータです。", + "description": "token 使用量を含む実行メタデータ。", "properties": { "total_tokens": { "type": "integer", "nullable": true, - "description": "このノードで消費された合計トークン数です。" + "description": "このノードで消費された合計 token 数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, - "description": "このノード実行の合計コストです。" + "description": "このノード実行の合計コスト。" }, "currency": { "type": "string", "nullable": true, - "description": "コストの通貨（例: `USD`）です。" + "description": "コストの通貨（例：`USD`）。" } } }, "created_at": { "type": "integer", "format": "int64", - "description": "ノード実行が開始した Unix タイムスタンプです。" + "description": "ノード実行が開始された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", - "description": "ノード実行が完了した Unix タイムスタンプです。" + "description": "ノード実行が終了した Unix タイムスタンプ。" }, "files": { "type": "array", @@ -2459,17 +2459,17 @@ "type": "object", "additionalProperties": true }, - "description": "このノードで生成されたファイルです。" + "description": "このノードで生成されたファイル。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "このノードがイテレーション内で実行される場合の親イテレーション ID です。" + "description": "このノードがイテレーション内で実行される場合の親イテレーション ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "このノードがループ内で実行される場合の親ループ ID です。" + "description": "このノードがループ内で実行される場合の親ループ ID。" } } } @@ -2494,28 +2494,28 @@ "id": { "type": "string", "format": "uuid", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "ワークフローグラフ内のノード ID です。" + "description": "ワークフローグラフ内のノード ID。" }, "node_type": { "type": "string", - "description": "Node type." + "description": "ノードタイプ。" }, "title": { "type": "string", - "description": "ノードの表示名です。" + "description": "ノードの表示名。" }, "index": { "type": "integer", - "description": "実行シーケンスインデックスです。" + "description": "実行シーケンスインデックス。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "先行ノードの ID（存在する場合）です。" + "description": "前のノードの ID（存在する場合）。" }, "inputs": { "type": "object", @@ -2524,17 +2524,17 @@ }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ノード実行中に生成された処理データです。" + "description": "ノード実行中に生成された処理データ。" }, "process_data_truncated": { "type": "boolean", - "description": "`process_data` が切り詰められたかどうかです。" + "description": "`process_data` が切り詰められたかどうか。" }, "outputs": { "type": "object", @@ -2543,21 +2543,21 @@ }, "outputs_truncated": { "type": "boolean", - "description": "`outputs` データが切り詰められたかどうかです。" + "description": "`outputs` データが切り詰められたかどうか。" }, "status": { "type": "string", - "description": "リトライ時点のノード実行ステータスです。" + "description": "リトライ時点でのノード実行ステータス。" }, "error": { "type": "string", "nullable": true, - "description": "リトライをトリガーしたエラーメッセージです。" + "description": "リトライをトリガーしたエラーメッセージ。" }, "elapsed_time": { "type": "number", "format": "float", - "description": "経過時間（秒）です。" + "description": "経過時間（秒）。" }, "created_at": { "type": "integer", @@ -2569,7 +2569,7 @@ }, "retry_index": { "type": "integer", - "description": "ゼロ始まりのリトライ回数インデックスです。" + "description": "ゼロベースのリトライ試行インデックス。" }, "iteration_id": { "type": "string", @@ -2583,7 +2583,7 @@ "type": "object", "additionalProperties": true, "nullable": true, - "description": "ノード実行のメタデータです。" + "description": "ノード実行からのメタデータ。" }, "files": { "type": "array", @@ -2591,7 +2591,7 @@ "type": "object", "additionalProperties": true }, - "description": "実行中にノードが生成したファイルです。" + "description": "実行中にノードによって生成されたファイル。" } } } @@ -2616,19 +2616,19 @@ "id": { "type": "string", "format": "uuid", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "node_id": { "type": "string", - "description": "イテレーションノード ID です。" + "description": "イテレーションノード ID。" }, "node_type": { "type": "string", - "description": "ノードの種類（常に `iteration`）です。" + "description": "ノードタイプ（常に `iteration`）。" }, "title": { "type": "string", - "description": "イテレーションノードの表示名です。" + "description": "イテレーションノードの表示名。" }, "created_at": { "type": "integer", @@ -2637,16 +2637,16 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "イテレーションの入力変数です。" + "description": "イテレーションの入力変数。" }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "metadata": { "type": "object", "additionalProperties": true, - "description": "イテレーションのメタデータです。" + "description": "イテレーションメタデータ。" }, "extras": { "type": "object", @@ -2687,7 +2687,7 @@ }, "index": { "type": "integer", - "description": "現在のイテレーションインデックス（ゼロ始まり）です。" + "description": "現在のイテレーションインデックス（ゼロベース）。" }, "created_at": { "type": "integer", @@ -2737,32 +2737,32 @@ }, "outputs_truncated": { "type": "boolean", - "description": "`outputs` データが切り詰められたかどうかです。" + "description": "`outputs` データが切り詰められたかどうか。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "イテレーションの入力変数です。" + "description": "イテレーションの入力変数。" }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "created_at": { "type": "integer", "format": "int64", - "description": "イテレーションが開始した Unix タイムスタンプです。" + "description": "イテレーションが開始された Unix タイムスタンプ。" }, "extras": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "イテレーションの追加メタデータです。" + "description": "イテレーションの追加メタデータ。" }, "status": { "type": "string", - "description": "イテレーションの完了ステータスです。" + "description": "イテレーション完了ステータス。" }, "error": { "type": "string", @@ -2778,7 +2778,7 @@ "execution_metadata": { "type": "object", "additionalProperties": true, - "description": "トークン使用量を含む実行メタデータです。" + "description": "token 使用量を含む実行メタデータ。" }, "finished_at": { "type": "integer", @@ -2786,7 +2786,7 @@ }, "steps": { "type": "integer", - "description": "完了したイテレーションステップ数です。" + "description": "完了したイテレーションステップ数。" } } } @@ -2831,7 +2831,7 @@ }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "metadata": { "type": "object", @@ -2876,14 +2876,14 @@ }, "index": { "type": "integer", - "description": "現在のループイテレーションインデックス（ゼロベース）です。" + "description": "現在のループイテレーションインデックス（ゼロベース）。" }, "created_at": { "type": "integer", "format": "int64" }, "pre_loop_output": { - "description": "前回のループイテレーションからの出力です。", + "description": "前のループイテレーションからの出力。", "nullable": true }, "extras": { @@ -2930,17 +2930,17 @@ }, "outputs_truncated": { "type": "boolean", - "description": "`outputs` データが切り詰められたかどうかです。" + "description": "`outputs` データが切り詰められたかどうか。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ループの入力変数です。" + "description": "ループの入力変数。" }, "inputs_truncated": { "type": "boolean", - "description": "`inputs` データが切り捨てられたかどうかです。" + "description": "`inputs` データが切り詰められたかどうか。" }, "created_at": { "type": "integer", @@ -2950,11 +2950,11 @@ "type": "object", "additionalProperties": true, "nullable": true, - "description": "ループの追加メタデータです。" + "description": "ループの追加メタデータ。" }, "status": { "type": "string", - "description": "ループの完了ステータスです。" + "description": "ループ完了ステータス。" }, "error": { "type": "string", @@ -2970,7 +2970,7 @@ "execution_metadata": { "type": "object", "additionalProperties": true, - "description": "トークン使用量を含む実行メタデータです。" + "description": "token 使用量を含む実行メタデータ。" }, "finished_at": { "type": "integer", @@ -2978,7 +2978,7 @@ }, "steps": { "type": "integer", - "description": "完了したループイテレーション数です。" + "description": "完了したループイテレーション数。" } } } @@ -3002,7 +3002,7 @@ "properties": { "text": { "type": "string", - "description": "テキスト内容のチャンクです。" + "description": "テキストコンテンツチャンク。" }, "from_variable_selector": { "type": "array", @@ -3010,7 +3010,7 @@ "type": "string" }, "nullable": true, - "description": "ワークフロー内のテキスト変数のソースパスです。" + "description": "ワークフロー内のテキスト変数のソースパス。" } } } @@ -3034,7 +3034,7 @@ "properties": { "text": { "type": "string", - "description": "置換テキスト内容です。" + "description": "置換テキストコンテンツ。" } } } @@ -3074,12 +3074,12 @@ "audio": { "type": "string", "format": "byte", - "description": "Base64 エンコードされた MP3 音声チャンク。すべてのチャンクを順番にデコードして連結すると、完全な音声ファイルが生成されます。" + "description": "Base64 エンコードされた MP3 音声チャンク。完全な音声ファイルを生成するには、すべてのチャンクをデコードして順番に連結します。" }, "created_at": { "type": "integer", "format": "int64", - "description": "このオーディオチャンクが生成された Unix タイムスタンプです。" + "description": "この音声チャンクが生成された Unix タイムスタンプ。" } } } @@ -3098,12 +3098,12 @@ "properties": { "audio": { "type": "string", - "description": "空の文字列。音声ストリームの終了を示します。" + "description": "空文字列。音声ストリームの終了を示します。" }, "created_at": { "type": "integer", "format": "int64", - "description": "音声ストリームが終了した Unix タイムスタンプです。" + "description": "音声ストリームが終了した Unix タイムスタンプ。" } } } @@ -3122,7 +3122,7 @@ "properties": { "status": { "type": "integer", - "description": "エラーの HTTP ステータスコードです。" + "description": "エラーの HTTP ステータスコード。" }, "code": { "type": "string", @@ -3143,7 +3143,7 @@ }, { "type": "object", - "description": "キープアライブ ping イベントです。追加プロパティはありません。" + "description": "キープアライブ ping イベント。追加のプロパティはありません。" } ] }, @@ -3153,61 +3153,61 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", - "description": "Workflow ID." + "description": "ワークフロー ID。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。`running` は実行中、`succeeded` は正常完了、`failed` は実行エラー、`stopped` は手動停止、`partial-succeeded` は一部のノードが成功し他が失敗、`paused` は人間の入力待ちを示します。" + "description": "ワークフロー実行ステータス。`running` は進行中の実行、`succeeded` は正常に完了、`failed` はエラーが発生、`stopped` は手動で停止、`partial-succeeded` は一部のノードは成功したが他は失敗、`paused` は人間の入力を待機中。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ワークフローからの出力データです。" + "description": "ワークフローからの出力データ。" }, "error": { "type": "string", "nullable": true, - "description": "ワークフローが失敗した場合のエラーメッセージです。" + "description": "ワークフローが失敗した場合のエラーメッセージ。" }, "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "全ノードで消費された合計トークン数です。" + "description": "すべてのノードで消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行されたワークフローの合計ステップ数です。" + "description": "実行されたワークフローステップの合計数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が作成された Unix タイムスタンプです。" + "description": "ワークフロー実行が作成された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "ワークフロー実行が完了した Unix タイムスタンプです。" + "description": "ワークフロー実行が終了した Unix タイムスタンプ。" }, "created_by": { "type": "object", "additionalProperties": true, - "description": "作成者情報です。ストリーミングの `workflow_finished` イベントにのみ存在します。" + "description": "作成者情報。ストリーミング `workflow_finished` イベントでのみ存在します。" }, "exceptions_count": { "type": "integer", "nullable": true, - "description": "実行中に発生した例外の数です。ストリーミングの `workflow_finished` イベントにのみ含まれます。" + "description": "実行中に発生した例外の数。ストリーミング `workflow_finished` イベントでのみ存在します。" }, "files": { "type": "array", @@ -3216,7 +3216,7 @@ "additionalProperties": true }, "nullable": true, - "description": "ワークフロー実行中に生成されたファイルです。ストリーミングの `workflow_finished` イベントにのみ存在します。" + "description": "ワークフロー実行中に生成されたファイル。ストリーミング `workflow_finished` イベントでのみ存在します。" } } }, @@ -3226,57 +3226,57 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", - "description": "Workflow ID." + "description": "ワークフロー ID。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。`running` は実行中、`succeeded` は正常完了、`failed` は実行エラー、`stopped` は手動停止、`partial-succeeded` は一部のノードが成功し他が失敗、`paused` は人間の入力待ちを示します。" + "description": "ワークフロー実行ステータス。`running` は進行中の実行、`succeeded` は正常に完了、`failed` はエラーが発生、`stopped` は手動で停止、`partial-succeeded` は一部のノードは成功したが他は失敗、`paused` は人間の入力を待機中。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "ワークフロー実行の入力変数です。" + "description": "ワークフロー実行の入力変数。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ワークフローからの出力データです。" + "description": "ワークフローからの出力データ。" }, "error": { "type": "string", "nullable": true, - "description": "ワークフローが失敗した場合のエラーメッセージです。" + "description": "ワークフローが失敗した場合のエラーメッセージ。" }, "total_steps": { "type": "integer", - "description": "実行されたワークフローの合計ステップ数です。" + "description": "実行されたワークフローステップの合計数。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が作成された Unix タイムスタンプです。" + "description": "ワークフロー実行が作成された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "ワークフロー実行が完了した Unix タイムスタンプです。" + "description": "ワークフロー実行が終了した Unix タイムスタンプ。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" } } }, @@ -3378,12 +3378,12 @@ }, "type": { "type": "string", - "description": "エンドユーザーのタイプ。Service API ユーザーの場合は常に `service_api` です。" + "description": "エンドユーザータイプ。サービス API ユーザーの場合は常に `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API リクエストで提供された `user` 識別子です（例：[チャットメッセージを送信](/api-reference/チャットメッセージ/チャットメッセージを送信) の `user` フィールド）。" + "description": "API リクエストで提供された `user` 識別子（例：[チャットメッセージを送信](/api-reference/chats/send-chat-message) の `user` フィールド）。" }, "name": { "type": "string", @@ -3392,11 +3392,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "ユーザーが匿名かどうかを示します。元の API リクエストで `user` 識別子が提供されなかった場合、`true` になります。" + "description": "ユーザーが匿名かどうか。元の API リクエストで `user` 識別子が提供されなかった場合は `true`。" }, "session_id": { "type": "string", - "description": "セッション識別子。デフォルトは `external_user_id` の値です。" + "description": "セッション識別子。デフォルトは `external_user_id` の値。" }, "created_at": { "type": "string", @@ -3415,26 +3415,26 @@ "properties": { "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1ページあたりの項目数。" }, "total": { "type": "integer", - "description": "ログエントリの合計数です。" + "description": "ログエントリの合計数。" }, "has_more": { "type": "boolean", - "description": "さらにページがあるかどうかです。" + "description": "さらにページがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItem" }, - "description": "ワークフローログエントリのリストです。" + "description": "ワークフローログエントリのリスト。" } } }, @@ -3444,23 +3444,23 @@ "id": { "type": "string", "format": "uuid", - "description": "ログエントリ ID です。" + "description": "ログエントリ ID。" }, "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummary" }, "created_from": { "type": "string", - "description": "ワークフロー実行のソース（例：`service-api`）です。" + "description": "ワークフロー実行のソース（例：`service-api`）。" }, "created_by_role": { "type": "string", - "description": "作成者のロール（例：`end_user`、`account`）です。" + "description": "作成者のロール（例：`end_user`、`account`）。" }, "created_by_account": { "type": "object", "nullable": true, - "description": "管理者ユーザーが作成した場合のアカウント詳細です。", + "description": "管理者ユーザーによって作成された場合のアカウント詳細。", "properties": { "id": { "type": "string", @@ -3483,13 +3483,13 @@ "created_at": { "type": "integer", "format": "int64", - "description": "ログエントリが作成された Unix タイムスタンプです。" + "description": "ログエントリが作成された Unix タイムスタンプ。" }, "details": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ログエントリの追加詳細です。" + "description": "ログエントリの追加詳細。" } } }, @@ -3499,52 +3499,52 @@ "id": { "type": "string", "format": "uuid", - "description": "ワークフロー実行 ID です。" + "description": "ワークフロー実行 ID。" }, "version": { "type": "string", - "description": "ワークフローバージョン識別子です。" + "description": "ワークフローバージョン識別子。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。`running` は実行中、`succeeded` は正常完了、`failed` は実行エラー、`stopped` は手動停止、`partial-succeeded` は一部のノードが成功し他が失敗、`paused` は人間の入力待ちを示します。" + "description": "ワークフロー実行ステータス。`running` は進行中の実行、`succeeded` は正常に完了、`failed` はエラーが発生、`stopped` は手動で停止、`partial-succeeded` は一部のノードは成功したが他は失敗、`paused` は人間の入力を待機中。" }, "error": { "type": "string", "nullable": true, - "description": "ワークフローが失敗した場合のエラーメッセージです。" + "description": "ワークフローが失敗した場合のエラーメッセージ。" }, "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行されたワークフローの合計ステップ数です。" + "description": "実行されたワークフローステップの合計数。" }, "created_at": { "type": "integer", "format": "int64", - "description": "ワークフロー実行が作成された Unix タイムスタンプです。" + "description": "ワークフロー実行が作成された Unix タイムスタンプ。" }, "finished_at": { "type": "integer", "format": "int64", "nullable": true, - "description": "ワークフロー実行が完了した Unix タイムスタンプです。" + "description": "ワークフロー実行が終了した Unix タイムスタンプ。" }, "exceptions_count": { "type": "integer", - "description": "実行中に発生した例外の数です。" + "description": "実行中に発生した例外の数。" }, "triggered_from": { "type": "string", - "description": "ワークフロー実行をトリガーしたソースです。`debugging` はエディタからのテスト実行、`app` は API またはアプリからの実行を示します。" + "description": "ワークフロー実行をトリガーしたソース。エディターからのテスト実行の場合は `debugging`、API またはアプリから開始された実行の場合は `app`。" } } }, @@ -3558,15 +3558,15 @@ }, "type": { "type": "string", - "description": "エンドユーザーの種類です。" + "description": "エンドユーザータイプ。" }, "is_anonymous": { "type": "boolean", - "description": "エンドユーザーが匿名かどうかです。" + "description": "エンドユーザーが匿名かどうか。" }, "session_id": { "type": "string", - "description": "セッション識別子です。" + "description": "セッション識別子。" } } }, @@ -3580,7 +3580,7 @@ "file": { "type": "string", "format": "binary", - "description": "音声ファイルです。対応形式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。上限：`30 MB`。" + "description": "音声ファイル。サポート：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。制限：`30 MB`。" }, "user": { "type": "string", @@ -3599,12 +3599,12 @@ }, "TextToAudioRequest": { "type": "object", - "description": "テキストから音声への変換のリクエストボディ。`message_id` または `text` のいずれかを指定してください。", + "description": "テキストから音声への変換のリクエストボディ。`message_id` または `text` のいずれかを提供してください。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "メッセージ ID です。両方が指定された場合、`text` よりも優先されます。" + "description": "メッセージ ID。両方が提供された場合、`text` より優先されます。" }, "text": { "type": "string", @@ -3616,7 +3616,7 @@ }, "voice": { "type": "string", - "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) → `text_to_speech.voice` の `voice` 値を使用してください。" + "description": "テキスト音声変換に使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには [アプリパラメータを取得](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` の `voice` 値を使用してください。" }, "streaming": { "type": "boolean", @@ -3644,7 +3644,7 @@ }, "mode": { "type": "string", - "description": "アプリケーションモード。`completion` はテキスト生成アプリ、`chat` は基本チャットアプリ、`agent-chat` はエージェントベースのアプリ、`advanced-chat` は Chatflow アプリ、`workflow` はワークフローアプリです。" + "description": "アプリケーションモード。テキスト生成アプリの場合は `completion`、基本的なチャットアプリの場合は `chat`、Agent ベースのアプリの場合は `agent-chat`、チャットフローアプリの場合は `advanced-chat`、ワークフローアプリの場合は `workflow`。" }, "author_name": { "type": "string", @@ -3658,18 +3658,18 @@ "opening_statement": { "type": "string", "nullable": true, - "description": "オープニングステートメントのテキストです。" + "description": "オープニングステートメントテキスト。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, - "description": "提案された質問のリストです。" + "description": "推奨質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", - "description": "回答後の提案質問の設定です。", + "description": "回答後の推奨質問の設定。", "properties": { "enabled": { "type": "boolean", @@ -3679,7 +3679,7 @@ }, "speech_to_text": { "type": "object", - "description": "音声テキスト変換機能の設定です。", + "description": "音声テキスト変換機能の設定。", "properties": { "enabled": { "type": "boolean", @@ -3689,7 +3689,7 @@ }, "text_to_speech": { "type": "object", - "description": "テキスト音声変換機能の設定です。", + "description": "テキスト音声変換機能の設定。", "properties": { "enabled": { "type": "boolean", @@ -3697,17 +3697,17 @@ }, "voice": { "type": "string", - "description": "TTS 音声識別子。" + "description": "TTS の音声識別子。" }, "language": { "type": "string", - "description": "TTS 言語。" + "description": "TTS の言語。" } } }, "retriever_resource": { "type": "object", - "description": "ナレッジ検索の引用リソース設定です。", + "description": "ナレッジ検索引用リソースの設定。", "properties": { "enabled": { "type": "boolean", @@ -3717,7 +3717,7 @@ }, "annotation_reply": { "type": "object", - "description": "アノテーション返信機能の設定です。", + "description": "注釈返信機能の設定。", "properties": { "enabled": { "type": "boolean", @@ -3727,7 +3727,7 @@ }, "more_like_this": { "type": "object", - "description": "類似コンテンツ機能の設定です。", + "description": "類似コンテンツ機能の設定。", "properties": { "enabled": { "type": "boolean", @@ -3737,7 +3737,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "コンテンツモデレーション機能の設定です。", + "description": "コンテンツモデレーション機能の設定。", "properties": { "enabled": { "type": "boolean", @@ -3751,7 +3751,7 @@ "type": "object", "oneOf": [ { - "title": "Text Input", + "title": "テキスト入力", "type": "object", "properties": { "text-input": { @@ -3759,26 +3759,26 @@ "properties": { "label": { "type": "string", - "description": "入力フィールドの表示ラベルです。" + "description": "入力フィールドの表示ラベル。" }, "variable": { "type": "string", - "description": "ワークフローで使用される変数名です。" + "description": "ワークフローで使用される変数名。" }, "required": { "type": "boolean", - "description": "このフィールドが必須かどうかです。" + "description": "このフィールドが必須かどうか。" }, "default": { "type": "string", - "description": "入力フィールドのデフォルト値です。" + "description": "入力フィールドのデフォルト値。" } } } } }, { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -3786,26 +3786,26 @@ "properties": { "label": { "type": "string", - "description": "段落フィールドの表示ラベルです。" + "description": "段落フィールドの表示ラベル。" }, "variable": { "type": "string", - "description": "ワークフローで使用される変数名です。" + "description": "ワークフローで使用される変数名。" }, "required": { "type": "boolean", - "description": "このフィールドが必須かどうかです。" + "description": "このフィールドが必須かどうか。" }, "default": { "type": "string", - "description": "段落フィールドのデフォルト値です。" + "description": "段落フィールドのデフォルト値。" } } } } }, { - "title": "Select", + "title": "選択", "type": "object", "properties": { "select": { @@ -3813,26 +3813,26 @@ "properties": { "label": { "type": "string", - "description": "セレクトフィールドの表示ラベルです。" + "description": "選択フィールドの表示ラベル。" }, "variable": { "type": "string", - "description": "ワークフローで使用される変数名です。" + "description": "ワークフローで使用される変数名。" }, "required": { "type": "boolean", - "description": "このフィールドが必須かどうかです。" + "description": "このフィールドが必須かどうか。" }, "default": { "type": "string", - "description": "デフォルトで選択される値。" + "description": "デフォルトの選択値。" }, "options": { "type": "array", "items": { "type": "string" }, - "description": "このフォームコントロールの選択可能な値のリスト。" + "description": "このフォームコントロールで選択可能な値のリスト。" } } } @@ -3840,7 +3840,7 @@ } ] }, - "description": "ユーザー入力フォームの設定です。" + "description": "ユーザー入力フォームの設定。" }, "file_upload": { "type": "object", @@ -3855,18 +3855,18 @@ }, "number_limits": { "type": "integer", - "description": "アップロード可能な画像の最大数です。" + "description": "アップロードできる画像の最大数。" }, "detail": { "type": "string", - "description": "ビジョンモデルの画像詳細レベルです。" + "description": "ビジョンモデル用の画像詳細レベル。" }, "transfer_methods": { "type": "array", "items": { "type": "string" }, - "description": "画像アップロードで許可される転送方法です。`remote_url` はファイル URL 経由、`local_file` はアップロード済みファイルを示します。" + "description": "画像アップロードで許可される転送方法。ファイル URL の場合は `remote_url`、アップロードされたファイルの場合は `local_file`。" } } } @@ -3874,27 +3874,27 @@ }, "system_parameters": { "type": "object", - "description": "システムレベルのパラメータ制限です。", + "description": "システムレベルのパラメータ制限。", "properties": { "file_size_limit": { "type": "integer", - "description": "一般ファイルの最大サイズ（MB）です。" + "description": "一般ファイルの最大サイズ（MB）。" }, "image_file_size_limit": { "type": "integer", - "description": "最大画像ファイルサイズ（MB）。" + "description": "画像ファイルの最大サイズ（MB）。" }, "audio_file_size_limit": { "type": "integer", - "description": "最大音声ファイルサイズ（MB）。" + "description": "音声ファイルの最大サイズ（MB）。" }, "video_file_size_limit": { "type": "integer", - "description": "最大動画ファイルサイズ（MB）。" + "description": "動画ファイルの最大サイズ（MB）。" }, "workflow_file_upload_limit": { "type": "integer", - "description": "ワークフロー実行ごとの最大ファイル数です。" + "description": "ワークフロー実行ごとの最大ファイル数。" } } } @@ -3905,11 +3905,11 @@ "properties": { "background": { "type": "string", - "description": "ツールアイコンの背景色です。" + "description": "ツールアイコンの背景色。" }, "content": { "type": "string", - "description": "絵文字またはアイコンの内容です。" + "description": "絵文字またはアイコンコンテンツ。" } } }, @@ -3921,7 +3921,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコン URL", "type": "string", "format": "url", "description": "アイコンの URL。" @@ -3952,11 +3952,11 @@ }, "icon_type": { "type": "string", - "description": "使用されるアイコンのタイプ。`emoji` は絵文字アイコン、`image` はアップロードされた画像アイコンです。" + "description": "使用されるアイコンのタイプ。絵文字アイコンの場合は `emoji`、アップロードされた画像アイコンの場合は `image`。" }, "icon": { "type": "string", - "description": "アイコンのコンテンツ（絵文字または画像 ID）。" + "description": "アイコンコンテンツ（絵文字または画像 ID）。" }, "icon_background": { "type": "string", @@ -4015,19 +4015,19 @@ "workflow_run_id": { "type": "string", "format": "uuid", - "description": "このワークフロー実行記録の永続的な識別子です。[ワークフロー実行詳細を取得](/api-reference/ワークフロー/ワークフロー実行詳細を取得) と組み合わせて、実行後に結果を取得します。" + "description": "このワークフロー実行レコードの永続的な識別子。実行後に結果を取得するには [ワークフロー実行詳細を取得](/api-reference/workflows/get-workflow-run-detail) と共に使用します。" }, "paused_nodes": { "type": "array", "items": { "type": "string" }, - "description": "一時停止中のノード ID のリストです。" + "description": "一時停止中のノード ID のリスト。" }, "outputs": { "type": "object", "additionalProperties": true, - "description": "一時停止時の部分的な出力です。" + "description": "一時停止時点での部分的な出力。" }, "reasons": { "type": "array", @@ -4035,11 +4035,11 @@ "type": "object", "additionalProperties": true }, - "description": "一時停止の理由です。" + "description": "一時停止の理由。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。" + "description": "ワークフロー実行ステータス。" }, "created_at": { "type": "integer", @@ -4049,15 +4049,15 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行された合計ステップ数です。" + "description": "実行された合計ステップ数。" } } } @@ -4081,43 +4081,43 @@ "properties": { "node_execution_id": { "type": "string", - "description": "ノード実行 ID です。" + "description": "ノード実行 ID。" }, "id": { "type": "string", - "description": "エージェントログエントリ ID です。" + "description": "Agent ログエントリ ID。" }, "label": { "type": "string", - "description": "Log label." + "description": "ログラベル。" }, "parent_id": { "type": "string", "nullable": true, - "description": "親ログエントリ ID です。" + "description": "親ログエントリ ID。" }, "error": { "type": "string", "nullable": true, - "description": "エージェントステップが失敗した場合のエラーメッセージです。" + "description": "Agent ステップが失敗した場合のエラーメッセージ。" }, "status": { "type": "string", - "description": "エージェントステップのステータスです。" + "description": "Agent ステップステータス。" }, "data": { "type": "object", "additionalProperties": true, - "description": "エージェントステップのデータです。" + "description": "Agent ステップデータ。" }, "metadata": { "type": "object", "additionalProperties": true, - "description": "エージェントステップのメタデータです。" + "description": "Agent ステップメタデータ。" }, "node_id": { "type": "string", - "description": "Node ID." + "description": "ノード ID。" } } } @@ -4141,7 +4141,7 @@ "properties": { "form_id": { "type": "string", - "description": "フォームインスタンスの識別子。エラーメッセージやログに含まれます。Service API の呼び出しには `form_token` を使用してください。" + "description": "フォームインスタンスの識別子。エラーメッセージとログに表示されます。サービス API 呼び出しには `form_token` を使用してください。" }, "node_id": { "type": "string", @@ -4153,7 +4153,7 @@ }, "form_content": { "type": "string", - "description": "ワークフロー変数が置換された、事前レンダリング済みのフォーム本文。" + "description": "ワークフロー変数が置換された事前レンダリングされたフォーム本文。" }, "inputs": { "type": "array", @@ -4162,27 +4162,27 @@ "properties": { "type": { "type": "string", - "description": "フォーム入力コントロールの種類。使用可能な値：`text_input`（単一行テキスト）と `paragraph`（複数行テキスト）。" + "description": "フォーム入力コントロールタイプ。使用可能な値：`text_input`（単一行テキストフィールド）および `paragraph`（複数行テキストエリア）。" }, "output_variable_name": { "type": "string", - "description": "この入力の送信値をワークフロー内で参照する変数名。送信時の `inputs` オブジェクトのキーに対応します。" + "description": "ワークフロー内でこの入力の送信値を参照するために使用される変数名。送信 `inputs` オブジェクトのキーに対応します。" }, "default": { "type": "object", "nullable": true, - "description": "ワークフローコンテキストから解決されるデフォルト値。デフォルトが設定されていない場合は `null`。", + "description": "ワークフローコンテキストから解決されたデフォルト値。デフォルトが設定されていない場合は `null`。", "properties": { "type": { "type": "string", - "description": "デフォルト値のソース。`constant` は `value` をリテラル文字列として使用します。`variable` は `selector` がワークフロー変数を指します。" + "description": "デフォルトのソース。`constant` は `value` がリテラル文字列として使用されることを意味し、`variable` は `selector` がワークフロー変数を指すことを意味します。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも 2 要素を含みます。" + "description": "`type` が `variable` の場合の変数参照パス（例：`[\"node_id\", \"var_name\"]`）。少なくとも2つの要素を含む必要があります。" }, "value": { "type": "string", @@ -4192,7 +4192,7 @@ } } }, - "description": "受信者が記入するフォーム入力フィールド。" + "description": "受信者が入力するフォーム入力フィールド。" }, "actions": { "type": "array", @@ -4203,20 +4203,20 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "アクションボタンの識別子。受信者がこのボタンを選択したら、`action` として [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡します。" + "description": "アクションボタンの識別子。受信者がこのボタンを選択したときに [Human Input フォームを送信](/api-reference/human-input/submit-human-input-form) で `action` として渡します。" }, "title": { "type": "string", "maxLength": 100, - "description": "受信者に表示されるボタンのラベル。" + "description": "受信者に表示されるボタンラベル。" }, "button_style": { "type": "string", - "description": "ボタンの視覚スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" + "description": "ボタンの視覚的スタイル。使用可能な値：`primary`、`default`、`accent`、`ghost`。" } } }, - "description": "送信時に受信者が選択できるアクション（ボタン）。" + "description": "送信時に受信者が選択できる利用可能なユーザーアクション（ボタン）。" }, "display_in_ui": { "type": "boolean", @@ -4225,19 +4225,19 @@ "form_token": { "type": "string", "nullable": true, - "description": "[人間の入力フォームを取得](/api-reference/人間の入力/人間の入力フォームを取得) と [人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) のアクセストークン。人間の入力ノードがメール配信またはコンソール配信を使用する場合は `null` になります（Service API は WebApp 配信のフォームのみ操作できます）。" + "description": "[Human Input フォームを取得](/api-reference/human-input/get-human-input-form) および [Human Input フォームを送信](/api-reference/human-input/submit-human-input-form) 用のアクセストークン。Human Input ノードがメールまたはコンソール配信を使用している場合は `null`（サービス API は WebApp 配信されたフォームのみ操作できます）。" }, "resolved_default_values": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "入力の `output_variable_name` をキーとする事前入力デフォルト値。すべての値は文字列化されます。" + "description": "入力 `output_variable_name` をキーとするフォーム入力の事前入力されたデフォルト値。すべての値は文字列化されています。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。これを過ぎるとフォームは送信できなくなります。" + "description": "フォームが送信できなくなる Unix タイムスタンプ（秒）。" } } } @@ -4261,7 +4261,7 @@ "properties": { "node_id": { "type": "string", - "description": "フォームが記入された Human Input ノードの ID。" + "description": "フォームが入力された Human Input ノードの ID。" }, "node_title": { "type": "string", @@ -4269,11 +4269,11 @@ }, "rendered_content": { "type": "string", - "description": "受信者の入力値で描画されたフォーム本文（`human_input_required` の `form_content` は未入力のテンプレートです）。" + "description": "受信者の送信値でレンダリングされたフォーム本文（`human_input_required` の `form_content` は未入力のテンプレートです）。" }, "action_id": { "type": "string", - "description": "受信者が選択したアクションの識別子（[人間の入力フォームを送信](/api-reference/人間の入力/人間の入力フォームを送信) に渡された `action` の値と一致します）。" + "description": "受信者が選択したアクションの識別子（[Human Input フォームを送信](/api-reference/human-input/submit-human-input-form) に渡された `action` 値と一致します）。" }, "action_text": { "type": "string", @@ -4301,7 +4301,7 @@ "properties": { "node_id": { "type": "string", - "description": "フォームが期限切れとなった Human Input ノードの ID。" + "description": "フォームの有効期限が切れた Human Input ノードの ID。" }, "node_title": { "type": "string", @@ -4310,7 +4310,7 @@ "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix タイムスタンプ（秒）。フォームが期限切れとなった時刻。" + "description": "フォームの有効期限が切れた Unix タイムスタンプ（秒）。" } } } @@ -4322,28 +4322,28 @@ }, "tags": [ { - "name": "ワークフロー", - "description": "ワークフローの実行と管理のための操作です。" + "name": "Workflows", + "description": "ワークフローの実行と管理に関する操作。" }, { - "name": "ファイル操作", - "description": "ファイルのアップロードとダウンロードの操作です。" + "name": "Files", + "description": "ファイルのアップロードとダウンロード操作。" }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作です。" + "name": "End Users", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "音声・テキスト変換", - "description": "音声からテキストおよびテキストから音声への変換です。" + "name": "TTS", + "description": "音声からテキストおよびテキストから音声への変換。" }, { - "name": "アプリケーション設定", - "description": "アプリケーションの設定、パラメータ、メタデータです。" + "name": "Applications", + "description": "アプリケーション設定、パラメータ、メタデータ。" }, { - "name": "人間の入力", - "description": "人間の入力を要する一時停止中のワークフローの再開操作です。" + "name": "Human Input", + "description": "人間の入力を必要とする一時停止中のワークフローを再開するためのエンドポイント。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index ac6d02e8e..daa347300 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -2,13 +2,13 @@ "openapi": "3.0.1", "info": { "title": "对话型应用 API", - "description": "对话型应用支持会话持久化，允许将之前的聊天记录作为上下文进行回复。适用于聊天机器人、客服 AI 等场景。", + "description": "对话型应用支持会话持久化，允许将之前的聊天记录作为响应的上下文。适用于聊天机器人、客服 AI 等场景。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "对话型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。", + "description": "对话型应用 API 的基础 URL。请将 {api_base_url} 替换为您应用提供的实际 API 基础 URL。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -26,10 +26,10 @@ "/chat-messages": { "post": { "summary": "发送对话消息", - "description": "向应用发送请求。", - "operationId": "sendBasicChatMessageCn", + "description": "向对话型应用发送请求。", + "operationId": "sendChatMessage", "tags": [ - "对话消息" + "Chats" ], "requestBody": { "description": "发送对话消息的请求体。", @@ -41,7 +41,7 @@ }, "examples": { "streaming_example": { - "summary": "请求示例 - 流式模式", + "summary": "请求示例 - 流式返回", "value": { "inputs": { "city": "San Francisco" @@ -60,7 +60,7 @@ } }, "blocking_example": { - "summary": "请求示例 - 阻塞模式", + "summary": "请求示例 - 阻塞式返回", "value": { "inputs": {}, "query": "What are the specs of the iPhone 13 Pro Max?", @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "请求成功。内容类型和结构取决于请求中的 `response_mode` 参数。\n\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 和 `ChatCompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 和 `ChunkChatEvent` 对象流。", + "description": "成功响应。内容类型和结构取决于请求中的 `response_mode` 参数。\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 格式的 `ChatCompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 格式的 `ChunkChatEvent` 对象流。", "content": { "application/json": { "schema": { @@ -83,7 +83,7 @@ }, "examples": { "blockingResponse": { - "summary": "响应示例 - 阻塞模式", + "summary": "响应示例 - 阻塞式返回", "value": { "event": "message", "task_id": "c3800678-a077-43df-a102-53f23ed20b88", @@ -128,15 +128,15 @@ "text/event-stream": { "schema": { "type": "string", - "description": "服务器发送事件 (SSE) 流。每个事件是一个以 `data: ` 为前缀的 JSON 对象，以两个换行符终止。\n\n**SSE 解析指南：**每个事件是一行以 `data: ` 为前缀的 JSON 对象，以 `\\n\\n` 终止。解析 JSON 前先去除 `data: ` 前缀。JSON 内的 `event` 字段决定事件类型。当收到终止事件（如 `message_end`、`workflow_finished` 或 `error`）时流结束。忽略 `ping` 事件（每 10 秒发送一次以保持连接活跃）。注意即使流中出现错误事件，HTTP 状态码仍为 `200`。" + "description": "服务器推送事件（SSE）流。每个事件是一个以 `data: ` 为前缀并以两个换行符结尾的 JSON 对象。可能的事件结构请参阅 `ChunkChatEvent`。\n**SSE 解析指南：**每个事件是一行以 `data: ` 为前缀后跟 JSON 对象的内容，以 `\\n\\n` 结尾。解析 JSON 前需去除 `data: ` 前缀。JSON 内的 `event` 字段决定事件类型。当收到 `message_end` 事件时，流结束。忽略 `ping` 事件（每 10 秒发送一次以保持连接活跃）。如果在流中收到 `error` 事件，流将终止——解析错误对象以获取详情。请注意，即使流中发生错误事件，HTTP 状态码始终为 `200`。" }, "examples": { "streamingResponseBasic": { - "summary": "Response Example - Streaming (Basic)", + "summary": "响应示例 - 流式返回（基础）", "value": "data: {\"event\": \"message\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"answer\": \" I\", \"created_at\": 1679586595} data: {\"event\": \"message_end\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"metadata\": {\"usage\": {\"total_tokens\": 10, \"latency\": 1.0}}}" }, "streamingResponseAgent": { - "summary": "Response Example - Streaming (Agent)", + "summary": "响应示例 - 流式返回（Agent）", "value": "data: {\"event\": \"agent_thought\", \"id\": \"agent_thought_id_1\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"position\": 1, \"thought\": \"Thinking about calling a tool...\", \"tool\": \"dalle3\", \"tool_input\": \"{\\\"dalle3\\\": {\\\"prompt\\\": \\\"a cute cat\\\"}}\", \"created_at\": 1705395332} data: {\"event\": \"message_file\", \"id\": \"file_id_1\", \"type\": \"image\", \"belongs_to\": \"assistant\", \"url\": \"https://example.com/cat.png\", \"conversation_id\": \"conv123\"} data: {\"event\": \"agent_message\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"answer\": \"Here is the image: \", \"created_at\": 1705395333} data: {\"event\": \"message_end\", \"task_id\":\"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"metadata\": {\"usage\": {\"total_tokens\": 50, \"latency\": 2.5}}}" } } @@ -144,7 +144,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `not_chat_app` : App mode does not match the API route.\n- `conversation_completed` : The conversation has ended.\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不可用。\n- `completion_request_error` : 文本生成失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `not_chat_app`：应用模式与 API 路由不匹配。\n- `conversation_completed`：对话已结束。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不可用。\n- `completion_request_error`：文本生成失败。", "content": { "application/json": { "examples": { @@ -209,7 +209,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -226,7 +226,7 @@ } }, "429": { - "description": "- `too_many_requests` : 该应用的并发请求过多。\n- `rate_limit_error` : 上游模型提供商的速率限制已超出。", + "description": "- `too_many_requests`：此应用的并发请求过多。\n- `rate_limit_error`：上游模型供应商速率限制已超出。", "content": { "application/json": { "examples": { @@ -251,7 +251,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -272,18 +272,18 @@ }, "/chat-messages/{task_id}/stop": { "post": { - "summary": "停止响应", - "description": "停止聊天消息生成任务。仅在 `streaming` 模式下支持。", - "operationId": "stopBasicChatMessageGenerationCn", + "summary": "停止对话消息生成", + "description": "停止对话消息生成任务。仅在 `streaming` 模式下支持。", + "operationId": "stopChatMessageGeneration", "tags": [ - "对话消息" + "Chats" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "任务 ID，可以从 [发送对话消息](/api-reference/对话消息/发送对话消息) API 的流式分块返回中获取。", + "description": "任务 ID，可从[发送对话消息](/api-reference/chats/send-chat-message) API 的流式返回中获取。", "schema": { "type": "string" } @@ -301,7 +301,7 @@ "properties": { "user": { "type": "string", - "description": "用户标识符，必须和发送消息接口传入的 user 保持一致。" + "description": "用户标识符，必须与发送消息接口中传递的用户一致。" } } }, @@ -321,7 +321,7 @@ "$ref": "#/components/responses/SuccessResult" }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -342,11 +342,11 @@ }, "/messages/{message_id}/suggested": { "get": { - "summary": "获取下一轮建议问题列表", - "description": "获取当前消息的下一步建议问题。", - "operationId": "getBasicChatSuggestedQuestionsCn", + "summary": "获取下一轮建议问题", + "description": "获取当前消息的下一轮建议问题。", + "operationId": "getSuggestedQuestions", "tags": [ - "对话消息" + "Chats" ], "parameters": [ { @@ -393,7 +393,7 @@ } }, "400": { - "description": "- `not_chat_app` : 应用模式与 API 路由不匹配。\n- `bad_request` : 建议问题功能已禁用。", + "description": "- `not_chat_app`：应用模式与 API 路由不匹配。\n- `bad_request`：建议问题功能已禁用。", "content": { "application/json": { "examples": { @@ -418,7 +418,7 @@ } }, "404": { - "description": "`not_found` : 消息不存在。", + "description": "`not_found`：消息不存在。", "content": { "application/json": { "examples": { @@ -435,7 +435,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -457,10 +457,10 @@ "/files/upload": { "post": { "summary": "上传文件", - "description": "上传文件用于发送消息时使用，支持图片、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", - "operationId": "uploadBasicChatFileCn", + "description": "上传文件以便在发送消息时使用，支持对图像、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", + "operationId": "uploadChatFile", "tags": [ - "文件操作" + "Files" ], "requestBody": { "description": "文件上传请求。需要 multipart/form-data 格式。", @@ -476,11 +476,11 @@ "file": { "type": "string", "format": "binary", - "description": "要上传的文件。支持的类型包括图片、文档、音频和视频。" + "description": "要上传的文件。支持的类型包括图像、文档、音频和视频。" }, "user": { "type": "string", - "description": "用户标识符，由开发者定义的规则生成，必须在应用内唯一。" + "description": "用户标识符，由开发者规则定义，必须在应用内唯一。" } } } @@ -520,7 +520,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : 请求中未提供文件。\n- `too_many_files` : 每次请求仅允许上传一个文件。\n- `filename_not_exists_error` : 上传的文件没有文件名。", + "description": "- `no_file_uploaded`：请求中未提供文件。\n- `too_many_files`：每次请求只允许上传一个文件。\n- `filename_not_exists_error`：上传的文件没有文件名。", "content": { "application/json": { "examples": { @@ -553,7 +553,7 @@ } }, "413": { - "description": "`file_too_large` : 文件大小超出限制。", + "description": "`file_too_large`：文件大小超出限制。", "content": { "application/json": { "examples": { @@ -570,7 +570,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 不允许的文件类型。", + "description": "`unsupported_file_type`：不允许的文件类型。", "content": { "application/json": { "examples": { @@ -592,17 +592,17 @@ "/files/{file_id}/preview": { "get": { "summary": "下载文件", - "description": "预览或下载之前通过[上传文件](/api-reference/文件操作/上传文件) API 上传的文件。仅可访问属于请求应用内消息的文件。", - "operationId": "previewBasicChatFileCn", + "description": "预览或下载之前通过[上传文件](/api-reference/files/upload-file) API 上传的文件。只有属于请求应用中消息的文件才能被访问。", + "operationId": "previewChatFile", "tags": [ - "文件操作" + "Files" ], "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "要预览的文件唯一标识符，从 [上传文件](/api-reference/文件操作/上传文件) API 响应中获取。", + "description": "要预览的文件的唯一标识符，从[上传文件](/api-reference/files/upload-file) API 响应中获取。", "schema": { "type": "string", "format": "uuid" @@ -612,7 +612,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "如果为 `true`，则强制文件以附件形式下载，而不是在浏览器中预览。", + "description": "如果为 `true`，则强制将文件作为附件下载，而不是在浏览器中预览。", "schema": { "type": "boolean", "default": false @@ -630,7 +630,7 @@ ], "responses": { "200": { - "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将以 `Content-Disposition: attachment` 方式作为下载返回。", + "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，则文件以 `Content-Disposition: attachment` 形式作为下载返回。", "content": { "application/octet-stream": { "schema": { @@ -641,7 +641,7 @@ } }, "403": { - "description": "`file_access_denied` : 拒绝访问请求的文件。", + "description": "`file_access_denied`：请求的文件访问被拒绝。", "content": { "application/json": { "examples": { @@ -658,7 +658,7 @@ } }, "404": { - "description": "`file_not_found` : 未找到请求的文件。", + "description": "`file_not_found`：请求的文件未找到。", "content": { "application/json": { "examples": { @@ -680,10 +680,10 @@ "/end-users/{end_user_id}": { "get": { "summary": "获取终端用户信息", - "description": "根据 ID 获取终端用户信息。当其他 API 返回终端用户 ID（例如[上传文件](/api-reference/文件操作/上传文件)返回的 `created_by`）时很有用。", - "operationId": "getEndUserChatCn", + "description": "根据 ID 检索终端用户。当其他 API 返回终端用户 ID 时（例如[上传文件](/api-reference/files/upload-file)中的 `created_by`）非常有用。", + "operationId": "getEndUserChat", "tags": [ - "终端用户" + "End Users" ], "parameters": [ { @@ -726,7 +726,7 @@ } }, "404": { - "description": "`end_user_not_found` : 未找到终端用户。", + "description": "`end_user_not_found`：终端用户未找到。", "content": { "application/json": { "examples": { @@ -748,10 +748,10 @@ "/messages/{message_id}/feedbacks": { "post": { "summary": "提交消息反馈", - "description": "提交消息反馈。终端用户可以对消息评价 `like` 或 `dislike`，并可选择提供文字反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", - "operationId": "postBasicChatMessageFeedbackCn", + "description": "提交消息反馈。终端用户可以将消息评价为 `like` 或 `dislike`，并可选择提供文本反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", + "operationId": "postChatMessageFeedback", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -789,7 +789,7 @@ "$ref": "#/components/responses/SuccessResult" }, "404": { - "description": "`not_found` : 消息不存在。", + "description": "`not_found`：消息不存在。", "content": { "application/json": { "examples": { @@ -810,11 +810,11 @@ }, "/app/feedbacks": { "get": { - "summary": "获取应用的消息反馈", - "description": "获取此应用中所有消息反馈的分页列表，包括终端用户和管理员反馈。", - "operationId": "getBasicChatAppFeedbacksCn", + "summary": "获取应用反馈列表", + "description": "获取此应用中消息提交的所有反馈的分页列表，包括终端用户和管理员反馈。", + "operationId": "getChatAppFeedbacks", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -892,11 +892,11 @@ }, "/conversations": { "get": { - "summary": "获取会话列表", - "description": "获取当前用户的会话列表，按最近活跃时间排序。", - "operationId": "getBasicChatConversationsListCn", + "summary": "获取对话列表", + "description": "获取当前用户的对话列表，按最近活跃排序。", + "operationId": "getConversationsList", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -948,7 +948,7 @@ ], "responses": { "200": { - "description": "成功获取会话列表。", + "description": "成功获取对话列表。", "content": { "application/json": { "schema": { @@ -980,7 +980,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -997,7 +997,7 @@ } }, "404": { - "description": "`not_found` : 上一个会话不存在（无效的 `last_id`）。", + "description": "`not_found`：最后一条对话不存在（无效的 `last_id`）。", "content": { "application/json": { "examples": { @@ -1018,18 +1018,18 @@ }, "/messages": { "get": { - "summary": "获取会话历史消息", - "description": "以滚动加载的格式返回历史聊天记录，首页返回最新的 `limit` 条消息，即按时间倒序排列。", - "operationId": "getBasicChatConversationHistoryCn", + "summary": "获取对话消息列表", + "description": "以滚动加载格式返回历史聊天记录，第一页返回最新的 `limit` 条消息，即按倒序排列。", + "operationId": "getConversationHistory", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "query", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1047,7 +1047,7 @@ "name": "first_id", "in": "query", "required": false, - "description": "当前页第一条聊天记录的 ID。默认为 `null`（获取最新消息）。获取后续页面时，使用当前列表中第一条消息的 ID 来获取更早的消息。", + "description": "当前页第一条聊天记录的 ID。默认为 `null`（获取最新消息）。后续页面使用当前列表中第一条消息的 ID 以获取更早的消息。", "schema": { "type": "string" } @@ -1067,7 +1067,7 @@ ], "responses": { "200": { - "description": "成功获取会话历史。", + "description": "成功获取对话历史。", "content": { "application/json": { "schema": { @@ -1108,7 +1108,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1125,7 +1125,7 @@ } }, "404": { - "description": "- `not_found` : 会话不存在。\n- `not_found` : 第一条消息不存在。", + "description": "- `not_found`：对话不存在。\n- `not_found`：第一条消息不存在。", "content": { "application/json": { "examples": { @@ -1154,18 +1154,18 @@ }, "/conversations/{conversation_id}/variables": { "get": { - "summary": "获取对话变量", - "description": "从特定会话中获取变量。", - "operationId": "getBasicChatConversationVariablesCn", + "summary": "获取会话变量列表", + "description": "从特定对话中检索变量。", + "operationId": "getConversationVariables", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1204,7 +1204,7 @@ "name": "variable_name", "in": "query", "required": false, - "description": "按指定名称筛选变量。", + "description": "按特定名称过滤变量。", "schema": { "type": "string", "minLength": 1, @@ -1244,7 +1244,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1261,7 +1261,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1282,18 +1282,18 @@ }, "/conversations/{conversation_id}/name": { "post": { - "summary": "重命名会话", - "description": "重命名会话或自动生成名称。会话名称用于在支持多会话的客户端上显示。", - "operationId": "renameBasicChatConversationCn", + "summary": "重命名对话", + "description": "重命名对话或自动生成名称。对话名称用于在支持多对话的客户端上显示。", + "operationId": "renameConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1320,7 +1320,7 @@ }, "responses": { "200": { - "description": "会话重命名成功。", + "description": "对话重命名成功。", "content": { "application/json": { "schema": { @@ -1346,7 +1346,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1363,7 +1363,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1384,18 +1384,18 @@ }, "/conversations/{conversation_id}/variables/{variable_id}": { "put": { - "summary": "更新对话变量", + "summary": "更新会话变量", "description": "更新特定会话变量的值。值必须与预期类型匹配。", - "operationId": "updateChatConversationVariableZh", + "operationId": "updateChatConversationVariable", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string", "format": "uuid" @@ -1405,7 +1405,7 @@ "name": "variable_id", "in": "path", "required": true, - "description": "Variable ID.", + "description": "变量 ID。", "schema": { "type": "string", "format": "uuid" @@ -1457,7 +1457,7 @@ } }, "400": { - "description": "- `not_chat_app` : 应用模式与 API 路由不匹配。\n- `bad_request` : 变量值类型不匹配。", + "description": "- `not_chat_app`：应用模式与 API 路由不匹配。\n- `bad_request`：变量值类型不匹配。", "content": { "application/json": { "examples": { @@ -1482,7 +1482,7 @@ } }, "404": { - "description": "- `not_found` : 会话不存在。\n- `not_found` : 会话变量不存在。", + "description": "- `not_found`：对话不存在。\n- `not_found`：会话变量不存在。", "content": { "application/json": { "examples": { @@ -1511,18 +1511,18 @@ }, "/conversations/{conversation_id}": { "delete": { - "summary": "删除会话", - "description": "删除会话。", - "operationId": "deleteBasicChatConversationCn", + "summary": "删除对话", + "description": "删除对话。", + "operationId": "deleteConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1554,10 +1554,10 @@ }, "responses": { "204": { - "description": "会话删除成功。" + "description": "对话删除成功。" }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1574,7 +1574,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1597,9 +1597,9 @@ "post": { "summary": "语音转文字", "description": "将音频文件转换为文字。支持的格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。文件大小限制为 `30 MB`。", - "operationId": "basicChatAudioToTextCn", + "operationId": "audioToText", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -1613,7 +1613,7 @@ }, "responses": { "200": { - "description": "语音转文字成功。", + "description": "成功将音频转换为文字。", "content": { "application/json": { "schema": { @@ -1631,7 +1631,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `no_audio_uploaded` : 未上传音频文件。\n- `provider_not_support_speech_to_text` : 模型提供商不支持语音转文字。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 语音识别请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `no_audio_uploaded`：未上传音频文件。\n- `provider_not_support_speech_to_text`：模型供应商不支持语音转文字。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：语音识别请求失败。", "content": { "application/json": { "examples": { @@ -1696,7 +1696,7 @@ } }, "413": { - "description": "`audio_too_large` : 音频文件大小超出限制。", + "description": "`audio_too_large`：音频文件大小超出限制。", "content": { "application/json": { "examples": { @@ -1713,7 +1713,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 不允许的音频类型。", + "description": "`unsupported_audio_type`：不允许的音频类型。", "content": { "application/json": { "examples": { @@ -1730,7 +1730,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1753,9 +1753,9 @@ "post": { "summary": "文字转语音", "description": "将文字转换为语音。", - "operationId": "basicChatTextToAudioCn", + "operationId": "textToAudioChat", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -1780,7 +1780,7 @@ }, "responses": { "200": { - "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式返回。", + "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式传输。", "content": { "audio/mpeg": { "schema": { @@ -1791,7 +1791,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 文字转语音请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：文字转语音请求失败。", "content": { "application/json": { "examples": { @@ -1840,7 +1840,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1861,11 +1861,11 @@ }, "/info": { "get": { - "summary": "获取应用基本信息", - "description": "获取应用的基本信息，包括名称、描述、标签和模式。", - "operationId": "getBasicChatAppInfoCn", + "summary": "获取应用信息", + "description": "获取此应用的基本信息，包括名称、描述、标签和模式。", + "operationId": "getChatAppInfo", "tags": [ - "应用配置" + "Applications" ], "responses": { "200": { @@ -1880,7 +1880,7 @@ "summary": "响应示例", "value": { "name": "My Chat App", - "description": "一个有用的客服聊天机器人。", + "description": "一个有帮助的客服聊天机器人。", "tags": [ "customer-service", "chatbot" @@ -1900,9 +1900,9 @@ "get": { "summary": "获取应用参数", "description": "获取应用的输入表单配置，包括功能开关、输入参数名称、类型和默认值。", - "operationId": "getBasicChatAppParametersCn", + "operationId": "getChatAppParameters", "tags": [ - "应用配置" + "Applications" ], "responses": { "200": { @@ -1980,7 +1980,7 @@ } }, "400": { - "description": "`app_unavailable` : 应用不可用或配置错误。", + "description": "`app_unavailable`：应用不可用或配置错误。", "content": { "application/json": { "examples": { @@ -2002,14 +2002,14 @@ "/meta": { "get": { "summary": "获取应用元数据", - "description": "获取应用的元数据，包括工具图标和其他配置详情。", - "operationId": "getBasicChatAppMetaCn", + "description": "获取此应用的元数据，包括工具图标和其他配置详情。", + "operationId": "getChatAppMeta", "tags": [ - "应用配置" + "Applications" ], "responses": { "200": { - "description": "成功获取应用元数据。", + "description": "成功获取应用元数据信息。", "content": { "application/json": { "schema": { @@ -2038,10 +2038,10 @@ "/site": { "get": { "summary": "获取应用 WebApp 设置", - "description": "获取应用的 WebApp 设置，包括站点配置、主题和自定义选项。", - "operationId": "getBasicChatWebAppSettingsCn", + "description": "获取此应用的 WebApp 设置，包括站点配置、主题和自定义选项。", + "operationId": "getChatWebAppSettings", "tags": [ - "应用配置" + "Applications" ], "responses": { "200": { @@ -2055,14 +2055,14 @@ "webAppSettings": { "summary": "响应示例", "value": { - "title": "My Chat App", + "title": "我的聊天应用", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", "icon": "🤖", "icon_background": "#FFFFFF", "icon_url": null, - "description": "一个有用的客服聊天机器人。", + "description": "一个有帮助的客服聊天机器人。", "copyright": "2025 Dify", "privacy_policy": "https://example.com/privacy", "custom_disclaimer": "", @@ -2076,7 +2076,7 @@ } }, "403": { - "description": "`forbidden` : 未找到此应用的站点或工作空间已归档。", + "description": "`forbidden`：此应用未找到站点或工作区已归档。", "content": { "application/json": { "examples": { @@ -2098,10 +2098,10 @@ "/apps/annotations": { "post": { "summary": "创建标注", - "description": "创建新的标注。标注提供预定义的问答对，应用可以直接匹配并返回，而无需生成回复。", - "operationId": "createChatAnnotationZh", + "description": "创建新的标注。标注提供预定义的问答对，应用可以匹配并直接返回，而不是生成响应。", + "operationId": "createAnnotation", "tags": [ - "标注管理" + "Annotations" ], "requestBody": { "required": true, @@ -2149,10 +2149,10 @@ }, "get": { "summary": "获取标注列表", - "description": "获取应用的标注分页列表。支持关键词搜索筛选。", - "operationId": "listChatAnnotationsZh", + "description": "获取应用标注的分页列表。支持关键词搜索过滤。", + "operationId": "getAnnotationList", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2168,7 +2168,7 @@ { "name": "limit", "in": "query", - "description": "每页条目数。", + "description": "每页项目数。", "required": false, "schema": { "type": "integer", @@ -2178,7 +2178,7 @@ { "name": "keyword", "in": "query", - "description": "按问题或回答内容筛选标注的关键词。", + "description": "按问题或答案内容过滤标注的关键词。", "required": false, "schema": { "type": "string" @@ -2222,10 +2222,10 @@ "/apps/annotations/{annotation_id}": { "put": { "summary": "更新标注", - "description": "更新现有标注的问题和回答。", - "operationId": "updateChatAnnotationZh", + "description": "更新现有标注的问题和答案。", + "operationId": "updateAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2282,7 +2282,7 @@ } }, "403": { - "description": "`forbidden` : 编辑标注的权限不足。", + "description": "`forbidden`：没有足够的权限编辑标注。", "content": { "application/json": { "examples": { @@ -2299,7 +2299,7 @@ } }, "404": { - "description": "`not_found` : 标注不存在。", + "description": "`not_found`：标注不存在。", "content": { "application/json": { "examples": { @@ -2320,9 +2320,9 @@ "delete": { "summary": "删除标注", "description": "删除标注及其关联的命中历史。", - "operationId": "deleteChatAnnotationZh", + "operationId": "deleteAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2341,7 +2341,7 @@ "description": "标注删除成功。" }, "403": { - "description": "`forbidden` : 编辑标注的权限不足。", + "description": "`forbidden`：没有足够的权限编辑标注。", "content": { "application/json": { "examples": { @@ -2358,7 +2358,7 @@ } }, "404": { - "description": "`not_found` : 标注不存在。", + "description": "`not_found`：标注不存在。", "content": { "application/json": { "examples": { @@ -2380,10 +2380,10 @@ "/apps/annotation-reply/{action}": { "post": { "summary": "配置标注回复", - "description": "启用或禁用标注回复功能。启用时需要配置嵌入模型。异步执行——使用 [查询标注回复配置任务状态](/api-reference/标注管理/查询标注回复配置任务状态) 跟踪进度。", - "operationId": "setChatAnnotationReplyZh", + "description": "启用或禁用标注回复功能。启用时需要嵌入模型配置。异步执行——使用[获取标注回复任务状态](/api-reference/annotations/get-annotation-reply-job-status)跟踪进度。", + "operationId": "initialAnnotationReplySettings", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2445,18 +2445,18 @@ }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { - "summary": "查询标注回复配置任务状态", - "description": "获取由 [配置标注回复](/api-reference/标注管理/配置标注回复) 发起的异步标注回复配置任务的状态。", - "operationId": "getChatAnnotationReplyStatusZh", + "summary": "获取标注回复任务状态", + "description": "获取由[配置标注回复](/api-reference/annotations/configure-annotation-reply)启动的异步标注回复配置任务的状态。", + "operationId": "getInitialAnnotationReplySettingsStatus", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "操作类型，必须与 [配置标注回复](/api-reference/标注管理/配置标注回复) 调用中的一致。", + "description": "操作类型，必须与[配置标注回复](/api-reference/annotations/configure-annotation-reply)调用匹配。", "schema": { "type": "string", "enum": [ @@ -2469,7 +2469,7 @@ "name": "job_id", "in": "path", "required": true, - "description": "由 [配置标注回复](/api-reference/标注管理/配置标注回复) 接口返回的任务 ID。", + "description": "由[配置标注回复](/api-reference/annotations/configure-annotation-reply)返回的任务 ID。", "schema": { "type": "string", "format": "uuid" @@ -2498,7 +2498,7 @@ } }, "400": { - "description": "`invalid_param` : 指定的任务不存在。", + "description": "`invalid_param`：指定的任务不存在。", "content": { "application/json": { "examples": { @@ -2524,7 +2524,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上 `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**" + "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并以 `Bearer ` 为前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将您的 API Key 存储在服务器端，不要在客户端共享或存储，以避免可能导致严重后果的 API Key 泄露。**" } }, "responses": { @@ -2568,7 +2568,7 @@ }, "inputs": { "type": "object", - "description": "允许输入应用定义的各种变量值。包含键值对。请参阅 [获取应用参数](/api-reference/应用配置/获取应用参数) 响应中的 `user_input_form` 字段，以了解应用所需的变量名称和类型。", + "description": "允许输入应用定义的各种变量值。包含键/值对。请参阅[获取应用参数](/api-reference/applications/get-app-parameters)响应中的 `user_input_form` 字段以了解您的应用期望的变量名称和类型。", "additionalProperties": true }, "response_mode": { @@ -2577,19 +2577,19 @@ "streaming", "blocking" ], - "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 在完成后返回（长时间处理可能中断；Agent 助手模式不支持此选项）。Cloudflare 超时时间为 `100 s`。未指定时默认为阻塞模式。" + "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 在完成后返回（长时间处理可能会被中断；Agent 模式不支持）。Cloudflare 超时为 `100 s`。省略时默认为阻塞式返回行为。" }, "user": { "type": "string", - "description": "用户标识符，在应用内唯一。此标识符用于限定数据访问范围——会话、消息和文件仅在使用相同的 `user` 值查询时可见。" + "description": "用户标识符，在应用内唯一。此标识符限定数据访问范围——对话、消息和文件仅在使用相同 `user` 值查询时可见。" }, "conversation_id": { "type": "string", - "description": "用于继续会话的会话 ID。传入上一条消息的 `conversation_id`。要开始新会话，请省略此字段或传入空字符串。响应会返回一个 `conversation_id`——在后续消息中传入该值即可继续该会话。" + "description": "对话 ID，用于继续对话。传递前一条消息的 `conversation_id`。要开始新对话，请省略此字段或传递空字符串。响应将返回一个 `conversation_id`——在后续消息中传递它以继续该对话。" }, "files": { "type": "array", - "description": "用于多模态理解的文件列表，包括图片、文档、音频和视频。要附加本地文件，请先通过 [上传文件](/api-reference/文件操作/上传文件) 上传，然后将返回的 `id` 作为 `upload_file_id`，并设置 `transfer_method: local_file`。", + "description": "用于多模态理解的文件列表，包括图像、文档、音频和视频。要附加本地文件，首先通过[上传文件](/api-reference/files/upload-file)上传它，并使用返回的 `id` 作为 `upload_file_id`，设置 `transfer_method: local_file`。", "items": { "type": "object", "required": [ @@ -2614,7 +2614,7 @@ "remote_url", "local_file" ], - "description": "传输方式：文件 URL 使用 `remote_url`，上传文件使用 `local_file`。" + "description": "传输方式：`remote_url` 表示文件 URL，`local_file` 表示已上传的文件。" }, "url": { "type": "string", @@ -2623,14 +2623,14 @@ }, "upload_file_id": { "type": "string", - "description": "通过 [上传文件](/api-reference/文件操作/上传文件) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时必填）。" + "description": "从[上传文件](/api-reference/files/upload-file) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时必填）。" } } } }, "auto_generate_name": { "type": "boolean", - "description": "自动生成会话标题。如果为 `false`，请使用 [重命名会话](/api-reference/会话管理/重命名会话) API 并设置 `auto_generate: true` 来异步生成标题。", + "description": "自动生成对话标题。如果为 `false`，使用[重命名对话](/api-reference/conversations/rename-conversation) API 并设置 `auto_generate: true` 进行异步标题生成。", "default": true } } @@ -2645,22 +2645,22 @@ "task_id": { "type": "string", "format": "uuid", - "description": "用于请求追踪和停止响应 API 的任务 ID。" + "description": "任务 ID，用于请求跟踪和停止响应 API。" }, "id": { "type": "string", "format": "uuid", - "description": "该响应事件的唯一 ID。" + "description": "此响应事件的唯一 ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "唯一的消息 ID。调用反馈或推荐问题接口时，将此值作为 `message_id` 参数使用。" + "description": "唯一消息 ID。在调用反馈或建议问题端点时将其作为 `message_id` 参数使用。" }, "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "mode": { "type": "string", @@ -2672,7 +2672,7 @@ }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括使用量和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -2695,7 +2695,7 @@ }, "ChunkChatEvent": { "type": "object", - "description": "流式模式下 Server-Sent Event 块的基础 schema。", + "description": "流式返回模式下服务器推送事件块的基础 schema。", "properties": { "event": { "type": "string", @@ -2732,7 +2732,7 @@ }, "StreamEventBase": { "type": "object", - "description": "流式事件的基础属性。", + "description": "流事件的基础属性。", "properties": { "task_id": { "type": "string", @@ -2747,7 +2747,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "created_at": { "type": "integer", @@ -2804,12 +2804,12 @@ }, { "type": "object", - "description": "TTS 音频流事件（base64 编码的 Mp3）。自动播放启用时可用。", + "description": "TTS 音频流事件（Base64 编码的 Mp3）。启用自动播放时可用。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 编码的 MP3 音频块。按顺序解码并拼接所有块即可生成完整的音频文件。" + "description": "Base64 编码的 MP3 音频块。按顺序解码并连接所有块以生成完整的音频文件。" } } } @@ -2829,7 +2829,7 @@ "properties": { "audio": { "type": "string", - "description": "空字符串。标识音频流结束。" + "description": "空字符串。表示音频流结束。" } } } @@ -2854,7 +2854,7 @@ }, "position": { "type": "integer", - "description": "该思考在消息序列中的位置。" + "description": "此思考在消息序列中的位置。" }, "thought": { "type": "string", @@ -2870,7 +2870,7 @@ }, "tool_input": { "type": "string", - "description": "工具输入（JSON 格式）。" + "description": "JSON 格式的工具输入。" }, "message_files": { "type": "array", @@ -2878,7 +2878,7 @@ "type": "string", "format": "uuid" }, - "description": "与该思考相关的文件 ID 列表。" + "description": "与此思考相关的文件 ID。" } } } @@ -2904,7 +2904,7 @@ }, "belongs_to": { "type": "string", - "description": "该文件的所属者。工具生成的文件始终为 `assistant`。" + "description": "此文件归属于谁。工具生成的文件始终为 `assistant`。" }, "url": { "type": "string", @@ -2914,7 +2914,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" } } } @@ -2935,11 +2935,11 @@ "id": { "type": "string", "format": "uuid", - "description": "消息的唯一 ID。" + "description": "唯一消息 ID。" }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括使用量和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -2967,7 +2967,7 @@ }, { "type": "object", - "description": "消息内容替换事件（例如由于内容审核）。", + "description": "消息内容替换事件（例如，由于内容审核）。", "properties": { "answer": { "type": "string", @@ -2991,7 +2991,7 @@ }, { "type": "object", - "description": "流式输出过程中的错误事件。", + "description": "流式传输期间的错误事件。", "properties": { "status": { "type": "integer", @@ -2999,11 +2999,11 @@ }, "code": { "type": "string", - "description": "错误码。" + "description": "错误代码。" }, "message": { "type": "string", - "description": "错误信息。" + "description": "错误消息。" } } } @@ -3022,63 +3022,63 @@ }, "Usage": { "type": "object", - "description": "模型使用信息。", + "description": "模型使用量信息。", "properties": { "prompt_tokens": { "type": "integer", - "description": "提示词中的令牌数。" + "description": "提示词中的 token 数量。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "每个提示词令牌的单价。" + "description": "每个提示词 token 的单价。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "提示词令牌的价格单位。" + "description": "提示词 token 的价格单位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "提示词令牌的总价。" + "description": "提示词 token 的总价。" }, "completion_tokens": { "type": "integer", - "description": "补全内容中的令牌数。" + "description": "补全中的 token 数量。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "每个补全令牌的单价。" + "description": "每个补全 token 的单价。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "补全令牌的价格单位。" + "description": "补全 token 的价格单位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "补全令牌的总价。" + "description": "补全 token 的总价。" }, "total_tokens": { "type": "integer", - "description": "使用的令牌总数。" + "description": "使用的 token 总数。" }, "total_price": { "type": "string", "format": "decimal", - "description": "所有令牌的总价。" + "description": "所有 token 的总价。" }, "currency": { "type": "string", - "description": "计价货币。" + "description": "定价货币。" }, "latency": { "type": "number", "format": "double", - "description": "延迟时间（秒）。" + "description": "延迟（秒）。" } } }, @@ -3094,7 +3094,7 @@ "message_id": { "type": "string", "format": "uuid", - "description": "该资源所属消息的 ID。" + "description": "此资源所属消息的 ID。" }, "position": { "type": "integer", @@ -3125,24 +3125,24 @@ "segment_id": { "type": "string", "format": "uuid", - "description": "文档中特定块的 ID。" + "description": "文档内特定分段的 ID。" }, "score": { "type": "number", "format": "float", - "description": "资源的相关性评分。" + "description": "资源的相似度分数。" }, "hit_count": { "type": "integer", - "description": "该块被命中的次数。" + "description": "此分段被命中的次数。" }, "word_count": { "type": "integer", - "description": "块的字数。" + "description": "分段的字数。" }, "segment_position": { "type": "integer", - "description": "块在文档中的位置。" + "description": "分段在文档中的位置。" }, "index_node_hash": { "type": "string", @@ -3155,7 +3155,7 @@ "summary": { "type": "string", "nullable": true, - "description": "块内容的摘要。" + "description": "分段内容的摘要。" }, "created_at": { "type": "integer", @@ -3170,7 +3170,7 @@ "id": { "type": "string", "format": "uuid", - "description": "唯一文件 ID。" + "description": "文件唯一 ID。" }, "name": { "type": "string", @@ -3220,19 +3220,19 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "关联的用户 ID。" + "description": "关联用户的 ID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的租户 ID。" + "description": "关联租户的 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的会话 ID。" + "description": "关联对话的 ID。" }, "file_key": { "type": "string", @@ -3262,12 +3262,12 @@ }, "type": { "type": "string", - "description": "终端用户类型。Service API 用户固定为 `service_api`。" + "description": "终端用户类型。服务 API 用户始终为 `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API 请求中提供的 `user` 标识符（例如 [发送对话消息](/api-reference/对话消息/发送对话消息) 中的 `user` 字段）。" + "description": "API 请求中提供的 `user` 标识符（例如[发送对话消息](/api-reference/chats/send-chat-message)中的 `user` 字段）。" }, "name": { "type": "string", @@ -3276,11 +3276,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时，值为 `true`。" + "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时为 `true`。" }, "session_id": { "type": "string", - "description": "会话标识符。默认为 `external_user_id` 的值。" + "description": "会话标识符。默认为 `external_user_id` 值。" }, "created_at": { "type": "string", @@ -3317,7 +3317,7 @@ }, "content": { "type": "string", - "description": "提供额外详情的可选文字反馈。" + "description": "可选的文本反馈，提供额外详情。" } } }, @@ -3335,7 +3335,7 @@ }, "FeedbackItem": { "type": "object", - "description": "单条反馈项。", + "description": "单个反馈项。", "properties": { "id": { "type": "string", @@ -3350,7 +3350,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "message_id": { "type": "string", @@ -3359,16 +3359,16 @@ }, "rating": { "type": "string", - "description": "反馈评分。`like` 为正面，`dislike` 为负面。" + "description": "反馈评分。`like` 表示正面，`dislike` 表示负面。" }, "content": { "type": "string", "nullable": true, - "description": "可选的文字反馈。" + "description": "可选的文本反馈。" }, "from_source": { "type": "string", - "description": "反馈来源。`user` 为终端用户通过 API 提交的反馈，`admin` 为从控制台提交的反馈。" + "description": "反馈来源。`user` 表示通过 API 提交的终端用户反馈，`admin` 表示从控制台提交的反馈。" }, "from_end_user_id": { "type": "string", @@ -3415,11 +3415,11 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", - "description": "是否有更多消息。" + "description": "是否还有更多消息。" }, "data": { "type": "array", @@ -3432,7 +3432,7 @@ }, "ConversationMessageItem": { "type": "object", - "description": "会话中的单条消息。", + "description": "对话中的单条消息。", "properties": { "id": { "type": "string", @@ -3442,18 +3442,18 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "parent_message_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "线程会话的父消息 ID。" + "description": "线程对话的父消息 ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "该消息的输入变量。" + "description": "此消息的输入变量。" }, "query": { "type": "string", @@ -3465,16 +3465,16 @@ }, "status": { "type": "string", - "description": "消息状态。成功消息为 `normal`，生成失败时为 `error`。" + "description": "消息状态。`normal` 表示成功消息，`error` 表示生成失败。" }, "error": { "type": "string", "nullable": true, - "description": "当 `status` 为 `error` 时的错误消息。" + "description": "如果 `status` 为 `error` 时的错误消息。" }, "message_files": { "type": "array", - "description": "附加到该消息的文件。", + "description": "附加到此消息的文件。", "items": { "$ref": "#/components/schemas/MessageFileItem" } @@ -3482,24 +3482,24 @@ "feedback": { "type": "object", "nullable": true, - "description": "该消息的用户反馈。", + "description": "此消息的用户反馈。", "properties": { "rating": { "type": "string", - "description": "反馈评分。`like` 为正面，`dislike` 为负面。" + "description": "反馈评分。`like` 表示正面，`dislike` 表示负面。" } } }, "retriever_resources": { "type": "array", - "description": "该消息使用的检索资源。", + "description": "此消息使用的检索资源。", "items": { "$ref": "#/components/schemas/RetrieverResource" } }, "agent_thoughts": { "type": "array", - "description": "该消息的 Agent 思考。", + "description": "此消息的 Agent 思考。", "items": { "$ref": "#/components/schemas/AgentThoughtItem" } @@ -3511,7 +3511,7 @@ }, "extra_contents": { "type": "array", - "description": "与该消息关联的附加执行内容，例如人工介入表单数据。", + "description": "与此消息关联的额外执行内容，例如人工输入表单数据。", "items": { "type": "object", "additionalProperties": true @@ -3526,7 +3526,7 @@ "id": { "type": "string", "format": "uuid", - "description": "File ID." + "description": "文件 ID。" }, "filename": { "type": "string", @@ -3559,13 +3559,13 @@ "belongs_to": { "type": "string", "nullable": true, - "description": "该文件的所属者。用户上传的文件为 `user`，助手生成的文件为 `assistant`。" + "description": "此文件归属于谁。`user` 表示用户上传的文件，`assistant` 表示助手生成的文件。" }, "upload_file_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "通过 `local_file` 传输时的上传文件 ID。" + "description": "如果通过 `local_file` 传输的上传文件 ID。" } } }, @@ -3581,16 +3581,16 @@ "chain_id": { "type": "string", "nullable": true, - "description": "该思考的链 ID。" + "description": "此思考的链 ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "该思考所属的唯一消息 ID。" + "description": "此思考所属的唯一消息 ID。" }, "position": { "type": "integer", - "description": "该思考的位置。" + "description": "此思考的位置。" }, "thought": { "type": "string", @@ -3604,11 +3604,11 @@ "type": "object", "nullable": true, "additionalProperties": true, - "description": "已使用工具的标签。" + "description": "使用的工具标签。" }, "tool_input": { "type": "string", - "description": "工具输入（JSON 格式）。" + "description": "JSON 格式的工具输入。" }, "observation": { "type": "string", @@ -3619,7 +3619,7 @@ "items": { "type": "string" }, - "description": "与该思考相关的文件 ID。" + "description": "与此思考相关的文件 ID。" }, "created_at": { "type": "integer", @@ -3633,15 +3633,15 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", - "description": "是否有更多会话。" + "description": "是否还有更多对话。" }, "data": { "type": "array", - "description": "会话列表。", + "description": "对话列表。", "items": { "$ref": "#/components/schemas/ConversationListItem" } @@ -3654,24 +3654,24 @@ "id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "name": { "type": "string", - "description": "会话名称。" + "description": "对话名称。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "会话的输入变量。" + "description": "对话的输入变量。" }, "status": { "type": "string", - "description": "会话状态。活跃会话为 `normal`。" + "description": "对话状态。`normal` 表示活跃对话。" }, "introduction": { "type": "string", - "description": "会话介绍。" + "description": "对话简介。" }, "created_at": { "type": "integer", @@ -3687,16 +3687,16 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "重命名会话的请求体。", + "description": "重命名对话的请求体。", "properties": { "name": { "type": "string", - "description": "会话名称。当 `auto_generate` 为 `false` 时必填。" + "description": "对话名称。当 `auto_generate` 为 `false` 时必填。" }, "auto_generate": { "type": "boolean", "default": false, - "description": "自动生成会话名称。当为 `true` 时，`name` 字段将被忽略。" + "description": "自动生成对话名称。当为 `true` 时，`name` 字段将被忽略。" }, "user": { "type": "string", @@ -3709,7 +3709,7 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", @@ -3730,7 +3730,7 @@ "id": { "type": "string", "format": "uuid", - "description": "Variable ID." + "description": "变量 ID。" }, "name": { "type": "string", @@ -3738,7 +3738,7 @@ }, "value_type": { "type": "string", - "description": "变量值类型。可选值：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" + "description": "变量值类型。可能的值：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" }, "value": { "type": "string", @@ -3786,7 +3786,7 @@ "file": { "type": "string", "format": "binary", - "description": "音频文件。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。大小限制：`30 MB`。" + "description": "音频文件。支持：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。限制：`30 MB`。" }, "user": { "type": "string", @@ -3799,18 +3799,18 @@ "properties": { "text": { "type": "string", - "description": "语音识别输出的文字。" + "description": "语音识别输出的文本。" } } }, "TextToAudioRequest": { "type": "object", - "description": "文字转语音的请求体。提供 `message_id` 或 `text` 其中之一。", + "description": "文字转语音的请求体。提供 `message_id` 或 `text` 之一。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "消息 ID。当同时提供 `text` 时，优先使用消息 ID。" + "description": "消息 ID。当同时提供时优先于 `text`。" }, "text": { "type": "string", @@ -3822,11 +3822,11 @@ }, "voice": { "type": "string", - "description": "文字转语音使用的声音。可用声音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/应用配置/获取应用参数) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" + "description": "用于文字转语音的语音。可用语音取决于此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" }, "streaming": { "type": "boolean", - "description": "是否启用流式响应。" + "description": "是否启用流式返回响应。" } } }, @@ -3850,7 +3850,7 @@ }, "mode": { "type": "string", - "description": "应用模式。`chat` 表示基础聊天应用，`agent-chat` 表示 Agent 应用，`advanced-chat` 表示对话流应用。" + "description": "应用模式。`chat` 表示基础聊天应用，`agent-chat` 表示基于 Agent 的应用，`advanced-chat` 表示 Chatflow 应用。" }, "author_name": { "type": "string", @@ -3863,7 +3863,7 @@ "properties": { "opening_statement": { "type": "string", - "description": "会话开始时显示的开场白。" + "description": "对话开始时显示的开场白。" }, "suggested_questions": { "type": "array", @@ -3878,7 +3878,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -3888,7 +3888,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -3898,11 +3898,11 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" }, "voice": { "type": "string", - "description": "TTS 的声音标识符。" + "description": "TTS 的语音标识符。" }, "language": { "type": "string", @@ -3910,7 +3910,7 @@ }, "autoPlay": { "type": "string", - "description": "自动播放设置。`enabled` 为自动播放音频，`disabled` 为需要手动播放。" + "description": "自动播放设置。`enabled` 表示自动播放音频，`disabled` 表示需要手动播放。" } } }, @@ -3920,7 +3920,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -3930,7 +3930,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -3940,17 +3940,17 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, "sensitive_word_avoidance": { "type": "object", - "description": "敏感词过滤配置。", + "description": "敏感词规避配置。", "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -3971,7 +3971,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用图片上传。" + "description": "图片上传是否启用。" }, "number_limits": { "type": "integer", @@ -3979,7 +3979,7 @@ }, "detail": { "type": "string", - "description": "图片精细程度。" + "description": "图片详细程度。" }, "transfer_methods": { "type": "array", @@ -4014,7 +4014,7 @@ }, "workflow_file_upload_limit": { "type": "integer", - "description": "工作流文件上传的最大文件数。" + "description": "工作流文件上传的最大文件数量。" } } } @@ -4035,7 +4035,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "文本输入", "type": "object", "properties": { "text-input": { @@ -4044,7 +4044,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -4053,7 +4053,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "下拉选项", "type": "object", "properties": { "select": { @@ -4075,7 +4075,7 @@ }, "required": { "type": "boolean", - "description": "输入是否必填。" + "description": "是否必填。" }, "default": { "type": "string", @@ -4097,7 +4097,7 @@ }, "required": { "type": "boolean", - "description": "输入是否必填。" + "description": "是否必填。" }, "default": { "type": "string", @@ -4107,7 +4107,7 @@ }, "SelectControl": { "type": "object", - "description": "下拉选择表单控件。", + "description": "下拉选项表单控件。", "properties": { "label": { "type": "string", @@ -4119,11 +4119,11 @@ }, "required": { "type": "boolean", - "description": "是否必须选择。" + "description": "是否必选。" }, "default": { "type": "string", - "description": "默认选中的值。" + "description": "默认选中值。" }, "options": { "type": "array", @@ -4142,7 +4142,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "图标 URL", "type": "string", "format": "url", "description": "图标的 URL。" @@ -4157,7 +4157,7 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "Emoji 图标", "type": "object", "description": "使用 emoji 的工具图标详情。", "properties": { @@ -4180,19 +4180,19 @@ }, "chat_color_theme": { "type": "string", - "description": "聊天主题颜色。" + "description": "聊天颜色主题。" }, "chat_color_theme_inverted": { "type": "boolean", - "description": "聊天主题颜色是否反转。" + "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", - "description": "使用的图标类型。`emoji` 为表情图标，`image` 为上传的图片图标。" + "description": "使用的图标类型。`emoji` 表示 emoji 图标，`image` 表示上传的图片图标。" }, "icon": { "type": "string", - "description": "图标内容（表情或图片 ID）。" + "description": "图标内容（emoji 或图片 ID）。" }, "icon_background": { "type": "string", @@ -4242,19 +4242,19 @@ "items": { "$ref": "#/components/schemas/AnnotationItem" }, - "description": "当前页面的标注项列表。" + "description": "当前页的标注项列表。" }, "has_more": { "type": "boolean", - "description": "如果当前结果集之后还有更多页面，则为 `true`。" + "description": "如果当前结果集之外还有更多页面则为 `true`。" }, "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "total": { "type": "integer", - "description": "匹配查询条件的标注总数。" + "description": "匹配查询的标注总数。" }, "page": { "type": "integer", @@ -4268,22 +4268,22 @@ "id": { "type": "string", "format": "uuid", - "description": "标注唯一标识符。" + "description": "标注的唯一标识符。" }, "question": { "type": "string", "nullable": true, - "description": "触发该标注的问题文本。" + "description": "触发此标注的问题文本。" }, "answer": { "type": "string", "nullable": true, - "description": "标注被匹配时返回的预定义回答。" + "description": "标注匹配时返回的预定义答案。" }, "hit_count": { "type": "integer", "nullable": true, - "description": "该标注被匹配并作为回复返回的次数。" + "description": "此标注被匹配并作为回复返回的次数。" }, "created_at": { "type": "integer", @@ -4340,7 +4340,7 @@ "properties": { "embedding_provider_name": { "type": "string", - "description": "嵌入模型提供商名称（例如 `openai`、`cohere`）。" + "description": "嵌入模型供应商名称（例如 `openai`、`cohere`）。" }, "embedding_model_name": { "type": "string", @@ -4349,7 +4349,7 @@ "score_threshold": { "type": "number", "format": "float", - "description": "标注被视为匹配的最低相似度分数。值越高，要求匹配越精确。", + "description": "标注被视为匹配的最小相似度分数。值越高要求匹配越精确。", "minimum": 0, "maximum": 1 } @@ -4361,11 +4361,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "异步任务 ID。配合 [查询标注回复配置任务状态](/api-reference/标注管理/查询标注回复配置任务状态) 使用以跟踪进度。" + "description": "异步任务 ID。使用[获取标注回复任务状态](/api-reference/annotations/get-annotation-reply-job-status)跟踪进度。" }, "job_status": { "type": "string", - "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示已完成，`error` 表示失败。" + "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示完成，`error` 表示失败。" } } }, @@ -4375,11 +4375,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "来自 [配置标注回复](/api-reference/标注管理/配置标注回复) 调用的任务 ID。" + "description": "来自[配置标注回复](/api-reference/annotations/configure-annotation-reply)调用的任务 ID。" }, "job_status": { "type": "string", - "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示已完成，`error` 表示失败。" + "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示完成，`error` 表示失败。" }, "error_msg": { "type": "string", @@ -4391,36 +4391,36 @@ }, "tags": [ { - "name": "对话消息", - "description": "与聊天消息和交互相关的操作。" + "name": "Chats", + "description": "与对话消息和交互相关的操作。" }, { - "name": "文件操作", + "name": "Files", "description": "文件上传和预览操作。" }, { - "name": "终端用户", - "description": "终端用户信息相关操作。" + "name": "End Users", + "description": "与终端用户信息相关的操作。" }, { - "name": "消息反馈", + "name": "Feedback", "description": "用户反馈操作。" }, { - "name": "会话管理", - "description": "与管理会话相关的操作。" + "name": "Conversations", + "description": "与对话管理相关的操作。" }, { - "name": "语音与文字转换", + "name": "TTS", "description": "文字转语音和语音转文字操作。" }, { - "name": "应用配置", + "name": "Applications", "description": "获取应用设置和信息的操作。" }, { - "name": "标注管理", - "description": "与管理标注直接回复相关的操作。" + "name": "Annotations", + "description": "与直接回复标注管理相关的操作。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index b815a39ee..8a947934c 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "工作流编排对话型应用 API (对话流 API)", - "description": "对话流应用支持会话持久化，允许将之前的聊天记录作为响应的上下文。对话流应用使用 `advanced-chat` 模式，提供工作流级别的流式事件，用于详细的执行追踪，包括节点开始、完成、迭代和工作流生命周期。", + "title": "Chatflow 应用 API", + "description": "Chatflow 应用支持会话持久化，允许将之前的聊天历史记录用作响应的上下文。Chatflow 应用使用 `advanced-chat` 模式，提供工作流级别的流式事件，用于详细的执行跟踪，包括节点开始、完成、迭代和工作流生命周期。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "工作流编排对话型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。", + "description": "Chatflow 应用 API 的基础 URL。将 {api_base_url} 替换为为您的应用程序提供的实际 API 基础 URL。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -25,14 +25,14 @@ "paths": { "/chat-messages": { "post": { - "summary": "发送对话消息", - "description": "向对话型应用发送请求。", - "operationId": "sendChatMessageCn", + "summary": "发送聊天消息", + "description": "向聊天应用发送请求。", + "operationId": "sendAdvancedChatMessage", "tags": [ - "对话流" + "Chatflows" ], "requestBody": { - "description": "发送对话消息的请求体。", + "description": "发送聊天消息的请求体。", "required": true, "content": { "application/json": { @@ -41,7 +41,7 @@ }, "examples": { "streaming_example": { - "summary": "请求示例 - 流式模式", + "summary": "请求示例 - 流式返回模式", "value": { "inputs": { "city": "San Francisco" @@ -60,7 +60,7 @@ } }, "blocking_example": { - "summary": "请求示例 - 阻塞模式", + "summary": "请求示例 - 阻塞式返回模式", "value": { "inputs": {}, "query": "What are the specs of the iPhone 13 Pro Max?", @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "请求成功。内容类型和结构取决于请求中的 `response_mode` 参数。\n\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 和 `ChatCompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 和 `ChunkChatEvent` 对象流。", + "description": "成功响应。内容类型和结构取决于请求中的 `response_mode` 参数。\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 格式的 `ChatCompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 格式的 `ChunkChatEvent` 对象流。", "content": { "application/json": { "schema": { @@ -83,7 +83,7 @@ }, "examples": { "blockingResponse": { - "summary": "响应示例 - 阻塞模式", + "summary": "响应示例 - 阻塞式返回模式", "value": { "event": "message", "task_id": "c3800678-a077-43df-a102-53f23ed20b88", @@ -128,15 +128,15 @@ "text/event-stream": { "schema": { "type": "string", - "description": "服务器发送事件 (SSE) 流。\n\n**解析**：每行以 `data: ` 开头，后接一个 JSON 对象，以 `\\n\\n` 终止。解析 JSON 前先去除 `data: ` 前缀，再读取 `event` 字段确定事件类型。忽略 `ping` 事件，该事件每 10 秒发送一次以保持连接活跃。\n\n**流生命周期**：`message_end` 标志聊天消息的结束，但流会继续发送工作流生命周期事件。收到 `workflow_finished`、`workflow_paused` 或 `error` 时流关闭。错误以流内 `error` 事件的形式返回，HTTP 状态码始终为 `200`；请检查事件载荷获取详情，不要依赖状态码判断。\n\n**人工介入事件**：\n- `human_input_required`：工作流到达人工介入节点时与 `workflow_paused` 一同触发。使用载荷中的 `form_token` 通过 [人工介入 API](/api-reference/人工介入/获取人工介入表单) 处理表单。\n- `human_input_form_filled`：接收者提交了表单，工作流恢复执行。\n- `human_input_form_timeout`：表单超时未响应。如定义了超时回退分支，工作流将沿该分支执行。" + "description": "服务器发送事件 (SSE) 流。\n**解析**：每行以 `data: ` 开头，后跟 JSON 对象，以 `\\n\\n` 结尾。在解析 JSON 之前去除 `data: ` 前缀，然后读取 `event` 字段以确定事件类型。忽略 `ping` 事件，该事件每 10 秒触发一次以保持连接活跃。\n**流生命周期**：`message_end` 表示聊天消息结束，但流会继续处理工作流生命周期事件。当收到 `workflow_finished`、`workflow_paused` 或 `error` 时，流将关闭。错误以 HTTP 状态 `200` 在流中传递；请检查事件负载以获取详细信息，而不是依赖状态码。\n**人工介入事件**：\n- `human_input_required`：当工作流到达人工介入节点时，与 `workflow_paused` 一起触发。使用负载中的 `form_token` 通过[人工介入 API](/api-reference/human-input/get-human-input-form)驱动表单处理流程。\n- `human_input_form_filled`：接收者提交了表单；工作流执行恢复。\n- `human_input_form_timeout`：表单在没有响应的情况下过期。如果定义了超时回退边，工作流将遵循该路径。" }, "examples": { "streamingResponseBasic": { - "summary": "Response Example - Streaming (Basic)", + "summary": "响应示例 - 流式返回（基础）", "value": "data: {\"event\": \"message\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"answer\": \" I\", \"created_at\": 1679586595} data: {\"event\": \"message_end\", \"task_id\":\"mock_task_id\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"conversation_id\": \"45701982-8118-4bc5-8e9b-64562b4555f2\", \"metadata\": {\"usage\": {\"total_tokens\": 10, \"latency\": 1.0}}}" }, "streamingResponseWorkflow": { - "summary": "Response Example - Streaming (工作流)", + "summary": "响应示例 - 流式返回（工作流）", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"wfr_abc123\", \"workflow_id\": \"wf_def456\", \"inputs\": {\"city\": \"San Francisco\"}, \"created_at\": 1705395332}} data: {\"event\": \"node_started\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"ne_001\", \"node_id\": \"node_llm_1\", \"node_type\": \"llm\", \"title\": \"LLM\", \"index\": 1, \"created_at\": 1705395332}} data: {\"event\": \"message\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"answer\": \" I\", \"created_at\": 1705395333} data: {\"event\": \"node_finished\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"ne_001\", \"node_id\": \"node_llm_1\", \"node_type\": \"llm\", \"title\": \"LLM\", \"index\": 1, \"status\": \"succeeded\", \"elapsed_time\": 1.5, \"created_at\": 1705395332, \"finished_at\": 1705395334}} data: {\"event\": \"message_end\", \"task_id\": \"task123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"metadata\": {\"usage\": {\"total_tokens\": 50, \"latency\": 2.5}}} data: {\"event\": \"workflow_finished\", \"task_id\": \"task123\", \"workflow_run_id\": \"wfr_abc123\", \"message_id\": \"msg123\", \"conversation_id\": \"conv123\", \"data\": {\"id\": \"wfr_abc123\", \"workflow_id\": \"wf_def456\", \"status\": \"succeeded\", \"elapsed_time\": 2.5, \"total_tokens\": 50, \"total_steps\": 2, \"created_at\": 1705395332, \"finished_at\": 1705395335}}" }, "humanInputPause": { @@ -148,7 +148,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `not_chat_app` : App mode does not match the API route.\n- `conversation_completed` : The conversation has ended.\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不可用。\n- `completion_request_error` : 文本生成失败。\n- `bad_request` : Cannot use draft 工作流 version.\n- `bad_request` : Invalid `workflow_id` format.", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `not_chat_app`：应用模式与 API 路由不匹配。\n- `conversation_completed`：对话已结束。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不可用。\n- `completion_request_error`：文本生成失败。\n- `bad_request`：无法使用草稿工作流版本。\n- `bad_request`：`workflow_id` 格式无效。", "content": { "application/json": { "examples": { @@ -229,7 +229,7 @@ } }, "404": { - "description": "- `not_found` : Conversation does not exist.\n- `not_found` : 工作流 not found with the specified `workflow_id`.", + "description": "- `not_found`：对话不存在。\n- `not_found`：未找到指定 `workflow_id` 的工作流。", "content": { "application/json": { "examples": { @@ -254,7 +254,7 @@ } }, "429": { - "description": "- `too_many_requests` : 该应用的并发请求过多。\n- `rate_limit_error` : 上游模型提供商的速率限制已超出。", + "description": "- `too_many_requests`：此应用的并发请求过多。\n- `rate_limit_error`：上游模型供应商速率限制已超出。", "content": { "application/json": { "examples": { @@ -279,7 +279,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -300,18 +300,18 @@ }, "/chat-messages/{task_id}/stop": { "post": { - "summary": "停止响应", + "summary": "停止聊天消息生成", "description": "停止聊天消息生成任务。仅在 `streaming` 模式下支持。", - "operationId": "stopChatMessageGenerationCn", + "operationId": "stopAdvancedChatMessageGeneration", "tags": [ - "对话流" + "Chatflows" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "任务 ID，可以从 [发送对话消息](/api-reference/对话流/发送对话消息) API 的流式分块返回中获取。", + "description": "任务 ID，可从[发送聊天消息](/api-reference/chatflows/send-chat-message) API 的流式返回块中获取。", "schema": { "type": "string" } @@ -329,7 +329,7 @@ "properties": { "user": { "type": "string", - "description": "用户标识符，必须和发送消息接口传入的 user 保持一致。" + "description": "用户标识符，必须与发送消息接口中传递的用户一致。" } } }, @@ -349,7 +349,7 @@ "$ref": "#/components/responses/SuccessResult" }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -370,11 +370,11 @@ }, "/messages/{message_id}/suggested": { "get": { - "summary": "获取下一轮建议问题列表", - "description": "获取当前消息的下一步建议问题。", - "operationId": "getSuggestedQuestionsCn", + "summary": "获取下一轮建议问题", + "description": "获取当前消息的下一轮建议问题。", + "operationId": "getAdvancedSuggestedQuestions", "tags": [ - "对话流" + "Chatflows" ], "parameters": [ { @@ -421,7 +421,7 @@ } }, "400": { - "description": "- `not_chat_app` : 应用模式与 API 路由不匹配。\n- `bad_request` : 建议问题功能已禁用。", + "description": "- `not_chat_app`：应用模式与 API 路由不匹配。\n- `bad_request`：建议问题功能已禁用。", "content": { "application/json": { "examples": { @@ -446,7 +446,7 @@ } }, "404": { - "description": "`not_found` : 消息不存在。", + "description": "`not_found`：消息不存在。", "content": { "application/json": { "examples": { @@ -463,7 +463,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -484,14 +484,14 @@ }, "/files/upload": { "post": { - "operationId": "uploadFileCn", + "operationId": "uploadAdvancedChatFile", "tags": [ - "文件操作" + "Files" ], "summary": "上传文件", - "description": "上传文件用于发送消息时使用，支持图片、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", + "description": "上传用于发送消息时使用的文件，支持图像、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", "requestBody": { - "description": "文件上传请求。需要 multipart/form-data 格式。", + "description": "文件上传请求。需要 multipart/form-data。", "required": true, "content": { "multipart/form-data": { @@ -504,11 +504,11 @@ "file": { "type": "string", "format": "binary", - "description": "要上传的文件。支持的类型包括图片、文档、音频和视频。" + "description": "要上传的文件。支持的类型包括图像、文档、音频和视频。" }, "user": { "type": "string", - "description": "用户标识符，由开发者定义的规则生成，必须在应用内唯一。" + "description": "用户标识符，由开发者规则定义，在应用内必须唯一。" } } } @@ -548,7 +548,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : 请求中未提供文件。\n- `too_many_files` : 每次请求仅允许上传一个文件。\n- `filename_not_exists_error` : 上传的文件没有文件名。", + "description": "- `no_file_uploaded`：请求中未提供文件。\n- `too_many_files`：每个请求只允许一个文件。\n- `filename_not_exists_error`：上传的文件没有文件名。", "content": { "application/json": { "examples": { @@ -581,7 +581,7 @@ } }, "413": { - "description": "`file_too_large` : 文件大小超出限制。", + "description": "`file_too_large`：文件大小超出限制。", "content": { "application/json": { "examples": { @@ -598,7 +598,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 不允许的文件类型。", + "description": "`unsupported_file_type`：文件类型不允许。", "content": { "application/json": { "examples": { @@ -619,18 +619,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "previewChatFlowFileCn", + "operationId": "previewChatFlowFile", "tags": [ - "文件操作" + "Files" ], "summary": "下载文件", - "description": "预览或下载之前通过[上传文件](/api-reference/文件操作/上传文件) API 上传的文件。仅可访问属于请求应用内消息的文件。", + "description": "预览或下载之前通过[上传文件](/api-reference/files/upload-file) API 上传的文件。只有属于请求应用内消息的文件才能被访问。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "要预览的文件唯一标识符，从 [上传文件](/api-reference/文件操作/上传文件) API 响应中获取。", + "description": "要预览的文件的唯一标识符，从[上传文件](/api-reference/files/upload-file) API 响应中获取。", "schema": { "type": "string", "format": "uuid" @@ -640,7 +640,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "如果为 `true`，则强制文件以附件形式下载，而不是在浏览器中预览。", + "description": "如果为 `true`，强制文件作为附件下载而不是在浏览器中预览。", "schema": { "type": "boolean", "default": false @@ -658,7 +658,7 @@ ], "responses": { "200": { - "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将以 `Content-Disposition: attachment` 方式作为下载返回。", + "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将作为下载返回，带有 `Content-Disposition: attachment`。", "content": { "application/octet-stream": { "schema": { @@ -669,7 +669,7 @@ } }, "403": { - "description": "`file_access_denied` : 拒绝访问请求的文件。", + "description": "`file_access_denied`：拒绝访问请求的文件。", "content": { "application/json": { "examples": { @@ -686,7 +686,7 @@ } }, "404": { - "description": "`file_not_found` : 未找到请求的文件。", + "description": "`file_not_found`：未找到请求的文件。", "content": { "application/json": { "examples": { @@ -707,12 +707,12 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserChatflowCn", + "operationId": "getEndUserChatflow", "tags": [ - "终端用户" + "End Users" ], "summary": "获取终端用户信息", - "description": "根据 ID 获取终端用户信息。当其他 API 返回终端用户 ID（例如[上传文件](/api-reference/文件操作/上传文件)返回的 `created_by`）时很有用。", + "description": "通过 ID 获取终端用户。当其他 API 返回终端用户 ID 时很有用（例如，[上传文件](/api-reference/files/upload-file)中的 `created_by`）。", "parameters": [ { "name": "end_user_id", @@ -754,7 +754,7 @@ } }, "404": { - "description": "`end_user_not_found` : 未找到终端用户。", + "description": "`end_user_not_found`：未找到终端用户。", "content": { "application/json": { "examples": { @@ -775,12 +775,12 @@ }, "/messages/{message_id}/feedbacks": { "post": { - "operationId": "postMessageFeedbackCn", + "operationId": "postAdvancedChatMessageFeedback", "tags": [ - "消息反馈" + "Feedback" ], "summary": "提交消息反馈", - "description": "提交消息反馈。终端用户可以对消息评价 `like` 或 `dislike`，并可选择提供文字反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", + "description": "提交消息反馈。终端用户可以将消息评为 `like` 或 `dislike`，并可选择提供文本反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", "parameters": [ { "name": "message_id", @@ -817,7 +817,7 @@ "$ref": "#/components/responses/SuccessResult" }, "404": { - "description": "`not_found` : 消息不存在。", + "description": "`not_found`：消息不存在。", "content": { "application/json": { "examples": { @@ -838,17 +838,17 @@ }, "/app/feedbacks": { "get": { - "operationId": "getAppFeedbacksCn", + "operationId": "getAdvancedChatAppFeedbacks", "tags": [ - "消息反馈" + "Feedback" ], - "summary": "获取应用的消息反馈", + "summary": "获取应用反馈列表", "description": "获取此应用中所有消息反馈的分页列表，包括终端用户和管理员反馈。", "parameters": [ { "name": "page", "in": "query", - "description": "分页页码。", + "description": "分页的页码。", "required": false, "schema": { "type": "integer", @@ -920,11 +920,11 @@ }, "/conversations": { "get": { - "summary": "获取会话列表", - "description": "获取当前用户的会话列表，按最近活跃时间排序。", - "operationId": "getConversationsListCn", + "summary": "获取对话列表", + "description": "获取当前用户的对话列表，按最近活跃排序。", + "operationId": "getAdvancedConversationsList", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -949,7 +949,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返回的记录数。", + "description": "要返回的记录数。", "schema": { "type": "integer", "default": 20, @@ -976,7 +976,7 @@ ], "responses": { "200": { - "description": "成功获取会话列表。", + "description": "成功获取对话列表。", "content": { "application/json": { "schema": { @@ -1008,7 +1008,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1025,7 +1025,7 @@ } }, "404": { - "description": "`not_found` : 上一个会话不存在（无效的 `last_id`）。", + "description": "`not_found`：最后一个对话不存在（`last_id` 无效）。", "content": { "application/json": { "examples": { @@ -1046,18 +1046,18 @@ }, "/messages": { "get": { - "summary": "获取会话历史消息", - "description": "以滚动加载的格式返回历史聊天记录，首页返回最新的 `limit` 条消息，即按时间倒序排列。", - "operationId": "getConversationHistoryCn", + "summary": "获取对话消息列表", + "description": "以滚动加载格式返回历史聊天记录，第一页返回最新的 `limit` 条消息，即倒序排列。", + "operationId": "getAdvancedConversationHistory", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "query", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1075,7 +1075,7 @@ "name": "first_id", "in": "query", "required": false, - "description": "当前页第一条聊天记录的 ID。默认为 `null`（获取最新消息）。获取后续页面时，使用当前列表中第一条消息的 ID 来获取更早的消息。", + "description": "当前页第一条聊天记录的 ID。默认为 `null`（获取最新消息）。对于后续页面，使用当前列表中第一条消息的 ID 来获取更早的消息。", "schema": { "type": "string" } @@ -1095,7 +1095,7 @@ ], "responses": { "200": { - "description": "成功获取会话历史。", + "description": "成功获取对话历史。", "content": { "application/json": { "schema": { @@ -1135,7 +1135,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1152,7 +1152,7 @@ } }, "404": { - "description": "- `not_found` : 会话不存在。\n- `not_found` : 第一条消息不存在。", + "description": "- `not_found`：对话不存在。\n- `not_found`：第一条消息不存在。", "content": { "application/json": { "examples": { @@ -1181,18 +1181,18 @@ }, "/conversations/{conversation_id}/variables": { "get": { - "summary": "获取对话变量", - "description": "从特定会话中获取变量。", - "operationId": "getConversationVariablesCn", + "summary": "获取会话变量列表", + "description": "从特定对话中获取变量。", + "operationId": "getAdvancedConversationVariables", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1219,7 +1219,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返回的记录数。", + "description": "要返回的记录数。", "schema": { "type": "integer", "default": 20, @@ -1231,7 +1231,7 @@ "name": "variable_name", "in": "query", "required": false, - "description": "按指定名称筛选变量。", + "description": "按特定名称筛选变量。", "schema": { "type": "string", "minLength": 1, @@ -1271,7 +1271,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1288,7 +1288,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1309,18 +1309,18 @@ }, "/conversations/{conversation_id}/name": { "post": { - "summary": "重命名会话", - "description": "重命名会话或自动生成名称。会话名称用于在支持多会话的客户端上显示。", - "operationId": "renameConversationCn", + "summary": "重命名对话", + "description": "重命名对话或自动生成名称。对话名称用于在支持多对话的客户端上显示。", + "operationId": "renameAdvancedConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1347,7 +1347,7 @@ }, "responses": { "200": { - "description": "会话重命名成功。", + "description": "对话重命名成功。", "content": { "application/json": { "schema": { @@ -1373,7 +1373,7 @@ } }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1390,7 +1390,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1411,18 +1411,18 @@ }, "/conversations/{conversation_id}/variables/{variable_id}": { "put": { - "summary": "更新对话变量", + "summary": "更新会话变量", "description": "更新特定会话变量的值。值必须与预期类型匹配。", - "operationId": "updateChatflowConversationVariableZh", + "operationId": "updateChatflowConversationVariable", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string", "format": "uuid" @@ -1432,7 +1432,7 @@ "name": "variable_id", "in": "path", "required": true, - "description": "Variable ID.", + "description": "变量 ID。", "schema": { "type": "string", "format": "uuid" @@ -1484,7 +1484,7 @@ } }, "400": { - "description": "- `not_chat_app` : 应用模式与 API 路由不匹配。\n- `bad_request` : 变量值类型不匹配。", + "description": "- `not_chat_app`：应用模式与 API 路由不匹配。\n- `bad_request`：变量值类型不匹配。", "content": { "application/json": { "examples": { @@ -1509,7 +1509,7 @@ } }, "404": { - "description": "- `not_found` : 会话不存在。\n- `not_found` : 会话变量不存在。", + "description": "- `not_found`：对话不存在。\n- `not_found`：会话变量不存在。", "content": { "application/json": { "examples": { @@ -1538,18 +1538,18 @@ }, "/conversations/{conversation_id}": { "delete": { - "summary": "删除会话", - "description": "删除会话。", - "operationId": "deleteConversationCn", + "summary": "删除对话", + "description": "删除对话。", + "operationId": "deleteAdvancedConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, - "description": "会话 ID。", + "description": "对话 ID。", "schema": { "type": "string" } @@ -1581,10 +1581,10 @@ }, "responses": { "204": { - "description": "会话删除成功。无返回内容。" + "description": "对话删除成功。不返回内容。" }, "400": { - "description": "`not_chat_app` : 应用模式与 API 路由不匹配。", + "description": "`not_chat_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -1601,7 +1601,7 @@ } }, "404": { - "description": "`not_found` : 会话不存在。", + "description": "`not_found`：对话不存在。", "content": { "application/json": { "examples": { @@ -1622,11 +1622,11 @@ }, "/audio-to-text": { "post": { - "operationId": "audioToTextCn", + "operationId": "advancedAudioToText", "tags": [ - "语音与文字转换" + "TTS" ], - "summary": "语音转文字", + "summary": "音频转文字", "description": "将音频文件转换为文字。支持的格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。文件大小限制为 `30 MB`。", "requestBody": { "required": true, @@ -1640,7 +1640,7 @@ }, "responses": { "200": { - "description": "语音转文字成功。", + "description": "成功将音频转换为文字。", "content": { "application/json": { "schema": { @@ -1658,7 +1658,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `no_audio_uploaded` : 未上传音频文件。\n- `provider_not_support_speech_to_text` : 模型提供商不支持语音转文字。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 语音识别请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `no_audio_uploaded`：未上传音频文件。\n- `provider_not_support_speech_to_text`：模型供应商不支持语音转文字。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：语音识别请求失败。", "content": { "application/json": { "examples": { @@ -1723,7 +1723,7 @@ } }, "413": { - "description": "`audio_too_large` : 音频文件大小超出限制。", + "description": "`audio_too_large`：音频文件大小超出限制。", "content": { "application/json": { "examples": { @@ -1740,7 +1740,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 不允许的音频类型。", + "description": "`unsupported_audio_type`：音频类型不允许。", "content": { "application/json": { "examples": { @@ -1757,7 +1757,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1778,11 +1778,11 @@ }, "/text-to-audio": { "post": { - "operationId": "textToAudioCn", + "operationId": "advancedTextToAudio", "tags": [ - "语音与文字转换" + "TTS" ], - "summary": "文字转语音", + "summary": "文字转音频", "description": "将文字转换为语音。", "requestBody": { "required": true, @@ -1807,7 +1807,7 @@ }, "responses": { "200": { - "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式返回。", + "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式传输。", "content": { "audio/mpeg": { "schema": { @@ -1818,7 +1818,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 文字转语音请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `provider_not_initialize`：未找到有效的模型供应商凭据。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：文字转语音请求失败。", "content": { "application/json": { "examples": { @@ -1867,7 +1867,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1888,12 +1888,12 @@ }, "/info": { "get": { - "operationId": "getAppInfoCn", + "operationId": "getAdvancedChatAppInfo", "tags": [ - "应用配置" + "Applications" ], - "summary": "获取应用基本信息", - "description": "获取应用的基本信息，包括名称、描述、标签和模式。", + "summary": "获取应用信息", + "description": "获取此应用的基本信息，包括名称、描述、标签和模式。", "responses": { "200": { "description": "应用的基本信息。", @@ -1925,9 +1925,9 @@ }, "/parameters": { "get": { - "operationId": "getAppParametersCn", + "operationId": "getAdvancedChatAppParameters", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用参数", "description": "获取应用的输入表单配置，包括功能开关、输入参数名称、类型和默认值。", @@ -2007,7 +2007,7 @@ } }, "400": { - "description": "`app_unavailable` : 应用不可用或配置错误。", + "description": "`app_unavailable`：应用不可用或配置错误。", "content": { "application/json": { "examples": { @@ -2028,15 +2028,15 @@ }, "/meta": { "get": { - "operationId": "getAppMetaCn", + "operationId": "getAdvancedChatAppMeta", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用元数据", - "description": "获取应用的元数据，包括工具图标和其他配置详情。", + "description": "获取此应用的元数据，包括工具图标和其他配置详情。", "responses": { "200": { - "description": "成功获取应用元数据。", + "description": "成功获取应用元数据信息。", "content": { "application/json": { "schema": { @@ -2064,12 +2064,12 @@ }, "/site": { "get": { - "operationId": "getWebAppSettingsCn", + "operationId": "getAdvancedChatWebAppSettings", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用 WebApp 设置", - "description": "获取应用的 WebApp 设置，包括站点配置、主题和自定义选项。", + "description": "获取此应用的 WebApp 设置，包括站点配置、主题和自定义选项。", "responses": { "200": { "description": "应用的 WebApp 设置。", @@ -2082,7 +2082,7 @@ "webAppSettings": { "summary": "响应示例", "value": { - "title": "My Chat App", + "title": "我的聊天应用", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", @@ -2103,7 +2103,7 @@ } }, "403": { - "description": "`forbidden` : 未找到此应用的站点或工作空间已归档。", + "description": "`forbidden`：未找到此应用的站点或工作区已归档。", "content": { "application/json": { "examples": { @@ -2125,10 +2125,10 @@ "/apps/annotations": { "post": { "summary": "创建标注", - "description": "创建新的标注。标注提供预定义的问答对，应用可以直接匹配并返回，而无需生成回复。", - "operationId": "createAnnotationCn", + "description": "创建新标注。标注提供预定义的问答对，应用可以匹配并直接返回，而不是生成响应。", + "operationId": "createAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "requestBody": { "required": true, @@ -2176,16 +2176,16 @@ }, "get": { "summary": "获取标注列表", - "description": "获取应用的标注分页列表。支持关键词搜索筛选。", - "operationId": "getAnnotationListCn", + "description": "获取应用标注的分页列表。支持关键字搜索筛选。", + "operationId": "getAdvancedAnnotationList", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { "name": "page", "in": "query", - "description": "分页页码。", + "description": "分页的页码。", "required": false, "schema": { "type": "integer", @@ -2195,7 +2195,7 @@ { "name": "limit", "in": "query", - "description": "每页条目数。", + "description": "每页项目数。", "required": false, "schema": { "type": "integer", @@ -2205,7 +2205,7 @@ { "name": "keyword", "in": "query", - "description": "按问题或回答内容筛选标注的关键词。", + "description": "按问题或答案内容筛选标注的关键字。", "required": false, "schema": { "type": "string" @@ -2249,10 +2249,10 @@ "/apps/annotations/{annotation_id}": { "put": { "summary": "更新标注", - "description": "更新现有标注的问题和回答。", - "operationId": "updateAnnotationCn", + "description": "更新现有标注的问题和答案。", + "operationId": "updateAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2309,7 +2309,7 @@ } }, "403": { - "description": "`forbidden` : 编辑标注的权限不足。", + "description": "`forbidden`：编辑标注权限不足。", "content": { "application/json": { "examples": { @@ -2326,7 +2326,7 @@ } }, "404": { - "description": "`not_found` : 标注不存在。", + "description": "`not_found`：标注不存在。", "content": { "application/json": { "examples": { @@ -2347,9 +2347,9 @@ "delete": { "summary": "删除标注", "description": "删除标注及其关联的命中历史。", - "operationId": "deleteAnnotationCn", + "operationId": "deleteAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2368,7 +2368,7 @@ "description": "标注删除成功。" }, "403": { - "description": "`forbidden` : 编辑标注的权限不足。", + "description": "`forbidden`：编辑标注权限不足。", "content": { "application/json": { "examples": { @@ -2385,7 +2385,7 @@ } }, "404": { - "description": "`not_found` : 标注不存在。", + "description": "`not_found`：标注不存在。", "content": { "application/json": { "examples": { @@ -2407,10 +2407,10 @@ "/apps/annotation-reply/{action}": { "post": { "summary": "配置标注回复", - "description": "启用或禁用标注回复功能。启用时需要配置嵌入模型。异步执行——使用 [查询标注回复配置任务状态](/api-reference/标注管理/查询标注回复配置任务状态) 跟踪进度。", - "operationId": "initialAnnotationReplySettingsCn", + "description": "启用或禁用标注回复功能。启用时需要配置嵌入模型。异步执行 - 使用[获取标注回复任务状态](/api-reference/annotations/get-annotation-reply-job-status)跟踪进度。", + "operationId": "initialAdvancedAnnotationReplySettings", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -2472,18 +2472,18 @@ }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { - "summary": "查询标注回复配置任务状态", - "description": "获取由 [配置标注回复](/api-reference/标注管理/配置标注回复) 发起的异步标注回复配置任务的状态。", - "operationId": "getInitialAnnotationReplySettingsStatusCn", + "summary": "获取标注回复任务状态", + "description": "获取由[配置标注回复](/api-reference/annotations/configure-annotation-reply)启动的异步标注回复配置任务的状态。", + "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "操作类型，必须与 [配置标注回复](/api-reference/标注管理/配置标注回复) 调用中的一致。", + "description": "操作类型，必须与[配置标注回复](/api-reference/annotations/configure-annotation-reply)调用匹配。", "schema": { "type": "string", "enum": [ @@ -2496,7 +2496,7 @@ "name": "job_id", "in": "path", "required": true, - "description": "由 [配置标注回复](/api-reference/标注管理/配置标注回复) 接口返回的任务 ID。", + "description": "由[配置标注回复](/api-reference/annotations/configure-annotation-reply)返回的任务 ID。", "schema": { "type": "string", "format": "uuid" @@ -2525,7 +2525,7 @@ } }, "400": { - "description": "`invalid_param` : 指定的任务不存在。", + "description": "`invalid_param`：指定的任务不存在。", "content": { "application/json": { "examples": { @@ -2546,11 +2546,11 @@ }, "/workflows/run/{workflow_run_id}": { "get": { - "summary": "获取工作流执行情况", + "summary": "获取工作流运行详情", "description": "根据工作流执行 ID 获取工作流任务的当前执行结果。", - "operationId": "getChatflowWorkflowRunDetailZh", + "operationId": "getChatflowWorkflowRunDetail", "tags": [ - "对话流" + "Chatflows" ], "parameters": [ { @@ -2597,7 +2597,7 @@ } }, "400": { - "description": "`not_workflow_app` : 应用模式与 API 路由不匹配。", + "description": "`not_workflow_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -2614,7 +2614,7 @@ } }, "404": { - "description": "`not_found` : 未找到工作流运行记录。", + "description": "`not_found`：未找到工作流运行。", "content": { "application/json": { "examples": { @@ -2635,17 +2635,17 @@ }, "/workflows/logs": { "get": { - "summary": "获取工作流日志", - "description": "获取分页的工作流执行日志，支持筛选选项。", - "operationId": "listChatflowWorkflowLogsZh", + "summary": "获取工作流日志列表", + "description": "获取带有筛选选项的分页工作流执行日志。", + "operationId": "listChatflowWorkflowLogs", "tags": [ - "对话流" + "Chatflows" ], "parameters": [ { "name": "keyword", "in": "query", - "description": "在日志中搜索的关键词。", + "description": "在日志中搜索的关键字。", "schema": { "type": "string" } @@ -2666,7 +2666,7 @@ { "name": "page", "in": "query", - "description": "分页页码。", + "description": "分页的页码。", "schema": { "type": "integer", "default": 1, @@ -2677,7 +2677,7 @@ { "name": "limit", "in": "query", - "description": "每页条目数。", + "description": "每页项目数。", "schema": { "type": "integer", "default": 20, @@ -2775,10 +2775,10 @@ "/form/human_input/{form_token}": { "get": { "tags": [ - "人工介入" + "Human Input" ], "summary": "获取人工介入表单", - "description": "使用 `human_input_required` 事件返回的 `form_token` 获取暂停中的人工介入表单内容。需要 **WebApp** 送达方式。", + "description": "使用 `human_input_required` 事件中的 `form_token` 获取暂停的人工介入表单内容。需要 **WebApp** 交付。", "operationId": "getChatflowHumanInputForm", "parameters": [ { @@ -2788,12 +2788,12 @@ "schema": { "type": "string" }, - "description": "暂停表单的访问令牌，由流式模式下 [发送对话消息](/api-reference/对话流/发送对话消息) 返回的 `human_input_required` 事件提供。" + "description": "暂停表单的访问令牌，在流式返回模式下从[发送聊天消息](/api-reference/chatflows/send-chat-message)的 `human_input_required` 事件中返回。" } ], "responses": { "200": { - "description": "表单内容获取成功。", + "description": "成功获取表单内容。", "content": { "application/json": { "schema": { @@ -2801,7 +2801,7 @@ "properties": { "form_content": { "type": "string", - "description": "已替换工作流变量的预渲染表单正文。" + "description": "预渲染的表单正文，已替换工作流变量。" }, "inputs": { "type": "array", @@ -2810,27 +2810,27 @@ "properties": { "type": { "type": "string", - "description": "表单输入控件类型。可用值：`text_input`（单行文本输入框）和 `paragraph`（多行文本区域）。" + "description": "表单输入控件类型。可用值：`text_input`（单行文本字段）和 `paragraph`（多行文本区域）。" }, "output_variable_name": { "type": "string", - "description": "引用该输入提交值在工作流中使用的变量名。对应提交 `inputs` 对象中的键。" + "description": "用于在工作流中引用此输入提交值的变量名称。对应提交 `inputs` 对象中的键。" }, "default": { "type": "object", "nullable": true, - "description": "从工作流上下文解析得到的默认值。未配置默认值时为 `null`。", + "description": "从工作流上下文解析的默认值。未配置默认值时为 `null`。", "properties": { "type": { "type": "string", - "description": "默认值来源。`constant` 表示将 `value` 作为字面字符串；`variable` 表示 `selector` 指向工作流变量。" + "description": "默认值的来源。`constant` 表示 `value` 用作字面字符串；`variable` 表示 `selector` 指向工作流变量。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "当 `type` 为 `variable` 时，变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。至少包含两个元素。" + "description": "当 `type` 为 `variable` 时的变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。必须包含至少两个元素。" }, "value": { "type": "string", @@ -2847,7 +2847,7 @@ "additionalProperties": { "type": "string" }, - "description": "预填充默认值，按输入的 `output_variable_name` 分组。所有值均为字符串。" + "description": "预填充的默认值，以输入的 `output_variable_name` 为键。所有值都已字符串化。" }, "user_actions": { "type": "array", @@ -2858,16 +2858,16 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "操作按钮的标识。当接收者选择该按钮时，作为 `action` 传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单)。" + "description": "操作按钮的标识符。当接收者选择此按钮时，在[提交人工介入表单](/api-reference/human-input/submit-human-input-form)中作为 `action` 传递。" }, "title": { "type": "string", "maxLength": 100, - "description": "显示给接收者的按钮文本。" + "description": "显示给接收者的按钮标签。" }, "button_style": { "type": "string", - "description": "按钮视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" + "description": "按钮的视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" } } }, @@ -2876,7 +2876,7 @@ "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），超过后无法再提交该表单。" + "description": "此表单无法再提交的 Unix 时间戳（秒）。" } } }, @@ -2902,12 +2902,12 @@ "user_actions": [ { "id": "approve", - "title": "Approve", + "title": "批准", "button_style": "primary" }, { "id": "reject", - "title": "Request changes", + "title": "请求修改", "button_style": "default" } ], @@ -2919,7 +2919,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found`：未找到表单。", "content": { "application/json": { "examples": { @@ -2936,7 +2936,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted`：表单已提交。表单是一次性的；无论哪个用户提交，第一个响应都会生效。\n- `human_input_form_expired`：表单的过期时间在提交到达之前已过。", "content": { "application/json": { "examples": { @@ -2964,10 +2964,10 @@ }, "post": { "tags": [ - "人工介入" + "Human Input" ], "summary": "提交人工介入表单", - "description": "提交接收者对暂停中人工介入表单的响应。表单被接受后工作流恢复执行；可订阅 [流式获取工作流事件](/api-reference/对话流/流式获取工作流事件) 接收后续事件。需要 **WebApp** 送达方式。", + "description": "提交接收者对暂停的人工介入表单的响应。工作流在接受后恢复；使用[流式工作流事件](/api-reference/chatflows/stream-workflow-events)跟踪后续事件。需要 **WebApp** 交付。", "operationId": "submitChatflowHumanInputForm", "parameters": [ { @@ -2977,7 +2977,7 @@ "schema": { "type": "string" }, - "description": "暂停表单的访问令牌，由流式模式下 [发送对话消息](/api-reference/对话流/发送对话消息) 返回的 `human_input_required` 事件提供。" + "description": "暂停表单的访问令牌，在流式返回模式下从[发送聊天消息](/api-reference/chatflows/send-chat-message)的 `human_input_required` 事件中返回。" } ], "requestBody": { @@ -2995,17 +2995,17 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "接收者提交的值，按输入的 `output_variable_name` 分组。" + "description": "接收者提供的值，以输入的 `output_variable_name` 为键。" }, "action": { "type": "string", - "description": "接收者选择的操作按钮 ID。必须与 [获取人工介入表单](/api-reference/人工介入/获取人工介入表单) 返回的 `user_actions` 列表中的某个 `id` 值匹配。", + "description": "接收者选择的操作按钮的 ID。必须与表单 `user_actions` 列表中的 `id` 值之一匹配（由[获取人工介入表单](/api-reference/human-input/get-human-input-form)返回）。", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "user": { "type": "string", - "description": "提交者的终端用户标识。" + "description": "提交者的终端用户标识符。" } } }, @@ -3042,7 +3042,7 @@ } }, "400": { - "description": "- `bad_request` : Form recipient type is invalid.\n- `invalid_form_data` : Submission failed validation against the form definition.", + "description": "- `bad_request`：表单接收者类型无效。\n- `invalid_form_data`：提交未通过表单定义验证。", "content": { "application/json": { "examples": { @@ -3067,7 +3067,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found`：未找到表单。", "content": { "application/json": { "examples": { @@ -3084,7 +3084,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted`：表单已提交。表单是一次性的；无论哪个用户提交，第一个响应都会生效。\n- `human_input_form_expired`：表单的过期时间在提交到达之前已过。", "content": { "application/json": { "examples": { @@ -3114,10 +3114,10 @@ "/workflow/{task_id}/events": { "get": { "tags": [ - "对话流" + "Chatflows" ], - "summary": "流式获取工作流事件", - "description": "在工作流运行暂停或原始 SSE 连接断开后恢复 Server-Sent Events 流。对于已结束的运行，流仅发送单个 `workflow_finished` 事件后关闭。", + "summary": "流式工作流事件", + "description": "在暂停或 SSE 连接断开后恢复工作流运行的服务器发送事件流。对于已完成的运行，流会发送单个 `workflow_finished` 事件并关闭。", "operationId": "streamChatflowEvents", "parameters": [ { @@ -3128,7 +3128,7 @@ "type": "string", "format": "uuid" }, - "description": "原始 [发送对话消息](/api-reference/对话流/发送对话消息) 请求返回的工作流运行 ID。" + "description": "由原始[发送聊天消息](/api-reference/chatflows/send-chat-message)请求返回的工作流运行 ID。" }, { "name": "user", @@ -3137,7 +3137,7 @@ "schema": { "type": "string" }, - "description": "发送该对话消息的终端用户标识。必须与工作流运行的创建者一致。" + "description": "发送聊天消息的终端用户标识符。必须与工作流运行的创建者匹配。" }, { "name": "include_state_snapshot", @@ -3147,7 +3147,7 @@ "type": "boolean", "default": false }, - "description": "为 `true` 时，从持久化状态快照重放，在流式发送新事件前附带已执行节点的状态摘要。" + "description": "当为 `true` 时，从持久化状态快照重放，在流式传输新事件之前包含已执行节点的状态摘要。" }, { "name": "continue_on_pause", @@ -3157,12 +3157,12 @@ "type": "boolean", "default": false }, - "description": "设为 `true` 时，流会在多次 `workflow_paused` 事件之间保持打开（适用于工作流包含多个连续人工介入节点的场景）。默认在首次暂停时关闭流。" + "description": "设置为 `true` 以在多个 `workflow_paused` 事件之间保持流打开（当工作流有多个连续的人工介入节点时很有用）。默认在第一次暂停后关闭流。" } ], "responses": { "200": { - "description": "Server-Sent Events 流。每个事件以 `data: {JSON}\\n\\n` 形式送达。事件载荷结构与原始流式响应一致。", + "description": "服务器发送事件流。每个事件以 `data: {JSON}\\n\\n` 格式传递。事件负载遵循与原始流式响应相同的模式。", "content": { "text/event-stream": { "schema": { @@ -3173,7 +3173,7 @@ } }, "400": { - "description": "`not_workflow_app` : Please check if your app mode matches the right API route.", + "description": "`not_workflow_app`：请检查您的应用模式是否与正确的 API 路由匹配。", "content": { "application/json": { "examples": { @@ -3190,7 +3190,7 @@ } }, "404": { - "description": "`not_found` : Workflow run not found.", + "description": "`not_found`：未找到工作流运行。", "content": { "application/json": { "examples": { @@ -3216,7 +3216,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上 `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**" + "description": "API Key 认证。对于所有 API 请求，在 `Authorization` HTTP 头中包含您的 API Key，以 `Bearer ` 为前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将您的 API Key 存储在服务器端，不要在客户端共享或存储，以避免可能导致严重后果的 API Key 泄露。**" } }, "responses": { @@ -3260,7 +3260,7 @@ }, "inputs": { "type": "object", - "description": "允许输入应用定义的各种变量值。包含键值对。请参阅 [获取应用参数](/api-reference/应用配置/获取应用参数) 响应中的 `user_input_form` 字段，以了解应用所需的变量名称和类型。", + "description": "允许输入应用定义的各种变量值。包含键/值对。参考[获取应用参数](/api-reference/applications/get-app-parameters)响应中的 `user_input_form` 字段以了解应用期望的变量名称和类型。", "additionalProperties": true }, "response_mode": { @@ -3269,19 +3269,19 @@ "streaming", "blocking" ], - "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 等待完成后返回（长时间处理可能会被中断）。Cloudflare 超时为 `100 s`。省略时默认为阻塞模式。" + "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 在完成后返回（长时间处理可能会中断）。Cloudflare 超时为 `100 秒`。省略时默认为阻塞式返回行为。" }, "user": { "type": "string", - "description": "用户标识符，在应用内唯一。此标识符用于限定数据访问范围——会话、消息和文件仅在使用相同的 `user` 值查询时可见。" + "description": "用户标识符，在应用内唯一。此标识符限定数据访问范围 - 对话、消息和文件仅在使用相同 `user` 值查询时可见。" }, "conversation_id": { "type": "string", - "description": "用于继续会话的会话 ID。传入上一条消息的 `conversation_id`。要开始新会话，请省略此字段或传入空字符串。响应会返回一个 `conversation_id`——在后续消息中传入该值即可继续该会话。" + "description": "用于继续对话的对话 ID。传递上一条消息的 `conversation_id`。要开始新对话，请省略此字段或传递空字符串。响应将返回 `conversation_id` - 在后续消息中传递它以继续该对话。" }, "files": { "type": "array", - "description": "用于多模态理解的文件列表，包括图片、文档、音频和视频。要附加本地文件，请先通过 [上传文件](/api-reference/文件操作/上传文件) 上传，然后将返回的 `id` 作为 `upload_file_id`，并设置 `transfer_method: local_file`。", + "description": "用于多模态理解的文件列表，包括图像、文档、音频和视频。要附加本地文件，首先通过[上传文件](/api-reference/files/upload-file)上传它，并使用返回的 `id` 作为 `upload_file_id`，`transfer_method` 设为 `local_file`。", "items": { "type": "object", "required": [ @@ -3306,28 +3306,28 @@ "remote_url", "local_file" ], - "description": "传输方式：文件 URL 使用 `remote_url`，上传文件使用 `local_file`。" + "description": "传输方式：`remote_url` 用于文件 URL，`local_file` 用于已上传的文件。" }, "url": { "type": "string", "format": "url", - "description": "文件 URL（当 `transfer_method` 为 `remote_url` 时必填）。" + "description": "文件 URL（当 `transfer_method` 为 `remote_url` 时必需）。" }, "upload_file_id": { "type": "string", - "description": "通过 [上传文件](/api-reference/文件操作/上传文件) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时必填）。" + "description": "从[上传文件](/api-reference/files/upload-file) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时必需）。" } } } }, "auto_generate_name": { "type": "boolean", - "description": "自动生成会话标题。如果为 `false`，请使用 [重命名会话](/api-reference/会话管理/重命名会话) API 并设置 `auto_generate: true` 来异步生成标题。", + "description": "自动生成对话标题。如果为 `false`，使用[重命名对话](/api-reference/conversations/rename-conversation) API 并设置 `auto_generate: true` 进行异步标题生成。", "default": true }, "workflow_id": { "type": "string", - "description": "指定要执行的已发布工作流版本 ID。如果未提供，将使用最新发布的版本。" + "description": "指定要执行的已发布工作流版本 ID。如果未提供，使用最新发布的版本。" } } }, @@ -3341,22 +3341,22 @@ "task_id": { "type": "string", "format": "uuid", - "description": "用于请求追踪和停止响应 API 的任务 ID。" + "description": "用于请求跟踪和停止响应 API 的任务 ID。" }, "id": { "type": "string", "format": "uuid", - "description": "该响应事件的唯一 ID。" + "description": "此响应事件的唯一 ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "唯一的消息 ID。调用反馈或推荐问题接口时，将此值作为 `message_id` 参数使用。" + "description": "唯一消息 ID。在调用反馈或建议问题端点时用作 `message_id` 参数。" }, "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "mode": { "type": "string", @@ -3364,11 +3364,11 @@ }, "answer": { "type": "string", - "description": "完整的响应内容。" + "description": "完整响应内容。" }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括用量和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -3391,7 +3391,7 @@ }, "ChunkChatEvent": { "type": "object", - "description": "流式模式下 Server-Sent Event 块的基础 schema。", + "description": "流式返回模式下服务器发送事件块的基础模式。", "properties": { "event": { "type": "string", @@ -3460,7 +3460,7 @@ }, "StreamEventBase": { "type": "object", - "description": "流式事件的基础属性。", + "description": "流事件的基础属性。", "properties": { "task_id": { "type": "string", @@ -3475,7 +3475,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "created_at": { "type": "integer", @@ -3513,12 +3513,12 @@ }, { "type": "object", - "description": "TTS 音频流事件（base64 编码的 Mp3）。自动播放启用时可用。", + "description": "TTS 音频流事件（base64 编码的 Mp3）。启用自动播放时可用。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 编码的 MP3 音频块。按顺序解码并拼接所有块即可生成完整的音频文件。" + "description": "Base64 编码的 MP3 音频块。按顺序解码并连接所有块以生成完整的音频文件。" } } } @@ -3538,7 +3538,7 @@ "properties": { "audio": { "type": "string", - "description": "空字符串。标识音频流结束。" + "description": "空字符串。表示音频流结束。" } } } @@ -3551,7 +3551,7 @@ }, { "type": "object", - "description": "消息文件事件，由工具创建的新文件。", + "description": "消息文件事件，工具创建的新文件。", "properties": { "id": { "type": "string", @@ -3567,7 +3567,7 @@ "enum": [ "assistant" ], - "description": "该文件的归属方，此处始终为 `assistant`。" + "description": "此文件属于谁，这里始终为 `assistant`。" }, "url": { "type": "string", @@ -3577,7 +3577,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" } } } @@ -3598,11 +3598,11 @@ "id": { "type": "string", "format": "uuid", - "description": "消息的唯一 ID。" + "description": "唯一消息 ID。" }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括用量和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -3654,7 +3654,7 @@ }, { "type": "object", - "description": "流式输出过程中的错误事件。", + "description": "流式传输期间的错误事件。", "properties": { "status": { "type": "integer", @@ -3662,11 +3662,11 @@ }, "code": { "type": "string", - "description": "错误码。" + "description": "错误代码。" }, "message": { "type": "string", - "description": "错误信息。" + "description": "错误消息。" } } } @@ -3679,7 +3679,7 @@ }, { "type": "object", - "description": "Ping 事件，用于保持连接活跃。" + "description": "保持连接活跃的 Ping 事件。" } ] }, @@ -3689,59 +3689,59 @@ "properties": { "prompt_tokens": { "type": "integer", - "description": "提示词中的令牌数。" + "description": "提示词中的 token 数量。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "每个提示词令牌的单价。" + "description": "每个提示词 token 的单价。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "提示词令牌的价格单位。" + "description": "提示词 token 的价格单位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "提示词令牌的总价。" + "description": "提示词 token 的总价格。" }, "completion_tokens": { "type": "integer", - "description": "补全内容中的令牌数。" + "description": "补全中的 token 数量。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "每个补全令牌的单价。" + "description": "每个补全 token 的单价。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "补全令牌的价格单位。" + "description": "补全 token 的价格单位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "补全令牌的总价。" + "description": "补全 token 的总价格。" }, "total_tokens": { "type": "integer", - "description": "使用的令牌总数。" + "description": "使用的 token 总数。" }, "total_price": { "type": "string", "format": "decimal", - "description": "所有令牌的总价。" + "description": "所有 token 的总价格。" }, "currency": { "type": "string", - "description": "计价货币。" + "description": "定价货币。" }, "latency": { "type": "number", "format": "double", - "description": "延迟时间（秒）。" + "description": "延迟（秒）。" } } }, @@ -3757,7 +3757,7 @@ "message_id": { "type": "string", "format": "uuid", - "description": "该资源所属消息的 ID。" + "description": "此资源所属消息的 ID。" }, "position": { "type": "integer", @@ -3766,46 +3766,46 @@ "dataset_id": { "type": "string", "format": "uuid", - "description": "知识库 ID。" + "description": "知识库的 ID。" }, "dataset_name": { "type": "string", - "description": "知识库名称。" + "description": "知识库的名称。" }, "document_id": { "type": "string", "format": "uuid", - "description": "文档 ID。" + "description": "文档的 ID。" }, "document_name": { "type": "string", - "description": "文档名称。" + "description": "文档的名称。" }, "data_source_type": { "type": "string", - "description": "数据源类型。" + "description": "数据来源的类型。" }, "segment_id": { "type": "string", "format": "uuid", - "description": "文档中特定块的 ID。" + "description": "文档内特定分段的 ID。" }, "score": { "type": "number", "format": "float", - "description": "资源的相关性评分。" + "description": "资源的相似度分数。" }, "hit_count": { "type": "integer", - "description": "该块被命中的次数。" + "description": "此分段被命中的次数。" }, "word_count": { "type": "integer", - "description": "块的字数。" + "description": "分段的字数。" }, "segment_position": { "type": "integer", - "description": "块在文档中的位置。" + "description": "分段在文档中的位置。" }, "index_node_hash": { "type": "string", @@ -3818,7 +3818,7 @@ "summary": { "type": "string", "nullable": true, - "description": "块内容的摘要。" + "description": "分段内容的摘要。" }, "created_at": { "type": "integer", @@ -3883,19 +3883,19 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "关联的用户 ID。" + "description": "关联用户的 ID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的租户 ID。" + "description": "关联租户的 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的会话 ID。" + "description": "关联对话的 ID。" }, "file_key": { "type": "string", @@ -3925,12 +3925,12 @@ }, "type": { "type": "string", - "description": "终端用户类型。Service API 用户固定为 `service_api`。" + "description": "终端用户类型。对于服务 API 用户始终为 `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API 请求中提供的 `user` 标识符（例如 [发送对话消息](/api-reference/对话流/发送对话消息) 中的 `user` 字段）。" + "description": "API 请求中提供的 `user` 标识符（例如[发送聊天消息](/api-reference/chatflows/send-chat-message)中的 `user` 字段）。" }, "name": { "type": "string", @@ -3939,11 +3939,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时，值为 `true`。" + "description": "用户是否匿名。当原始 API 请求中未提供 `user` 标识符时为 `true`。" }, "session_id": { "type": "string", - "description": "会话标识符。默认为 `external_user_id` 的值。" + "description": "会话标识符。默认为 `external_user_id` 值。" }, "created_at": { "type": "string", @@ -3972,7 +3972,7 @@ null ], "nullable": true, - "description": "反馈评分。设为 `null` 可撤销之前提交的反馈。" + "description": "反馈评分。设置为 `null` 可撤销之前提交的反馈。" }, "user": { "type": "string", @@ -3980,7 +3980,7 @@ }, "content": { "type": "string", - "description": "提供额外详情的可选文字反馈。" + "description": "可选的文本反馈，提供额外详情。" } } }, @@ -3989,7 +3989,7 @@ "properties": { "data": { "type": "array", - "description": "反馈项列表。", + "description": "反馈项目列表。", "items": { "$ref": "#/components/schemas/FeedbackItem" } @@ -3998,7 +3998,7 @@ }, "FeedbackItem": { "type": "object", - "description": "单条反馈项。", + "description": "单个反馈项目。", "properties": { "id": { "type": "string", @@ -4013,7 +4013,7 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "message_id": { "type": "string", @@ -4022,16 +4022,16 @@ }, "rating": { "type": "string", - "description": "反馈评分。`like` 为正面，`dislike` 为负面。" + "description": "反馈评分。`like` 表示正面，`dislike` 表示负面。" }, "content": { "type": "string", "nullable": true, - "description": "可选的文字反馈。" + "description": "可选的文本反馈。" }, "from_source": { "type": "string", - "description": "反馈来源。`user` 为终端用户通过 API 提交的反馈，`admin` 为从控制台提交的反馈。" + "description": "反馈来源。`user` 表示通过 API 提交的终端用户反馈，`admin` 表示从控制台提交的反馈。" }, "from_end_user_id": { "type": "string", @@ -4078,7 +4078,7 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", @@ -4095,7 +4095,7 @@ }, "ConversationMessageItem": { "type": "object", - "description": "会话中的单条消息。", + "description": "对话中的单条消息。", "properties": { "id": { "type": "string", @@ -4105,18 +4105,18 @@ "conversation_id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "parent_message_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "线程会话的父消息 ID。" + "description": "线程对话中的父消息 ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "该消息的输入变量。" + "description": "此消息的输入变量。" }, "query": { "type": "string", @@ -4128,16 +4128,16 @@ }, "status": { "type": "string", - "description": "消息状态。成功消息为 `normal`，生成失败时为 `error`。" + "description": "消息状态。`normal` 表示成功的消息，`error` 表示生成失败。" }, "error": { "type": "string", "nullable": true, - "description": "当 `status` 为 `error` 时的错误消息。" + "description": "如果 `status` 为 `error` 时的错误消息。" }, "message_files": { "type": "array", - "description": "附加到该消息的文件。", + "description": "附加到此消息的文件。", "items": { "$ref": "#/components/schemas/MessageFileItem" } @@ -4145,24 +4145,24 @@ "feedback": { "type": "object", "nullable": true, - "description": "该消息的用户反馈。", + "description": "此消息的用户反馈。", "properties": { "rating": { "type": "string", - "description": "反馈评分。`like` 为正面，`dislike` 为负面。" + "description": "反馈评分。`like` 表示正面，`dislike` 表示负面。" } } }, "retriever_resources": { "type": "array", - "description": "该消息使用的检索资源。", + "description": "此消息使用的检索资源。", "items": { "$ref": "#/components/schemas/RetrieverResource" } }, "agent_thoughts": { "type": "array", - "description": "该消息的 Agent 思考。", + "description": "此消息的 Agent 思考过程。", "items": { "$ref": "#/components/schemas/AgentThoughtItem" } @@ -4174,7 +4174,7 @@ }, "extra_contents": { "type": "array", - "description": "与此消息关联的附加执行内容，例如对话流工作流中人工介入节点的表单数据。", + "description": "与此消息关联的额外执行内容，例如 chatflow 工作流中人工介入节点的人工介入表单数据。", "items": { "$ref": "#/components/schemas/HumanInputContent" } @@ -4188,7 +4188,7 @@ "id": { "type": "string", "format": "uuid", - "description": "File ID." + "description": "文件 ID。" }, "filename": { "type": "string", @@ -4216,12 +4216,12 @@ }, "transfer_method": { "type": "string", - "description": "使用的传输方式。`remote_url` 表示基于 URL 的文件，`local_file` 表示已上传的文件，`tool_file` 表示工具生成的文件。" + "description": "使用的传输方式。`remote_url` 用于基于 URL 的文件，`local_file` 用于已上传的文件，`tool_file` 用于工具生成的文件。" }, "belongs_to": { "type": "string", "nullable": true, - "description": "该文件的所属者。用户上传的文件为 `user`，助手生成的文件为 `assistant`。" + "description": "此文件属于谁。`user` 表示用户上传的文件，`assistant` 表示助手生成的文件。" }, "upload_file_id": { "type": "string", @@ -4243,16 +4243,16 @@ "chain_id": { "type": "string", "nullable": true, - "description": "该思考的链 ID。" + "description": "此思考的链 ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "该思考所属的唯一消息 ID。" + "description": "此思考所属的唯一消息 ID。" }, "position": { "type": "integer", - "description": "该思考的位置。" + "description": "此思考的位置。" }, "thought": { "type": "string", @@ -4266,11 +4266,11 @@ "type": "object", "nullable": true, "additionalProperties": true, - "description": "已使用工具的标签。" + "description": "使用的工具标签。" }, "tool_input": { "type": "string", - "description": "工具输入（JSON 格式）。" + "description": "JSON 格式的工具输入。" }, "observation": { "type": "string", @@ -4281,7 +4281,7 @@ "items": { "type": "string" }, - "description": "与该思考相关的文件 ID。" + "description": "与此思考相关的文件 ID。" }, "created_at": { "type": "integer", @@ -4295,15 +4295,15 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", - "description": "是否有更多会话。" + "description": "是否有更多对话。" }, "data": { "type": "array", - "description": "会话列表。", + "description": "对话列表。", "items": { "$ref": "#/components/schemas/ConversationListItem" } @@ -4316,24 +4316,24 @@ "id": { "type": "string", "format": "uuid", - "description": "会话 ID。" + "description": "对话 ID。" }, "name": { "type": "string", - "description": "会话名称。" + "description": "对话名称。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "会话的输入变量。" + "description": "对话的输入变量。" }, "status": { "type": "string", - "description": "会话状态。活跃会话为 `normal`。" + "description": "对话状态。`normal` 表示活跃的对话。" }, "introduction": { "type": "string", - "description": "会话介绍。" + "description": "对话介绍。" }, "created_at": { "type": "integer", @@ -4349,19 +4349,19 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "重命名会话的请求体。", + "description": "重命名对话的请求体。", "required": [ "user" ], "properties": { "name": { "type": "string", - "description": "会话名称。当 `auto_generate` 为 `false` 时必填。" + "description": "对话的名称。当 `auto_generate` 为 `false` 时必需。" }, "auto_generate": { "type": "boolean", "default": false, - "description": "自动生成会话名称。当为 `true` 时，`name` 字段将被忽略。" + "description": "自动生成对话名称。当为 `true` 时，`name` 字段被忽略。" }, "user": { "type": "string", @@ -4374,7 +4374,7 @@ "properties": { "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "has_more": { "type": "boolean", @@ -4395,7 +4395,7 @@ "id": { "type": "string", "format": "uuid", - "description": "Variable ID." + "description": "变量 ID。" }, "name": { "type": "string", @@ -4403,11 +4403,11 @@ }, "value_type": { "type": "string", - "description": "变量值类型。可选值：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" + "description": "变量值类型。可能的值：`string`、`number`、`object`、`secret`、`file`、`boolean`、`array[any]`、`array[string]`、`array[number]`、`array[object]`、`array[file]`、`array[boolean]`。" }, "value": { "type": "string", - "description": "变量值（复杂类型可以是 JSON 字符串）。" + "description": "变量值（对于复杂类型可以是 JSON 字符串）。" }, "description": { "type": "string", @@ -4443,7 +4443,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "语音转文字的请求体。", + "description": "音频转文字转换的请求体。", "required": [ "file" ], @@ -4451,7 +4451,7 @@ "file": { "type": "string", "format": "binary", - "description": "音频文件。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。大小限制：`30 MB`。" + "description": "音频文件。支持：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。限制：`30 MB`。" }, "user": { "type": "string", @@ -4464,18 +4464,18 @@ "properties": { "text": { "type": "string", - "description": "语音识别输出的文字。" + "description": "语音识别的输出文本。" } } }, "TextToAudioRequest": { "type": "object", - "description": "文字转语音的请求体。提供 `message_id` 或 `text` 其中之一。", + "description": "文字转音频转换的请求体。提供 `message_id` 或 `text` 之一。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "消息 ID。当同时提供 `text` 时，优先使用消息 ID。" + "description": "消息 ID。当同时提供两者时优先于 `text`。" }, "text": { "type": "string", @@ -4487,7 +4487,7 @@ }, "voice": { "type": "string", - "description": "文字转语音使用的声音。可用声音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/应用配置/获取应用参数) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" + "description": "用于文字转语音的语音。可用的语音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" }, "streaming": { "type": "boolean", @@ -4515,11 +4515,11 @@ }, "mode": { "type": "string", - "description": "应用模式。`completion` 为文本生成应用，`chat` 为基础对话应用，`agent-chat` 为 Agent 应用，`advanced-chat` 为对话流应用，`workflow` 为工作流应用。" + "description": "应用模式。`completion` 用于文本生成应用，`chat` 用于基础聊天应用，`agent-chat` 用于基于 Agent 的应用，`advanced-chat` 用于 Chatflow 应用，`workflow` 用于工作流应用。" }, "author_name": { "type": "string", - "description": "应用作者名称。" + "description": "应用作者的名称。" } } }, @@ -4528,14 +4528,14 @@ "properties": { "opening_statement": { "type": "string", - "description": "会话开始时显示的开场白。" + "description": "对话开始时显示的开场白。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, - "description": "建议的初始问题列表。" + "description": "建议的开场问题列表。" }, "suggested_questions_after_answer": { "type": "object", @@ -4543,7 +4543,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, @@ -4553,7 +4553,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, @@ -4563,11 +4563,11 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" }, "voice": { "type": "string", - "description": "TTS 的声音标识符。" + "description": "TTS 的语音标识符。" }, "language": { "type": "string", @@ -4575,7 +4575,7 @@ }, "autoPlay": { "type": "string", - "description": "自动播放设置。`enabled` 为自动播放音频，`disabled` 为需要手动播放。" + "description": "自动播放设置。`enabled` 自动播放音频，`disabled` 需要手动播放。" } } }, @@ -4585,7 +4585,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, @@ -4595,7 +4595,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, @@ -4605,17 +4605,17 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, "sensitive_word_avoidance": { "type": "object", - "description": "敏感词过滤配置。", + "description": "敏感词规避配置。", "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否已启用。" } } }, @@ -4632,19 +4632,19 @@ "properties": { "image": { "type": "object", - "description": "图片上传设置。", + "description": "图像上传设置。", "properties": { "enabled": { "type": "boolean", - "description": "是否启用图片上传。" + "description": "是否启用图像上传。" }, "number_limits": { "type": "integer", - "description": "最大图片数量。" + "description": "最大图像数量。" }, "detail": { "type": "string", - "description": "图片精细程度。" + "description": "图像详细程度。" }, "transfer_methods": { "type": "array", @@ -4667,7 +4667,7 @@ }, "image_file_size_limit": { "type": "integer", - "description": "最大图片文件大小（MB）。" + "description": "最大图像文件大小（MB）。" }, "audio_file_size_limit": { "type": "integer", @@ -4679,7 +4679,7 @@ }, "workflow_file_upload_limit": { "type": "integer", - "description": "工作流文件上传的最大文件数。" + "description": "工作流文件上传的最大文件数量。" } } } @@ -4700,7 +4700,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "文本输入", "type": "object", "properties": { "text-input": { @@ -4709,7 +4709,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -4718,7 +4718,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "下拉选项", "type": "object", "properties": { "select": { @@ -4740,7 +4740,7 @@ }, "required": { "type": "boolean", - "description": "输入是否必填。" + "description": "输入是否必需。" }, "default": { "type": "string", @@ -4762,7 +4762,7 @@ }, "required": { "type": "boolean", - "description": "输入是否必填。" + "description": "输入是否必需。" }, "default": { "type": "string", @@ -4772,7 +4772,7 @@ }, "SelectControl": { "type": "object", - "description": "下拉选择表单控件。", + "description": "下拉选项（下拉框）表单控件。", "properties": { "label": { "type": "string", @@ -4784,11 +4784,11 @@ }, "required": { "type": "boolean", - "description": "是否必须选择。" + "description": "选择是否必需。" }, "default": { "type": "string", - "description": "默认选中的值。" + "description": "默认选中值。" }, "options": { "type": "array", @@ -4807,7 +4807,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "图标 URL", "type": "string", "format": "url", "description": "图标的 URL。" @@ -4822,7 +4822,7 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "Emoji 图标", "type": "object", "description": "使用 emoji 的工具图标详情。", "properties": { @@ -4845,19 +4845,19 @@ }, "chat_color_theme": { "type": "string", - "description": "聊天主题颜色。" + "description": "聊天颜色主题。" }, "chat_color_theme_inverted": { "type": "boolean", - "description": "聊天主题颜色是否反转。" + "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", - "description": "使用的图标类型。`emoji` 为表情图标，`image` 为上传的图片图标。" + "description": "使用的图标类型。`emoji` 用于 emoji 图标，`image` 用于上传的图像图标。" }, "icon": { "type": "string", - "description": "图标内容（表情或图片 ID）。" + "description": "图标内容（emoji 或图像 ID）。" }, "icon_background": { "type": "string", @@ -4867,7 +4867,7 @@ "type": "string", "format": "url", "nullable": true, - "description": "图标图片的 URL。" + "description": "图标图像的 URL。" }, "description": { "type": "string", @@ -4907,19 +4907,19 @@ "items": { "$ref": "#/components/schemas/AnnotationItem" }, - "description": "当前页面的标注项列表。" + "description": "当前页的标注项目列表。" }, "has_more": { "type": "boolean", - "description": "如果当前结果集之后还有更多页面，则为 `true`。" + "description": "如果当前结果集之外还有更多页，则为 `true`。" }, "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "total": { "type": "integer", - "description": "匹配查询条件的标注总数。" + "description": "匹配查询的标注总数。" }, "page": { "type": "integer", @@ -4933,22 +4933,22 @@ "id": { "type": "string", "format": "uuid", - "description": "标注唯一标识符。" + "description": "唯一标注标识符。" }, "question": { "type": "string", "nullable": true, - "description": "触发该标注的问题文本。" + "description": "触发此标注的问题文本。" }, "answer": { "type": "string", "nullable": true, - "description": "标注被匹配时返回的预定义回答。" + "description": "匹配标注时返回的预定义答案。" }, "hit_count": { "type": "integer", "nullable": true, - "description": "该标注被匹配并作为回复返回的次数。" + "description": "此标注被匹配并作为回复返回的次数。" }, "created_at": { "type": "integer", @@ -4986,11 +4986,11 @@ "properties": { "question": { "type": "string", - "description": "更新后的标注问题。" + "description": "更新的标注问题。" }, "answer": { "type": "string", - "description": "更新后的标注答案。" + "description": "更新的标注答案。" } } }, @@ -5005,7 +5005,7 @@ "properties": { "embedding_provider_name": { "type": "string", - "description": "嵌入模型提供商名称（例如 `openai`、`cohere`）。" + "description": "嵌入模型提供商的名称（例如 `openai`、`cohere`）。" }, "embedding_model_name": { "type": "string", @@ -5014,7 +5014,7 @@ "score_threshold": { "type": "number", "format": "float", - "description": "标注被视为匹配的最低相似度分数。值越高，要求匹配越精确。", + "description": "标注被视为匹配的最小相似度分数。较高的值需要更接近的匹配。", "minimum": 0, "maximum": 1 } @@ -5026,11 +5026,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "异步任务 ID。配合 [查询标注回复配置任务状态](/api-reference/标注管理/查询标注回复配置任务状态) 使用以跟踪进度。" + "description": "异步任务 ID。与[获取标注回复任务状态](/api-reference/annotations/get-annotation-reply-job-status)一起使用以跟踪进度。" }, "job_status": { "type": "string", - "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示已完成，`error` 表示失败。" + "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示进行中，`completed` 表示已完成，`error` 表示失败。" } } }, @@ -5040,15 +5040,15 @@ "job_id": { "type": "string", "format": "uuid", - "description": "来自 [配置标注回复](/api-reference/标注管理/配置标注回复) 调用的任务 ID。" + "description": "来自[配置标注回复](/api-reference/annotations/configure-annotation-reply)调用的任务 ID。" }, "job_status": { "type": "string", - "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示处理中，`completed` 表示已完成，`error` 表示失败。" + "description": "当前任务状态。`waiting` 表示排队中，`processing` 表示进行中，`completed` 表示已完成，`error` 表示失败。" }, "error_msg": { "type": "string", - "description": "描述任务失败原因的错误消息。当 `job_status` 不是 `error` 时为空字符串。" + "description": "描述任务失败原因的错误消息。当 `job_status` 不为 `error` 时为空字符串。" } } }, @@ -5082,7 +5082,7 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "本次工作流执行的输入变量。" + "description": "此工作流执行的输入变量。" }, "created_at": { "type": "integer", @@ -5091,7 +5091,7 @@ }, "reason": { "type": "string", - "description": "工作流启动原因。`initial` 表示首次启动，`resumption` 表示暂停后恢复（例如人工介入后）。" + "description": "工作流开始的原因。`initial` 表示首次开始，`resumption` 表示暂停后恢复（例如人工介入后）。" } } } @@ -5143,15 +5143,15 @@ }, "elapsed_time": { "type": "number", - "description": "总执行耗时（秒）。" + "description": "总执行时间（秒）。" }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的 token 总数。" }, "total_steps": { "type": "integer", - "description": "已执行的总步数。" + "description": "执行的总步骤数。" }, "created_at": { "type": "integer", @@ -5162,7 +5162,7 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "结束时间戳（Unix 纪元秒）。" + "description": "完成时间戳（Unix 纪元秒）。" }, "exceptions_count": { "type": "integer", @@ -5217,7 +5217,7 @@ }, "title": { "type": "string", - "description": "Node title." + "description": "节点标题。" }, "index": { "type": "integer", @@ -5226,13 +5226,13 @@ "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID。" + "description": "前置节点的 ID。" }, "inputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "节点输入数据。在简化 API 响应中可能为 `null`。" + "description": "节点输入数据。在简化的 API 响应中可能为 `null`。" }, "created_at": { "type": "integer", @@ -5242,17 +5242,17 @@ "extras": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "如果该节点在迭代内运行，则为迭代 ID。" + "description": "如果此节点在迭代内运行时的迭代 ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "当该节点在循环内运行时的循环 ID。" + "description": "如果此节点在循环内运行时的循环 ID。" } } } @@ -5289,11 +5289,11 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", - "description": "Node title." + "description": "节点标题。" }, "index": { "type": "integer", @@ -5302,25 +5302,25 @@ "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID。" + "description": "前置节点的 ID。" }, "inputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "节点输入数据。在简化 API 响应中可能为 `null`。" + "description": "节点输入数据。在简化的 API 响应中可能为 `null`。" }, "process_data": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "节点处理数据。在简化 API 响应中可能为 `null`。" + "description": "节点处理数据。在简化的 API 响应中可能为 `null`。" }, "outputs": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "节点输出数据。在简化 API 响应中可能为 `null`。" + "description": "节点输出数据。在简化的 API 响应中可能为 `null`。" }, "status": { "type": "string", @@ -5333,13 +5333,13 @@ }, "elapsed_time": { "type": "number", - "description": "节点执行耗时（秒）。" + "description": "节点执行时间（秒）。" }, "execution_metadata": { "type": "object", "nullable": true, "additionalProperties": true, - "description": "执行元数据（例如令牌用量、模型信息）。在简化 API 响应中可能为 `null`。" + "description": "执行元数据（例如 token 使用量、模型信息）。在简化的 API 响应中可能为 `null`。" }, "created_at": { "type": "integer", @@ -5349,7 +5349,7 @@ "finished_at": { "type": "integer", "format": "int64", - "description": "结束时间戳（Unix 纪元秒）。" + "description": "完成时间戳（Unix 纪元秒）。" }, "files": { "type": "array", @@ -5358,17 +5358,17 @@ "type": "object", "additionalProperties": true }, - "description": "该节点生成的文件。" + "description": "此节点生成的文件。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "如果该节点在迭代内运行，则为迭代 ID。" + "description": "如果此节点在迭代内运行时的迭代 ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "当该节点在循环内运行时的循环 ID。" + "description": "如果此节点在循环内运行时的循环 ID。" } } } @@ -5386,7 +5386,7 @@ }, { "type": "object", - "description": "节点重试次数。", + "description": "节点重试尝试。", "properties": { "workflow_run_id": { "type": "string", @@ -5405,11 +5405,11 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", - "description": "Node title." + "description": "节点标题。" }, "index": { "type": "integer", @@ -5418,7 +5418,7 @@ "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID。" + "description": "前置节点的 ID。" }, "inputs": { "type": "object", @@ -5445,11 +5445,11 @@ "error": { "type": "string", "nullable": true, - "description": "本次重试的错误消息。" + "description": "此次重试尝试的错误消息。" }, "elapsed_time": { "type": "number", - "description": "本次尝试的执行时间（秒）。" + "description": "此次尝试的执行时间（秒）。" }, "execution_metadata": { "type": "object", @@ -5465,7 +5465,7 @@ "finished_at": { "type": "integer", "format": "int64", - "description": "结束时间戳（Unix 纪元秒）。" + "description": "完成时间戳（Unix 纪元秒）。" }, "files": { "type": "array", @@ -5474,21 +5474,21 @@ "type": "object", "additionalProperties": true }, - "description": "本次重试期间生成的文件。" + "description": "此次重试期间生成的文件。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "迭代 ID（如适用）。" + "description": "如果适用的迭代 ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "循环 ID（如适用）。" + "description": "如果适用的循环 ID。" }, "retry_index": { "type": "integer", - "description": "重试次数索引，从 `0` 开始。" + "description": "重试尝试索引，从 `0` 开始。" } } } @@ -5525,7 +5525,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5539,7 +5539,7 @@ "extras": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" }, "metadata": { "type": "object", @@ -5567,7 +5567,7 @@ }, { "type": "object", - "description": "迭代已进入下一项。", + "description": "迭代进入下一项。", "properties": { "workflow_run_id": { "type": "string", @@ -5586,7 +5586,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5604,7 +5604,7 @@ "extras": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" } } } @@ -5641,7 +5641,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5664,11 +5664,11 @@ }, "elapsed_time": { "type": "number", - "description": "迭代总耗时（秒）。" + "description": "总迭代时间（秒）。" }, "total_tokens": { "type": "integer", - "description": "所有迭代中消耗的令牌总数。" + "description": "所有迭代消耗的 token 总数。" }, "created_at": { "type": "integer", @@ -5678,11 +5678,11 @@ "finished_at": { "type": "integer", "format": "int64", - "description": "结束时间戳（Unix 纪元秒）。" + "description": "完成时间戳（Unix 纪元秒）。" }, "steps": { "type": "integer", - "description": "已执行的迭代步骤总数。" + "description": "执行的迭代步骤总数。" } } } @@ -5719,7 +5719,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5733,7 +5733,7 @@ "extras": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" }, "metadata": { "type": "object", @@ -5761,7 +5761,7 @@ }, { "type": "object", - "description": "循环已进入下一次迭代。", + "description": "循环进入下一次迭代。", "properties": { "workflow_run_id": { "type": "string", @@ -5780,7 +5780,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5801,7 +5801,7 @@ "extras": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" } } } @@ -5838,7 +5838,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -5861,11 +5861,11 @@ }, "elapsed_time": { "type": "number", - "description": "循环总执行耗时（秒）。" + "description": "总循环执行时间（秒）。" }, "total_tokens": { "type": "integer", - "description": "所有循环迭代中消耗的令牌总数。" + "description": "所有循环迭代消耗的 token 总数。" }, "created_at": { "type": "integer", @@ -5875,11 +5875,11 @@ "finished_at": { "type": "integer", "format": "int64", - "description": "结束时间戳（Unix 纪元秒）。" + "description": "完成时间戳（Unix 纪元秒）。" }, "steps": { "type": "integer", - "description": "已执行的循环总步数。" + "description": "执行的循环步骤总数。" } } } @@ -5907,19 +5907,19 @@ "properties": { "form_id": { "type": "string", - "description": "表单实例的标识符，会在错误消息和日志中出现。Service API 调用请使用 `form_token`。" + "description": "表单实例的标识符，在错误消息和日志中显示。服务 API 调用使用 `form_token`。" }, "node_id": { "type": "string", - "description": "产生该表单的 Human Input 节点 ID。" + "description": "生成此表单的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "form_content": { "type": "string", - "description": "已替换工作流变量的预渲染表单正文。" + "description": "预渲染的表单正文，已替换工作流变量。" }, "inputs": { "type": "array", @@ -5928,27 +5928,27 @@ "properties": { "type": { "type": "string", - "description": "表单输入控件类型。可用值：`text_input`（单行文本输入框）和 `paragraph`（多行文本区域）。" + "description": "表单输入控件类型。可用值：`text_input`（单行文本字段）和 `paragraph`（多行文本区域）。" }, "output_variable_name": { "type": "string", - "description": "引用该输入提交值在工作流中使用的变量名。对应提交 `inputs` 对象中的键。" + "description": "用于在工作流中引用此输入提交值的变量名称。对应提交 `inputs` 对象中的键。" }, "default": { "type": "object", "nullable": true, - "description": "从工作流上下文解析得到的默认值。未配置默认值时为 `null`。", + "description": "从工作流上下文解析的默认值。未配置默认值时为 `null`。", "properties": { "type": { "type": "string", - "description": "默认值来源。`constant` 表示将 `value` 作为字面字符串；`variable` 表示 `selector` 指向工作流变量。" + "description": "默认值的来源。`constant` 表示 `value` 用作字面字符串；`variable` 表示 `selector` 指向工作流变量。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "当 `type` 为 `variable` 时，变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。至少包含两个元素。" + "description": "当 `type` 为 `variable` 时的变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。必须包含至少两个元素。" }, "value": { "type": "string", @@ -5958,7 +5958,7 @@ } } }, - "description": "接收者需要填写的表单输入字段。" + "description": "接收者填写的表单输入字段。" }, "actions": { "type": "array", @@ -5969,41 +5969,41 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "操作按钮的标识。当接收者选择该按钮时，作为 `action` 传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单)。" + "description": "操作按钮的标识符。当接收者选择此按钮时，在[提交人工介入表单](/api-reference/human-input/submit-human-input-form)中作为 `action` 传递。" }, "title": { "type": "string", "maxLength": 100, - "description": "显示给接收者的按钮文本。" + "description": "显示给接收者的按钮标签。" }, "button_style": { "type": "string", - "description": "按钮视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" + "description": "按钮的视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" } } }, - "description": "接收者提交时可选择的用户操作（按钮）。" + "description": "接收者提交时可选择的可用用户操作（按钮）。" }, "display_in_ui": { "type": "boolean", - "description": "表单是否也在 Dify 控制台中显示。" + "description": "表单是否也在 Dify 控制台 UI 中显示。" }, "form_token": { "type": "string", "nullable": true, - "description": "[获取人工介入表单](/api-reference/人工介入/获取人工介入表单) 和 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单) 的访问令牌。当人工介入节点使用邮件或控制台送达时为 `null`（Service API 仅能处理 WebApp 送达的表单）。" + "description": "用于[获取人工介入表单](/api-reference/human-input/get-human-input-form)和[提交人工介入表单](/api-reference/human-input/submit-human-input-form)的访问令牌。当人工介入节点使用邮件或控制台交付时为 `null`（服务 API 只能操作 WebApp 交付的表单）。" }, "resolved_default_values": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "按输入的 `output_variable_name` 分组的预填充默认值。所有值均为字符串。" + "description": "表单输入的预填充默认值，以输入的 `output_variable_name` 为键。所有值都已字符串化。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），超过后表单无法再被提交。" + "description": "表单无法再提交的 Unix 时间戳（秒）。" } } } @@ -6027,14 +6027,14 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "此工作流运行记录的持久化标识符。配合 [获取工作流运行详情](/api-reference/对话流/获取工作流执行情况) 使用以在执行后获取结果。" + "description": "此工作流运行记录的持久标识符。在执行后与[获取工作流运行详情](/api-reference/chatflows/get-workflow-run-detail)一起使用以获取结果。" }, "paused_nodes": { "type": "array", "items": { "type": "string" }, - "description": "已暂停的节点 ID 列表。" + "description": "暂停的节点 ID 列表。" }, "outputs": { "type": "object", @@ -6061,15 +6061,15 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "总耗时（秒）。" + "description": "总经过时间（秒）。" }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的 token 总数。" }, "total_steps": { "type": "integer", - "description": "已执行的总步数。" + "description": "执行的总步骤数。" } } } @@ -6097,19 +6097,19 @@ "properties": { "node_id": { "type": "string", - "description": "表单被填写的 Human Input 节点 ID。" + "description": "填写表单的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "rendered_content": { "type": "string", - "description": "包含接收者提交值的渲染后表单内容（`human_input_required` 上的 `form_content` 是未填写的模板）。" + "description": "使用接收者提交值渲染的表单正文（`human_input_required` 上的 `form_content` 是未填充的模板）。" }, "action_id": { "type": "string", - "description": "接收者所选操作的标识（与传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单) 的 `action` 一致）。" + "description": "接收者选择的操作标识符（与传递给[提交人工介入表单](/api-reference/human-input/submit-human-input-form)的 `action` 值匹配）。" }, "action_text": { "type": "string", @@ -6141,16 +6141,16 @@ "properties": { "node_id": { "type": "string", - "description": "表单过期的 Human Input 节点 ID。" + "description": "表单过期的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），表示表单过期时刻。" + "description": "表单过期的 Unix 时间戳（秒）。" } } } @@ -6168,7 +6168,7 @@ }, { "type": "object", - "description": "工作流中 Agent 节点的 Agent 日志。", + "description": "来自工作流内 Agent 节点的 Agent 日志。", "properties": { "data": { "type": "object", @@ -6193,7 +6193,7 @@ "error": { "type": "string", "nullable": true, - "description": "错误消息（如适用）。" + "description": "如果适用的错误消息。" }, "status": { "type": "string", @@ -6207,7 +6207,7 @@ "metadata": { "type": "object", "additionalProperties": true, - "description": "附加元数据。" + "description": "额外元数据。" }, "node_id": { "type": "string", @@ -6267,7 +6267,7 @@ "properties": { "text": { "type": "string", - "description": "替换的文本内容。" + "description": "替换文本内容。" } } } @@ -6286,11 +6286,11 @@ "workflow_id": { "type": "string", "format": "uuid", - "description": "工作流 ID." + "description": "工作流 ID。" }, "status": { "type": "string", - "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" + "description": "工作流执行状态。`running` 表示正在进行的执行，`succeeded` 表示成功完成，`failed` 表示执行遇到错误，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" }, "inputs": { "type": "object", @@ -6310,11 +6310,11 @@ }, "total_steps": { "type": "integer", - "description": "已执行的工作流总步数。" + "description": "执行的工作流步骤总数。" }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的 token 总数。" }, "created_at": { "type": "integer", @@ -6325,13 +6325,13 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "工作流运行结束时的 Unix 时间戳。" + "description": "工作流运行完成时的 Unix 时间戳。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, - "description": "总耗时（秒）。" + "description": "总经过时间（秒）。" } } }, @@ -6344,7 +6344,7 @@ }, "limit": { "type": "integer", - "description": "每页条目数。" + "description": "每页项目数。" }, "total": { "type": "integer", @@ -6352,7 +6352,7 @@ }, "has_more": { "type": "boolean", - "description": "是否有更多可用页面。" + "description": "是否有更多页可用。" }, "data": { "type": "array", @@ -6385,7 +6385,7 @@ "created_by_account": { "type": "object", "nullable": true, - "description": "由管理员用户创建时的账户详情。", + "description": "如果由管理员用户创建的账户详情。", "properties": { "id": { "type": "string", @@ -6414,7 +6414,7 @@ "type": "object", "additionalProperties": true, "nullable": true, - "description": "日志条目的附加详情。" + "description": "日志条目的额外详情。" } } }, @@ -6432,7 +6432,7 @@ }, "status": { "type": "string", - "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" + "description": "工作流执行状态。`running` 表示正在进行的执行，`succeeded` 表示成功完成，`failed` 表示执行遇到错误，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" }, "error": { "type": "string", @@ -6442,15 +6442,15 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "总耗时（秒）。" + "description": "总经过时间（秒）。" }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的 token 总数。" }, "total_steps": { "type": "integer", - "description": "已执行的工作流总步数。" + "description": "执行的工作流步骤总数。" }, "created_at": { "type": "integer", @@ -6461,7 +6461,7 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "工作流运行结束时的 Unix 时间戳。" + "description": "工作流运行完成时的 Unix 时间戳。" }, "exceptions_count": { "type": "integer", @@ -6469,7 +6469,7 @@ }, "triggered_from": { "type": "string", - "description": "触发工作流运行的来源。`debugging` 表示从编辑器发起的测试运行，`app` 表示 API 或应用发起的运行。" + "description": "触发工作流运行的来源。`debugging` 用于从编辑器的测试运行，`app` 用于 API 或应用启动的运行。" } } }, @@ -6487,7 +6487,7 @@ }, "is_anonymous": { "type": "boolean", - "description": "终端用户是否为匿名。" + "description": "终端用户是否匿名。" }, "session_id": { "type": "string", @@ -6497,11 +6497,11 @@ }, "HumanInputContent": { "type": "object", - "description": "人工介入节点的执行内容，包括表单定义和提交数据。", + "description": "来自人工介入节点的执行内容，包括表单定义和提交数据。", "properties": { "workflow_run_id": { "type": "string", - "description": "该内容所属的工作流运行 ID。" + "description": "此内容所属的工作流运行 ID。" }, "submitted": { "type": "boolean", @@ -6509,31 +6509,31 @@ }, "type": { "type": "string", - "description": "`human_input` 表示人工介入内容。" + "description": "人工介入内容为 `human_input`。" }, "form_definition": { "nullable": true, - "description": "人工介入节点的表单定义。当内容表示提交响应时为 `null`。", + "description": "来自人工介入节点的表单定义。当内容表示提交响应时为 `null`。", "$ref": "#/components/schemas/HumanInputFormDefinition" }, "form_submission_data": { "nullable": true, - "description": "已提交的表单数据。表单尚未提交时为 `null`。", + "description": "提交的表单数据。当表单尚未提交时为 `null`。", "$ref": "#/components/schemas/HumanInputFormSubmissionData" } } }, "HumanInputFormDefinition": { "type": "object", - "description": "由人工介入节点渲染的人工介入表单定义。", + "description": "由人工介入节点渲染的人工介入表单的定义。", "properties": { "form_id": { "type": "string", - "description": "表单唯一标识符。" + "description": "唯一表单标识符。" }, "node_id": { "type": "string", - "description": "生成该表单的人工介入节点 ID。" + "description": "生成此表单的人工介入节点的 ID。" }, "node_title": { "type": "string", @@ -6564,12 +6564,12 @@ "form_token": { "type": "string", "nullable": true, - "description": "表单提交认证的令牌。" + "description": "用于表单提交认证的令牌。" }, "resolved_default_values": { "type": "object", "additionalProperties": true, - "description": "表单输入的已解析默认值，按输出变量名称索引。" + "description": "表单输入的已解析默认值，以输出变量名为键。" }, "expiration_time": { "type": "integer", @@ -6579,7 +6579,7 @@ }, "HumanInputFormSubmissionData": { "type": "object", - "description": "来自已提交的人工介入表单的数据。", + "description": "已提交人工介入表单的数据。", "properties": { "node_id": { "type": "string", @@ -6595,11 +6595,11 @@ }, "action_id": { "type": "string", - "description": "被点击的操作按钮的 ID。" + "description": "点击的操作按钮的 ID。" }, "action_text": { "type": "string", - "description": "被点击的操作按钮的显示文本。" + "description": "点击的操作按钮的显示文本。" } } }, @@ -6609,7 +6609,7 @@ "properties": { "type": { "type": "string", - "description": "`text_input` 为单行文本，`paragraph` 为多行文本。" + "description": "`text_input` 用于单行文本，`paragraph` 用于多行文本。" }, "output_variable_name": { "type": "string", @@ -6617,7 +6617,7 @@ }, "default": { "nullable": true, - "description": "该输入的默认值配置。", + "description": "此输入的默认值配置。", "$ref": "#/components/schemas/FormInputDefault" } } @@ -6628,7 +6628,7 @@ "properties": { "type": { "type": "string", - "description": "`variable` for dynamic values from 工作流 variables, `constant` for static values." + "description": "`variable` 用于来自工作流变量的动态值，`constant` 用于静态值。" }, "selector": { "type": "array", @@ -6649,7 +6649,7 @@ "properties": { "id": { "type": "string", - "description": "操作唯一标识符。" + "description": "唯一操作标识符。" }, "title": { "type": "string", @@ -6657,7 +6657,7 @@ }, "button_style": { "type": "string", - "description": "`primary`, `default`, `accent`, or `ghost`." + "description": "`primary`、`default`、`accent` 或 `ghost`。" } } } @@ -6665,40 +6665,40 @@ }, "tags": [ { - "name": "对话流", - "description": "对话流应用的操作，包括对话消息、工作流执行详情和事件流。" + "name": "Chatflows", + "description": "Chatflow 应用的操作，包括聊天消息、工作流运行详情和事件流。" }, { - "name": "文件操作", + "name": "Files", "description": "文件上传和预览操作。" }, { - "name": "终端用户", - "description": "终端用户信息相关操作。" + "name": "End Users", + "description": "与终端用户信息相关的操作。" }, { - "name": "消息反馈", + "name": "Feedback", "description": "用户反馈操作。" }, { - "name": "会话管理", - "description": "与管理会话相关的操作。" + "name": "Conversations", + "description": "与管理对话相关的操作。" }, { - "name": "语音与文字转换", + "name": "TTS", "description": "文字转语音和语音转文字操作。" }, { - "name": "应用配置", + "name": "Applications", "description": "获取应用设置和信息的操作。" }, { - "name": "标注管理", - "description": "与管理标注直接回复相关的操作。" + "name": "Annotations", + "description": "与管理直接回复标注相关的操作。" }, { - "name": "人工介入", - "description": "暂停等待人工输入的工作流恢复操作。" + "name": "Human Input", + "description": "用于恢复需要人工介入的暂停工作流的端点。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 43bff9e05..b2f325ce4 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "文本生成型应用 API", - "description": "文本生成型应用提供无会话支持，适用于翻译、文章撰写、摘要总结 AI 等场景。", + "title": "文本生成应用 API", + "description": "文本生成应用提供非会话支持，适用于翻译、文章写作、摘要生成 AI 等场景。", "version": "1.0.0" }, "servers": [ { "url": "{api_base_url}", - "description": "文本生成型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。", + "description": "文本生成应用 API 的基础 URL。请将 {api_base_url} 替换为您应用程序提供的实际 API 基础 URL。", "variables": { "api_base_url": { "default": "https://api.dify.ai/v1", @@ -25,11 +25,11 @@ "paths": { "/completion-messages": { "post": { - "summary": "发送消息", - "description": "向文本生成型应用发送请求。", + "summary": "发送文本生成消息", + "description": "向文本生成应用发送请求。", "operationId": "createCompletionMessage", "tags": [ - "文本生成" + "Completions" ], "requestBody": { "description": "创建文本生成消息的请求体。", @@ -41,7 +41,7 @@ }, "examples": { "streaming_example": { - "summary": "请求示例 - 流式模式", + "summary": "请求示例 - 流式返回", "value": { "inputs": { "city": "San Francisco" @@ -59,7 +59,7 @@ } }, "blocking_example": { - "summary": "请求示例 - 阻塞模式", + "summary": "请求示例 - 阻塞式返回", "value": { "inputs": { "city": "New York" @@ -75,7 +75,7 @@ }, "responses": { "200": { - "description": "请求成功。内容类型和结构取决于请求中的 `response_mode` 参数。\n\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 和 `CompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 和 `ChunkCompletionEvent` 对象流。", + "description": "成功响应。内容类型和结构取决于请求中的 `response_mode` 参数。\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 格式的 `CompletionResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 格式的 `ChunkCompletionEvent` 对象流。", "content": { "application/json": { "schema": { @@ -83,7 +83,7 @@ }, "examples": { "blockingResponse": { - "summary": "响应示例 - 阻塞模式", + "summary": "响应示例 - 阻塞式返回", "value": { "event": "message", "task_id": "c3800678-a077-43df-a102-53f23ed20b88", @@ -115,11 +115,11 @@ "text/event-stream": { "schema": { "type": "string", - "description": "服务器发送事件 (SSE) 流。每个事件是一个以 `data: ` 为前缀的 JSON 对象，以两个换行符终止。\n\n**SSE 解析指南：**每个事件是一行以 `data: ` 为前缀的 JSON 对象，以 `\\n\\n` 终止。解析 JSON 前先去除 `data: ` 前缀。JSON 内的 `event` 字段决定事件类型。当收到终止事件（如 `message_end` 或 `error`）时流结束。忽略 `ping` 事件（每 10 秒发送一次以保持连接活跃）。注意即使流中出现错误事件，HTTP 状态码仍为 `200`。" + "description": "Server-Sent Events (SSE) 流。每个事件是一个以 `data: ` 为前缀并以两个换行符结尾的 JSON 对象。有关可能的事件结构，请参阅 `ChunkCompletionEvent`。\n**SSE 解析指南：** 每个事件是以 `data: ` 为前缀的一行，后跟 JSON 对象，以 `\\n\\n` 结尾。解析 JSON 前需去除 `data: ` 前缀。JSON 中的 `event` 字段决定事件类型。当收到 `message_end` 事件时，流结束。忽略 `ping` 事件（每 10 秒发送一次以保持连接）。如果在流中收到 `error` 事件，流将终止——解析错误对象以获取详情。请注意，即使流中发生错误事件，HTTP 状态码始终为 `200`。" }, "examples": { "streamingResponse": { - "summary": "响应示例 - 流式模式", + "summary": "响应示例 - 流式返回", "value": "data: {\"event\": \"message\", \"task_id\": \"900bbd43-dc0b-4383-a372-aa6e6c414227\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"answer\": \" I\", \"created_at\": 1679586595}\n\ndata: {\"event\": \"message\", \"task_id\": \"900bbd43-dc0b-4383-a372-aa6e6c414227\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"answer\": \"'m\", \"created_at\": 1679586595}\n\ndata: {\"event\": \"message_end\", \"task_id\": \"900bbd43-dc0b-4383-a372-aa6e6c414227\", \"id\": \"5e52ce04-874b-4d27-9045-b3bc80def685\", \"message_id\": \"5ad4cb98-f0c7-4085-b384-88c403be6290\", \"metadata\": {\"usage\": {\"prompt_tokens\": 1033, \"prompt_unit_price\": \"0.001\", \"prompt_price_unit\": \"0.001\", \"prompt_price\": \"0.0010330\", \"completion_tokens\": 135, \"completion_unit_price\": \"0.002\", \"completion_price_unit\": \"0.001\", \"completion_price\": \"0.0002700\", \"total_tokens\": 1168, \"total_price\": \"0.0013030\", \"currency\": \"USD\", \"latency\": 1.381760165997548}}}\n\n" } } @@ -127,7 +127,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不可用。\n- `completion_request_error` : 文本生成失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不可用。\n- `completion_request_error`：文本生成失败。", "content": { "application/json": { "examples": { @@ -176,7 +176,7 @@ } }, "429": { - "description": "`too_many_requests` : 该应用的并发请求过多。", + "description": "`too_many_requests`：此应用的并发请求过多。", "content": { "application/json": { "examples": { @@ -193,7 +193,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -214,18 +214,18 @@ }, "/completion-messages/{task_id}/stop": { "post": { - "summary": "停止响应", - "description": "停止文本生成消息生成任务。仅在 `streaming` 模式下支持。", - "operationId": "stopCompletionGeneration", + "summary": "停止文本生成消息", + "description": "停止文本生成消息任务。仅在 `streaming` 模式下支持。", + "operationId": "stopGenerate", "tags": [ - "文本生成" + "Completions" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "任务 ID，可以从 [发送消息](/api-reference/文本生成/发送消息) API 的流式分块返回中获取。", + "description": "任务 ID，可从[发送文本生成消息](/api-reference/completions/send-completion-message) API 的流式返回中获取。", "schema": { "type": "string" } @@ -243,7 +243,7 @@ "properties": { "user": { "type": "string", - "description": "用户标识符，必须和发送消息接口传入的 user 保持一致。" + "description": "用户标识符，必须与发送消息接口中传递的用户保持一致。" } } }, @@ -263,7 +263,7 @@ "$ref": "#/components/responses/SuccessResult" }, "400": { - "description": "`app_unavailable` : 应用不可用或配置错误。", + "description": "`app_unavailable`：应用不可用或配置错误。", "content": { "application/json": { "examples": { @@ -286,10 +286,10 @@ "post": { "operationId": "postMessageFeedback", "tags": [ - "消息反馈" + "Feedback" ], "summary": "提交消息反馈", - "description": "提交消息反馈。终端用户可以对消息评价 `like` 或 `dislike`，并可选择提供文字反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", + "description": "提交消息反馈。终端用户可以将消息评为 `like` 或 `dislike`，并可选择提供文字反馈。将 `rating` 设为 `null` 可撤销之前提交的反馈。", "parameters": [ { "name": "message_id", @@ -326,7 +326,7 @@ "$ref": "#/components/responses/SuccessResult" }, "404": { - "description": "`not_found` : 消息不存在。", + "description": "`not_found`：消息不存在。", "content": { "application/json": { "examples": { @@ -349,10 +349,10 @@ "get": { "operationId": "getAppFeedbacks", "tags": [ - "消息反馈" + "Feedback" ], - "summary": "获取应用的消息反馈", - "description": "获取此应用中所有消息反馈的分页列表，包括终端用户和管理员反馈。", + "summary": "获取应用反馈列表", + "description": "获取此应用中所有消息反馈的分页列表，包括终端用户和管理员的反馈。", "parameters": [ { "name": "page", @@ -431,10 +431,10 @@ "post": { "operationId": "uploadFile", "tags": [ - "文件操作" + "Files" ], "summary": "上传文件", - "description": "上传文件用于发送消息时使用，支持图片、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", + "description": "上传文件以便在发送消息时使用，支持图像、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", "requestBody": { "description": "文件上传请求。需要 multipart/form-data 格式。", "required": true, @@ -449,11 +449,11 @@ "file": { "type": "string", "format": "binary", - "description": "要上传的文件。支持的类型包括图片、文档、音频和视频。" + "description": "要上传的文件。支持的类型包括图像、文档、音频和视频。" }, "user": { "type": "string", - "description": "用户标识符，由开发者定义的规则生成，必须在应用内唯一。" + "description": "用户标识符，由开发者规则定义，在应用内必须唯一。" } } } @@ -493,7 +493,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : 请求中未提供文件。\n- `too_many_files` : 每次请求仅允许上传一个文件。\n- `filename_not_exists_error` : 上传的文件没有文件名。", + "description": "- `no_file_uploaded`：请求中未提供文件。\n- `too_many_files`：每次请求只允许上传一个文件。\n- `filename_not_exists_error`：上传的文件没有文件名。", "content": { "application/json": { "examples": { @@ -526,7 +526,7 @@ } }, "413": { - "description": "`file_too_large` : 文件大小超出限制。", + "description": "`file_too_large`：文件大小超限。", "content": { "application/json": { "examples": { @@ -543,7 +543,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 不允许的文件类型。", + "description": "`unsupported_file_type`：不允许的文件类型。", "content": { "application/json": { "examples": { @@ -564,18 +564,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "previewCompletionFileZh", + "operationId": "previewCompletionFile", "tags": [ - "文件操作" + "Files" ], "summary": "下载文件", - "description": "预览或下载之前通过[上传文件](/api-reference/文件操作/上传文件) API 上传的文件。仅可访问属于请求应用内消息的文件。", + "description": "预览或下载之前通过[上传文件](/api-reference/files/upload-file) API 上传的文件。只有当文件属于请求应用中的消息时才能访问。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "要预览的文件唯一标识符，从 [上传文件](/api-reference/文件操作/上传文件) API 响应中获取。", + "description": "要预览的文件的唯一标识符，从[上传文件](/api-reference/files/upload-file) API 响应中获取。", "schema": { "type": "string", "format": "uuid" @@ -585,7 +585,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "如果为 `true`，则强制文件以附件形式下载，而不是在浏览器中预览。", + "description": "如果为 `true`，强制将文件作为附件下载，而不是在浏览器中预览。", "schema": { "type": "boolean", "default": false @@ -603,7 +603,7 @@ ], "responses": { "200": { - "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将以 `Content-Disposition: attachment` 方式作为下载返回。", + "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将作为下载返回，带有 `Content-Disposition: attachment`。", "content": { "application/octet-stream": { "schema": { @@ -614,7 +614,7 @@ } }, "403": { - "description": "`file_access_denied` : 拒绝访问请求的文件。", + "description": "`file_access_denied`：拒绝访问请求的文件。", "content": { "application/json": { "examples": { @@ -631,7 +631,7 @@ } }, "404": { - "description": "`file_not_found` : 未找到请求的文件。", + "description": "`file_not_found`：未找到请求的文件。", "content": { "application/json": { "examples": { @@ -652,12 +652,12 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserCompletionCn", + "operationId": "getEndUserCompletion", "tags": [ - "终端用户" + "End Users" ], - "summary": "获取终端用户", - "description": "根据 ID 获取终端用户信息。当其他 API 返回终端用户 ID（例如[上传文件](/api-reference/文件操作/上传文件)返回的 `created_by`）时很有用。", + "summary": "获取终端用户信息", + "description": "通过 ID 获取终端用户。当其他 API 返回终端用户 ID 时（例如[上传文件](/api-reference/files/upload-file)中的 `created_by`），此接口很有用。", "parameters": [ { "name": "end_user_id", @@ -699,7 +699,7 @@ } }, "404": { - "description": "`end_user_not_found` : 未找到终端用户。", + "description": "`end_user_not_found`：未找到终端用户。", "content": { "application/json": { "examples": { @@ -720,12 +720,12 @@ }, "/audio-to-text": { "post": { - "operationId": "completionAudioToTextZh", + "operationId": "completionAudioToText", "tags": [ - "语音与文字转换" + "TTS" ], "summary": "语音转文字", - "description": "将音频文件转换为文字。支持的格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。文件大小限制为 `30 MB`。", + "description": "将音频文件转换为文本。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。文件大小限制为 `30 MB`。", "requestBody": { "required": true, "content": { @@ -738,7 +738,7 @@ }, "responses": { "200": { - "description": "语音转文字成功。", + "description": "成功将音频转换为文本。", "content": { "application/json": { "schema": { @@ -756,7 +756,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `no_audio_uploaded` : 未上传音频文件。\n- `provider_not_support_speech_to_text` : 模型提供商不支持语音转文字。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 语音识别请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `no_audio_uploaded`：未上传音频文件。\n- `provider_not_support_speech_to_text`：模型供应商不支持语音转文字。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：语音识别请求失败。", "content": { "application/json": { "examples": { @@ -821,7 +821,7 @@ } }, "413": { - "description": "`audio_too_large` : 音频文件大小超出限制。", + "description": "`audio_too_large`：音频文件大小超出限制。", "content": { "application/json": { "examples": { @@ -838,7 +838,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 不允许的音频类型。", + "description": "`unsupported_audio_type`：不允许的音频类型。", "content": { "application/json": { "examples": { @@ -855,7 +855,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -878,10 +878,10 @@ "post": { "operationId": "textToAudio", "tags": [ - "语音与文字转换" + "TTS" ], "summary": "文字转语音", - "description": "将文字转换为语音。", + "description": "将文本转换为语音。", "requestBody": { "required": true, "content": { @@ -905,7 +905,7 @@ }, "responses": { "200": { - "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式返回。", + "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码进行流式传输。", "content": { "audio/mpeg": { "schema": { @@ -916,7 +916,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 文字转语音请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已耗尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：文字转语音请求失败。", "content": { "application/json": { "examples": { @@ -965,7 +965,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -988,10 +988,10 @@ "get": { "operationId": "getAppInfo", "tags": [ - "应用配置" + "Applications" ], - "summary": "获取应用基本信息", - "description": "获取应用的基本信息，包括名称、描述、标签和模式。", + "summary": "获取应用信息", + "description": "获取此应用的基本信息，包括名称、描述、标签和模式。", "responses": { "200": { "description": "应用的基本信息。", @@ -1025,7 +1025,7 @@ "get": { "operationId": "getAppParameters", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用参数", "description": "获取应用的输入表单配置，包括功能开关、输入参数名称、类型和默认值。", @@ -1105,7 +1105,7 @@ } }, "400": { - "description": "`app_unavailable` : 应用不可用或配置错误。", + "description": "`app_unavailable`：应用不可用或配置错误。", "content": { "application/json": { "examples": { @@ -1126,15 +1126,15 @@ }, "/meta": { "get": { - "operationId": "getCompletionAppMetaZh", + "operationId": "getCompletionAppMeta", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用元数据", - "description": "获取应用的元数据，包括工具图标和其他配置详情。", + "description": "获取此应用的元数据，包括工具图标和其他配置详情。", "responses": { "200": { - "description": "成功获取应用元数据。", + "description": "成功获取应用元信息。", "content": { "application/json": { "schema": { @@ -1164,10 +1164,10 @@ "get": { "operationId": "getWebAppSettings", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用 WebApp 设置", - "description": "获取应用的 WebApp 设置，包括站点配置、主题和自定义选项。", + "description": "获取此应用的 WebApp 设置，包括站点配置、主题和自定义选项。", "responses": { "200": { "description": "应用的 WebApp 设置。", @@ -1180,7 +1180,7 @@ "webAppSettings": { "summary": "响应示例", "value": { - "title": "My Chat App", + "title": "我的聊天应用", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", @@ -1201,7 +1201,7 @@ } }, "403": { - "description": "`forbidden` : 未找到此应用的站点或工作空间已归档。", + "description": "`forbidden`：未找到此应用的站点或工作区已被归档。", "content": { "application/json": { "examples": { @@ -1227,7 +1227,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上 `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**" + "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并以 `Bearer ` 为前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将您的 API Key 存储在服务器端，不要在客户端共享或存储，以避免可能导致严重后果的 API Key 泄露。**" } }, "responses": { @@ -1266,13 +1266,13 @@ "properties": { "inputs": { "type": "object", - "description": "允许输入应用定义的各种变量值。包含键值对，每个键对应一个特定变量，每个值为该变量的具体值。请参阅 [获取应用参数](/api-reference/应用配置/获取应用参数) 响应中的 `user_input_form` 字段，以了解应用所需的变量名称和类型。", + "description": "允许输入应用定义的各种变量值。包含键/值对，每个键对应一个特定变量，每个值是该变量的具体值。请参阅[获取应用参数](/api-reference/applications/get-app-parameters)响应中的 `user_input_form` 字段，以了解您的应用期望的变量名称和类型。", "additionalProperties": true }, "query": { "type": "string", "default": "", - "description": "要处理的输入文本。这是一个旧版参数；在较新的应用中，查询内容应通过 `inputs` 对象传递。" + "description": "要处理的输入文本。这是一个遗留参数；在较新的应用中，查询应在 `inputs` 对象中传递。" }, "response_mode": { "type": "string", @@ -1280,7 +1280,7 @@ "streaming", "blocking" ], - "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 等待完成后返回（长时间处理可能会被中断）。Cloudflare 超时为 `100 s`。省略时默认为阻塞模式。" + "description": "响应返回模式。`streaming`（推荐）使用 SSE。`blocking` 在完成后返回（长时间处理可能被中断）。Cloudflare 超时为 `100 秒`。省略时，默认为阻塞式返回行为。" }, "user": { "type": "string", @@ -1291,7 +1291,7 @@ "items": { "$ref": "#/components/schemas/InputFileObject" }, - "description": "用于多模态理解的文件列表，包括图片、文档、音频和视频。要附加本地文件，请先通过 [上传文件](/api-reference/文件操作/上传文件) 上传，然后将返回的 `id` 作为 `upload_file_id`，并设置 `transfer_method: local_file`。" + "description": "用于多模态理解的文件列表，包括图像、文档、音频和视频。要附加本地文件，请先通过[上传文件](/api-reference/files/upload-file)上传，并使用返回的 `id` 作为 `upload_file_id`，同时设置 `transfer_method: local_file`。" } } }, @@ -1319,7 +1319,7 @@ "remote_url", "local_file" ], - "description": "传输方式：文件 URL 使用 `remote_url`，上传文件使用 `local_file`。" + "description": "传输方式：`remote_url` 表示文件 URL，`local_file` 表示已上传的文件。" }, "url": { "type": "string", @@ -1328,7 +1328,7 @@ }, "upload_file_id": { "type": "string", - "description": "已上传文件 ID，通过 [上传文件](/api-reference/文件操作/上传文件) API 预先上传获取（当 `transfer_method` 为 `local_file` 时使用）。" + "description": "已上传文件的 ID，通过预先调用[上传文件](/api-reference/files/upload-file) API 获取（当 `transfer_method` 为 `local_file` 时）。" } }, "anyOf": [ @@ -1385,17 +1385,17 @@ "task_id": { "type": "string", "format": "uuid", - "description": "用于请求追踪和 [停止响应](/api-reference/文本生成/停止响应) API 的任务 ID。" + "description": "任务 ID，用于请求跟踪和[停止文本生成消息](/api-reference/completions/stop-completion-message-generation) API。" }, "id": { "type": "string", "format": "uuid", - "description": "该响应事件的唯一 ID。" + "description": "此响应事件的唯一 ID。" }, "message_id": { "type": "string", "format": "uuid", - "description": "唯一的消息 ID。调用反馈或推荐问题接口时，将此值作为 `message_id` 参数使用。" + "description": "唯一消息 ID。调用反馈或建议问题端点时，将此作为 `message_id` 参数使用。" }, "mode": { "type": "string", @@ -1407,7 +1407,7 @@ }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括使用情况和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -1510,16 +1510,16 @@ }, { "type": "object", - "description": "消息结束事件，收到此事件表示流式输出已结束。", + "description": "消息结束事件，收到此事件表示流式传输已结束。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "消息的唯一 ID。" + "description": "唯一消息 ID。" }, "metadata": { "type": "object", - "description": "包含用量和检索资源的元数据。", + "description": "元数据，包括使用情况和检索资源。", "properties": { "usage": { "$ref": "#/components/schemas/Usage" @@ -1547,12 +1547,12 @@ }, { "type": "object", - "description": "TTS 音频流事件（base64 编码的 MP3）。在启用自动播放时可用。", + "description": "TTS 音频流事件（base64 编码的 MP3）。启用自动播放时可用。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 编码的 MP3 音频块。按顺序解码并拼接所有块即可生成完整的音频文件。" + "description": "Base64 编码的 MP3 音频块。按顺序解码并连接所有块以生成完整的音频文件。" } } } @@ -1572,7 +1572,7 @@ "properties": { "audio": { "type": "string", - "description": "空字符串。标识音频流结束。" + "description": "空字符串。表示音频流结束。" } } } @@ -1601,7 +1601,7 @@ "enum": [ "assistant" ], - "description": "该文件的归属方，此处始终为 `assistant`。" + "description": "此文件所属者，此处始终为 `assistant`。" }, "url": { "type": "string", @@ -1646,7 +1646,7 @@ }, { "type": "object", - "description": "流式输出过程中的错误事件。", + "description": "流式传输期间的错误事件。", "properties": { "status": { "type": "integer", @@ -1654,11 +1654,11 @@ }, "code": { "type": "string", - "description": "错误码。" + "description": "错误代码。" }, "message": { "type": "string", - "description": "错误信息。" + "description": "错误消息。" } } } @@ -1671,7 +1671,7 @@ }, { "type": "object", - "description": "Ping 事件，用于保持连接活跃。" + "description": "用于保持连接的 Ping 事件。" } ] }, @@ -1680,59 +1680,59 @@ "properties": { "prompt_tokens": { "type": "integer", - "description": "提示词中的令牌数。" + "description": "提示词中的 token 数量。" }, "prompt_unit_price": { "type": "string", "format": "decimal", - "description": "每个提示词令牌的单价。" + "description": "每个提示词 token 的单价。" }, "prompt_price_unit": { "type": "string", "format": "decimal", - "description": "提示词令牌的价格单位。" + "description": "提示词 token 的价格单位。" }, "prompt_price": { "type": "string", "format": "decimal", - "description": "提示词令牌的总价。" + "description": "提示词 token 的总价格。" }, "completion_tokens": { "type": "integer", - "description": "补全内容中的令牌数。" + "description": "补全中的 token 数量。" }, "completion_unit_price": { "type": "string", "format": "decimal", - "description": "每个补全令牌的单价。" + "description": "每个补全 token 的单价。" }, "completion_price_unit": { "type": "string", "format": "decimal", - "description": "补全令牌的价格单位。" + "description": "补全 token 的价格单位。" }, "completion_price": { "type": "string", "format": "decimal", - "description": "补全令牌的总价。" + "description": "补全 token 的总价格。" }, "total_tokens": { "type": "integer", - "description": "使用的令牌总数。" + "description": "使用的总 token 数量。" }, "total_price": { "type": "string", "format": "decimal", - "description": "所有令牌的总价。" + "description": "所有 token 的总价格。" }, "currency": { "type": "string", - "description": "计价货币。" + "description": "定价货币。" }, "latency": { "type": "number", "format": "double", - "description": "延迟时间（秒）。" + "description": "延迟（秒）。" } } }, @@ -1747,7 +1747,7 @@ "message_id": { "type": "string", "format": "uuid", - "description": "该资源所属消息的 ID。" + "description": "此资源所属的消息 ID。" }, "position": { "type": "integer", @@ -1756,46 +1756,46 @@ "dataset_id": { "type": "string", "format": "uuid", - "description": "知识库 ID。" + "description": "知识库的 ID。" }, "dataset_name": { "type": "string", - "description": "知识库名称。" + "description": "知识库的名称。" }, "document_id": { "type": "string", "format": "uuid", - "description": "文档 ID。" + "description": "文档的 ID。" }, "document_name": { "type": "string", - "description": "文档名称。" + "description": "文档的名称。" }, "data_source_type": { "type": "string", - "description": "数据源类型。" + "description": "数据来源的类型。" }, "segment_id": { "type": "string", "format": "uuid", - "description": "文档中特定块的 ID。" + "description": "文档中特定分段的 ID。" }, "score": { "type": "number", "format": "float", - "description": "资源的相关性评分。" + "description": "资源的相似度分数。" }, "hit_count": { "type": "integer", - "description": "该块被命中的次数。" + "description": "此分段被命中的次数。" }, "word_count": { "type": "integer", - "description": "块的字数。" + "description": "分段的字数。" }, "segment_position": { "type": "integer", - "description": "块在文档中的位置。" + "description": "分段在文档中的位置。" }, "index_node_hash": { "type": "string", @@ -1808,7 +1808,7 @@ "summary": { "type": "string", "nullable": true, - "description": "块内容的摘要。" + "description": "分段内容的摘要。" }, "created_at": { "type": "integer", @@ -1823,11 +1823,11 @@ "id": { "type": "string", "format": "uuid", - "description": "唯一文件 ID。" + "description": "文件唯一 ID。" }, "name": { "type": "string", - "description": "文件名。" + "description": "文件名称。" }, "size": { "type": "integer", @@ -1862,7 +1862,7 @@ "source_url": { "type": "string", "nullable": true, - "description": "文件的源 URL。" + "description": "文件的来源 URL。" }, "original_url": { "type": "string", @@ -1873,19 +1873,19 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "关联的用户 ID。" + "description": "关联用户的 ID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的租户 ID。" + "description": "关联租户的 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的会话 ID。" + "description": "关联会话的 ID。" }, "file_key": { "type": "string", @@ -1915,12 +1915,12 @@ }, "type": { "type": "string", - "description": "终端用户类型。Service API 用户固定为 `service_api`。" + "description": "终端用户类型。对于服务 API 用户，始终为 `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API 请求中提供的 `user` 标识符（例如 [发送消息](/api-reference/文本生成/发送消息) 中的 `user` 字段）。" + "description": "API 请求中提供的 `user` 标识符（例如[发送文本生成消息](/api-reference/completions/send-completion-message)中的 `user` 字段）。" }, "name": { "type": "string", @@ -1929,11 +1929,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时，值为 `true`。" + "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时为 `true`。" }, "session_id": { "type": "string", - "description": "会话标识符。默认为 `external_user_id` 的值。" + "description": "会话标识符。默认为 `external_user_id` 值。" }, "created_at": { "type": "string", @@ -1970,7 +1970,7 @@ }, "content": { "type": "string", - "description": "提供额外详情的可选文字反馈。" + "description": "可选的文字反馈，提供额外详情。" } } }, @@ -1988,7 +1988,7 @@ }, "FeedbackItem": { "type": "object", - "description": "单条反馈项。", + "description": "单个反馈项。", "properties": { "id": { "type": "string", @@ -2012,7 +2012,7 @@ }, "rating": { "type": "string", - "description": "反馈评分。`like` 为正面，`dislike` 为负面。" + "description": "反馈评分。`like` 表示正面，`dislike` 表示负面。" }, "content": { "type": "string", @@ -2021,7 +2021,7 @@ }, "from_source": { "type": "string", - "description": "反馈来源。`user` 为终端用户通过 API 提交的反馈，`admin` 为从控制台提交的反馈。" + "description": "反馈来源。`user` 表示通过 API 提交的终端用户反馈，`admin` 表示从控制台提交的反馈。" }, "from_end_user_id": { "type": "string", @@ -2057,7 +2057,7 @@ "file": { "type": "string", "format": "binary", - "description": "音频文件。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。大小限制：`30 MB`。" + "description": "音频文件。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。限制：`30 MB`。" }, "user": { "type": "string", @@ -2070,7 +2070,7 @@ "properties": { "text": { "type": "string", - "description": "语音识别输出的文字。" + "description": "语音识别输出的文本。" } } }, @@ -2081,7 +2081,7 @@ "message_id": { "type": "string", "format": "uuid", - "description": "消息 ID。当同时提供 `text` 时，优先使用消息 ID。" + "description": "消息 ID。当同时提供两者时，优先于 `text`。" }, "text": { "type": "string", @@ -2093,7 +2093,7 @@ }, "voice": { "type": "string", - "description": "文字转语音使用的声音。可用声音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/应用配置/获取应用参数) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" + "description": "用于文字转语音的语音。可用语音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" }, "streaming": { "type": "boolean", @@ -2121,11 +2121,11 @@ }, "mode": { "type": "string", - "description": "应用模式。`completion` 为文本生成应用，`chat` 为基础对话应用，`agent-chat` 为 Agent 应用，`advanced-chat` 为对话流应用，`workflow` 为工作流应用。" + "description": "应用模式。`completion` 表示文本生成应用，`chat` 表示基础聊天应用，`agent-chat` 表示 Agent 应用，`advanced-chat` 表示 Chatflow 应用，`workflow` 表示工作流应用。" }, "author_name": { "type": "string", - "description": "应用作者名称。" + "description": "应用作者的名称。" } } }, @@ -2141,7 +2141,7 @@ "items": { "type": "string" }, - "description": "建议的初始问题列表。" + "description": "建议的开场问题列表。" }, "suggested_questions_after_answer": { "type": "object", @@ -2149,7 +2149,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -2159,7 +2159,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -2169,11 +2169,11 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" }, "voice": { "type": "string", - "description": "TTS 的声音标识符。" + "description": "TTS 的语音标识符。" }, "language": { "type": "string", @@ -2195,7 +2195,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -2205,7 +2205,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -2215,17 +2215,17 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, "sensitive_word_avoidance": { "type": "object", - "description": "敏感词过滤配置。", + "description": "敏感词规避配置。", "properties": { "enabled": { "type": "boolean", - "description": "是否启用此功能。" + "description": "此功能是否启用。" } } }, @@ -2242,19 +2242,19 @@ "properties": { "image": { "type": "object", - "description": "图片上传设置。", + "description": "图像上传设置。", "properties": { "enabled": { "type": "boolean", - "description": "是否启用图片上传。" + "description": "是否启用图像上传。" }, "number_limits": { "type": "integer", - "description": "最大图片数量。" + "description": "最大图像数量。" }, "detail": { "type": "string", - "description": "图片精细程度。" + "description": "图像详细程度。" }, "transfer_methods": { "type": "array", @@ -2281,7 +2281,7 @@ }, "image_file_size_limit": { "type": "integer", - "description": "最大图片文件大小（MB）。" + "description": "最大图像文件大小（MB）。" }, "audio_file_size_limit": { "type": "integer", @@ -2293,7 +2293,7 @@ }, "workflow_file_upload_limit": { "type": "integer", - "description": "工作流文件上传的最大文件数。" + "description": "工作流文件上传的最大文件数量。" } } } @@ -2314,7 +2314,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "文本输入", "type": "object", "properties": { "text-input": { @@ -2323,7 +2323,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -2332,7 +2332,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "下拉选项", "type": "object", "properties": { "select": { @@ -2349,7 +2349,7 @@ }, "variable": { "type": "string", - "description": "用作 `inputs` 对象中键的变量名。" + "description": "在 `inputs` 对象中用作键的变量名称。" }, "required": { "type": "boolean", @@ -2370,7 +2370,7 @@ }, "variable": { "type": "string", - "description": "用作 `inputs` 对象中键的变量名。" + "description": "在 `inputs` 对象中用作键的变量名称。" }, "required": { "type": "boolean", @@ -2391,11 +2391,11 @@ }, "variable": { "type": "string", - "description": "用作 `inputs` 对象中键的变量名。" + "description": "在 `inputs` 对象中用作键的变量名称。" }, "required": { "type": "boolean", - "description": "提交前是否必须做出选择。" + "description": "提交前是否必须进行选择。" }, "default": { "type": "string", @@ -2418,7 +2418,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "图标 URL", "type": "string", "format": "url", "description": "图标的 URL。" @@ -2433,9 +2433,9 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "表情图标", "type": "object", - "description": "使用 emoji 的工具图标详情。", + "description": "使用表情符号的工具图标详情。", "properties": { "background": { "type": "string", @@ -2443,7 +2443,7 @@ }, "content": { "type": "string", - "description": "Emoji 内容。" + "description": "表情符号内容。" } } }, @@ -2456,19 +2456,19 @@ }, "chat_color_theme": { "type": "string", - "description": "聊天主题颜色。" + "description": "聊天颜色主题。" }, "chat_color_theme_inverted": { "type": "boolean", - "description": "聊天主题颜色是否反转。" + "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", - "description": "使用的图标类型。`emoji` 为表情图标，`image` 为上传的图片图标。" + "description": "使用的图标类型。`emoji` 表示表情符号图标，`image` 表示上传的图像图标。" }, "icon": { "type": "string", - "description": "图标内容（表情或图片 ID）。" + "description": "图标内容（表情符号或图像 ID）。" }, "icon_background": { "type": "string", @@ -2478,7 +2478,7 @@ "type": "string", "format": "url", "nullable": true, - "description": "图标图片的 URL。" + "description": "图标图像的 URL。" }, "description": { "type": "string", @@ -2514,28 +2514,28 @@ }, "tags": [ { - "name": "文本生成", - "description": "文本生成相关操作。" + "name": "Completions", + "description": "与文本生成和补全相关的操作。" }, { - "name": "文件操作", - "description": "文件管理相关操作。" + "name": "Files", + "description": "与文件管理相关的操作。" }, { - "name": "终端用户", - "description": "终端用户信息相关操作。" + "name": "End Users", + "description": "与终端用户信息相关的操作。" }, { - "name": "消息反馈", - "description": "用户反馈相关操作。" + "name": "Feedback", + "description": "与用户反馈相关的操作。" }, { - "name": "语音与文字转换", - "description": "语音转文字和文字转语音相关操作。" + "name": "TTS", + "description": "与文字转语音和语音转文字相关的操作。" }, { - "name": "应用配置", + "name": "Applications", "description": "获取应用设置和信息的操作。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index 6acc5872e..90a868e9d 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "工作流应用 API", - "description": "工作流应用提供无会话支持，适用于翻译、文章写作、摘要 AI 等场景。", + "description": "工作流应用提供非会话支持，适用于翻译、文章写作、摘要生成 AI 等场景。", "version": "1.0.0" }, "servers": [ @@ -26,10 +26,10 @@ "/workflows/run": { "post": { "summary": "执行工作流", - "description": "执行工作流。没有已发布的工作流时无法执行。", - "operationId": "executeWorkflowCn", + "description": "执行工作流。未发布的工作流无法执行。", + "operationId": "executeWorkflow", "tags": [ - "工作流" + "Workflows" ], "requestBody": { "required": true, @@ -40,7 +40,7 @@ }, "examples": { "streaming_example": { - "summary": "请求示例 - 流式模式", + "summary": "请求示例 - 流式返回", "value": { "inputs": { "query": "Summarize this text: The quick brown fox jumps over the lazy dog." @@ -50,7 +50,7 @@ } }, "blocking_example": { - "summary": "请求示例 - 阻塞模式", + "summary": "请求示例 - 阻塞式返回", "value": { "inputs": { "query": "Translate this to French: Hello world" @@ -60,7 +60,7 @@ } }, "with_file_array_variable": { - "summary": "Request Example - File array input", + "summary": "请求示例 - 文件数组输入", "value": { "inputs": { "my_documents": [ @@ -86,7 +86,7 @@ }, "responses": { "200": { - "description": "请求成功。内容类型和结构取决于请求中的 `response_mode` 参数。\n\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 和 `WorkflowBlockingResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 和 `ChunkWorkflowEvent` 对象流。", + "description": "成功响应。内容类型和结构取决于请求中的 `response_mode` 参数。\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 格式的 `WorkflowBlockingResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 格式的 `ChunkWorkflowEvent` 对象流。", "content": { "application/json": { "schema": { @@ -94,7 +94,7 @@ }, "examples": { "blockingResponse": { - "summary": "响应示例 - 阻塞模式", + "summary": "响应示例 - 阻塞式返回", "value": { "task_id": "c3800678-a077-43df-a102-53f23ed20b88", "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156", @@ -119,11 +119,11 @@ "text/event-stream": { "schema": { "type": "string", - "description": "服务器发送事件 (SSE) 流。\n\n**解析**：每行以 `data: ` 开头，后接一个 JSON 对象，以 `\\n\\n` 终止。解析 JSON 前先去除 `data: ` 前缀，再读取 `event` 字段确定事件类型。忽略 `ping` 事件，该事件每 10 秒发送一次以保持连接活跃。\n\n**流生命周期**：收到 `workflow_finished`、`workflow_paused` 或 `error` 事件时流关闭。错误以流内 `error` 事件的形式返回，HTTP 状态码始终为 `200`；请检查事件载荷获取详情，不要依赖状态码判断。\n\n**人工介入事件**：\n- `human_input_required`：工作流到达人工介入节点时与 `workflow_paused` 一同触发。使用载荷中的 `form_token` 通过 [人工介入 API](/api-reference/人工介入/获取人工介入表单) 处理表单。\n- `human_input_form_filled`：接收者提交了表单，工作流恢复执行。\n- `human_input_form_timeout`：表单超时未响应。如定义了超时回退分支，工作流将沿该分支执行。" + "description": "Server-Sent Events (SSE) 流。\n**解析**：每行以 `data: ` 开头，后跟 JSON 对象，以 `\\n\\n` 结尾。解析 JSON 前需去除 `data: ` 前缀，然后读取 `event` 字段以确定事件类型。忽略 `ping` 事件，该事件每 10 秒触发一次以保持连接活跃。\n**流生命周期**：当收到 `workflow_finished`、`workflow_paused` 或 `error` 事件时，流将关闭。错误通过流内传递，HTTP 状态码为 `200`；请检查事件负载以获取详情，而不要依赖状态码。\n**人工介入事件**：\n- `human_input_required`：当工作流到达人工介入节点时，与 `workflow_paused` 一起触发。使用负载中的 `form_token` 通过 [Human Input API](/api-reference/human-input/get-human-input-form) 驱动表单处理流程。\n- `human_input_form_filled`：接收者提交了表单；工作流执行恢复。\n- `human_input_form_timeout`：表单在未收到响应的情况下过期。如果定义了超时回退边，工作流将遵循该路径。" }, "examples": { "streamingResponse": { - "summary": "响应示例 - 流式模式", + "summary": "响应示例 - 流式返回", "value": "data: {\"event\": \"workflow_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"inputs\": {\"query\": \"Translate this\"}, \"created_at\": 1705407629, \"reason\": \"initial\"}} data: {\"event\": \"node_started\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"node_exec_1\", \"node_id\": \"node_1\", \"node_type\": \"llm\", \"title\": \"LLM Node\", \"index\": 1, \"created_at\": 1705407629}} data: {\"event\": \"text_chunk\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"text\": \"Bonjour\", \"from_variable_selector\": [\"node_1\", \"text\"]}} data: {\"event\": \"workflow_finished\", \"task_id\": \"c3800678-a077-43df-a102-53f23ed20b88\", \"workflow_run_id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"data\": {\"id\": \"fb47b2e6-5e43-4f90-be01-d5c5a088d156\", \"workflow_id\": \"7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345\", \"status\": \"succeeded\", \"outputs\": {\"result\": \"Bonjour le monde\"}, \"elapsed_time\": 1.23, \"total_tokens\": 150, \"total_steps\": 3, \"created_at\": 1705407629, \"finished_at\": 1705407630}}" }, "humanInputPause": { @@ -135,7 +135,7 @@ } }, "400": { - "description": "- `not_workflow_app` : App mode does not match the API route.\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不可用。\n- `completion_request_error` : 工作流 execution request failed.\n- `invalid_param` : Invalid parameter value.", + "description": "- `not_workflow_app`：应用模式与 API 路由不匹配。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不可用。\n- `completion_request_error`：工作流执行请求失败。\n- `invalid_param`：参数值无效。", "content": { "application/json": { "examples": { @@ -192,7 +192,7 @@ } }, "429": { - "description": "- `too_many_requests` : 该应用的并发请求过多。\n- `rate_limit_error` : 上游模型提供商的速率限制已超出。", + "description": "- `too_many_requests`：该应用的并发请求过多。\n- `rate_limit_error`：超出上游模型供应商的速率限制。", "content": { "application/json": { "examples": { @@ -217,7 +217,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -239,17 +239,17 @@ "/workflows/{workflow_id}/run": { "post": { "summary": "按 ID 执行工作流", - "description": "通过 ID 执行指定的工作流版本。适用于运行工作流的特定已发布版本。", - "operationId": "runWorkflowByIdZh", + "description": "通过 ID 执行特定版本的工作流。适用于运行工作流的特定已发布版本。", + "operationId": "runWorkflowById", "tags": [ - "工作流" + "Workflows" ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, - "description": "要执行的特定版本的工作流 ID。此值在 [执行工作流](/api-reference/工作流/执行-工作流) 响应和 [获取工作流运行详情](/api-reference/工作流/获取-工作流-执行情况) 的 `workflow_id` 字段中返回。", + "description": "要执行的特定版本的工作流 ID。此值在 [执行工作流](/api-reference/workflows/run-workflow) 响应和 [获取工作流运行详情](/api-reference/workflows/get-workflow-run-detail) 的 `workflow_id` 字段中返回。", "schema": { "type": "string" } @@ -279,7 +279,7 @@ }, "responses": { "200": { - "description": "请求成功。内容类型和结构取决于请求中的 `response_mode` 参数。\n\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 和 `WorkflowBlockingResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 和 `ChunkWorkflowEvent` 对象流。", + "description": "成功响应。内容类型和结构取决于请求中的 `response_mode` 参数。\n- 如果 `response_mode` 为 `blocking`，返回 `application/json` 格式的 `WorkflowBlockingResponse` 对象。\n- 如果 `response_mode` 为 `streaming`，返回 `text/event-stream` 格式的 `ChunkWorkflowEvent` 对象流。", "content": { "application/json": { "schema": { @@ -287,7 +287,7 @@ }, "examples": { "blockingResponse": { - "summary": "响应示例 - 阻塞模式", + "summary": "响应示例 - 阻塞式返回", "value": { "task_id": "c3800678-a077-43df-a102-53f23ed20b88", "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156", @@ -312,7 +312,7 @@ "text/event-stream": { "schema": { "type": "string", - "description": "服务器发送事件 (SSE) 流。\n\n**解析**：每行以 `data: ` 开头，后接一个 JSON 对象，以 `\\n\\n` 终止。解析 JSON 前先去除 `data: ` 前缀，再读取 `event` 字段确定事件类型。忽略 `ping` 事件，该事件每 10 秒发送一次以保持连接活跃。\n\n**流生命周期**：收到 `workflow_finished`、`workflow_paused` 或 `error` 事件时流关闭。错误以流内 `error` 事件的形式返回，HTTP 状态码始终为 `200`；请检查事件载荷获取详情，不要依赖状态码判断。\n\n**人工介入事件**：\n- `human_input_required`：工作流到达人工介入节点时与 `workflow_paused` 一同触发。使用载荷中的 `form_token` 通过 [人工介入 API](/api-reference/人工介入/获取人工介入表单) 处理表单。\n- `human_input_form_filled`：接收者提交了表单，工作流恢复执行。\n- `human_input_form_timeout`：表单超时未响应。如定义了超时回退分支，工作流将沿该分支执行。" + "description": "Server-Sent Events (SSE) 流。\n**解析**：每行以 `data: ` 开头，后跟 JSON 对象，以 `\\n\\n` 结尾。解析 JSON 前需去除 `data: ` 前缀，然后读取 `event` 字段以确定事件类型。忽略 `ping` 事件，该事件每 10 秒触发一次以保持连接活跃。\n**流生命周期**：当收到 `workflow_finished`、`workflow_paused` 或 `error` 事件时，流将关闭。错误通过流内传递，HTTP 状态码为 `200`；请检查事件负载以获取详情，而不要依赖状态码。\n**人工介入事件**：\n- `human_input_required`：当工作流到达人工介入节点时，与 `workflow_paused` 一起触发。使用负载中的 `form_token` 通过 [Human Input API](/api-reference/human-input/get-human-input-form) 驱动表单处理流程。\n- `human_input_form_filled`：接收者提交了表单；工作流执行恢复。\n- `human_input_form_timeout`：表单在未收到响应的情况下过期。如果定义了超时回退边，工作流将遵循该路径。" }, "examples": { "humanInputPause": { @@ -324,7 +324,7 @@ } }, "400": { - "description": "- `not_workflow_app` : App mode does not match the API route.\n- `bad_request` : 工作流 is a draft or has an invalid ID format.\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不可用。\n- `completion_request_error` : 工作流 execution request failed.\n- `invalid_param` : Required parameter missing or invalid.", + "description": "- `not_workflow_app`：应用模式与 API 路由不匹配。\n- `bad_request`：工作流是草稿或 ID 格式无效。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不可用。\n- `completion_request_error`：工作流执行请求失败。\n- `invalid_param`：缺少必需参数或参数无效。", "content": { "application/json": { "examples": { @@ -389,7 +389,7 @@ } }, "404": { - "description": "`not_found` : 工作流 not found.", + "description": "`not_found`：未找到工作流。", "content": { "application/json": { "examples": { @@ -406,7 +406,7 @@ } }, "429": { - "description": "- `too_many_requests` : 该应用的并发请求过多。\n- `rate_limit_error` : 上游模型提供商的速率限制已超出。", + "description": "- `too_many_requests`：该应用的并发请求过多。\n- `rate_limit_error`：超出上游模型供应商的速率限制。", "content": { "application/json": { "examples": { @@ -431,7 +431,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -452,11 +452,11 @@ }, "/workflows/run/{workflow_run_id}": { "get": { - "summary": "获取工作流执行情况", + "summary": "获取工作流运行详情", "description": "根据工作流执行 ID 获取工作流任务的当前执行结果。", - "operationId": "getWorkflowRunDetailCn", + "operationId": "getWorkflowRunDetail", "tags": [ - "工作流" + "Workflows" ], "parameters": [ { @@ -503,7 +503,7 @@ } }, "400": { - "description": "`not_workflow_app` : 应用模式与 API 路由不匹配。", + "description": "`not_workflow_app`：应用模式与 API 路由不匹配。", "content": { "application/json": { "examples": { @@ -520,7 +520,7 @@ } }, "404": { - "description": "`not_found` : 未找到工作流运行记录。", + "description": "`not_found`：未找到工作流运行记录。", "content": { "application/json": { "examples": { @@ -541,11 +541,11 @@ }, "/workflows/logs": { "get": { - "summary": "获取工作流日志", - "description": "获取分页的工作流执行日志，支持筛选选项。", - "operationId": "getWorkflowLogsCn", + "summary": "获取工作流日志列表", + "description": "获取带有筛选选项的分页工作流执行日志。", + "operationId": "getWorkflowLogs", "tags": [ - "工作流" + "Workflows" ], "parameters": [ { @@ -572,7 +572,7 @@ { "name": "page", "in": "query", - "description": "分页页码。", + "description": "分页的页码。", "schema": { "type": "integer", "default": 1, @@ -583,7 +583,7 @@ { "name": "limit", "in": "query", - "description": "每页条目数。", + "description": "每页的条目数。", "schema": { "type": "integer", "default": 20, @@ -594,7 +594,7 @@ { "name": "created_at__before", "in": "query", - "description": "筛选在此 ISO 8601 时间戳之前创建的日志。", + "description": "筛选此 ISO 8601 时间戳之前创建的日志。", "schema": { "type": "string", "format": "date-time" @@ -603,7 +603,7 @@ { "name": "created_at__after", "in": "query", - "description": "筛选在此 ISO 8601 时间戳之后创建的日志。", + "description": "筛选此 ISO 8601 时间戳之后创建的日志。", "schema": { "type": "string", "format": "date-time" @@ -683,16 +683,16 @@ "post": { "summary": "停止工作流任务", "description": "停止正在运行的工作流任务。仅在 `streaming` 模式下支持。", - "operationId": "stopWorkflowTaskGenerationCn", + "operationId": "stopWorkflowTaskGeneration", "tags": [ - "工作流" + "Workflows" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "任务 ID，可以从 [执行工作流](/api-reference/工作流/执行-工作流) API 的流式分块返回中获取。", + "description": "任务 ID，可从 [执行工作流](/api-reference/workflows/run-workflow) API 的流式返回中获取。", "schema": { "type": "string" } @@ -710,7 +710,7 @@ "properties": { "user": { "type": "string", - "description": "用户标识符，必须与 [执行工作流](/api-reference/工作流/执行-工作流) 请求中传递的用户一致。" + "description": "用户标识符，必须与 [执行工作流](/api-reference/workflows/run-workflow) 请求中传递的用户一致。" } } }, @@ -730,7 +730,7 @@ "$ref": "#/components/responses/SuccessResult" }, "400": { - "description": "- `not_workflow_app` : 应用模式与 API 路由不匹配。\n- `invalid_param` : 必要参数缺失或无效。", + "description": "- `not_workflow_app`：应用模式与 API 路由不匹配。\n- `invalid_param`：缺少必需参数或参数无效。", "content": { "application/json": { "examples": { @@ -759,12 +759,12 @@ }, "/files/upload": { "post": { - "operationId": "uploadWorkflowFileCn", + "operationId": "uploadWorkflowFile", "tags": [ - "文件操作" + "Files" ], "summary": "上传文件", - "description": "上传文件用于发送消息时使用，支持图片、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", + "description": "上传文件以便在发送消息时使用，支持图像、文档、音频和视频的多模态理解。上传的文件仅供当前终端用户使用。", "requestBody": { "description": "文件上传请求。需要 multipart/form-data 格式。", "required": true, @@ -779,11 +779,11 @@ "file": { "type": "string", "format": "binary", - "description": "要上传的文件。支持的类型包括图片、文档、音频和视频。" + "description": "要上传的文件。支持的类型包括图像、文档、音频和视频。" }, "user": { "type": "string", - "description": "用户标识符，由开发者定义的规则生成，必须在应用内唯一。" + "description": "用户标识符，由开发者的规则定义，必须在应用内唯一。" } } } @@ -823,7 +823,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : 请求中未提供文件。\n- `too_many_files` : 每次请求仅允许上传一个文件。\n- `filename_not_exists_error` : 上传的文件没有文件名。", + "description": "- `no_file_uploaded`：请求中未提供文件。\n- `too_many_files`：每次请求只允许上传一个文件。\n- `filename_not_exists_error`：上传的文件没有文件名。", "content": { "application/json": { "examples": { @@ -856,7 +856,7 @@ } }, "413": { - "description": "`file_too_large` : 文件大小超出限制。", + "description": "`file_too_large`：文件大小超出限制。", "content": { "application/json": { "examples": { @@ -873,7 +873,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 不允许的文件类型。", + "description": "`unsupported_file_type`：不允许的文件类型。", "content": { "application/json": { "examples": { @@ -894,18 +894,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "downloadWorkflowFileZh", + "operationId": "downloadWorkflowFile", "tags": [ - "文件操作" + "Files" ], "summary": "下载文件", - "description": "预览或下载之前通过[上传文件](/api-reference/文件操作/上传文件) API 上传的文件。仅可访问属于请求应用内消息的文件。", + "description": "预览或下载之前通过 [上传文件](/api-reference/files/upload-file) API 上传的文件。只有属于请求应用内消息的文件才能访问。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "要预览的文件唯一标识符，从 [上传文件](/api-reference/文件操作/上传文件) API 响应中获取。", + "description": "要预览的文件的唯一标识符，从 [上传文件](/api-reference/files/upload-file) API 响应中获取。", "schema": { "type": "string", "format": "uuid" @@ -915,7 +915,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "如果为 `true`，则强制文件以附件形式下载，而不是在浏览器中预览。", + "description": "如果为 `true`，强制将文件作为附件下载而不是在浏览器中预览。", "schema": { "type": "boolean", "default": false @@ -933,7 +933,7 @@ ], "responses": { "200": { - "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将以 `Content-Disposition: attachment` 方式作为下载返回。", + "description": "返回原始文件内容。`Content-Type` 头设置为文件的 MIME 类型。如果 `as_attachment` 为 `true`，文件将作为下载返回，带有 `Content-Disposition: attachment`。", "content": { "application/octet-stream": { "schema": { @@ -944,7 +944,7 @@ } }, "403": { - "description": "`file_access_denied` : 拒绝访问请求的文件。", + "description": "`file_access_denied`：拒绝访问请求的文件。", "content": { "application/json": { "examples": { @@ -961,7 +961,7 @@ } }, "404": { - "description": "`file_not_found` : 未找到请求的文件。", + "description": "`file_not_found`：未找到请求的文件。", "content": { "application/json": { "examples": { @@ -982,12 +982,12 @@ }, "/end-users/{end_user_id}": { "get": { - "operationId": "getEndUserWorkflowCn", + "operationId": "getEndUserWorkflow", "tags": [ - "终端用户" + "End Users" ], "summary": "获取终端用户信息", - "description": "根据 ID 获取终端用户信息。当其他 API 返回终端用户 ID（例如[上传文件](/api-reference/文件操作/上传文件)返回的 `created_by`）时很有用。", + "description": "通过 ID 获取终端用户。当其他 API 返回终端用户 ID 时非常有用（例如，[上传文件](/api-reference/files/upload-file) 返回的 `created_by`）。", "parameters": [ { "name": "end_user_id", @@ -1002,7 +1002,7 @@ ], "responses": { "200": { - "description": "成功获取终端用户。", + "description": "成功获取终端用户信息。", "content": { "application/json": { "schema": { @@ -1029,7 +1029,7 @@ } }, "404": { - "description": "`end_user_not_found` : 未找到终端用户。", + "description": "`end_user_not_found`：未找到终端用户。", "content": { "application/json": { "examples": { @@ -1050,11 +1050,11 @@ }, "/audio-to-text": { "post": { - "operationId": "workflowAudioToTextZh", + "operationId": "workflowAudioToText", "tags": [ - "语音与文字转换" + "TTS" ], - "summary": "语音转文字", + "summary": "音频转文字", "description": "将音频文件转换为文字。支持的格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。文件大小限制为 `30 MB`。", "requestBody": { "required": true, @@ -1068,7 +1068,7 @@ }, "responses": { "200": { - "description": "语音转文字成功。", + "description": "成功将音频转换为文字。", "content": { "application/json": { "schema": { @@ -1086,7 +1086,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `no_audio_uploaded` : 未上传音频文件。\n- `provider_not_support_speech_to_text` : 模型提供商不支持语音转文字。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 语音识别请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `no_audio_uploaded`：未上传音频文件。\n- `provider_not_support_speech_to_text`：模型供应商不支持语音转文字。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：语音识别请求失败。", "content": { "application/json": { "examples": { @@ -1151,7 +1151,7 @@ } }, "413": { - "description": "`audio_too_large` : 音频文件大小超出限制。", + "description": "`audio_too_large`：音频文件大小超出限制。", "content": { "application/json": { "examples": { @@ -1168,7 +1168,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 不允许的音频类型。", + "description": "`unsupported_audio_type`：不允许的音频类型。", "content": { "application/json": { "examples": { @@ -1185,7 +1185,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1206,11 +1206,11 @@ }, "/text-to-audio": { "post": { - "operationId": "workflowTextToAudioZh", + "operationId": "workflowTextToAudio", "tags": [ - "语音与文字转换" + "TTS" ], - "summary": "文字转语音", + "summary": "文字转音频", "description": "将文字转换为语音。", "requestBody": { "required": true, @@ -1235,7 +1235,7 @@ }, "responses": { "200": { - "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式返回。", + "description": "返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如 `audio/wav`、`audio/mp3`）。如果 `streaming` 为 `true`，音频将以分块传输编码方式流式传输。", "content": { "audio/mpeg": { "schema": { @@ -1246,7 +1246,7 @@ } }, "400": { - "description": "- `app_unavailable` : 应用不可用或配置错误。\n- `provider_not_initialize` : 未找到有效的模型提供商凭据。\n- `provider_quota_exceeded` : 模型提供商配额已用尽。\n- `model_currently_not_support` : 当前模型不支持此操作。\n- `completion_request_error` : 文字转语音请求失败。", + "description": "- `app_unavailable`：应用不可用或配置错误。\n- `provider_not_initialize`：未找到有效的模型供应商凭证。\n- `provider_quota_exceeded`：模型供应商配额已用尽。\n- `model_currently_not_support`：当前模型不支持此操作。\n- `completion_request_error`：文字转语音请求失败。", "content": { "application/json": { "examples": { @@ -1295,7 +1295,7 @@ } }, "500": { - "description": "`internal_server_error` : 内部服务器错误。", + "description": "`internal_server_error`：内部服务器错误。", "content": { "application/json": { "examples": { @@ -1316,12 +1316,12 @@ }, "/info": { "get": { - "operationId": "getWorkflowAppInfoCn", + "operationId": "getWorkflowAppInfo", "tags": [ - "应用配置" + "Applications" ], - "summary": "获取应用基本信息", - "description": "获取应用的基本信息，包括名称、描述、标签和模式。", + "summary": "获取应用信息", + "description": "获取此应用的基本信息，包括名称、描述、标签和模式。", "responses": { "200": { "description": "应用的基本信息。", @@ -1353,9 +1353,9 @@ }, "/parameters": { "get": { - "operationId": "getWorkflowAppParametersCn", + "operationId": "getWorkflowAppParameters", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用参数", "description": "获取应用的输入表单配置，包括功能开关、输入参数名称、类型和默认值。", @@ -1435,7 +1435,7 @@ } }, "400": { - "description": "`app_unavailable` : 应用不可用或配置错误。", + "description": "`app_unavailable`：应用不可用或配置错误。", "content": { "application/json": { "examples": { @@ -1456,15 +1456,15 @@ }, "/meta": { "get": { - "operationId": "getWorkflowAppMetaZh", + "operationId": "getWorkflowAppMeta", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用元数据", - "description": "获取应用的元数据，包括工具图标和其他配置详情。", + "description": "获取此应用的元数据，包括工具图标和其他配置详情。", "responses": { "200": { - "description": "成功获取应用元数据。", + "description": "成功获取应用元数据信息。", "content": { "application/json": { "schema": { @@ -1492,12 +1492,12 @@ }, "/site": { "get": { - "operationId": "getWorkflowWebAppSettingsCn", + "operationId": "getWorkflowWebAppSettings", "tags": [ - "应用配置" + "Applications" ], "summary": "获取应用 WebApp 设置", - "description": "获取应用的 WebApp 设置，包括站点配置、主题和自定义选项。", + "description": "获取此应用的 WebApp 设置，包括站点配置、主题和自定义选项。", "responses": { "200": { "description": "应用的 WebApp 设置。", @@ -1510,7 +1510,7 @@ "webAppSettings": { "summary": "响应示例", "value": { - "title": "My Chat App", + "title": "我的聊天应用", "chat_color_theme": "#4A90D9", "chat_color_theme_inverted": false, "icon_type": "emoji", @@ -1531,7 +1531,7 @@ } }, "403": { - "description": "`forbidden` : 未找到此应用的站点或工作空间已归档。", + "description": "`forbidden`：未找到此应用的站点或工作区已归档。", "content": { "application/json": { "examples": { @@ -1553,10 +1553,10 @@ "/form/human_input/{form_token}": { "get": { "tags": [ - "人工介入" + "Human Input" ], "summary": "获取人工介入表单", - "description": "使用 `human_input_required` 事件返回的 `form_token` 获取暂停中的人工介入表单内容。需要 **WebApp** 送达方式。", + "description": "使用 `human_input_required` 事件中的 `form_token` 获取暂停的人工介入表单内容。需要 **WebApp** 交付方式。", "operationId": "getWorkflowHumanInputForm", "parameters": [ { @@ -1566,12 +1566,12 @@ "schema": { "type": "string" }, - "description": "暂停表单的访问令牌，由流式模式下 [执行工作流](/api-reference/工作流/执行工作流) 返回的 `human_input_required` 事件提供。" + "description": "暂停表单的访问令牌，在 [执行工作流](/api-reference/workflows/run-workflow) 流式模式的 `human_input_required` 事件中返回。" } ], "responses": { "200": { - "description": "表单内容获取成功。", + "description": "成功获取表单内容。", "content": { "application/json": { "schema": { @@ -1579,7 +1579,7 @@ "properties": { "form_content": { "type": "string", - "description": "已替换工作流变量的预渲染表单正文。" + "description": "预渲染的表单主体，已替换工作流变量。" }, "inputs": { "type": "array", @@ -1588,27 +1588,27 @@ "properties": { "type": { "type": "string", - "description": "表单输入控件类型。可用值：`text_input`（单行文本输入框）和 `paragraph`（多行文本区域）。" + "description": "表单输入控件类型。可用值：`text_input`（单行文本字段）和 `paragraph`（多行文本区域）。" }, "output_variable_name": { "type": "string", - "description": "引用该输入提交值在工作流中使用的变量名。对应提交 `inputs` 对象中的键。" + "description": "用于在工作流中引用此输入提交值的变量名。对应提交 `inputs` 对象中的键。" }, "default": { "type": "object", "nullable": true, - "description": "从工作流上下文解析得到的默认值。未配置默认值时为 `null`。", + "description": "从工作流上下文解析的默认值。未配置默认值时为 `null`。", "properties": { "type": { "type": "string", - "description": "默认值来源。`constant` 表示将 `value` 作为字面字符串；`variable` 表示 `selector` 指向工作流变量。" + "description": "默认值的来源。`constant` 表示 `value` 用作字面字符串；`variable` 表示 `selector` 指向工作流变量。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "当 `type` 为 `variable` 时，变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。至少包含两个元素。" + "description": "当 `type` 为 `variable` 时的变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。必须包含至少两个元素。" }, "value": { "type": "string", @@ -1625,7 +1625,7 @@ "additionalProperties": { "type": "string" }, - "description": "预填充默认值，按输入的 `output_variable_name` 分组。所有值均为字符串。" + "description": "预填充的默认值，以输入的 `output_variable_name` 为键。所有值都已字符串化。" }, "user_actions": { "type": "array", @@ -1636,16 +1636,16 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "操作按钮的标识。当接收者选择该按钮时，作为 `action` 传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单)。" + "description": "操作按钮的标识符。当接收者选择此按钮时，在 [提交人工介入表单](/api-reference/human-input/submit-human-input-form) 中作为 `action` 传递。" }, "title": { "type": "string", "maxLength": 100, - "description": "显示给接收者的按钮文本。" + "description": "显示给接收者的按钮标签。" }, "button_style": { "type": "string", - "description": "按钮视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" + "description": "按钮的视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" } } }, @@ -1654,7 +1654,7 @@ "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），超过后无法再提交该表单。" + "description": "Unix 时间戳（秒），此后表单将无法再提交。" } } }, @@ -1680,12 +1680,12 @@ "user_actions": [ { "id": "approve", - "title": "Approve", + "title": "批准", "button_style": "primary" }, { "id": "reject", - "title": "Request changes", + "title": "请求修改", "button_style": "default" } ], @@ -1697,7 +1697,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found`：未找到表单。", "content": { "application/json": { "examples": { @@ -1714,7 +1714,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted`：表单已提交。表单是一次性的；无论哪个用户提交，第一个响应获胜。\n- `human_input_form_expired`：表单在提交到达前已过期。", "content": { "application/json": { "examples": { @@ -1742,10 +1742,10 @@ }, "post": { "tags": [ - "人工介入" + "Human Input" ], "summary": "提交人工介入表单", - "description": "提交接收者对暂停中人工介入表单的响应。表单被接受后工作流恢复执行；可订阅 [流式获取工作流事件](/api-reference/工作流/流式获取工作流事件) 接收后续事件。需要 **WebApp** 送达方式。", + "description": "提交接收者对暂停的人工介入表单的响应。接受后工作流恢复；使用 [获取工作流事件流](/api-reference/workflows/stream-workflow-events) 跟踪后续事件。需要 **WebApp** 交付方式。", "operationId": "submitWorkflowHumanInputForm", "parameters": [ { @@ -1755,7 +1755,7 @@ "schema": { "type": "string" }, - "description": "暂停表单的访问令牌，由流式模式下 [执行工作流](/api-reference/工作流/执行工作流) 返回的 `human_input_required` 事件提供。" + "description": "暂停表单的访问令牌，在 [执行工作流](/api-reference/workflows/run-workflow) 流式模式的 `human_input_required` 事件中返回。" } ], "requestBody": { @@ -1773,17 +1773,17 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "接收者提交的值，按输入的 `output_variable_name` 分组。" + "description": "接收者提供的值，以输入的 `output_variable_name` 为键。" }, "action": { "type": "string", - "description": "接收者选择的操作按钮 ID。必须与 [获取人工介入表单](/api-reference/人工介入/获取人工介入表单) 返回的 `user_actions` 列表中的某个 `id` 值匹配。", + "description": "接收者选择的操作按钮 ID。必须与表单的 `user_actions` 列表中的某个 `id` 值匹配（由 [获取人工介入表单](/api-reference/human-input/get-human-input-form) 返回）。", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "user": { "type": "string", - "description": "提交者的终端用户标识。" + "description": "提交者的终端用户标识符。" } } }, @@ -1804,7 +1804,7 @@ }, "responses": { "200": { - "description": "表单提交成功。响应体为空对象。", + "description": "表单提交成功。响应主体为空对象。", "content": { "application/json": { "schema": { @@ -1820,7 +1820,7 @@ } }, "400": { - "description": "- `bad_request` : Form recipient type is invalid.\n- `invalid_form_data` : Submission failed validation against the form definition.", + "description": "- `bad_request`：表单接收者类型无效。\n- `invalid_form_data`：提交未通过表单定义验证。", "content": { "application/json": { "examples": { @@ -1845,7 +1845,7 @@ } }, "404": { - "description": "`not_found` : Form not found.", + "description": "`not_found`：未找到表单。", "content": { "application/json": { "examples": { @@ -1862,7 +1862,7 @@ } }, "412": { - "description": "- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.\n- `human_input_form_expired` : The form's expiration time passed before submission arrived.", + "description": "- `human_input_form_submitted`：表单已提交。表单是一次性的；无论哪个用户提交，第一个响应获胜。\n- `human_input_form_expired`：表单在提交到达前已过期。", "content": { "application/json": { "examples": { @@ -1892,10 +1892,10 @@ "/workflow/{task_id}/events": { "get": { "tags": [ - "工作流" + "Workflows" ], - "summary": "流式获取工作流事件", - "description": "在工作流运行暂停或原始 SSE 连接断开后恢复 Server-Sent Events 流。对于已结束的运行，流仅发送单个 `workflow_finished` 事件后关闭。", + "summary": "获取工作流事件流", + "description": "在暂停或 SSE 连接断开后恢复工作流运行的 Server-Sent Events 流。对于已完成的运行，流将发出单个 `workflow_finished` 事件然后关闭。", "operationId": "streamWorkflowEvents", "parameters": [ { @@ -1915,7 +1915,7 @@ "schema": { "type": "string" }, - "description": "最初触发该运行的终端用户标识。必须与工作流运行的创建者一致。" + "description": "最初触发运行的终端用户标识符。必须与工作流运行的创建者匹配。" }, { "name": "include_state_snapshot", @@ -1925,7 +1925,7 @@ "type": "boolean", "default": false }, - "description": "为 `true` 时，从持久化状态快照重放，在流式发送新事件前附带已执行节点的状态摘要。" + "description": "当为 `true` 时，从持久化状态快照重放，以在流式传输新事件之前包含已执行节点的状态摘要。" }, { "name": "continue_on_pause", @@ -1935,12 +1935,12 @@ "type": "boolean", "default": false }, - "description": "设为 `true` 时，流会在多次 `workflow_paused` 事件之间保持打开（适用于工作流包含多个连续人工介入节点的场景）。默认在首次暂停时关闭流。" + "description": "设置为 `true` 以在多个 `workflow_paused` 事件之间保持流开启（当工作流有多个连续的人工介入节点时很有用）。默认在第一次暂停后关闭流。" } ], "responses": { "200": { - "description": "Server-Sent Events 流。每个事件以 `data: {JSON}\\n\\n` 形式送达。事件载荷结构与原始流式响应一致。", + "description": "Server-Sent Events 流。每个事件以 `data: {JSON}\\n\\n` 的形式传递。事件负载遵循与原始流式响应相同的模式。", "content": { "text/event-stream": { "schema": { @@ -1951,7 +1951,7 @@ } }, "400": { - "description": "`not_workflow_app` : Please check if your app mode matches the right API route.", + "description": "`not_workflow_app`：请检查您的应用模式是否与正确的 API 路由匹配。", "content": { "application/json": { "examples": { @@ -1968,7 +1968,7 @@ } }, "404": { - "description": "`not_found` : Workflow run not found.", + "description": "`not_found`：未找到工作流运行记录。", "content": { "application/json": { "examples": { @@ -1994,7 +1994,7 @@ "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", - "description": "API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上 `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**" + "description": "API Key 认证。对于所有 API 请求，在 `Authorization` HTTP 头中包含您的 API Key，并加上 `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将您的 API Key 存储在服务器端，不要在客户端共享或存储，以避免可能导致严重后果的 API Key 泄露。**" } }, "responses": { @@ -2036,7 +2036,7 @@ "properties": { "inputs": { "type": "object", - "description": "工作流输入变量的键值对。文件类型变量的值应为文件对象数组，包含 `type`、`transfer_method` 以及 `url` 或 `upload_file_id`。请参阅 [获取应用参数](/api-reference/应用配置/获取应用参数) 响应中的 `user_input_form` 字段，以了解应用所需的变量名称和类型。", + "description": "工作流输入变量的键值对。文件类型变量的值应为包含 `type`、`transfer_method` 以及 `url` 或 `upload_file_id` 的文件对象数组。请参考 [获取应用参数](/api-reference/applications/get-app-parameters) 响应中的 `user_input_form` 字段来了解应用期望的变量名称和类型。", "additionalProperties": { "oneOf": [ { @@ -2066,11 +2066,11 @@ "streaming", "blocking" ], - "description": "响应模式。使用 `blocking` 获取同步响应（Cloudflare 超时时间为 `100 s`），使用 `streaming` 获取服务器发送事件。未指定时默认为阻塞模式。" + "description": "响应模式。使用 `blocking` 进行同步响应（Cloudflare 超时为 `100 秒`），或使用 `streaming` 进行 Server-Sent Events。省略时默认为阻塞式返回行为。" }, "user": { "type": "string", - "description": "用户标识符，由开发者自定义规则，在应用内必须唯一。此标识符用于限定数据访问范围——工作流运行和文件仅在使用相同的 `user` 值查询时可见。" + "description": "用户标识符，由开发者的规则定义，必须在应用内唯一。此标识符限定数据访问范围 — 工作流运行和文件仅在使用相同 `user` 值查询时可见。" }, "files": { "type": "array", @@ -2078,7 +2078,7 @@ "$ref": "#/components/schemas/InputFileObject" }, "nullable": true, - "description": "文件列表。适用于需要将文件与文本组合输入的场景，仅在模型支持 Vision 能力时可用。要附加本地文件，请先通过 [上传文件](/api-reference/文件操作/上传文件) 上传，然后将返回的 `id` 作为 `upload_file_id`，并设置 `transfer_method: local_file`。" + "description": "文件列表。适用于需要将文件与文本组合输入的情况，仅在模型支持视觉能力时可用。要附加本地文件，请先通过 [上传文件](/api-reference/files/upload-file) 上传并使用返回的 `id` 作为 `upload_file_id`，配合 `transfer_method: local_file`。" } } }, @@ -2106,7 +2106,7 @@ "remote_url", "local_file" ], - "description": "传输方式：文件 URL 使用 `remote_url`，上传文件使用 `local_file`。" + "description": "传输方式：`remote_url` 用于文件 URL，`local_file` 用于已上传的文件。" }, "url": { "type": "string", @@ -2115,7 +2115,7 @@ }, "upload_file_id": { "type": "string", - "description": "通过 [上传文件](/api-reference/文件操作/上传文件) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时使用）。" + "description": "从 [上传文件](/api-reference/files/upload-file) API 获取的已上传文件 ID（当 `transfer_method` 为 `local_file` 时）。" } } }, @@ -2125,12 +2125,12 @@ "task_id": { "type": "string", "format": "uuid", - "description": "进行中的执行任务 ID。配合 [停止工作流任务](/api-reference/工作流/停止-工作流-任务) 使用以取消运行中的工作流。仅在执行期间有效。" + "description": "正在进行的执行的任务 ID。与 [停止工作流任务](/api-reference/workflows/stop-workflow-task) 一起使用可取消正在运行的工作流。仅在执行期间有效。" }, "workflow_run_id": { "type": "string", "format": "uuid", - "description": "此工作流运行记录的持久化标识符。配合 [获取工作流运行详情](/api-reference/工作流/获取-工作流-执行情况) 使用以在执行后获取结果。" + "description": "此工作流运行记录的持久化标识符。与 [获取工作流运行详情](/api-reference/workflows/get-workflow-run-detail) 一起使用可在执行后获取结果。" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedData" @@ -2145,6 +2145,7 @@ "properties": { "event": { "type": "string", + "description": "流式事件的类型。", "enum": [ "workflow_started", "node_started", @@ -2168,8 +2169,7 @@ "human_input_form_timeout", "error", "ping" - ], - "description": "流式事件的类型。" + ] } }, "discriminator": { @@ -2206,12 +2206,12 @@ "task_id": { "type": "string", "format": "uuid", - "description": "进行中的执行任务 ID。配合 [停止工作流任务](/api-reference/工作流/停止-工作流-任务) 使用以取消运行中的工作流。仅在执行期间有效。" + "description": "正在进行的执行的任务 ID。与 [停止工作流任务](/api-reference/workflows/stop-workflow-task) 一起使用可取消正在运行的工作流。仅在执行期间有效。" }, "workflow_run_id": { "type": "string", "format": "uuid", - "description": "此工作流运行记录的持久化标识符。配合 [获取工作流运行详情](/api-reference/工作流/获取-工作流-执行情况) 使用以在执行后获取结果。" + "description": "此工作流运行记录的持久化标识符。与 [获取工作流运行详情](/api-reference/workflows/get-workflow-run-detail) 一起使用可在执行后获取结果。" } } }, @@ -2237,12 +2237,12 @@ "workflow_id": { "type": "string", "format": "uuid", - "description": "工作流 ID." + "description": "工作流 ID。" }, "inputs": { "type": "object", "additionalProperties": true, - "description": "本次工作流运行的输入变量。" + "description": "此工作流运行的输入变量。" }, "created_at": { "type": "integer", @@ -2251,7 +2251,7 @@ }, "reason": { "type": "string", - "description": "工作流启动原因。`initial` 表示新执行，`resumption` 表示从暂停状态恢复。" + "description": "工作流启动的原因。`initial` 表示新执行，`resumption` 表示从暂停状态恢复。" } } } @@ -2292,18 +2292,18 @@ }, "index": { "type": "integer", - "description": "执行序列索引。" + "description": "执行顺序索引。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID（如有）。" + "description": "前置节点的 ID（如有）。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "该节点的输入变量。" + "description": "此节点的输入变量。" }, "inputs_truncated": { "type": "boolean", @@ -2322,12 +2322,12 @@ "iteration_id": { "type": "string", "nullable": true, - "description": "如果该节点在迭代内运行，则为父迭代 ID。" + "description": "如果此节点在迭代内运行，则为父迭代 ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "如果该节点在循环内运行，则为父循环 ID。" + "description": "如果此节点在循环内运行，则为父循环 ID。" } } } @@ -2360,7 +2360,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -2368,18 +2368,18 @@ }, "index": { "type": "integer", - "description": "执行序列索引。" + "description": "执行顺序索引。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID（如有）。" + "description": "前置节点的 ID（如有）。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "该节点的输入变量。" + "description": "此节点的输入变量。" }, "inputs_truncated": { "type": "boolean", @@ -2417,28 +2417,28 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "耗时（秒）。" + "description": "已用时间（秒）。" }, "execution_metadata": { "type": "object", "nullable": true, - "description": "执行元数据，包含令牌用量。", + "description": "包含 token 使用量的执行元数据。", "properties": { "total_tokens": { "type": "integer", "nullable": true, - "description": "该节点消耗的总令牌数。" + "description": "此节点消耗的总 token 数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, - "description": "该节点执行的总费用。" + "description": "此节点执行的总成本。" }, "currency": { "type": "string", "nullable": true, - "description": "费用货币（例如 `USD`）。" + "description": "成本货币（例如 `USD`）。" } } }, @@ -2450,7 +2450,7 @@ "finished_at": { "type": "integer", "format": "int64", - "description": "节点执行结束时的 Unix 时间戳。" + "description": "节点执行完成时的 Unix 时间戳。" }, "files": { "type": "array", @@ -2459,17 +2459,17 @@ "type": "object", "additionalProperties": true }, - "description": "该节点生成的文件。" + "description": "此节点生成的文件。" }, "iteration_id": { "type": "string", "nullable": true, - "description": "如果该节点在迭代内运行，则为父迭代 ID。" + "description": "如果此节点在迭代内运行，则为父迭代 ID。" }, "loop_id": { "type": "string", "nullable": true, - "description": "如果该节点在循环内运行，则为父循环 ID。" + "description": "如果此节点在循环内运行，则为父循环 ID。" } } } @@ -2502,7 +2502,7 @@ }, "node_type": { "type": "string", - "description": "Node type." + "description": "节点类型。" }, "title": { "type": "string", @@ -2510,12 +2510,12 @@ }, "index": { "type": "integer", - "description": "执行序列索引。" + "description": "执行顺序索引。" }, "predecessor_node_id": { "type": "string", "nullable": true, - "description": "前驱节点的 ID（如有）。" + "description": "前置节点的 ID（如有）。" }, "inputs": { "type": "object", @@ -2547,7 +2547,7 @@ }, "status": { "type": "string", - "description": "重试点的节点执行状态。" + "description": "重试时的节点执行状态。" }, "error": { "type": "string", @@ -2557,7 +2557,7 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "耗时（秒）。" + "description": "已用时间（秒）。" }, "created_at": { "type": "integer", @@ -2569,7 +2569,7 @@ }, "retry_index": { "type": "integer", - "description": "从零开始的重试次数索引。" + "description": "从零开始的重试尝试索引。" }, "iteration_id": { "type": "string", @@ -2591,7 +2591,7 @@ "type": "object", "additionalProperties": true }, - "description": "节点在执行期间生成的文件。" + "description": "节点执行期间生成的文件。" } } } @@ -2778,7 +2778,7 @@ "execution_metadata": { "type": "object", "additionalProperties": true, - "description": "执行元数据，包含令牌用量。" + "description": "包含 token 使用量的执行元数据。" }, "finished_at": { "type": "integer", @@ -2970,7 +2970,7 @@ "execution_metadata": { "type": "object", "additionalProperties": true, - "description": "执行元数据，包含令牌用量。" + "description": "包含 token 使用量的执行元数据。" }, "finished_at": { "type": "integer", @@ -3002,7 +3002,7 @@ "properties": { "text": { "type": "string", - "description": "文本内容块。" + "description": "文本内容片段。" }, "from_variable_selector": { "type": "array", @@ -3074,12 +3074,12 @@ "audio": { "type": "string", "format": "byte", - "description": "Base64 编码的 MP3 音频块。按顺序解码并拼接所有块即可生成完整的音频文件。" + "description": "Base64 编码的 MP3 音频片段。解码并按顺序连接所有片段以生成完整的音频文件。" }, "created_at": { "type": "integer", "format": "int64", - "description": "该音频块生成时的 Unix 时间戳。" + "description": "此音频片段生成时的 Unix 时间戳。" } } } @@ -3098,7 +3098,7 @@ "properties": { "audio": { "type": "string", - "description": "空字符串。标识音频流结束。" + "description": "空字符串。表示音频流结束。" }, "created_at": { "type": "integer", @@ -3126,11 +3126,11 @@ }, "code": { "type": "string", - "description": "错误码。" + "description": "错误代码。" }, "message": { "type": "string", - "description": "错误信息。" + "description": "错误消息。" } } } @@ -3143,7 +3143,7 @@ }, { "type": "object", - "description": "保活 ping 事件。无附加属性。" + "description": "保持活跃的 ping 事件。无附加属性。" } ] }, @@ -3158,11 +3158,11 @@ "workflow_id": { "type": "string", "format": "uuid", - "description": "工作流 ID." + "description": "工作流 ID。" }, "status": { "type": "string", - "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" + "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行遇到错误，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他节点失败，`paused` 表示等待人工介入。" }, "outputs": { "type": "object", @@ -3182,11 +3182,11 @@ }, "total_tokens": { "type": "integer", - "description": "所有节点消耗的总令牌数。" + "description": "所有节点消耗的总 token 数。" }, "total_steps": { "type": "integer", - "description": "已执行的工作流总步数。" + "description": "执行的工作流步骤总数。" }, "created_at": { "type": "integer", @@ -3197,17 +3197,17 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "工作流运行结束时的 Unix 时间戳。" + "description": "工作流运行完成时的 Unix 时间戳。" }, "created_by": { "type": "object", "additionalProperties": true, - "description": "创建者信息。仅存在于流式 `workflow_finished` 事件中。" + "description": "创建者信息。仅在流式 `workflow_finished` 事件中出现。" }, "exceptions_count": { "type": "integer", "nullable": true, - "description": "执行过程中遇到的异常数量。仅在流式 `workflow_finished` 事件中出现。" + "description": "执行期间遇到的异常数量。仅在流式 `workflow_finished` 事件中出现。" }, "files": { "type": "array", @@ -3216,7 +3216,7 @@ "additionalProperties": true }, "nullable": true, - "description": "工作流执行期间生成的文件。仅存在于流式 `workflow_finished` 事件中。" + "description": "工作流执行期间生成的文件。仅在流式 `workflow_finished` 事件中出现。" } } }, @@ -3231,11 +3231,11 @@ "workflow_id": { "type": "string", "format": "uuid", - "description": "工作流 ID." + "description": "工作流 ID。" }, "status": { "type": "string", - "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" + "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行遇到错误，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他节点失败，`paused` 表示等待人工介入。" }, "inputs": { "type": "object", @@ -3255,11 +3255,11 @@ }, "total_steps": { "type": "integer", - "description": "已执行的工作流总步数。" + "description": "执行的工作流步骤总数。" }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的总 token 数。" }, "created_at": { "type": "integer", @@ -3270,7 +3270,7 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "工作流运行结束时的 Unix 时间戳。" + "description": "工作流运行完成时的 Unix 时间戳。" }, "elapsed_time": { "type": "number", @@ -3336,19 +3336,19 @@ "type": "string", "format": "uuid", "nullable": true, - "description": "关联的用户 ID。" + "description": "关联用户的 ID。" }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的租户 ID。" + "description": "关联租户的 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true, - "description": "关联的会话 ID。" + "description": "关联对话的 ID。" }, "file_key": { "type": "string", @@ -3378,12 +3378,12 @@ }, "type": { "type": "string", - "description": "终端用户类型。Service API 用户固定为 `service_api`。" + "description": "终端用户类型。Service API 用户始终为 `service_api`。" }, "external_user_id": { "type": "string", "nullable": true, - "description": "API 请求中提供的 `user` 标识符（例如 [发送对话消息](/api-reference/对话消息/发送对话消息) 中的 `user` 字段）。" + "description": "API 请求中提供的 `user` 标识符（例如 [发送聊天消息](/api-reference/chats/send-chat-message) 中的 `user` 字段）。" }, "name": { "type": "string", @@ -3392,11 +3392,11 @@ }, "is_anonymous": { "type": "boolean", - "description": "用户是否为匿名用户。当原始 API 请求中未提供 `user` 标识符时，值为 `true`。" + "description": "用户是否匿名。当原始 API 请求中未提供 `user` 标识符时为 `true`。" }, "session_id": { "type": "string", - "description": "会话标识符。默认为 `external_user_id` 的值。" + "description": "会话标识符。默认为 `external_user_id` 值。" }, "created_at": { "type": "string", @@ -3427,7 +3427,7 @@ }, "has_more": { "type": "boolean", - "description": "是否有更多可用页面。" + "description": "是否有更多页面可用。" }, "data": { "type": "array", @@ -3460,7 +3460,7 @@ "created_by_account": { "type": "object", "nullable": true, - "description": "由管理员用户创建时的账户详情。", + "description": "如果由管理员用户创建，则为账户详情。", "properties": { "id": { "type": "string", @@ -3507,7 +3507,7 @@ }, "status": { "type": "string", - "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。" + "description": "工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行遇到错误，`stopped` 表示手动停止，`partial-succeeded` 表示部分节点成功但其他节点失败，`paused` 表示等待人工介入。" }, "error": { "type": "string", @@ -3521,11 +3521,11 @@ }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的总 token 数。" }, "total_steps": { "type": "integer", - "description": "已执行的工作流总步数。" + "description": "执行的工作流步骤总数。" }, "created_at": { "type": "integer", @@ -3536,7 +3536,7 @@ "type": "integer", "format": "int64", "nullable": true, - "description": "工作流运行结束时的 Unix 时间戳。" + "description": "工作流运行完成时的 Unix 时间戳。" }, "exceptions_count": { "type": "integer", @@ -3544,7 +3544,7 @@ }, "triggered_from": { "type": "string", - "description": "触发工作流运行的来源。`debugging` 表示从编辑器发起的测试运行，`app` 表示 API 或应用发起的运行。" + "description": "触发工作流运行的来源。`debugging` 表示来自编辑器的测试运行，`app` 表示 API 或应用发起的运行。" } } }, @@ -3562,7 +3562,7 @@ }, "is_anonymous": { "type": "boolean", - "description": "终端用户是否为匿名。" + "description": "终端用户是否匿名。" }, "session_id": { "type": "string", @@ -3572,7 +3572,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "语音转文字的请求体。", + "description": "音频转文字的请求体。", "required": [ "file" ], @@ -3580,7 +3580,7 @@ "file": { "type": "string", "format": "binary", - "description": "音频文件。支持格式：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。大小限制：`30 MB`。" + "description": "音频文件。支持：`mp3`、`mp4`、`mpeg`、`mpga`、`m4a`、`wav`、`webm`。限制：`30 MB`。" }, "user": { "type": "string", @@ -3593,18 +3593,18 @@ "properties": { "text": { "type": "string", - "description": "语音识别输出的文字。" + "description": "语音识别的输出文本。" } } }, "TextToAudioRequest": { "type": "object", - "description": "文字转语音的请求体。提供 `message_id` 或 `text` 其中之一。", + "description": "文字转音频的请求体。提供 `message_id` 或 `text` 之一。", "properties": { "message_id": { "type": "string", "format": "uuid", - "description": "消息 ID。当同时提供 `text` 时，优先使用消息 ID。" + "description": "消息 ID。当两者都提供时优先于 `text`。" }, "text": { "type": "string", @@ -3616,7 +3616,7 @@ }, "voice": { "type": "string", - "description": "文字转语音使用的声音。可用声音取决于为此应用配置的 TTS 提供商。使用[获取应用参数](/api-reference/应用配置/获取应用参数) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" + "description": "用于文字转语音的声音。可用声音取决于为此应用配置的 TTS 提供商。使用 [获取应用参数](/api-reference/applications/get-app-parameters) → `text_to_speech.voice` 中的 `voice` 值作为默认值。" }, "streaming": { "type": "boolean", @@ -3644,7 +3644,7 @@ }, "mode": { "type": "string", - "description": "应用模式。`completion` 为文本生成应用，`chat` 为基础对话应用，`agent-chat` 为 Agent 应用，`advanced-chat` 为对话流应用，`workflow` 为工作流应用。" + "description": "应用模式。`completion` 用于文本生成应用，`chat` 用于基础聊天应用，`agent-chat` 用于基于 Agent 的应用，`advanced-chat` 用于 Chatflow 应用，`workflow` 用于工作流应用。" }, "author_name": { "type": "string", @@ -3697,17 +3697,17 @@ }, "voice": { "type": "string", - "description": "TTS 声音标识符。" + "description": "TTS 的声音标识符。" }, "language": { "type": "string", - "description": "TTS 语言。" + "description": "TTS 的语言。" } } }, "retriever_resource": { "type": "object", - "description": "知识检索引用资源配置。", + "description": "知识库检索引用资源配置。", "properties": { "enabled": { "type": "boolean", @@ -3727,7 +3727,7 @@ }, "more_like_this": { "type": "object", - "description": "更多类似推荐功能配置。", + "description": "更多类似功能配置。", "properties": { "enabled": { "type": "boolean", @@ -3751,7 +3751,7 @@ "type": "object", "oneOf": [ { - "title": "Text Input", + "title": "文本输入", "type": "object", "properties": { "text-input": { @@ -3763,11 +3763,11 @@ }, "variable": { "type": "string", - "description": "工作流中使用的变量名称。" + "description": "工作流中使用的变量名。" }, "required": { "type": "boolean", - "description": "该字段是否必填。" + "description": "此字段是否必填。" }, "default": { "type": "string", @@ -3778,7 +3778,7 @@ } }, { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -3790,11 +3790,11 @@ }, "variable": { "type": "string", - "description": "工作流中使用的变量名称。" + "description": "工作流中使用的变量名。" }, "required": { "type": "boolean", - "description": "该字段是否必填。" + "description": "此字段是否必填。" }, "default": { "type": "string", @@ -3805,7 +3805,7 @@ } }, { - "title": "Select", + "title": "下拉选项", "type": "object", "properties": { "select": { @@ -3813,19 +3813,19 @@ "properties": { "label": { "type": "string", - "description": "下拉选择字段的显示标签。" + "description": "下拉选项字段的显示标签。" }, "variable": { "type": "string", - "description": "工作流中使用的变量名称。" + "description": "工作流中使用的变量名。" }, "required": { "type": "boolean", - "description": "该字段是否必填。" + "description": "此字段是否必填。" }, "default": { "type": "string", - "description": "默认选中的值。" + "description": "默认选中值。" }, "options": { "type": "array", @@ -3851,11 +3851,11 @@ "properties": { "enabled": { "type": "boolean", - "description": "是否启用图片上传。" + "description": "是否启用图像上传。" }, "number_limits": { "type": "integer", - "description": "可上传的最大图片数量。" + "description": "可上传图像的最大数量。" }, "detail": { "type": "string", @@ -3866,7 +3866,7 @@ "items": { "type": "string" }, - "description": "图片上传允许的传输方式。`remote_url` 表示通过文件 URL 上传，`local_file` 表示上传本地文件。" + "description": "图像上传允许的传输方式。`remote_url` 用于文件 URL，`local_file` 用于已上传的文件。" } } } @@ -3878,19 +3878,19 @@ "properties": { "file_size_limit": { "type": "integer", - "description": "常规文件最大大小（MB）。" + "description": "常规文件的最大大小（MB）。" }, "image_file_size_limit": { "type": "integer", - "description": "最大图片文件大小（MB）。" + "description": "图像文件的最大大小（MB）。" }, "audio_file_size_limit": { "type": "integer", - "description": "最大音频文件大小（MB）。" + "description": "音频文件的最大大小（MB）。" }, "video_file_size_limit": { "type": "integer", - "description": "最大视频文件大小（MB）。" + "description": "视频文件的最大大小（MB）。" }, "workflow_file_upload_limit": { "type": "integer", @@ -3921,7 +3921,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "图标 URL", "type": "string", "format": "url", "description": "图标的 URL。" @@ -3944,19 +3944,19 @@ }, "chat_color_theme": { "type": "string", - "description": "聊天主题颜色。" + "description": "聊天颜色主题。" }, "chat_color_theme_inverted": { "type": "boolean", - "description": "聊天主题颜色是否反转。" + "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", - "description": "使用的图标类型。`emoji` 为表情图标，`image` 为上传的图片图标。" + "description": "使用的图标类型。`emoji` 用于表情符号图标，`image` 用于上传的图像图标。" }, "icon": { "type": "string", - "description": "图标内容（表情或图片 ID）。" + "description": "图标内容（表情符号或图像 ID）。" }, "icon_background": { "type": "string", @@ -3966,7 +3966,7 @@ "type": "string", "format": "url", "nullable": true, - "description": "图标图片的 URL。" + "description": "图标图像的 URL。" }, "description": { "type": "string", @@ -4015,14 +4015,14 @@ "workflow_run_id": { "type": "string", "format": "uuid", - "description": "此工作流运行记录的持久化标识符。配合 [获取工作流运行详情](/api-reference/工作流/获取-工作流-执行情况) 使用以在执行后获取结果。" + "description": "此工作流运行记录的持久化标识符。与 [获取工作流运行详情](/api-reference/workflows/get-workflow-run-detail) 一起使用可在执行后获取结果。" }, "paused_nodes": { "type": "array", "items": { "type": "string" }, - "description": "已暂停的节点 ID 列表。" + "description": "暂停的节点 ID 列表。" }, "outputs": { "type": "object", @@ -4053,7 +4053,7 @@ }, "total_tokens": { "type": "integer", - "description": "消耗的总令牌数。" + "description": "消耗的总 token 数。" }, "total_steps": { "type": "integer", @@ -4089,7 +4089,7 @@ }, "label": { "type": "string", - "description": "Log label." + "description": "日志标签。" }, "parent_id": { "type": "string", @@ -4117,7 +4117,7 @@ }, "node_id": { "type": "string", - "description": "Node ID." + "description": "节点 ID。" } } } @@ -4141,19 +4141,19 @@ "properties": { "form_id": { "type": "string", - "description": "表单实例的标识符，会在错误消息和日志中出现。Service API 调用请使用 `form_token`。" + "description": "表单实例的标识符，在错误消息和日志中显示。Service API 调用请使用 `form_token`。" }, "node_id": { "type": "string", - "description": "产生该表单的 Human Input 节点 ID。" + "description": "生成此表单的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "form_content": { "type": "string", - "description": "已替换工作流变量的预渲染表单正文。" + "description": "预渲染的表单主体，已替换工作流变量。" }, "inputs": { "type": "array", @@ -4162,27 +4162,27 @@ "properties": { "type": { "type": "string", - "description": "表单输入控件类型。可用值：`text_input`（单行文本输入框）和 `paragraph`（多行文本区域）。" + "description": "表单输入控件类型。可用值：`text_input`（单行文本字段）和 `paragraph`（多行文本区域）。" }, "output_variable_name": { "type": "string", - "description": "引用该输入提交值在工作流中使用的变量名。对应提交 `inputs` 对象中的键。" + "description": "用于在工作流中引用此输入提交值的变量名。对应提交 `inputs` 对象中的键。" }, "default": { "type": "object", "nullable": true, - "description": "从工作流上下文解析得到的默认值。未配置默认值时为 `null`。", + "description": "从工作流上下文解析的默认值。未配置默认值时为 `null`。", "properties": { "type": { "type": "string", - "description": "默认值来源。`constant` 表示将 `value` 作为字面字符串；`variable` 表示 `selector` 指向工作流变量。" + "description": "默认值的来源。`constant` 表示 `value` 用作字面字符串；`variable` 表示 `selector` 指向工作流变量。" }, "selector": { "type": "array", "items": { "type": "string" }, - "description": "当 `type` 为 `variable` 时，变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。至少包含两个元素。" + "description": "当 `type` 为 `variable` 时的变量引用路径（例如 `[\"node_id\", \"var_name\"]`）。必须包含至少两个元素。" }, "value": { "type": "string", @@ -4192,7 +4192,7 @@ } } }, - "description": "接收者需要填写的表单输入字段。" + "description": "接收者填写的表单输入字段。" }, "actions": { "type": "array", @@ -4203,41 +4203,41 @@ "type": "string", "maxLength": 20, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", - "description": "操作按钮的标识。当接收者选择该按钮时，作为 `action` 传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单)。" + "description": "操作按钮的标识符。当接收者选择此按钮时，在 [提交人工介入表单](/api-reference/human-input/submit-human-input-form) 中作为 `action` 传递。" }, "title": { "type": "string", "maxLength": 100, - "description": "显示给接收者的按钮文本。" + "description": "显示给接收者的按钮标签。" }, "button_style": { "type": "string", - "description": "按钮视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" + "description": "按钮的视觉样式。可用值：`primary`、`default`、`accent`、`ghost`。" } } }, - "description": "接收者提交时可选择的用户操作（按钮）。" + "description": "接收者提交时可选择的可用用户操作（按钮）。" }, "display_in_ui": { "type": "boolean", - "description": "表单是否也在 Dify 控制台中显示。" + "description": "表单是否也在 Dify 控制台 UI 中显示。" }, "form_token": { "type": "string", "nullable": true, - "description": "[获取人工介入表单](/api-reference/人工介入/获取人工介入表单) 和 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单) 的访问令牌。当人工介入节点使用邮件或控制台送达时为 `null`（Service API 仅能处理 WebApp 送达的表单）。" + "description": "用于 [获取人工介入表单](/api-reference/human-input/get-human-input-form) 和 [提交人工介入表单](/api-reference/human-input/submit-human-input-form) 的访问令牌。当人工介入节点使用邮件或控制台交付方式时为 `null`（Service API 只能操作 WebApp 交付的表单）。" }, "resolved_default_values": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "按输入的 `output_variable_name` 分组的预填充默认值。所有值均为字符串。" + "description": "表单输入的预填充默认值，以输入的 `output_variable_name` 为键。所有值都已字符串化。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），超过后表单无法再被提交。" + "description": "Unix 时间戳（秒），此后表单将无法再提交。" } } } @@ -4261,19 +4261,19 @@ "properties": { "node_id": { "type": "string", - "description": "表单被填写的 Human Input 节点 ID。" + "description": "表单已填写的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "rendered_content": { "type": "string", - "description": "包含接收者提交值的渲染后表单内容（`human_input_required` 上的 `form_content` 是未填写的模板）。" + "description": "使用接收者提交值渲染的表单主体（`human_input_required` 上的 `form_content` 是未填写的模板）。" }, "action_id": { "type": "string", - "description": "接收者所选操作的标识（与传入 [提交人工介入表单](/api-reference/人工介入/提交人工介入表单) 的 `action` 一致）。" + "description": "接收者选择的操作标识符（与传递给 [提交人工介入表单](/api-reference/human-input/submit-human-input-form) 的 `action` 值匹配）。" }, "action_text": { "type": "string", @@ -4301,16 +4301,16 @@ "properties": { "node_id": { "type": "string", - "description": "表单过期的 Human Input 节点 ID。" + "description": "表单已过期的人工介入节点的 ID。" }, "node_title": { "type": "string", - "description": "Human Input 节点的显示标题。" + "description": "人工介入节点的显示标题。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "Unix 时间戳（秒），表示表单过期时刻。" + "description": "表单过期时的 Unix 时间戳（秒）。" } } } @@ -4322,28 +4322,28 @@ }, "tags": [ { - "name": "工作流", - "description": "用于执行和管理工作流的操作。" + "name": "Workflows", + "description": "执行和管理工作流的操作。" }, { - "name": "文件操作", + "name": "Files", "description": "文件上传和下载操作。" }, { - "name": "终端用户", - "description": "终端用户信息相关操作。" + "name": "End Users", + "description": "与终端用户信息相关的操作。" }, { - "name": "语音与文字转换", - "description": "语音转文字和文字转语音转换。" + "name": "TTS", + "description": "音频转文字和文字转音频转换。" }, { - "name": "应用配置", + "name": "Applications", "description": "应用设置、参数和元数据。" }, { - "name": "人工介入", - "description": "暂停等待人工输入的工作流恢复操作。" + "name": "Human Input", + "description": "用于恢复需要人工介入的暂停工作流的端点。" } ] -} +} \ No newline at end of file