From 10d145779fbe5cc2623d88539481562d9bfaed46 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 27 May 2026 07:53:23 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=90=20Initial=20translations=20for=20P?= =?UTF-8?q?R=20#794?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Auto-generated translations for documentation changes in PR #794. Last-Processed-Commit: 383b0988e4eab7beb67b871cafb13a4eb0c50464 Original-PR: #794 Languages: Chinese (zh), Japanese (ja) 🀖 Generated with GitHub Actions --- ja/api-reference/openapi_chat.json | 710 ++++++------ ja/api-reference/openapi_chatflow.json | 1326 +++++++++++----------- ja/api-reference/openapi_completion.json | 438 +++---- ja/api-reference/openapi_workflow.json | 768 ++++++------- zh/api-reference/openapi_chat.json | 652 +++++------ zh/api-reference/openapi_chatflow.json | 1046 ++++++++--------- zh/api-reference/openapi_completion.json | 368 +++--- zh/api-reference/openapi_workflow.json | 572 +++++----- 8 files changed, 2940 insertions(+), 2940 deletions(-) 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