diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 0d9be3355..79bced5a8 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": "生成を停止", - "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされます。", - "operationId": "stopBasicChatMessageGenerationJa", + "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": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。" } } }, @@ -342,11 +342,11 @@ }, "/messages/{message_id}/suggested": { "get": { - "summary": "次の推奨質問を取得", - "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getBasicChatSuggestedQuestionsJa", + "summary": "次の候補質問を取得", + "description": "現在のメッセージに対する次の質問候補を取得します。", + "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": { @@ -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": { @@ -658,7 +658,7 @@ } }, "404": { - "description": "`file_not_found` : リクエストされたファイルが見つかりません。", + "description": "`file_not_found` : リクエストされたファイルが見つかりませんでした。", "content": { "application/json": { "examples": { @@ -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,11 +810,11 @@ }, "/app/feedbacks": { "get": { - "summary": "アプリのフィードバック一覧を取得", - "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者のフィードバックの両方が含まれます。", - "operationId": "getBasicChatAppFeedbacksJa", + "summary": "アプリフィードバック一覧を取得", + "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーションされたリストを取得します。エンドユーザーと管理者の両方のフィードバックが含まれます。", + "operationId": "getChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -893,10 +893,10 @@ "/conversations": { "get": { "summary": "会話一覧を取得", - "description": "現在のユーザーの会話リストを、最近アクティブな順に取得します。", - "operationId": "getBasicChatConversationsListJa", + "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": { @@ -1386,9 +1386,9 @@ "put": { "summary": "会話変数を更新", "description": "特定の会話変数の値を更新します。値は期待される型と一致する必要があります。", - "operationId": "updateChatConversationVariableJa", + "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": { @@ -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, @@ -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": { @@ -2038,10 +2038,10 @@ "/site": { "get": { "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", - "operationId": "getBasicChatWebAppSettingsJa", + "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,11 +2148,11 @@ } }, "get": { - "summary": "アノテーションリストを取得", - "description": "アプリケーションのアノテーションをページネーションリストで取得します。キーワード検索によるフィルタリングをサポートしています。", - "operationId": "listChatAnnotationsJa", + "summary": "アノテーション一覧を取得", + "description": "アプリケーションのアノテーションのページネーションされたリストを取得します。キーワード検索フィルタリングをサポートしています。", + "operationId": "getAnnotationList", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { @@ -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" @@ -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", @@ -2904,7 +2904,7 @@ }, "belongs_to": { "type": "string", - "description": "このファイルの所有者です。ツールが生成したファイルの場合は常に `assistant` です。" + "description": "このファイルの所有者。ツール生成ファイルの場合は常に `assistant`。" }, "url": { "type": "string", @@ -2930,12 +2930,12 @@ }, { "type": "object", - "description": "メッセージ終了イベント、ストリーミングが終了しました。", + "description": "メッセージ終了イベント。ストリーミングが終了しました。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージ ID。" }, "metadata": { "type": "object", @@ -2967,7 +2967,7 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", @@ -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", @@ -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,11 +3687,11 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "会話の名前変更用リクエストボディです。", + "description": "会話名を変更するためのリクエストボディ。", "properties": { "name": { "type": "string", - "description": "会話の名前です。`auto_generate` が `false` の場合は必須です。" + "description": "会話の名前。`auto_generate` が `false` の場合に必須。" }, "auto_generate": { "type": "boolean", @@ -3700,7 +3700,7 @@ }, "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,15 +3730,15 @@ "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", @@ -3746,7 +3746,7 @@ }, "description": { "type": "string", - "description": "変数の説明です。" + "description": "変数の説明。" }, "created_at": { "type": "integer", @@ -3762,7 +3762,7 @@ }, "ConversationVariableUpdateRequest": { "type": "object", - "description": "会話変数を更新するためのリクエストボディです。", + "description": "会話変数を更新するためのリクエストボディ。", "required": [ "value" ], @@ -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-chat`、チャットフローアプリの場合は `advanced-chat`。" }, "author_name": { "type": "string", @@ -3863,18 +3863,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", @@ -3902,7 +3902,7 @@ }, "voice": { "type": "string", - "description": "TTS の音声識別子。" + "description": "TTS のボイス識別子。" }, "language": { "type": "string", @@ -3910,13 +3910,13 @@ }, "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", @@ -3975,11 +3975,11 @@ }, "number_limits": { "type": "integer", - "description": "最大画像数。" + "description": "画像の最大数。" }, "detail": { "type": "string", - "description": "画像の詳細レベル。" + "description": "画像詳細レベル。" }, "transfer_methods": { "type": "array", @@ -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,74 +4063,74 @@ }, "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", "items": { "type": "string" }, - "description": "このフォームコントロールの選択可能な値のリスト。" + "description": "このフォームコントロールで選択可能な値のリスト。" } } }, @@ -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": "絵文字コンテンツ。" } } }, @@ -4188,11 +4188,11 @@ }, "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 0a792b889..7bd3c111d 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": [ - "チャットメッセージ" + "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` はチャットメッセージの終了を示しますが、`workflow_finished` や `workflow_paused` などのワークフローライフサイクルイベントでストリームが続く場合があります。ストリームは終端ワークフローイベントを受信したとき、または `error` イベントがストリームを終了したときに終了します。`ping` イベント（接続を維持するために10秒ごとに送信される）は無視してください。ストリーム内でエラーイベントが発生した場合でも、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}}}" }, "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}}" } } @@ -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` : テキスト生成に失敗しました。\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": { @@ -250,7 +250,7 @@ } }, "429": { - "description": "- `too_many_requests` : このアプリケーションへの同時リクエストが多すぎます。\n- `rate_limit_error` : アップストリームのモデルプロバイダーのレート制限を超えました。", + "description": "- `too_many_requests` : このアプリへの同時リクエストが多すぎます。\n- `rate_limit_error` : 上流モデルプロバイダーのレート制限を超過しました。", "content": { "application/json": { "examples": { @@ -296,18 +296,18 @@ }, "/chat-messages/{task_id}/stop": { "post": { - "summary": "生成を停止", - "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされます。", - "operationId": "stopChatflowMessageGenerationJp", + "summary": "チャットメッセージ生成を停止", + "description": "チャットメッセージ生成タスクを停止します。`streaming` モードでのみサポートされています。", + "operationId": "stopAdvancedChatMessageGeneration", "tags": [ - "チャットメッセージ" + "Chats" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, - "description": "タスク ID です。[チャットメッセージを送信](/api-reference/チャットメッセージ/チャットメッセージを送信) API のストリーミングチャンクレスポンスから取得できます。", + "description": "タスク ID。[チャットメッセージを送信](/ja/api-reference/chats/send-chat-message) API のストリーミングチャンク応答から取得できます。", "schema": { "type": "string" } @@ -325,7 +325,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡された user と一致する必要があります。" + "description": "ユーザー識別子。メッセージ送信インターフェースで渡したユーザーと一致している必要があります。" } } }, @@ -368,9 +368,9 @@ "get": { "summary": "次の推奨質問を取得", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getChatflowSuggestedQuestionsJp", + "operationId": "getAdvancedSuggestedQuestions", "tags": [ - "チャットメッセージ" + "Chats" ], "parameters": [ { @@ -394,7 +394,7 @@ ], "responses": { "200": { - "description": "提案された質問の取得に成功しました。", + "description": "推奨質問の取得に成功しました。", "content": { "application/json": { "schema": { @@ -417,7 +417,7 @@ } }, "400": { - "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 推奨質問機能が無効です。", + "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 推奨質問機能が無効になっています。", "content": { "application/json": { "examples": { @@ -480,14 +480,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": { @@ -500,7 +500,7 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイル。サポートされるタイプには画像、ドキュメント、音声、動画が含まれます。" + "description": "アップロードするファイル。画像、ドキュメント、音声、動画などのタイプがサポートされています。" }, "user": { "type": "string", @@ -513,7 +513,7 @@ }, "responses": { "201": { - "description": "ファイルが正常にアップロードされました。", + "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { @@ -544,7 +544,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": { @@ -577,7 +577,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズが超過しました。", "content": { "application/json": { "examples": { @@ -594,7 +594,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプが許可されていません。", "content": { "application/json": { "examples": { @@ -615,18 +615,18 @@ }, "/files/{file_id}/preview": { "get": { - "operationId": "previewChatflowFileJp", + "operationId": "previewChatFlowFile", "tags": [ - "ファイル操作" + "Files" ], "summary": "ファイルをダウンロード", - "description": "以前[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", + "description": "[ファイルをアップロード](/ja/api-reference/files/upload-file) API で以前にアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセスできます。", "parameters": [ { "name": "file_id", "in": "path", "required": true, - "description": "プレビューするファイルの一意の識別子です。[ファイルをアップロード](/api-reference/ファイル操作/ファイルをアップロード) API のレスポンスから取得します。", + "description": "プレビューするファイルの一意の識別子。[ファイルをアップロード](/ja/api-reference/files/upload-file) API レスポンスから取得します。", "schema": { "type": "string", "format": "uuid" @@ -636,7 +636,7 @@ "name": "as_attachment", "in": "query", "required": false, - "description": "`true` の場合、ブラウザでプレビューする代わりにファイルを添付ファイルとして強制ダウンロードします。", + "description": "`true` の場合、ブラウザでプレビューする代わりに添付ファイルとしてダウンロードを強制します。", "schema": { "type": "boolean", "default": false @@ -646,7 +646,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子。エンドユーザーのコンテキストに使用されます。", + "description": "ユーザー識別子。エンドユーザーコンテキストに使用されます。", "schema": { "type": "string" } @@ -654,7 +654,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": { @@ -682,7 +682,7 @@ } }, "404": { - "description": "`file_not_found` : リクエストされたファイルが見つかりません。", + "description": "`file_not_found` : リクエストされたファイルが見つかりませんでした。", "content": { "application/json": { "examples": { @@ -703,12 +703,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 を返す場合（例：[ファイルをアップロード](/ja/api-reference/files/upload-file) の `created_by`）に便利です。", "parameters": [ { "name": "end_user_id", @@ -723,7 +723,7 @@ ], "responses": { "200": { - "description": "エンドユーザーを正常に取得しました。", + "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { "schema": { @@ -771,12 +771,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", @@ -834,17 +834,17 @@ }, "/app/feedbacks": { "get": { - "operationId": "getChatflowAppFeedbacksJp", + "operationId": "getAdvancedChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], - "summary": "アプリのフィードバック一覧を取得", - "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページネーション付きリストを取得します。エンドユーザーと管理者のフィードバックの両方が含まれます。", + "summary": "アプリフィードバック一覧", + "description": "このアプリケーションのメッセージに対して送信されたすべてのフィードバックのページ分割されたリストを取得します。エンドユーザーと管理者の両方のフィードバックを含みます。", "parameters": [ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページネーション用のページ番号。", "required": false, "schema": { "type": "integer", @@ -916,11 +916,11 @@ }, "/conversations": { "get": { - "summary": "会話一覧を取得", - "description": "現在のユーザーの会話リストを、最近アクティブな順に取得します。", - "operationId": "getChatflowConversationsListJp", + "summary": "会話一覧", + "description": "現在のユーザーの会話リストを、最も最近アクティブな順に取得します。", + "operationId": "getAdvancedConversationsList", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -936,7 +936,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページネーション用）。", "schema": { "type": "string" } @@ -945,7 +945,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -957,7 +957,7 @@ "name": "sort_by", "in": "query", "required": false, - "description": "ソートフィールドです。降順にするには '-' プレフィックスを使用します。", + "description": "ソートフィールド。降順の場合は '-' プレフィックスを使用します。", "schema": { "type": "string", "enum": [ @@ -1021,7 +1021,7 @@ } }, "404": { - "description": "`not_found` : 前の会話が存在しません（無効な `last_id`）。", + "description": "`not_found` : 最後の会話が存在しません（無効な `last_id`）。", "content": { "application/json": { "examples": { @@ -1042,11 +1042,11 @@ }, "/messages": { "get": { - "summary": "会話履歴メッセージ一覧を取得", - "description": "スクロール読み込み形式で過去のチャット記録を返します。最初のページは最新の `limit` 件のメッセージを返します（時系列の逆順）。", - "operationId": "getChatflowConversationHistoryJp", + "summary": "会話メッセージ一覧", + "description": "スクロールロード形式でチャット履歴を返します。最初のページでは最新の `limit` 件のメッセージを返します（逆順）。", + "operationId": "getAdvancedConversationHistory", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1071,7 +1071,7 @@ "name": "first_id", "in": "query", "required": false, - "description": "現在のページの最初のチャット記録の ID です。デフォルトは `null`（最新のメッセージを取得）です。次のページを取得するには、現在のリストの最初のメッセージの ID を使用して、より古いメッセージを取得します。", + "description": "現在のページの最初のチャットレコードの ID。デフォルトは `null`（最新のメッセージを取得）。後続のページでは、現在のリストの最初のメッセージの ID を使用して古いメッセージを取得します。", "schema": { "type": "string" } @@ -1080,7 +1080,7 @@ "name": "limit", "in": "query", "required": false, - "description": "リクエストごとに返すチャット履歴メッセージの数です。", + "description": "リクエストごとに返すチャット履歴メッセージの数。", "schema": { "type": "integer", "default": 20, @@ -1177,11 +1177,11 @@ }, "/conversations/{conversation_id}/variables": { "get": { - "summary": "会話変数の取得", + "summary": "会話変数一覧", "description": "特定の会話から変数を取得します。", - "operationId": "getChatflowConversationVariablesJp", + "operationId": "getAdvancedConversationVariables", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1197,7 +1197,7 @@ "name": "user", "in": "query", "required": false, - "description": "ユーザー識別子です。", + "description": "ユーザー識別子。", "schema": { "type": "string" } @@ -1206,7 +1206,7 @@ "name": "last_id", "in": "query", "required": false, - "description": "現在のページの最後のレコードの ID（ページネーション用）です。", + "description": "現在のページの最後のレコードの ID（ページネーション用）。", "schema": { "type": "string" } @@ -1215,7 +1215,7 @@ "name": "limit", "in": "query", "required": false, - "description": "返すレコード数です。", + "description": "返すレコード数。", "schema": { "type": "integer", "default": 20, @@ -1227,7 +1227,7 @@ "name": "variable_name", "in": "query", "required": false, - "description": "指定した名前で変数をフィルタリングします。", + "description": "特定の名前で変数をフィルタリングします。", "schema": { "type": "string", "minLength": 1, @@ -1306,10 +1306,10 @@ "/conversations/{conversation_id}/name": { "post": { "summary": "会話の名前を変更", - "description": "会話の名前を変更するか、自動的に生成します。会話名は複数の会話をサポートするクライアントでの表示に使用されます。", - "operationId": "renameChatflowConversationJp", + "description": "会話の名前を変更するか、自動生成します。会話名は、複数の会話をサポートするクライアントでの表示に使用されます。", + "operationId": "renameAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1343,7 +1343,7 @@ }, "responses": { "200": { - "description": "会話が正常に名前変更されました。", + "description": "会話の名前変更に成功しました。", "content": { "application/json": { "schema": { @@ -1408,10 +1408,10 @@ "/conversations/{conversation_id}/variables/{variable_id}": { "put": { "summary": "会話変数を更新", - "description": "特定の会話変数の値を更新します。値は期待される型と一致する必要があります。", - "operationId": "updateChatflowConversationVariableJa", + "description": "特定の会話変数の値を更新します。値は期待されるタイプと一致する必要があります。", + "operationId": "updateChatflowConversationVariable", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1428,7 +1428,7 @@ "name": "variable_id", "in": "path", "required": true, - "description": "Variable ID.", + "description": "変数 ID。", "schema": { "type": "string", "format": "uuid" @@ -1456,7 +1456,7 @@ }, "responses": { "200": { - "description": "変数が正常に更新されました。", + "description": "変数の更新に成功しました。", "content": { "application/json": { "schema": { @@ -1480,7 +1480,7 @@ } }, "400": { - "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 変数値の型が一致しません。", + "description": "- `not_chat_app` : アプリモードが API ルートと一致しません。\n- `bad_request` : 変数値のタイプが一致しません。", "content": { "application/json": { "examples": { @@ -1536,9 +1536,9 @@ "delete": { "summary": "会話を削除", "description": "会話を削除します。", - "operationId": "deleteChatflowConversationJp", + "operationId": "deleteAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -1560,7 +1560,7 @@ "properties": { "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -1618,12 +1618,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": { @@ -1654,7 +1654,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": { @@ -1719,7 +1719,7 @@ } }, "413": { - "description": "`audio_too_large` : 音声ファイルサイズが上限を超えています。", + "description": "`audio_too_large` : 音声ファイルサイズが制限を超えました。", "content": { "application/json": { "examples": { @@ -1736,7 +1736,7 @@ } }, "415": { - "description": "`unsupported_audio_type` : 許可されていない音声タイプです。", + "description": "`unsupported_audio_type` : 音声タイプが許可されていません。", "content": { "application/json": { "examples": { @@ -1774,9 +1774,9 @@ }, "/text-to-audio": { "post": { - "operationId": "chatflowTextToAudioJp", + "operationId": "advancedTextToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "テキストを音声に変換", "description": "テキストを音声に変換します。", @@ -1803,7 +1803,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": { @@ -1814,7 +1814,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": { @@ -1884,12 +1884,12 @@ }, "/info": { "get": { - "operationId": "getChatflowAppInfoJp", + "operationId": "getAdvancedChatAppInfo", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションの基本情報を取得", - "description": "このアプリケーションの基本情報（名前、説明、タグ、モード）を取得します。", + "summary": "アプリ情報を取得", + "description": "このアプリケーションの基本情報（名前、説明、タグ、モードを含む）を取得します。", "responses": { "200": { "description": "アプリケーションの基本情報。", @@ -1903,7 +1903,7 @@ "summary": "レスポンス例", "value": { "name": "My Chatflow App", - "description": "便利なカスタマーサービスチャットボット。", + "description": "役立つカスタマーサービスチャットボット。", "tags": [ "customer-service", "chatbot" @@ -1921,12 +1921,12 @@ }, "/parameters": { "get": { - "operationId": "getChatflowAppParametersJp", + "operationId": "getAdvancedChatAppParameters", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのパラメータ情報を取得", - "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。", + "summary": "アプリパラメータを取得", + "description": "アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値を含む）を取得します。", "responses": { "200": { "description": "アプリケーションパラメータ情報。", @@ -2003,7 +2003,7 @@ } }, "400": { - "description": "`app_unavailable` : アプリケーションが利用できないか、設定が正しくありません。", + "description": "`app_unavailable` : アプリが利用不可または設定が不正です。", "content": { "application/json": { "examples": { @@ -2024,15 +2024,15 @@ }, "/meta": { "get": { - "operationId": "getChatflowAppMetaJp", + "operationId": "getAdvancedChatAppMeta", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリケーションのメタ情報を取得", - "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細）を取得します。", + "summary": "アプリメタを取得", + "description": "このアプリケーションのメタデータ（ツールアイコンやその他の設定詳細を含む）を取得します。", "responses": { "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", + "description": "アプリケーションメタ情報の取得に成功しました。", "content": { "application/json": { "schema": { @@ -2060,12 +2060,12 @@ }, "/site": { "get": { - "operationId": "getChatflowWebAppSettingsJp", + "operationId": "getAdvancedChatWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", + "summary": "アプリ WebApp 設定を取得", + "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプションを含む）を取得します。", "responses": { "200": { "description": "アプリケーションの WebApp 設定。", @@ -2078,14 +2078,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": "", @@ -2121,10 +2121,10 @@ "/apps/annotations": { "post": { "summary": "アノテーションを作成", - "description": "新しいアノテーションを作成します。アノテーションは、アプリがレスポンスを生成する代わりに直接マッチして返すことができる、事前定義された質問と回答のペアを提供します。", - "operationId": "createChatflowAnnotationJa", + "description": "新しいアノテーションを作成します。アノテーションは、アプリがレスポンスを生成する代わりに直接マッチして返すことができる事前定義された質問と回答のペアを提供します。", + "operationId": "createAdvancedAnnotation", "tags": [ - "アノテーション管理" + "Annotations" ], "requestBody": { "required": true, @@ -2147,7 +2147,7 @@ }, "responses": { "201": { - "description": "アノテーションが正常に作成されました。", + "description": "アノテーションの作成に成功しました。", "content": { "application/json": { "schema": { @@ -2171,17 +2171,17 @@ } }, "get": { - "summary": "アノテーションリストを取得", - "description": "アプリケーションのアノテーションをページネーションリストで取得します。キーワード検索によるフィルタリングをサポートしています。", - "operationId": "listChatflowAnnotationsJa", + "summary": "アノテーション一覧", + "description": "アプリケーションのアノテーションのページ分割されたリストを取得します。キーワード検索フィルタリングをサポートしています。", + "operationId": "getAdvancedAnnotationList", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページネーション用のページ番号。", "required": false, "schema": { "type": "integer", @@ -2191,7 +2191,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "1ページあたりのアイテム数。", "required": false, "schema": { "type": "integer", @@ -2201,7 +2201,7 @@ { "name": "keyword", "in": "query", - "description": "質問または回答の内容でアノテーションをフィルタリングするためのキーワードです。", + "description": "質問または回答の内容でアノテーションをフィルタリングするキーワード。", "required": false, "schema": { "type": "string" @@ -2246,16 +2246,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" @@ -2283,7 +2283,7 @@ }, "responses": { "200": { - "description": "アノテーションが正常に更新されました。", + "description": "アノテーションの更新に成功しました。", "content": { "application/json": { "schema": { @@ -2342,17 +2342,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" @@ -2361,7 +2361,7 @@ ], "responses": { "204": { - "description": "アノテーションが正常に削除されました。" + "description": "アノテーションの削除に成功しました。" }, "403": { "description": "`forbidden` : アノテーションを編集する権限がありません。", @@ -2402,18 +2402,18 @@ }, "/apps/annotation-reply/{action}": { "post": { - "summary": "アノテーション返信を設定", - "description": "アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) で進捗を追跡します。", - "operationId": "setChatflowAnnotationReplyJa", + "summary": "アノテーション応答を設定", + "description": "アノテーション応答機能を有効化または無効化します。有効化時には埋め込みモデルの設定が必要です。非同期で実行されます — 進捗を追跡するには [アノテーション応答ジョブステータスを取得](/ja/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": [ @@ -2445,7 +2445,7 @@ }, "responses": { "200": { - "description": "アノテーション返信設定タスクが開始されました。", + "description": "アノテーション応答設定タスクが開始されました。", "content": { "application/json": { "schema": { @@ -2468,18 +2468,18 @@ }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { - "summary": "アノテーション返信の初期設定タスクステータスを取得", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) で開始された非同期アノテーション返信設定ジョブのステータスを取得します。", - "operationId": "getChatflowAnnotationReplyStatusJa", + "summary": "アノテーション応答ジョブステータスを取得", + "description": "[アノテーション応答を設定](/ja/api-reference/annotations/configure-annotation-reply) で開始された非同期アノテーション応答設定ジョブのステータスを取得します。", + "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", "tags": [ - "アノテーション管理" + "Annotations" ], "parameters": [ { "name": "action", "in": "path", "required": true, - "description": "アクションタイプです。[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) の呼び出しと一致する必要があります。", + "description": "アクションタイプ。[アノテーション応答を設定](/ja/api-reference/annotations/configure-annotation-reply) の呼び出しと一致する必要があります。", "schema": { "type": "string", "enum": [ @@ -2492,7 +2492,7 @@ "name": "job_id", "in": "path", "required": true, - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) から返されたジョブ ID です。", + "description": "[アノテーション応答を設定](/ja/api-reference/annotations/configure-annotation-reply) で返されたジョブ ID。", "schema": { "type": "string", "format": "uuid" @@ -2543,17 +2543,17 @@ "/workflows/run/{workflow_run_id}": { "get": { "summary": "ワークフロー実行詳細を取得", - "description": "ワークフロー実行 ID に基づいて、ワークフロータスクの現在の実行結果を取得します。", - "operationId": "getChatflowWorkflowRunDetailJa", + "description": "ワークフロー実行 ID に基づいてワークフロータスクの現在の実行結果を取得します。", + "operationId": "getChatflowWorkflowRunDetail", "tags": [ - "ワークフロー実行" + "Workflow Runs" ], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, - "description": "ワークフロー実行 ID です。ストリーミングイベントまたはメッセージメタデータから取得できます。", + "description": "ワークフロー実行 ID。ストリーミングイベントまたはメッセージメタデータから取得できます。", "schema": { "type": "string" } @@ -2561,7 +2561,7 @@ ], "responses": { "200": { - "description": "ワークフロー実行の詳細の取得に成功しました。", + "description": "ワークフロー実行詳細の取得に成功しました。", "content": { "application/json": { "schema": { @@ -2610,7 +2610,7 @@ } }, "404": { - "description": "`not_found` : ワークフロー実行記録が見つかりません。", + "description": "`not_found` : ワークフロー実行が見つかりません。", "content": { "application/json": { "examples": { @@ -2631,17 +2631,17 @@ }, "/workflows/logs": { "get": { - "summary": "ワークフローログ一覧を取得", - "description": "フィルタリングオプション付きでワークフロー実行ログをページネーションで取得します。", - "operationId": "listChatflowWorkflowLogsJa", + "summary": "ワークフローログ一覧", + "description": "フィルタリングオプション付きのページ分割されたワークフロー実行ログを取得します。", + "operationId": "listChatflowWorkflowLogs", "tags": [ - "ワークフロー実行" + "Workflow Runs" ], "parameters": [ { "name": "keyword", "in": "query", - "description": "ログ内を検索するキーワードです。", + "description": "ログ内を検索するキーワード。", "schema": { "type": "string" } @@ -2649,7 +2649,7 @@ { "name": "status", "in": "query", - "description": "実行ステータスでフィルタリングします。", + "description": "実行ステータスでフィルタリング。", "schema": { "type": "string", "enum": [ @@ -2662,7 +2662,7 @@ { "name": "page", "in": "query", - "description": "ページネーションのページ番号。", + "description": "ページネーション用のページ番号。", "schema": { "type": "integer", "default": 1, @@ -2673,7 +2673,7 @@ { "name": "limit", "in": "query", - "description": "1 ページあたりの件数です。", + "description": "1ページあたりのアイテム数。", "schema": { "type": "integer", "default": 20, @@ -2684,7 +2684,7 @@ { "name": "created_at__before", "in": "query", - "description": "この ISO 8601 タイムスタンプ以前に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより前に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -2693,7 +2693,7 @@ { "name": "created_at__after", "in": "query", - "description": "この ISO 8601 タイムスタンプ以降に作成されたログをフィルタリングします。", + "description": "この ISO 8601 タイムスタンプより後に作成されたログをフィルタリング。", "schema": { "type": "string", "format": "date-time" @@ -2702,7 +2702,7 @@ { "name": "created_by_end_user_session_id", "in": "query", - "description": "エンドユーザーセッション ID でフィルタリングします。", + "description": "エンドユーザーセッション ID でフィルタリング。", "schema": { "type": "string" } @@ -2710,7 +2710,7 @@ { "name": "created_by_account", "in": "query", - "description": "アカウント ID でフィルタリングします。", + "description": "アカウント ID でフィルタリング。", "schema": { "type": "string" } @@ -2775,7 +2775,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": { @@ -2815,11 +2815,11 @@ "properties": { "query": { "type": "string", - "description": "ユーザーの入力/質問内容です。" + "description": "ユーザー入力/質問内容。" }, "inputs": { "type": "object", - "description": "アプリで定義されたさまざまな変数の値を入力できます。キーと値のペアを含みます。アプリが期待する変数名と型については、[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) レスポンスの `user_input_form` フィールドを参照してください。", + "description": "アプリで定義された様々な変数値の入力を許可します。キー/値ペアを含みます。アプリが期待する変数名とタイプを確認するには、[アプリパラメータを取得](/ja/api-reference/applications/get-app-parameters) レスポンスの `user_input_form` フィールドを参照してください。", "additionalProperties": true }, "response_mode": { @@ -2828,19 +2828,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": "画像、ドキュメント、音声、動画を含むマルチモーダル理解用のファイルリスト。ローカルファイルを添付するには、まず [ファイルをアップロード](/ja/api-reference/files/upload-file) でアップロードし、返された `id` を `transfer_method: local_file` で `upload_file_id` として使用します。", "items": { "type": "object", "required": [ @@ -2865,28 +2865,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": "[ファイルをアップロード](/ja/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` の場合、[会話の名前を変更](/ja/api-reference/conversations/rename-conversation) API を `auto_generate: true` で使用して非同期でタイトルを生成します。", "default": true }, "workflow_id": { "type": "string", - "description": "実行する公開済みワークフローバージョンの ID を指定します。指定しない場合、最新の公開バージョンが使用されます。" + "description": "実行する公開済みワークフローバージョン ID を指定します。指定しない場合、最新の公開バージョンが使用されます。" } } }, @@ -2895,22 +2895,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", @@ -2919,11 +2919,11 @@ }, "mode": { "type": "string", - "description": "アプリモード、`advanced-chat` 固定です。" + "description": "アプリモード。`advanced-chat` で固定。" }, "answer": { "type": "string", - "description": "完全なレスポンスコンテンツ。" + "description": "完全なレスポンス内容。" }, "metadata": { "type": "object", @@ -2950,11 +2950,11 @@ }, "ChunkChatEvent": { "type": "object", - "description": "ストリーミングモードにおける Server-Sent Event チャンクのベーススキーマです。", + "description": "ストリーミングモードでの Server-Sent Event チャンクの基本スキーマ。", "properties": { "event": { "type": "string", - "description": "イベントの種類です。", + "description": "イベントのタイプ。", "enum": [ "message", "tts_message", @@ -3019,7 +3019,7 @@ }, "StreamEventBase": { "type": "object", - "description": "ストリームイベントの基本プロパティです。", + "description": "ストリームイベントの基本プロパティ。", "properties": { "task_id": { "type": "string", @@ -3056,7 +3056,7 @@ "properties": { "answer": { "type": "string", - "description": "LLM が返したテキストチャンクです。" + "description": "LLM が返したテキストチャンク。" } } } @@ -3072,12 +3072,12 @@ }, { "type": "object", - "description": "TTS 音声ストリームイベント（base64 エンコードの Mp3）です。自動再生が有効な場合に利用できます。", + "description": "TTS 音声ストリームイベント（base64 エンコードされた Mp3）。自動再生が有効な場合に利用可能。", "properties": { "audio": { "type": "string", "format": "byte", - "description": "Base64 エンコードされた MP3 音声チャンク。すべてのチャンクを順番にデコードして連結すると、完全な音声ファイルが生成されます。" + "description": "Base64 エンコードされた MP3 音声チャンク。完全な音声ファイルを生成するには、すべてのチャンクをデコードして順番に連結してください。" } } } @@ -3097,7 +3097,7 @@ "properties": { "audio": { "type": "string", - "description": "空の文字列。音声ストリームの終了を示します。" + "description": "空文字列。音声ストリームの終了を示します。" } } } @@ -3110,23 +3110,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", @@ -3152,12 +3152,12 @@ }, { "type": "object", - "description": "メッセージ終了イベント、ストリーミングが終了しました。", + "description": "メッセージ終了イベント。ストリーミングが終了しました。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージ ID。" }, "metadata": { "type": "object", @@ -3189,7 +3189,7 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージ内容置換イベント（例: コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", @@ -3244,58 +3244,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", @@ -3306,7 +3306,7 @@ }, "RetrieverResource": { "type": "object", - "description": "検索リソースの引用および帰属情報です。", + "description": "検索リソースの引用と帰属情報。", "properties": { "id": { "type": "string", @@ -3325,20 +3325,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", @@ -3442,19 +3442,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", @@ -3484,12 +3484,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` 識別子（例: [チャットメッセージを送信](/ja/api-reference/chats/send-chat-message) の `user` フィールド）。" }, "name": { "type": "string", @@ -3498,11 +3498,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", @@ -3518,7 +3518,7 @@ }, "MessageFeedbackRequest": { "type": "object", - "description": "メッセージフィードバックを送信するためのリクエストボディ。", + "description": "メッセージフィードバック送信用のリクエストボディ。", "required": [ "user" ], @@ -3531,15 +3531,15 @@ null ], "nullable": true, - "description": "フィードバック評価。以前送信したフィードバックを取り消すには `null` に設定します。" + "description": "フィードバック評価。以前に送信したフィードバックを取り消すには `null` を設定します。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者が定義し、アプリケーション内での一意性を確保する必要があります。" + "description": "ユーザー識別子。開発者によって定義され、アプリケーション内で一意性を確保する必要があります。" }, "content": { "type": "string", - "description": "追加の詳細を提供する任意のテキストフィードバック。" + "description": "追加の詳細を提供するオプションのテキストフィードバック。" } } }, @@ -3548,7 +3548,7 @@ "properties": { "data": { "type": "array", - "description": "フィードバック項目のリスト。", + "description": "フィードバックアイテムのリスト。", "items": { "$ref": "#/components/schemas/FeedbackItem" } @@ -3557,7 +3557,7 @@ }, "FeedbackItem": { "type": "object", - "description": "単一のフィードバック項目。", + "description": "単一のフィードバックアイテム。", "properties": { "id": { "type": "string", @@ -3581,16 +3581,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": "フィードバックソース。API 経由で送信されたエンドユーザーフィードバックは `user`、コンソールから送信されたフィードバックは `admin`。" }, "from_end_user_id": { "type": "string", @@ -3628,7 +3628,7 @@ "items": { "type": "string" }, - "description": "提案された質問のリストです。" + "description": "推奨質問のリスト。" } } }, @@ -3637,15 +3637,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" } @@ -3654,7 +3654,7 @@ }, "ConversationMessageItem": { "type": "object", - "description": "会話内の単一メッセージです。", + "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", @@ -3670,33 +3670,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" } @@ -3704,24 +3704,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" } @@ -3733,7 +3733,7 @@ }, "extra_contents": { "type": "array", - "description": "このメッセージに関連する追加の実行コンテンツです。chatflow ワークフローの人的介入ノードからのフォームデータなどが含まれます。", + "description": "このメッセージに関連する追加の実行コンテンツ。チャットフローワークフローの人間の入力ノードからの人間の入力フォームデータなど。", "items": { "$ref": "#/components/schemas/HumanInputContent" } @@ -3742,20 +3742,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", @@ -3775,72 +3775,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", @@ -3854,15 +3854,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" } @@ -3879,20 +3879,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", @@ -3908,14 +3908,14 @@ }, "ConversationRenameRequest": { "type": "object", - "description": "会話の名前変更用リクエストボディです。", + "description": "会話の名前変更用リクエストボディ。", "required": [ "user" ], "properties": { "name": { "type": "string", - "description": "会話の名前です。`auto_generate` が `false` の場合は必須です。" + "description": "会話の名前。`auto_generate` が `false` の場合に必須。" }, "auto_generate": { "type": "boolean", @@ -3924,7 +3924,7 @@ }, "user": { "type": "string", - "description": "ユーザー識別子です。" + "description": "ユーザー識別子。" } } }, @@ -3933,15 +3933,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" } @@ -3954,23 +3954,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", @@ -3986,13 +3986,13 @@ }, "ConversationVariableUpdateRequest": { "type": "object", - "description": "会話変数を更新するためのリクエストボディです。", + "description": "会話変数更新用のリクエストボディ。", "required": [ "value" ], "properties": { "value": { - "description": "変数の新しい値。変数の期待される型と一致する必要があります。" + "description": "変数の新しい値。変数の期待されるタイプと一致する必要があります。" }, "user": { "type": "string", @@ -4002,7 +4002,7 @@ }, "AudioToTextRequest": { "type": "object", - "description": "音声からテキストへの変換のリクエストボディ。", + "description": "音声からテキストへの変換用リクエストボディ。", "required": [ "file" ], @@ -4010,7 +4010,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", @@ -4029,12 +4029,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", @@ -4046,7 +4046,7 @@ }, "voice": { "type": "string", - "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトには[アプリケーションのパラメータ情報を取得](/api-reference/アプリケーション設定/アプリケーションのパラメータ情報を取得) → `text_to_speech.voice` の `voice` 値を使用してください。" + "description": "テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトについては [アプリパラメータを取得](/ja/api-reference/applications/get-app-parameters) → `text_to_speech.voice` の `voice` 値を使用してください。" }, "streaming": { "type": "boolean", @@ -4074,7 +4074,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", @@ -4087,14 +4087,14 @@ "properties": { "opening_statement": { "type": "string", - "description": "会話開始時に表示されるオープニングメッセージです。" + "description": "会話開始時に表示されるオープニングステートメント。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, - "description": "推奨される初期質問のリスト。" + "description": "推奨されるスターター質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", @@ -4108,7 +4108,7 @@ }, "speech_to_text": { "type": "object", - "description": "音声からテキストへの変換設定。", + "description": "音声認識の設定。", "properties": { "enabled": { "type": "boolean", @@ -4118,7 +4118,7 @@ }, "text_to_speech": { "type": "object", - "description": "テキストから音声への変換設定。", + "description": "テキスト読み上げの設定。", "properties": { "enabled": { "type": "boolean", @@ -4134,7 +4134,7 @@ }, "autoPlay": { "type": "string", - "description": "自動再生設定です。音声を自動再生するには `enabled`、手動再生を要求するには `disabled` を指定します。" + "description": "自動再生設定。`enabled` で音声を自動再生、`disabled` で手動再生を要求。" } } }, @@ -4150,7 +4150,7 @@ }, "annotation_reply": { "type": "object", - "description": "アノテーション返信の設定。", + "description": "アノテーション応答の設定。", "properties": { "enabled": { "type": "boolean", @@ -4170,7 +4170,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "センシティブワードフィルタリングの設定。", + "description": "機密語回避の設定。", "properties": { "enabled": { "type": "boolean", @@ -4191,7 +4191,7 @@ "properties": { "image": { "type": "object", - "description": "画像アップロードの設定。", + "description": "画像アップロード設定。", "properties": { "enabled": { "type": "boolean", @@ -4199,7 +4199,7 @@ }, "number_limits": { "type": "integer", - "description": "最大画像数。" + "description": "画像の最大数。" }, "detail": { "type": "string", @@ -4259,7 +4259,7 @@ ] }, "TextInputControlWrapper": { - "title": "Text Input", + "title": "テキスト入力", "type": "object", "properties": { "text-input": { @@ -4268,7 +4268,7 @@ } }, "ParagraphControlWrapper": { - "title": "Paragraph", + "title": "段落", "type": "object", "properties": { "paragraph": { @@ -4277,7 +4277,7 @@ } }, "SelectControlWrapper": { - "title": "Select", + "title": "選択", "type": "object", "properties": { "select": { @@ -4287,63 +4287,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", @@ -4366,7 +4366,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコン URL", "type": "string", "format": "url", "description": "アイコンの URL。" @@ -4381,7 +4381,7 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "絵文字アイコン", "type": "object", "description": "絵文字を使用したツールアイコンの詳細。", "properties": { @@ -4391,7 +4391,7 @@ }, "content": { "type": "string", - "description": "Emoji コンテンツ。" + "description": "絵文字コンテンツ。" } } }, @@ -4412,11 +4412,11 @@ }, "icon_type": { "type": "string", - "description": "使用されるアイコンのタイプ。`emoji` は絵文字アイコン、`image` はアップロードされた画像アイコンです。" + "description": "使用されるアイコンのタイプ。絵文字アイコンは `emoji`、アップロードされた画像アイコンは `image`。" }, "icon": { "type": "string", - "description": "アイコンのコンテンツ（絵文字または画像 ID）。" + "description": "アイコンコンテンツ（絵文字または画像 ID）。" }, "icon_background": { "type": "string", @@ -4466,23 +4466,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": "現在のページ番号。" } } }, @@ -4492,22 +4492,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", @@ -4519,7 +4519,7 @@ }, "CreateAnnotationRequest": { "type": "object", - "description": "新しいアノテーションを作成するためのリクエストボディです。", + "description": "新しいアノテーション作成用のリクエストボディ。", "required": [ "question", "answer" @@ -4527,17 +4527,17 @@ "properties": { "question": { "type": "string", - "description": "アノテーションの質問です。" + "description": "アノテーションの質問。" }, "answer": { "type": "string", - "description": "アノテーションの回答です。" + "description": "アノテーションの回答。" } } }, "UpdateAnnotationRequest": { "type": "object", - "description": "アノテーション更新のリクエストボディです。", + "description": "アノテーション更新用のリクエストボディ。", "required": [ "question", "answer" @@ -4545,17 +4545,17 @@ "properties": { "question": { "type": "string", - "description": "更新されたアノテーションの質問です。" + "description": "更新されたアノテーションの質問。" }, "answer": { "type": "string", - "description": "更新されたアノテーションの回答です。" + "description": "更新されたアノテーションの回答。" } } }, "InitialAnnotationReplySettingsRequest": { "type": "object", - "description": "アノテーション返信設定を構成するためのリクエストボディです。", + "description": "アノテーション応答設定用のリクエストボディ。", "required": [ "score_threshold", "embedding_provider_name", @@ -4564,16 +4564,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 } @@ -4585,11 +4585,11 @@ "job_id": { "type": "string", "format": "uuid", - "description": "非同期ジョブ ID です。[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得) と組み合わせて進捗を追跡します。" + "description": "非同期ジョブ ID。進捗を追跡するには [アノテーション応答ジョブステータスを取得](/ja/api-reference/annotations/get-annotation-reply-job-status) で使用してください。" }, "job_status": { "type": "string", - "description": "現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed` は完了、`error` は失敗を示します。" + "description": "現在のジョブステータス。キュー待ちは `waiting`、進行中は `processing`、完了は `completed`、失敗は `error`。" } } }, @@ -4599,15 +4599,15 @@ "job_id": { "type": "string", "format": "uuid", - "description": "[アノテーション返信を設定](/api-reference/アノテーション管理/アノテーション返信を設定) 呼び出しから取得したジョブ ID です。" + "description": "[アノテーション応答を設定](/ja/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` でない場合は空文字列。" } } }, @@ -4621,36 +4621,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`。" } } } @@ -4668,65 +4668,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", @@ -4735,7 +4735,7 @@ "type": "object", "additionalProperties": true }, - "description": "ワークフロー実行中に生成されたファイルです。" + "description": "ワークフロー実行中に生成されたファイル。" } } } @@ -4753,65 +4753,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。" } } } @@ -4829,86 +4829,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", @@ -4917,17 +4917,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。" } } } @@ -4945,86 +4945,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", @@ -5033,21 +5033,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` から開始。" } } } @@ -5069,46 +5069,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": "イテレーション入力データ。" } } } @@ -5126,44 +5126,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": "追加のメタデータ。" } } } @@ -5185,63 +5185,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": "実行されたイテレーションステップの総数。" } } } @@ -5263,46 +5263,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": "ループ入力データ。" } } } @@ -5324,43 +5324,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": "追加のメタデータ。" } } } @@ -5382,63 +5382,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": "実行されたループステップの総数。" } } } @@ -5456,30 +5456,30 @@ }, { "type": "object", - "description": "人的介入ノードがユーザー入力を待機しています。", + "description": "人間の入力ノードがユーザー入力を待っています。", "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "form_id": { "type": "string", - "description": "レスポンス送信用のフォーム ID です。" + "description": "レスポンス送信用のフォーム ID。" }, "node_id": { "type": "string", - "description": "人的介入ノードのノード ID です。" + "description": "人間の入力ノードのノード ID。" }, "node_title": { "type": "string", - "description": "人的介入ノードのタイトルです。" + "description": "人間の入力ノードのタイトル。" }, "form_content": { "type": "string", - "description": "ユーザー向けのフォーム内容/説明です。" + "description": "ユーザー向けのフォームコンテンツ/説明。" }, "inputs": { "type": "array", @@ -5487,7 +5487,7 @@ "type": "object", "additionalProperties": true }, - "description": "フォーム入力フィールドの定義です。" + "description": "フォーム入力フィールドの定義。" }, "actions": { "type": "array", @@ -5495,17 +5495,17 @@ "type": "object", "additionalProperties": true }, - "description": "利用可能なユーザーアクションです。" + "description": "利用可能なユーザーアクション。" }, "form_token": { "type": "string", "nullable": true, - "description": "フォーム送信認証用のトークンです。" + "description": "フォーム送信認証用のトークン。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "フォームが期限切れになる Unix タイムスタンプです。" + "description": "フォームが期限切れになる Unix タイムスタンプ。" } } } @@ -5530,19 +5530,19 @@ "workflow_run_id": { "type": "string", "format": "uuid", - "description": "このワークフロー実行記録の永続的な識別子です。[ワークフロー実行詳細を取得](/api-reference/ワークフロー/ワークフロー実行詳細を取得) と組み合わせて、実行後に結果を取得します。" + "description": "このワークフロー実行レコードの永続的な識別子。実行後に結果を取得するには [ワークフロー実行詳細を取得](/ja/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", @@ -5550,11 +5550,11 @@ "type": "object", "additionalProperties": true }, - "description": "一時停止の理由です。" + "description": "一時停止の理由。" }, "status": { "type": "string", - "description": "ワークフローの実行ステータスです。" + "description": "ワークフロー実行ステータス。" }, "created_at": { "type": "integer", @@ -5564,15 +5564,15 @@ "elapsed_time": { "type": "number", "format": "float", - "description": "合計経過時間（秒）です。" + "description": "合計経過時間（秒）。" }, "total_tokens": { "type": "integer", - "description": "消費された合計トークン数です。" + "description": "消費された合計 token 数。" }, "total_steps": { "type": "integer", - "description": "実行された合計ステップ数です。" + "description": "実行された合計ステップ数。" } } } @@ -5593,30 +5593,30 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "node_id": { "type": "string", - "description": "Node ID." + "description": "ノード ID。" }, "node_title": { "type": "string", - "description": "Node title." + "description": "ノードタイトル。" }, "rendered_content": { "type": "string", - "description": "フォーム送信後のレンダリングされた内容です。" + "description": "フォーム送信後にレンダリングされたコンテンツ。" }, "action_id": { "type": "string", - "description": "実行されたアクションの ID です。" + "description": "実行されたアクションの ID。" }, "action_text": { "type": "string", - "description": "実行されたアクションのテキストです。" + "description": "実行されたアクションのテキスト。" } } } @@ -5637,23 +5637,23 @@ "properties": { "workflow_run_id": { "type": "string", - "description": "ワークフロー実行の実行 ID です。" + "description": "ワークフロー実行 ID。" }, "data": { "type": "object", "properties": { "node_id": { "type": "string", - "description": "Node ID." + "description": "ノード ID。" }, "node_title": { "type": "string", - "description": "Node title." + "description": "ノードタイトル。" }, "expiration_time": { "type": "integer", "format": "int64", - "description": "フォームが期限切れになった Unix タイムスタンプです。" + "description": "フォームが期限切れになった Unix タイムスタンプ。" } } } @@ -5671,50 +5671,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。" } } } @@ -5738,7 +5738,7 @@ "properties": { "text": { "type": "string", - "description": "テキスト内容のチャンクです。" + "description": "テキストコンテンツチャンク。" }, "from_variable_selector": { "type": "array", @@ -5746,7 +5746,7 @@ "type": "string" }, "nullable": true, - "description": "ワークフロー内のテキスト変数のソースパスです。" + "description": "ワークフロー内のテキスト変数のソースパス。" } } } @@ -5770,7 +5770,7 @@ "properties": { "text": { "type": "string", - "description": "置換テキスト内容です。" + "description": "置換テキストコンテンツ。" } } } @@ -5784,57 +5784,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": "合計経過時間（秒）。" } } }, @@ -5843,26 +5843,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": "ワークフローログエントリのリスト。" } } }, @@ -5872,23 +5872,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", @@ -5911,13 +5911,13 @@ "created_at": { "type": "integer", "format": "int64", - "description": "ログエントリが作成された Unix タイムスタンプです。" + "description": "ログエントリが作成された Unix タイムスタンプ。" }, "details": { "type": "object", "additionalProperties": true, "nullable": true, - "description": "ログエントリの追加詳細です。" + "description": "ログエントリの追加詳細。" } } }, @@ -5927,52 +5927,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`。" } } }, @@ -5986,159 +5986,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", @@ -6148,19 +6148,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`。" } } } @@ -6168,40 +6168,40 @@ }, "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": "直接返信用のアノテーション管理に関連する操作。" }, { - "name": "ワークフロー実行", - "description": "ワークフロー実行の詳細とログに関連する操作です。" + "name": "Workflow Runs", + "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..9b0c46ab8 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -1,8 +1,8 @@ { "openapi": "3.0.1", "info": { - "title": "Completion アプリ API", - "description": "テキスト生成アプリケーションはセッションなしで動作し、翻訳、記事作成、要約 AI などに最適です。", + "title": "テキスト生成アプリ API", + "description": "テキスト生成アプリケーションは非セッションサポートを提供し、翻訳、記事作成、要約 AI などに最適です。", "version": "1.0.0" }, "servers": [ @@ -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,12 +284,12 @@ }, "/messages/{message_id}/feedbacks": { "post": { - "operationId": "postCompletionMessageFeedbackJp", + "operationId": "postMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "summary": "メッセージフィードバックを送信", - "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` で評価でき、任意でテキストフィードバックを提供できます。`rating` に `null` を渡すと、以前送信したフィードバックを取り消せます。", + "description": "メッセージに対するフィードバックを送信します。エンドユーザーはメッセージを `like` または `dislike` として評価でき、オプションでテキストフィードバックを提供できます。`rating` に `null` を渡すと、以前に送信したフィードバックを取り消します。", "parameters": [ { "name": "message_id", @@ -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": "メッセージ送信時に使用するファイルをアップロードします。画像、ドキュメント、音声、動画のマルチモーダル理解が可能です。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", + "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", @@ -462,7 +462,7 @@ }, "responses": { "201": { - "description": "ファイルが正常にアップロードされました。", + "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { @@ -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 経由でアップロードされたファイルをプレビューまたはダウンロードします。ファイルは、リクエスト元のアプリケーション内のメッセージに属する場合のみアクセスできます。", + "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,12 +652,12 @@ }, "/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", @@ -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` です。", + "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,9 +876,9 @@ }, "/text-to-audio": { "post": { - "operationId": "textToAudioCompletionJp", + "operationId": "textToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], "summary": "テキストを音声に変換", "description": "テキストを音声に変換します。", @@ -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,12 +1162,12 @@ }, "/site": { "get": { - "operationId": "getCompletionWebAppSettingsJp", + "operationId": "getWebAppSettings", "tags": [ - "アプリケーション設定" + "Applications" ], - "summary": "アプリの WebApp 設定を取得", - "description": "このアプリケーションの WebApp 設定（サイト設定、テーマ、カスタマイズオプション）を取得します。", + "summary": "アプリ 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", @@ -1227,12 +1227,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": { @@ -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 秒` です。省略した場合、デフォルトでブロッキング動作になります。" }, "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": "転送方法：ファイル 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": "アップロードされたファイル 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", @@ -1490,7 +1490,7 @@ }, { "type": "object", - "description": "LLM がテキストチャンクイベントを返します。", + "description": "LLM がテキストチャンクを返すイベント。", "properties": { "answer": { "type": "string", @@ -1510,12 +1510,12 @@ }, { "type": "object", - "description": "メッセージ終了イベント。このイベントを受信すると、ストリーミングが終了したことを意味します。", + "description": "メッセージ終了イベント。このイベントを受信するとストリーミングが終了したことを意味します。", "properties": { "id": { "type": "string", "format": "uuid", - "description": "メッセージの一意な ID。" + "description": "一意のメッセージ ID。" }, "metadata": { "type": "object", @@ -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": "空文字列。音声ストリームの終了を示します。" } } } @@ -1585,7 +1585,7 @@ }, { "type": "object", - "description": "メッセージファイルイベント。ツールによって作成された新しいファイルです。", + "description": "メッセージファイルイベント。ツールによって作成された新しいファイル。", "properties": { "id": { "type": "string", @@ -1594,14 +1594,14 @@ }, "type": { "type": "string", - "description": "ファイルタイプ（例：`image`）。" + "description": "ファイルタイプ。例：`image`。" }, "belongs_to": { "type": "string", "enum": [ "assistant" ], - "description": "このファイルの所有者。ここでは常に `assistant` です。" + "description": "このファイルの所属先。ここでは常に `assistant` です。" }, "url": { "type": "string", @@ -1622,7 +1622,7 @@ }, { "type": "object", - "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによるもの）。", + "description": "メッセージコンテンツ置換イベント（例：コンテンツモデレーションによる）。", "properties": { "answer": { "type": "string", @@ -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", @@ -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", @@ -1867,7 +1867,7 @@ "original_url": { "type": "string", "nullable": true, - "description": "ファイルの元の URL。" + "description": "ファイルのオリジナル URL。" }, "user_id": { "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,7 +1929,7 @@ }, "is_anonymous": { "type": "boolean", - "description": "ユーザーが匿名かどうかを示します。元の API リクエストで `user` 識別子が提供されなかった場合、`true` になります。" + "description": "ユーザーが匿名かどうか。元の API リクエストで `user` 識別子が提供されなかった場合は `true` です。" }, "session_id": { "type": "string", @@ -1962,15 +1962,15 @@ null ], "nullable": true, - "description": "フィードバック評価。以前送信したフィードバックを取り消すには `null` に設定します。" + "description": "フィードバック評価。以前に送信したフィードバックを取り消すには `null` に設定します。" }, "user": { "type": "string", - "description": "ユーザー識別子。開発者が定義し、アプリケーション内での一意性を確保する必要があります。" + "description": "ユーザー識別子。開発者によって定義され、アプリケーション内での一意性を確保する必要があります。" }, "content": { "type": "string", - "description": "追加の詳細を提供する任意のテキストフィードバック。" + "description": "追加の詳細を提供するオプションのテキストフィードバック。" } } }, @@ -2017,11 +2017,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", @@ -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", @@ -2117,11 +2117,11 @@ "items": { "type": "string" }, - "description": "アプリケーションタグ。" + "description": "アプリケーションのタグ。" }, "mode": { "type": "string", - "description": "アプリケーションモード。`completion` はテキスト生成アプリ、`chat` は基本チャットアプリ、`agent-chat` はエージェントベースのアプリ、`advanced-chat` は Chatflow アプリ、`workflow` はワークフローアプリです。" + "description": "アプリケーションモード。テキスト生成アプリの場合は `completion`、基本的なチャットアプリの場合は `chat`、エージェントベースのアプリの場合は `agent-chat`、チャットフローアプリの場合は `advanced-chat`、ワークフローアプリの場合は `workflow`。" }, "author_name": { "type": "string", @@ -2141,7 +2141,7 @@ "items": { "type": "string" }, - "description": "推奨される初期質問のリスト。" + "description": "推奨される開始質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", @@ -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", @@ -2201,7 +2201,7 @@ }, "annotation_reply": { "type": "object", - "description": "アノテーション返信の設定。", + "description": "注釈返信の設定。", "properties": { "enabled": { "type": "boolean", @@ -2221,7 +2221,7 @@ }, "sensitive_word_avoidance": { "type": "object", - "description": "センシティブワードフィルタリングの設定。", + "description": "機密語回避の設定。", "properties": { "enabled": { "type": "boolean", @@ -2250,7 +2250,7 @@ }, "number_limits": { "type": "integer", - "description": "最大画像数。" + "description": "画像の最大数。" }, "detail": { "type": "string", @@ -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": { @@ -2395,18 +2395,18 @@ }, "required": { "type": "boolean", - "description": "送信前に選択を行う必要があるかどうか。" + "description": "送信前に選択する必要があるかどうか。" }, "default": { "type": "string", - "description": "デフォルトで選択される値。" + "description": "デフォルトで選択された値。" }, "options": { "type": "array", "items": { "type": "string" }, - "description": "このフォームコントロールの選択可能な値のリスト。" + "description": "このフォームコントロールで選択可能な値のリスト。" } } }, @@ -2418,7 +2418,7 @@ "additionalProperties": { "oneOf": [ { - "title": "Icon URL", + "title": "アイコン URL", "type": "string", "format": "url", "description": "アイコンの URL。" @@ -2433,17 +2433,17 @@ } }, "ToolIconDetail": { - "title": "Emoji Icon", + "title": "絵文字アイコン", "type": "object", "description": "絵文字を使用したツールアイコンの詳細。", "properties": { "background": { "type": "string", - "description": "16進数形式の背景色。" + "description": "16進形式の背景色。" }, "content": { "type": "string", - "description": "Emoji コンテンツ。" + "description": "絵文字コンテンツ。" } } }, @@ -2460,15 +2460,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", @@ -2490,7 +2490,7 @@ }, "privacy_policy": { "type": "string", - "description": "プライバシーポリシー URL。" + "description": "プライバシーポリシーの URL。" }, "custom_disclaimer": { "type": "string", @@ -2498,7 +2498,7 @@ }, "default_language": { "type": "string", - "description": "デフォルト言語コード。" + "description": "デフォルトの言語コード。" }, "show_workflow_steps": { "type": "boolean", @@ -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_knowledge.json b/ja/api-reference/openapi_knowledge.json index dd8064013..10052ceeb 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -1,14 +1,14 @@ { "openapi": "3.0.1", "info": { - "title": "ナレッジAPI", - "description": "ナレッジベース、ドキュメント、チャンク、メタデータ、タグの管理（作成、取得、設定を含む）のための API です。**注意：**単一のナレッジベース API キーは、同じアカウント配下のすべての可視ナレッジベースを操作する権限を持ちます。データセキュリティにご注意ください。", + "title": "ナレッジベース API", + "description": "ナレッジベース、ドキュメント、チャンク、メタデータ、タグの管理（作成、取得、設定を含む）のための API です。**注意:** 単一のナレッジベース API キーは、同じアカウント配下のすべての可視ナレッジベースを操作する権限を持ちます。データセキュリティにご注意ください。", "version": "1.0.0" }, "servers": [ { "url": "{apiBaseUrl}", - "description": "Knowledge API のベース URL です。", + "description": "ナレッジベース API のベース URL です。", "variables": { "apiBaseUrl": { "default": "https://api.dify.ai/v1", @@ -24,42 +24,42 @@ ], "tags": [ { - "name": "データセット", - "description": "ナレッジベースの作成、設定、取得を含むナレッジベース管理の操作です。" + "name": "Knowledge Bases", + "description": "ナレッジベースの作成、設定、取得を含む管理操作です。" }, { - "name": "ドキュメント", - "description": "ナレッジベース内のドキュメントの作成、更新、管理のための操作です。" + "name": "Documents", + "description": "ナレッジベース内でのドキュメントの作成、更新、管理操作です。" }, { - "name": "チャンク", - "description": "ドキュメントチャンクと子チャンクの管理のための操作です。" + "name": "Chunks", + "description": "ドキュメントのチャンクと子チャンクの管理操作です。" }, { - "name": "メタデータ", - "description": "ナレッジベースのメタデータフィールドとドキュメントメタデータ値の管理のための操作です。" + "name": "Metadata", + "description": "ナレッジベースのメタデータフィールドとドキュメントのメタデータ値の管理操作です。" }, { - "name": "タグ管理", - "description": "ナレッジベースタグとタグバインディングの管理のための操作です。" + "name": "Tags", + "description": "ナレッジベースのタグとタグバインディングの管理操作です。" }, { - "name": "モデル", - "description": "利用可能なモデルを取得するための操作です。" + "name": "Models", + "description": "利用可能なモデルの取得操作です。" }, { - "name": "ナレッジパイプライン", - "description": "データソースプラグインとパイプライン実行を含むナレッジパイプラインの管理と実行のための操作です。" + "name": "Knowledge Pipeline", + "description": "データソースプラグインやパイプライン実行を含む、ナレッジパイプラインの管理と実行操作です。" } ], "paths": { "/datasets": { "post": { "tags": [ - "データセット" + "Knowledge Bases" ], "summary": "空のナレッジベースを作成", - "description": "新しい空のナレッジベースを作成します。作成後、[テキストからドキュメントを作成](/api-reference/ドキュメント/テキストからドキュメントを作成) または [ファイルからドキュメントを作成](/api-reference/ドキュメント/ファイルからドキュメントを作成) を使用してドキュメントを追加します。", + "description": "新しい空のナレッジベースを作成します。作成後、[テキストでドキュメントを作成](/api-reference/documents/create-document-by-text)または[ファイルでドキュメントを作成](/api-reference/documents/create-document-by-file)を使用してドキュメントを追加します。", "operationId": "createDataset", "requestBody": { "required": true, @@ -75,13 +75,13 @@ "type": "string", "minLength": 1, "maxLength": 40, - "description": "ナレッジベース名。" + "description": "ナレッジベースの名前。" }, "description": { "type": "string", "maxLength": 400, "default": "", - "description": "ナレッジベースの説明です。" + "description": "ナレッジベースの説明。" }, "indexing_technique": { "type": "string", @@ -90,7 +90,7 @@ "economy" ], "nullable": true, - "description": "`high_quality` は埋め込みモデルを使用した精密検索、`economy` はキーワードベースのインデキシングです。" + "description": "`high_quality` は埋め込みモデルを使用して精密な検索を行います。`economy` はキーワードベースのインデックスを使用します。" }, "permission": { "type": "string", @@ -100,7 +100,7 @@ "partial_members" ], "default": "only_me", - "description": "このナレッジベースにアクセスできるユーザーを制御します。`only_me` は作成者のみに制限、`all_team_members` はワークスペース全体にアクセスを許可、`partial_members` は指定されたメンバーにアクセスを許可します。" + "description": "このナレッジベースにアクセスできる人を制御します。`only_me` は作成者のみに制限、`all_team_members` はワークスペース全体にアクセスを許可、`partial_members` は指定されたメンバーにアクセスを許可します。" }, "provider": { "type": "string", @@ -113,44 +113,44 @@ }, "embedding_model": { "type": "string", - "description": "埋め込みモデル名です。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `model` フィールドの値を使用します。" + "description": "埋め込みモデル名。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `model` フィールドを使用してください。" }, "embedding_model_provider": { "type": "string", - "description": "埋め込みモデルプロバイダーです。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `provider` フィールドの値を使用します。" + "description": "埋め込みモデルプロバイダー。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `provider` フィールドを使用してください。" }, "retrieval_model": { "$ref": "#/components/schemas/RetrievalModel", - "description": "検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。" + "description": "検索モデル設定。このナレッジベースをクエリする際のチャンクの検索とランキング方法を制御します。" }, "external_knowledge_api_id": { "type": "string", - "description": "外部ナレッジ API 接続の ID です。" + "description": "外部ナレッジ API 接続の ID。" }, "external_knowledge_id": { "type": "string", - "description": "外部ナレッジベースの ID です。" + "description": "外部ナレッジベースの ID。" }, "summary_index_setting": { "type": "object", "nullable": true, - "description": "サマリーインデックスの設定です。", + "description": "要約インデックス設定。", "properties": { "enable": { "type": "boolean", - "description": "サマリーインデックスを有効にするかどうかです。" + "description": "要約インデックスを有効にするかどうか。" }, "model_name": { "type": "string", - "description": "要約生成に使用されるモデルの名前です。" + "description": "要約生成に使用するモデルの名前。" }, "model_provider_name": { "type": "string", - "description": "要約生成モデルのプロバイダーです。" + "description": "要約生成モデルのプロバイダー。" }, "summary_prompt": { "type": "string", - "description": "要約生成用のカスタムプロンプトテンプレートです。" + "description": "要約生成用のカスタムプロンプトテンプレート。" } } } @@ -173,7 +173,7 @@ "value": { "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9", "name": "Product Documentation", - "description": "プロダクト API 技術ドキュメント", + "description": "製品 API の技術ドキュメント", "provider": "vendor", "permission": "only_me", "data_source_type": null, @@ -225,7 +225,7 @@ } }, "409": { - "description": "`dataset_name_duplicate` : ナレッジベース名は既に存在します。名前を変更してください。", + "description": "`dataset_name_duplicate` : データセット名はすでに存在します。データセット名を変更してください。", "content": { "application/json": { "examples": { @@ -245,10 +245,10 @@ }, "get": { "tags": [ - "データセット" + "Knowledge Bases" ], - "summary": "ナレッジベースリストを取得", - "description": "ナレッジベースのページネーションリストを返します。キーワードとタグによるフィルタリングをサポートしています。", + "summary": "ナレッジベース一覧を取得", + "description": "ナレッジベースのページネーションされた一覧を返します。キーワードとタグによるフィルタリングをサポートしています。", "operationId": "listDatasets", "parameters": [ { @@ -267,7 +267,7 @@ "type": "integer", "default": 20 }, - "description": "1 ページあたりの件数です。" + "description": "1 ページあたりのアイテム数。" }, { "name": "keyword", @@ -275,7 +275,7 @@ "schema": { "type": "string" }, - "description": "名前でフィルタリングする検索キーワードです。" + "description": "名前でフィルタリングする検索キーワード。" }, { "name": "include_all", @@ -284,7 +284,7 @@ "type": "boolean", "default": false }, - "description": "権限に関係なくすべてのナレッジベースを含めるかどうかです。" + "description": "権限に関係なくすべてのナレッジベースを含めるかどうか。" }, { "name": "tag_ids", @@ -297,12 +297,12 @@ }, "style": "form", "explode": true, - "description": "フィルタリングに使用するタグ ID です。" + "description": "フィルタリングするタグ ID。" } ], "responses": { "200": { - "description": "ナレッジベースのリストです。", + "description": "ナレッジベースの一覧。", "content": { "application/json": { "schema": { @@ -310,26 +310,26 @@ "properties": { "data": { "type": "array", - "description": "ナレッジベースオブジェクトの配列です。", + "description": "ナレッジベースオブジェクトの配列。", "items": { "$ref": "#/components/schemas/Dataset" } }, "has_more": { "type": "boolean", - "description": "次のページにさらに項目が存在するかどうかです。" + "description": "次のページにさらにアイテムが存在するかどうか。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1 ページあたりのアイテム数。" }, "total": { "type": "integer", - "description": "一致する項目の合計数です。" + "description": "一致するアイテムの総数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" } } }, @@ -341,7 +341,7 @@ { "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9", "name": "Product Documentation", - "description": "プロダクト API 技術ドキュメント", + "description": "製品 API の技術ドキュメント", "provider": "vendor", "permission": "only_me", "data_source_type": null, @@ -404,9 +404,9 @@ "/datasets/{dataset_id}": { "get": { "tags": [ - "データセット" + "Knowledge Bases" ], - "summary": "ナレッジベース詳細を取得", + "summary": "ナレッジベースを取得", "description": "特定のナレッジベースの詳細情報（埋め込みモデル、検索設定、ドキュメント統計を含む）を取得します。", "operationId": "getDatasetDetail", "parameters": [ @@ -418,12 +418,12 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "responses": { "200": { - "description": "ナレッジベースの詳細です。", + "description": "ナレッジベースの詳細。", "content": { "application/json": { "schema": { @@ -435,7 +435,7 @@ "value": { "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9", "name": "Product Documentation", - "description": "プロダクト API 技術ドキュメント", + "description": "製品 API の技術ドキュメント", "provider": "vendor", "permission": "only_me", "data_source_type": null, @@ -504,7 +504,7 @@ } }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -524,10 +524,10 @@ }, "patch": { "tags": [ - "データセット" + "Knowledge Bases" ], "summary": "ナレッジベースを更新", - "description": "既存のナレッジベースの名前、説明、権限、または検索設定を更新します。リクエストボディで指定されたフィールドのみが更新されます。", + "description": "既存のナレッジベースの名前、説明、権限、または検索設定を更新します。リクエストボディで提供されたフィールドのみが更新されます。", "operationId": "updateDataset", "parameters": [ { @@ -538,7 +538,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -552,12 +552,12 @@ "type": "string", "minLength": 1, "maxLength": 40, - "description": "ナレッジベース名。" + "description": "ナレッジベースの名前。" }, "description": { "type": "string", "maxLength": 400, - "description": "ナレッジベースの説明です。" + "description": "ナレッジベースの説明。" }, "indexing_technique": { "type": "string", @@ -566,7 +566,7 @@ "economy" ], "nullable": true, - "description": "`high_quality` は埋め込みモデルを使用した精密検索、`economy` はキーワードベースのインデキシングです。" + "description": "`high_quality` は埋め込みモデルを使用して精密な検索を行います。`economy` はキーワードベースのインデックスを使用します。" }, "permission": { "type": "string", @@ -575,58 +575,58 @@ "all_team_members", "partial_members" ], - "description": "このナレッジベースにアクセスできるユーザーを制御します。`only_me` は作成者のみに制限、`all_team_members` はワークスペース全体にアクセスを許可、`partial_members` は指定されたメンバーにアクセスを許可します。" + "description": "このナレッジベースにアクセスできる人を制御します。`only_me` は作成者のみに制限、`all_team_members` はワークスペース全体にアクセスを許可、`partial_members` は指定されたメンバーにアクセスを許可します。" }, "embedding_model": { "type": "string", - "description": "埋め込みモデル名です。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `model` フィールドの値を使用します。" + "description": "埋め込みモデル名。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `model` フィールドを使用してください。" }, "embedding_model_provider": { "type": "string", - "description": "埋め込みモデルプロバイダーです。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `provider` フィールドの値を使用します。" + "description": "埋め込みモデルプロバイダー。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `provider` フィールドを使用してください。" }, "retrieval_model": { "$ref": "#/components/schemas/RetrievalModel", - "description": "検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。" + "description": "検索モデル設定。このナレッジベースをクエリする際のチャンクの検索とランキング方法を制御します。" }, "partial_member_list": { "type": "array", - "description": "`permission` が `partial_members` の場合にアクセス権を持つチームメンバーのリストです。", + "description": "`permission` が `partial_members` の場合にアクセスできるチームメンバーのリスト。", "items": { "type": "object", "properties": { "user_id": { "type": "string", - "description": "アクセス権を付与するチームメンバーの ID です。" + "description": "アクセスを許可するチームメンバーの ID。" } } } }, "external_retrieval_model": { "type": "object", - "description": "外部ナレッジベースの検索設定です。", + "description": "外部ナレッジベースの検索設定。", "properties": { "top_k": { "type": "integer", - "description": "返す結果の最大数です。" + "description": "返す結果の最大数。" }, "score_threshold": { "type": "number", - "description": "結果フィルタリング用の最小関連性スコア閾値です。" + "description": "結果をフィルタリングするための最小関連性スコアしきい値。" }, "score_threshold_enabled": { "type": "boolean", - "description": "スコア閾値フィルタリングが有効かどうかです。" + "description": "スコアしきい値フィルタリングが有効かどうか。" } } }, "external_knowledge_id": { "type": "string", - "description": "外部ナレッジベースの ID です。" + "description": "外部ナレッジベースの ID。" }, "external_knowledge_api_id": { "type": "string", - "description": "外部ナレッジ API 接続の ID です。" + "description": "外部ナレッジ API 接続の ID。" } } } @@ -647,7 +647,7 @@ "value": { "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9", "name": "Product Documentation", - "description": "プロダクト API 技術ドキュメント", + "description": "製品 API の技術ドキュメント", "provider": "vendor", "permission": "only_me", "data_source_type": null, @@ -716,7 +716,7 @@ } }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -736,10 +736,10 @@ }, "delete": { "tags": [ - "データセット" + "Knowledge Bases" ], "summary": "ナレッジベースを削除", - "description": "ナレッジベースとそのすべてのドキュメントを完全に削除します。対象のナレッジベースはどのアプリケーションでも使用されていない必要があります。", + "description": "ナレッジベースとそのすべてのドキュメントを完全に削除します。ナレッジベースはどのアプリケーションでも使用されていない必要があります。", "operationId": "deleteDataset", "parameters": [ { @@ -750,15 +750,15 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "responses": { "204": { - "description": "Success." + "description": "成功。" }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -775,7 +775,7 @@ } }, "409": { - "description": "`dataset_in_use` : このナレッジベースは一部のアプリで使用されています。削除する前にアプリから削除してください。", + "description": "`dataset_in_use` : このナレッジベースはいくつかのアプリで使用されています。削除する前にアプリから削除してください。", "content": { "application/json": { "examples": { @@ -797,10 +797,10 @@ "/datasets/{dataset_id}/document/create-by-text": { "post": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "テキストからドキュメントを作成", - "description": "テキストコンテンツからドキュメントを作成します。ドキュメントは非同期で処理されます——返された `batch` ID を [ドキュメント埋め込みステータス（進捗）を取得](/api-reference/ドキュメント/ドキュメント埋め込みステータス（進捗）を取得) で使用して進捗を追跡します。", + "summary": "テキストでドキュメントを作成", + "description": "生のテキストコンテンツからドキュメントを作成します。ドキュメントは非同期で処理されます。返された `batch` ID を[ドキュメントのインデックスステータスを取得](/api-reference/documents/get-document-indexing-status)で使用して進捗を追跡してください。", "operationId": "createDocumentFromText", "parameters": [ { @@ -811,7 +811,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -827,11 +827,11 @@ "properties": { "name": { "type": "string", - "description": "ドキュメント名です。" + "description": "ドキュメント名。" }, "text": { "type": "string", - "description": "ドキュメントのテキスト内容です。" + "description": "ドキュメントのテキストコンテンツ。" }, "indexing_technique": { "type": "string", @@ -839,7 +839,7 @@ "high_quality", "economy" ], - "description": "ナレッジベースに最初のドキュメントを追加する際に必須です。以降のドキュメントでは省略するとナレッジベースのインデックス方式を継承します。`high_quality` は埋め込みモデルによる精密検索、`economy` はキーワードベースのインデックスを使用します。" + "description": "ナレッジベースに最初のドキュメントを追加する際に必須です。省略した場合、後続のドキュメントはナレッジベースのインデックス方法を継承します。`high_quality` は埋め込みモデルを使用して精密な検索を行います。`economy` はキーワードベースのインデックスを使用します。" }, "doc_form": { "type": "string", @@ -849,16 +849,16 @@ "qa_model" ], "default": "text_model", - "description": "`text_model` は標準テキストチャンキング、`hierarchical_model` は親子チャンク構造、`qa_model` は質問・回答ペアの抽出です。" + "description": "`text_model` は標準的なテキストチャンキング、`hierarchical_model` は親子チャンク構造、`qa_model` は質問-回答ペアの抽出です。" }, "doc_language": { "type": "string", "default": "English", - "description": "処理最適化のためのドキュメント言語です。" + "description": "処理最適化のためのドキュメントの言語。" }, "process_rule": { "type": "object", - "description": "チャンキングの処理ルールです。", + "description": "チャンキングの処理ルール。", "required": [ "mode" ], @@ -870,7 +870,7 @@ "custom", "hierarchical" ], - "description": "処理モードです。`automatic` は組み込みルールを使用、`custom` は手動設定が可能、`hierarchical` は親子チャンク構造を有効にします（`doc_form: hierarchical_model` と組み合わせて使用）。" + "description": "処理モード。`automatic` は組み込みルールを使用、`custom` は手動設定を許可、`hierarchical` は親子チャンク構造を有効にします（`doc_form: hierarchical_model` と併用）。" }, "rules": { "type": "object", @@ -887,11 +887,11 @@ "remove_extra_spaces", "remove_urls_emails" ], - "description": "ルール識別子です。" + "description": "ルール識別子。" }, "enabled": { "type": "boolean", - "description": "この前処理ルールが有効かどうかです。" + "description": "この前処理ルールが有効かどうか。" } } } @@ -902,16 +902,16 @@ "separator": { "type": "string", "default": "\n", - "description": "テキスト分割用のカスタムセパレーターです。" + "description": "テキストを分割するためのカスタムデリミタ。" }, "max_tokens": { "type": "integer", - "description": "チャンクあたりの最大トークン数です。" + "description": "チャンクあたりの最大 token 数。" }, "chunk_overlap": { "type": "integer", "default": 0, - "description": "チャンク間のトークンオーバーラップです。" + "description": "チャンク間の token オーバーラップ。" } } } @@ -921,19 +921,19 @@ }, "retrieval_model": { "$ref": "#/components/schemas/RetrievalModel", - "description": "検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。" + "description": "検索モデル設定。このナレッジベースをクエリする際のチャンクの検索とランキング方法を制御します。" }, "embedding_model": { "type": "string", - "description": "埋め込みモデル名です。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `model` フィールドの値を使用します。" + "description": "埋め込みモデル名。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `model` フィールドを使用してください。" }, "embedding_model_provider": { "type": "string", - "description": "埋め込みモデルプロバイダーです。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `provider` フィールドの値を使用します。" + "description": "埋め込みモデルプロバイダー。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `provider` フィールドを使用してください。" }, "original_document_id": { "type": "string", - "description": "バージョン管理用の元ドキュメント ID です。" + "description": "バージョン管理用の元のドキュメント ID。" } } } @@ -953,7 +953,7 @@ }, "batch": { "type": "string", - "description": "インデックス進捗を追跡するためのバッチ ID です。" + "description": "インデックス進捗を追跡するためのバッチ ID。" } } }, @@ -1007,7 +1007,7 @@ } }, "400": { - "description": "- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 → モデルプロバイダーで認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しません。/ indexing_technique は必須です。/ doc_form が無効です（`text_model`、`hierarchical_model`、または `qa_model` のいずれかである必要があります）。", + "description": "- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 -> モデルプロバイダーでプロバイダーの認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しません。/ indexing_technique が必要です。/ 無効な doc_form（`text_model`、`hierarchical_model`、または `qa_model` である必要があります）。", "content": { "application/json": { "examples": { @@ -1045,10 +1045,10 @@ "/datasets/{dataset_id}/document/create-by-file": { "post": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "ファイルからドキュメントを作成", - "description": "ファイルをアップロードしてドキュメントを作成します。一般的なドキュメント形式（PDF、TXT、DOCX など）をサポートしています。処理は非同期で行われます——返された `batch` ID を [ドキュメント埋め込みステータス（進捗）を取得](/api-reference/ドキュメント/ドキュメント埋め込みステータス（進捗）を取得) で使用して進捗を追跡します。", + "summary": "ファイルでドキュメントを作成", + "description": "ファイルをアップロードしてドキュメントを作成します。一般的なドキュメント形式（PDF、TXT、DOCX など）をサポートしています。処理は非同期です。返された `batch` ID を[ドキュメントのインデックスステータスを取得](/api-reference/documents/get-document-indexing-status)で使用して進捗を追跡してください。", "operationId": "createDocumentFromFile", "parameters": [ { @@ -1059,7 +1059,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -1075,11 +1075,11 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイルです。" + "description": "アップロードするファイル。" }, "data": { "type": "string", - "description": "設定情報を含む JSON 文字列です。[テキストからドキュメントを作成](/api-reference/ドキュメント/テキストからドキュメントを作成) と同じフィールド（`indexing_technique`、`doc_form`、`doc_language`、`process_rule`、`retrieval_model`、`embedding_model`、`embedding_model_provider`）を受け付けますが、`name` と `text` は除きます。", + "description": "設定を含む JSON 文字列。[テキストでドキュメントを作成](/api-reference/documents/create-document-by-text)と同じフィールド（`indexing_technique`、`doc_form`、`doc_language`、`process_rule`、`retrieval_model`、`embedding_model`、`embedding_model_provider`）を受け付けます（`name` と `text` を除く）。", "example": "{\"indexing_technique\":\"high_quality\",\"doc_form\":\"text_model\",\"doc_language\":\"English\",\"process_rule\":{\"mode\":\"automatic\"}}" } } @@ -1100,7 +1100,7 @@ }, "batch": { "type": "string", - "description": "インデックス進捗を追跡するためのバッチ ID です。" + "description": "インデックス進捗を追跡するためのバッチ ID。" } } }, @@ -1154,7 +1154,7 @@ } }, "400": { - "description": "- `no_file_uploaded` : ファイルをアップロードしてください。\n- `too_many_files` : ファイルは 1 つのみ許可されています。\n- `filename_not_exists_error` : 指定されたファイル名が存在しません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 → モデルプロバイダーで認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、外部データセットは非対応、ファイルが大きすぎる、サポートされていないファイルタイプ、必須フィールドが不足している、または doc_form が無効です（`text_model`、`hierarchical_model`、または `qa_model` のいずれかである必要があります）。", + "description": "- `no_file_uploaded` : ファイルをアップロードしてください。\n- `too_many_files` : ファイルは 1 つのみ許可されています。\n- `filename_not_exists_error` : 指定されたファイル名が存在しません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 -> モデルプロバイダーでプロバイダーの認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、外部データセットはサポートされていない、ファイルが大きすぎる、サポートされていないファイルタイプ、必須フィールドが不足、または無効な doc_form（`text_model`、`hierarchical_model`、または `qa_model` である必要があります）。", "content": { "application/json": { "examples": { @@ -1248,10 +1248,10 @@ "/datasets/{dataset_id}/documents": { "get": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "ナレッジベースのドキュメントリストを取得", - "description": "ナレッジベース内のドキュメントのページネーションされた一覧を返します。キーワードやインデックスステータスによるフィルタリングをサポートしています。", + "summary": "ドキュメント一覧を取得", + "description": "ナレッジベース内のドキュメントのページネーションされた一覧を返します。キーワードとインデックスステータスによるフィルタリングをサポートしています。", "operationId": "listDocuments", "parameters": [ { @@ -1262,7 +1262,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "page", @@ -1280,7 +1280,7 @@ "type": "integer", "default": 20 }, - "description": "1 ページあたりの項目数です。サーバーの上限は `100` です。" + "description": "1 ページあたりのアイテム数。サーバーは `100` を上限とします。" }, { "name": "keyword", @@ -1288,7 +1288,7 @@ "schema": { "type": "string" }, - "description": "ドキュメント名でフィルタリングするための検索キーワードです。" + "description": "ドキュメント名でフィルタリングする検索キーワード。" }, { "name": "status", @@ -1305,12 +1305,12 @@ "archived" ] }, - "description": "表示ステータスでフィルタリングします。" + "description": "表示ステータスでフィルタリング。" } ], "responses": { "200": { - "description": "ドキュメントのリストです。", + "description": "ドキュメントの一覧。", "content": { "application/json": { "schema": { @@ -1318,26 +1318,26 @@ "properties": { "data": { "type": "array", - "description": "ナレッジベースオブジェクトの配列です。", + "description": "ナレッジベースオブジェクトの配列。", "items": { "$ref": "#/components/schemas/Document" } }, "has_more": { "type": "boolean", - "description": "次のページにさらに項目が存在するかどうかです。" + "description": "次のページにさらにアイテムが存在するかどうか。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1 ページあたりのアイテム数。" }, "total": { "type": "integer", - "description": "一致する項目の合計数です。" + "description": "一致するアイテムの総数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" } } }, @@ -1418,9 +1418,9 @@ "/datasets/{dataset_id}/documents/{document_id}": { "get": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "ドキュメント詳細を取得", + "summary": "ドキュメントを取得", "description": "特定のドキュメントの詳細情報（インデックスステータス、メタデータ、処理統計を含む）を取得します。", "operationId": "getDocumentDetail", "parameters": [ @@ -1432,7 +1432,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -1442,7 +1442,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "metadata", @@ -1461,7 +1461,7 @@ ], "responses": { "200": { - "description": "ドキュメントの詳細です。レスポンスの形式は `metadata` クエリパラメータによって異なります。`metadata` が `only` の場合、`id`、`doc_type`、`doc_metadata` のみが返されます。`metadata` が `without` の場合、`doc_type` と `doc_metadata` は省略されます。", + "description": "ドキュメントの詳細。レスポンスの形式は `metadata` クエリパラメータに基づいて異なります。`metadata` が `only` の場合、`id`、`doc_type`、`doc_metadata` のみが返されます。`metadata` が `without` の場合、`doc_type` と `doc_metadata` は省略されます。", "content": { "application/json": { "schema": { @@ -1469,160 +1469,160 @@ "properties": { "id": { "type": "string", - "description": "ドキュメント識別子です。" + "description": "ドキュメント識別子。" }, "position": { "type": "integer", - "description": "ナレッジベース内の位置インデックスです。" + "description": "ナレッジベース内の位置インデックス。" }, "data_source_type": { "type": "string", - "description": "ドキュメントのアップロード方法です。ファイルアップロードの場合は `upload_file`、Notion インポートの場合は `notion_import` です。" + "description": "ドキュメントのアップロード方法。`upload_file` はファイルアップロード、`notion_import` は Notion インポート。" }, "data_source_info": { "type": "object", - "description": "生データソース情報です。" + "description": "生のデータソース情報。" }, "dataset_process_rule_id": { "type": "string", - "description": "このドキュメントに適用された処理ルールの ID です。" + "description": "このドキュメントに適用された処理ルールの ID。" }, "dataset_process_rule": { "type": "object", - "description": "ナレッジベースレベルの処理ルール設定です。" + "description": "ナレッジベースレベルの処理ルール設定。" }, "document_process_rule": { "type": "object", - "description": "ドキュメントレベルの処理ルール設定です。" + "description": "ドキュメントレベルの処理ルール設定。" }, "name": { "type": "string", - "description": "ドキュメント名です。" + "description": "ドキュメント名。" }, "created_from": { "type": "string", - "description": "ドキュメントの作成元です。API で作成した場合は `api`、UI で作成した場合は `web` です。" + "description": "ドキュメントの作成元。`api` は API 作成、`web` は UI 作成。" }, "created_by": { "type": "string", - "description": "ドキュメントを作成したユーザーの ID です。" + "description": "ドキュメントを作成したユーザーの ID。" }, "created_at": { "type": "number", - "description": "ドキュメント作成の Unix タイムスタンプです。" + "description": "ドキュメント作成の Unix タイムスタンプ。" }, "tokens": { "type": "integer", - "description": "ドキュメント内のトークン数です。" + "description": "ドキュメント内の token 数。" }, "indexing_status": { "type": "string", - "description": "現在のインデックスステータスです（例：`waiting`、`parsing`、`cleaning`、`splitting`、`indexing`、`completed`、`error`、`paused`）。" + "description": "現在のインデックスステータス。例：`waiting`、`parsing`、`cleaning`、`splitting`、`indexing`、`completed`、`error`、`paused`。" }, "error": { "type": "string", "nullable": true, - "description": "インデックス作成が失敗した場合のエラーメッセージです。それ以外は `null` です。" + "description": "インデックスが失敗した場合のエラーメッセージ、それ以外は `null`。" }, "enabled": { "type": "boolean", - "description": "このドキュメントが検索に対して有効かどうかです。" + "description": "ドキュメントが検索で有効かどうか。" }, "disabled_at": { "type": "number", "nullable": true, - "description": "ドキュメントが無効化された Unix タイムスタンプです。有効な場合は `null` です。" + "description": "ドキュメントが無効化された Unix タイムスタンプ、有効な場合は `null`。" }, "disabled_by": { "type": "string", "nullable": true, - "description": "ドキュメントを無効化したユーザーの ID です。有効な場合は `null` です。" + "description": "ドキュメントを無効化したユーザーの ID、有効な場合は `null`。" }, "archived": { "type": "boolean", - "description": "ドキュメントがアーカイブ済みかどうかです。" + "description": "ドキュメントがアーカイブされているかどうか。" }, "display_status": { "type": "string", - "description": "UI 向けの表示用インデックスステータスです。" + "description": "UI 向けの表示用インデックスステータス。" }, "word_count": { "type": "integer", - "description": "ドキュメントの合計単語数です。" + "description": "ドキュメントの総単語数。" }, "hit_count": { "type": "integer", - "description": "このドキュメントが検索された回数です。" + "description": "このドキュメントが検索された回数。" }, "doc_form": { "type": "string", - "description": "ドキュメントのチャンキングモードです。`text_model` は標準テキスト、`hierarchical_model` は親子構造、`qa_model` は QA ペアを示します。" + "description": "ドキュメントのチャンキングモード。`text_model` は標準テキスト、`hierarchical_model` は親子構造、`qa_model` は QA ペア。" }, "doc_language": { "type": "string", - "description": "ドキュメント内容の言語です。" + "description": "ドキュメントコンテンツの言語。" }, "doc_type": { "type": "string", "nullable": true, - "description": "ドキュメントタイプの分類です。未設定の場合は `null` です。" + "description": "ドキュメントタイプの分類、設定されていない場合は `null`。" }, "doc_metadata": { "type": "array", + "description": "このドキュメントのカスタムメタデータキーバリューペア。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの種類です。" + "description": "メタデータフィールドタイプ。" }, "value": { "type": "string", "description": "このドキュメントのメタデータフィールド値。" } } - }, - "description": "このドキュメントのカスタムメタデータキーバリューペア。" + } }, "completed_at": { "type": "number", "nullable": true, - "description": "処理が完了した Unix タイムスタンプです。まだ完了していない場合は `null` です。" + "description": "処理が完了した Unix タイムスタンプ、まだ完了していない場合は `null`。" }, "updated_at": { "type": "number", "nullable": true, - "description": "最終更新の Unix タイムスタンプです。更新されたことがない場合は `null` です。" + "description": "最終更新の Unix タイムスタンプ、更新されていない場合は `null`。" }, "indexing_latency": { "type": "number", "nullable": true, - "description": "インデックス作成にかかった時間（秒）です。未完了の場合は `null` です。" + "description": "インデックスにかかった時間（秒）、完了していない場合は `null`。" }, "segment_count": { "type": "integer", - "description": "ドキュメント内のチャンク数です。" + "description": "ドキュメント内のチャンク数。" }, "average_segment_length": { "type": "number", - "description": "チャンクの平均文字長です。" + "description": "チャンクの平均文字長。" }, "summary_index_status": { "type": "string", "nullable": true, - "description": "要約インデックスのステータスです。要約インデックスが有効でない場合は `null` です。" + "description": "要約インデックスのステータス、要約インデックスが有効でない場合は `null`。" }, "need_summary": { "type": "boolean", - "description": "このドキュメントが要約生成を必要とするかどうかです。" + "description": "ドキュメントが要約生成を必要とするかどうか。" } } }, @@ -1738,10 +1738,10 @@ }, "delete": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメントを削除", - "description": "ナレッジベースからドキュメントとそのすべてのチャンクを完全に削除します。", + "description": "ドキュメントとそのすべてのチャンクをナレッジベースから完全に削除します。", "operationId": "deleteDocument", "parameters": [ { @@ -1752,7 +1752,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -1762,15 +1762,15 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" } ], "responses": { "204": { - "description": "Success." + "description": "成功。" }, "400": { - "description": "`document_indexing` : インデキシング中はドキュメントを削除できません。", + "description": "`document_indexing` : インデックス中のドキュメントは削除できません。", "content": { "application/json": { "examples": { @@ -1826,11 +1826,11 @@ "/datasets/{dataset_id}/documents/{document_id}/download": { "get": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメントをダウンロード", "description": "ドキュメントの元のアップロードファイルの署名付きダウンロード URL を取得します。", - "operationId": "downloadDocumentJa", + "operationId": "downloadDocument", "parameters": [ { "name": "dataset_id", @@ -1840,7 +1840,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -1850,7 +1850,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" } ], "responses": { @@ -1863,7 +1863,7 @@ "properties": { "url": { "type": "string", - "description": "元のアップロードファイルをダウンロードするための署名付き URL です。" + "description": "元のアップロードファイルをダウンロードするための署名付き URL。" } } }, @@ -1918,10 +1918,10 @@ "/datasets/{dataset_id}/documents/{batch}/indexing-status": { "get": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "ドキュメント埋め込みステータス（進捗）を取得", - "description": "バッチ内のドキュメントのインデックス進捗を確認します。各ドキュメントの現在の処理段階とチャンク完了数を返します。`indexing_status` が `completed` または `error` に達するまでこのエンドポイントをポーリングしてください。ステータスは次の順序で進行します：`waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`。", + "summary": "ドキュメントのインデックスステータスを取得", + "description": "バッチ内のドキュメントのインデックス進捗を確認します。各ドキュメントの現在の処理段階とチャンク完了数を返します。`indexing_status` が `completed` または `error` になるまでこのエンドポイントをポーリングしてください。ステータスは `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed` の順に進行します。", "operationId": "getDocumentIndexingStatus", "parameters": [ { @@ -1932,7 +1932,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "batch", @@ -1941,12 +1941,12 @@ "schema": { "type": "string" }, - "description": "ドキュメント作成時に返されるバッチ ID です。" + "description": "ドキュメント作成から返されたバッチ ID。" } ], "responses": { "200": { - "description": "バッチ内のドキュメントのインデックス状態です。", + "description": "バッチ内のドキュメントのインデックスステータス。", "content": { "application/json": { "schema": { @@ -1954,63 +1954,63 @@ "properties": { "data": { "type": "array", + "description": "インデックスステータスエントリのリスト。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "ドキュメント識別子です。" + "description": "ドキュメント識別子。" }, "indexing_status": { "type": "string", - "description": "現在のインデックスステータスです：`waiting`、`parsing`、`cleaning`、`splitting`、`indexing`、`completed`、または `error`。" + "description": "現在のインデックスステータス：`waiting`、`parsing`、`cleaning`、`splitting`、`indexing`、`completed`、または `error`。" }, "processing_started_at": { "type": "number", - "description": "処理開始時の Unix タイムスタンプです。" + "description": "処理が開始された Unix タイムスタンプ。" }, "parsing_completed_at": { "type": "number", - "description": "パース完了時の Unix タイムスタンプです。" + "description": "パースが完了した Unix タイムスタンプ。" }, "cleaning_completed_at": { "type": "number", - "description": "クリーニング完了時の Unix タイムスタンプです。" + "description": "クリーニングが完了した Unix タイムスタンプ。" }, "splitting_completed_at": { "type": "number", - "description": "分割完了時の Unix タイムスタンプです。" + "description": "分割が完了した Unix タイムスタンプ。" }, "completed_at": { "type": "number", - "description": "インデックス完了時の Unix タイムスタンプです。" + "description": "インデックスが完了した Unix タイムスタンプ。" }, "paused_at": { "type": "number", "nullable": true, - "description": "インデキシングが一時停止されたタイムスタンプ。一時停止されていない場合は `null`。" + "description": "インデックスが一時停止されたタイムスタンプ。一時停止されていない場合は `null`。" }, "error": { "type": "string", "nullable": true, - "description": "インデキシングが失敗した場合のエラーメッセージ。エラーがない場合は `null`。" + "description": "インデックスが失敗した場合のエラーメッセージ。エラーがない場合は `null`。" }, "stopped_at": { "type": "number", "nullable": true, - "description": "インデキシングが停止されたタイムスタンプ。停止されていない場合は `null`。" + "description": "インデックスが停止されたタイムスタンプ。停止されていない場合は `null`。" }, "completed_segments": { "type": "integer", - "description": "インデックス済みのチャンク数です。" + "description": "インデックス済みのチャンク数。" }, "total_segments": { "type": "integer", - "description": "インデックス対象のチャンクの合計数です。" + "description": "インデックスするチャンクの総数。" } } - }, - "description": "インデキシングステータスエントリのリスト。" + } } } }, @@ -2071,10 +2071,10 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-text": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "テキストでドキュメントを更新", - "description": "既存ドキュメントのテキストコンテンツ、名前、または処理設定を更新します。コンテンツが変更された場合はインデックスが再トリガーされます——返された `batch` ID を [ドキュメント埋め込みステータス（進捗）を取得](/api-reference/ドキュメント/ドキュメント埋め込みステータス（進捗）を取得) で使用して進捗を追跡します。", + "description": "既存のドキュメントのテキストコンテンツ、名前、または処理設定を更新します。コンテンツが変更された場合はインデックスが再トリガーされます。返された `batch` ID を[ドキュメントのインデックスステータスを取得](/api-reference/documents/get-document-indexing-status)で使用して進捗を追跡してください。", "operationId": "updateDocumentByText", "parameters": [ { @@ -2085,7 +2085,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -2095,7 +2095,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" } ], "requestBody": { @@ -2107,15 +2107,15 @@ "properties": { "name": { "type": "string", - "description": "ドキュメント名です。`text` を指定する場合は必須です。" + "description": "ドキュメント名。`text` が提供される場合は必須です。" }, "text": { "type": "string", - "description": "ドキュメントのテキスト内容です。" + "description": "ドキュメントのテキストコンテンツ。" }, "process_rule": { "type": "object", - "description": "チャンキングの処理ルールです。", + "description": "チャンキングの処理ルール。", "required": [ "mode" ], @@ -2127,7 +2127,7 @@ "custom", "hierarchical" ], - "description": "処理モードです。`automatic` は組み込みルールを使用、`custom` は手動設定が可能、`hierarchical` は親子チャンク構造を有効にします（`doc_form: hierarchical_model` と組み合わせて使用）。" + "description": "処理モード。`automatic` は組み込みルールを使用、`custom` は手動設定を許可、`hierarchical` は親子チャンク構造を有効にします（`doc_form: hierarchical_model` と併用）。" }, "rules": { "type": "object", @@ -2144,11 +2144,11 @@ "remove_extra_spaces", "remove_urls_emails" ], - "description": "ルール識別子です。" + "description": "ルール識別子。" }, "enabled": { "type": "boolean", - "description": "この前処理ルールが有効かどうかです。" + "description": "この前処理ルールが有効かどうか。" } } } @@ -2159,16 +2159,16 @@ "separator": { "type": "string", "default": "\n", - "description": "テキスト分割用のカスタムセパレーターです。" + "description": "テキストを分割するためのカスタムデリミタ。" }, "max_tokens": { "type": "integer", - "description": "チャンクあたりの最大トークン数です。" + "description": "チャンクあたりの最大 token 数。" }, "chunk_overlap": { "type": "integer", "default": 0, - "description": "チャンク間のトークンオーバーラップです。" + "description": "チャンク間の token オーバーラップ。" } } } @@ -2184,16 +2184,16 @@ "qa_model" ], "default": "text_model", - "description": "`text_model` は標準テキストチャンキング、`hierarchical_model` は親子チャンク構造、`qa_model` は質問・回答ペアの抽出です。" + "description": "`text_model` は標準的なテキストチャンキング、`hierarchical_model` は親子チャンク構造、`qa_model` は質問-回答ペアの抽出です。" }, "doc_language": { "type": "string", "default": "English", - "description": "処理最適化のためのドキュメント言語です。" + "description": "処理最適化のためのドキュメントの言語。" }, "retrieval_model": { "$ref": "#/components/schemas/RetrievalModel", - "description": "検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。" + "description": "検索モデル設定。このナレッジベースをクエリする際のチャンクの検索とランキング方法を制御します。" } } } @@ -2213,7 +2213,7 @@ }, "batch": { "type": "string", - "description": "インデックス進捗を追跡するためのバッチ ID です。" + "description": "インデックス進捗を追跡するためのバッチ ID。" } } }, @@ -2267,7 +2267,7 @@ } }, "400": { - "description": "- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 → モデルプロバイダーで認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、テキスト指定時は name が必須、または doc_form が無効です（`text_model`、`hierarchical_model`、または `qa_model` のいずれかである必要があります）。", + "description": "- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 -> モデルプロバイダーでプロバイダーの認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、text が提供される場合は name が必要、または無効な doc_form（`text_model`、`hierarchical_model`、または `qa_model` である必要があります）。", "content": { "application/json": { "examples": { @@ -2305,10 +2305,10 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-file": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ファイルでドキュメントを更新", - "description": "新しいファイルをアップロードして既存のドキュメントを更新します。インデックスが再トリガーされます——返された `batch` ID を [ドキュメント埋め込みステータス（進捗）を取得](/api-reference/ドキュメント/ドキュメント埋め込みステータス（進捗）を取得) で使用して進捗を追跡します。", + "description": "新しいファイルをアップロードして既存のドキュメントを更新します。インデックスが再トリガーされます。返された `batch` ID を[ドキュメントのインデックスステータスを取得](/api-reference/documents/get-document-indexing-status)で使用して進捗を追跡してください。", "operationId": "updateDocumentByFile", "parameters": [ { @@ -2319,7 +2319,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -2329,7 +2329,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" } ], "requestBody": { @@ -2342,11 +2342,11 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイルです。" + "description": "アップロードするファイル。" }, "data": { "type": "string", - "description": "設定情報を含む JSON 文字列です。[テキストからドキュメントを作成](/api-reference/ドキュメント/テキストからドキュメントを作成) と同じフィールド（`indexing_technique`、`doc_form`、`doc_language`、`process_rule`、`retrieval_model`、`embedding_model`、`embedding_model_provider`）を受け付けますが、`name` と `text` は除きます。", + "description": "設定を含む JSON 文字列。[テキストでドキュメントを作成](/api-reference/documents/create-document-by-text)と同じフィールド（`indexing_technique`、`doc_form`、`doc_language`、`process_rule`、`retrieval_model`、`embedding_model`、`embedding_model_provider`）を受け付けます（`name` と `text` を除く）。", "example": "{\"indexing_technique\":\"high_quality\",\"doc_form\":\"text_model\",\"doc_language\":\"English\",\"process_rule\":{\"mode\":\"automatic\"}}" } } @@ -2367,7 +2367,7 @@ }, "batch": { "type": "string", - "description": "インデックス進捗を追跡するためのバッチ ID です。" + "description": "インデックス進捗を追跡するためのバッチ ID。" } } }, @@ -2421,7 +2421,7 @@ } }, "400": { - "description": "- `too_many_files` : ファイルは 1 つのみ許可されています。\n- `filename_not_exists_error` : 指定されたファイル名が存在しません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 → モデルプロバイダーで認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、外部データセットは非対応、ファイルが大きすぎる、サポートされていないファイルタイプ、または doc_form が無効です（`text_model`、`hierarchical_model`、または `qa_model` のいずれかである必要があります）。", + "description": "- `too_many_files` : ファイルは 1 つのみ許可されています。\n- `filename_not_exists_error` : 指定されたファイル名が存在しません。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 -> モデルプロバイダーでプロバイダーの認証情報を完了してください。\n- `invalid_param` : ナレッジベースが存在しない、外部データセットはサポートされていない、ファイルが大きすぎる、サポートされていないファイルタイプ、または無効な doc_form（`text_model`、`hierarchical_model`、または `qa_model` である必要があります）。", "content": { "application/json": { "examples": { @@ -2491,11 +2491,11 @@ "/datasets/{dataset_id}/documents/download-zip": { "post": { "tags": [ - "ドキュメント" + "Documents" ], - "summary": "ドキュメントを一括ダウンロード（ZIP）", - "description": "複数のアップロードファイルドキュメントを単一の ZIP アーカイブとしてダウンロードします。最大 `100` 件のドキュメント ID を受け付けます。", - "operationId": "downloadDocumentsZipJa", + "summary": "ドキュメントを ZIP としてダウンロード", + "description": "複数のアップロードファイルドキュメントを単一の ZIP アーカイブとしてダウンロードします。最大 `100` 個のドキュメント ID を受け付けます。", + "operationId": "downloadDocumentsZip", "parameters": [ { "name": "dataset_id", @@ -2505,7 +2505,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -2526,7 +2526,7 @@ "type": "string", "format": "uuid" }, - "description": "ZIP アーカイブに含めるドキュメント ID の配列です。" + "description": "ZIP アーカイブに含めるドキュメント ID の配列。" } } } @@ -2535,19 +2535,19 @@ }, "responses": { "200": { - "description": "リクエストされたドキュメントを含む ZIP アーカイブです。", + "description": "リクエストされたドキュメントを含む ZIP アーカイブ。", "content": { "application/zip": { "schema": { "type": "string", "format": "binary", - "description": "ZIP アーカイブのバイナリストリームです。" + "description": "ZIP アーカイブバイナリストリーム。" } } } }, "403": { - "description": "`forbidden` : 権限が不足しています。", + "description": "`forbidden` : 権限がありません。", "content": { "application/json": { "examples": { @@ -2564,7 +2564,7 @@ } }, "404": { - "description": "`not_found` : ドキュメントまたはナレッジベースが見つかりません。", + "description": "`not_found` : ドキュメントまたはデータセットが見つかりません。", "content": { "application/json": { "examples": { @@ -2586,10 +2586,10 @@ "/datasets/{dataset_id}/documents/status/{action}": { "patch": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメントステータスを一括更新", - "description": "複数のドキュメントを一括で有効化、無効化、アーカイブ、またはアーカイブ解除します。", + "description": "複数のドキュメントを一度に有効化、無効化、アーカイブ、またはアーカイブ解除します。", "operationId": "batchUpdateDocumentStatus", "parameters": [ { @@ -2600,7 +2600,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "action", @@ -2615,7 +2615,7 @@ "un_archive" ] }, - "description": "`enable` で有効化、`disable` で無効化、`archive` でアーカイブ、`un_archive` でアーカイブから復元します。" + "description": "`enable` は有効化、`disable` は無効化、`archive` はアーカイブ、`un_archive` はアーカイブから復元。" } ], "requestBody": { @@ -2633,7 +2633,7 @@ "items": { "type": "string" }, - "description": "更新するドキュメント ID のリストです。" + "description": "更新するドキュメント ID のリスト。" } } } @@ -2650,7 +2650,7 @@ "properties": { "result": { "type": "string", - "description": "操作結果です。" + "description": "操作結果。" } } }, @@ -2683,7 +2683,7 @@ } }, "403": { - "description": "`forbidden` : 権限が不足しています。", + "description": "`forbidden` : 権限がありません。", "content": { "application/json": { "examples": { @@ -2722,9 +2722,9 @@ "/datasets/{dataset_id}/documents/{document_id}/segments": { "post": { "tags": [ - "チャンク" + "Chunks" ], - "summary": "ドキュメントにチャンクを追加", + "summary": "チャンクを作成", "description": "ドキュメント内に 1 つ以上のチャンクを作成します。各チャンクにはオプションのキーワードと回答フィールド（QA モードドキュメント用）を含めることができます。", "operationId": "createSegments", "parameters": [ @@ -2736,7 +2736,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -2746,7 +2746,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" } ], "requestBody": { @@ -2766,29 +2766,29 @@ "properties": { "content": { "type": "string", - "description": "チャンクのテキスト内容です。" + "description": "チャンクのテキストコンテンツ。" }, "answer": { "type": "string", - "description": "QA モードの回答内容です。" + "description": "QA モード用の回答コンテンツ。" }, "keywords": { "type": "array", "items": { "type": "string" }, - "description": "チャンクのキーワードです。" + "description": "チャンクのキーワード。" }, "attachment_ids": { "type": "array", "items": { "type": "string" }, - "description": "添付ファイル ID です。" + "description": "添付ファイル ID。" } } }, - "description": "作成するチャンクオブジェクトの配列です。" + "description": "作成するチャンクオブジェクトの配列。" } } } @@ -2805,14 +2805,14 @@ "properties": { "data": { "type": "array", + "description": "作成されたチャンクのリスト。", "items": { "$ref": "#/components/schemas/Segment" - }, - "description": "作成されたチャンクのリスト。" + } }, "doc_form": { "type": "string", - "description": "このドキュメントが使用するドキュメントチャンキングモードです。" + "description": "このドキュメントで使用されているドキュメントチャンキングモード。" } } }, @@ -2863,7 +2863,7 @@ } }, "404": { - "description": "`not_found` : ドキュメントが完了していないか、無効になっています。", + "description": "`not_found` : ドキュメントが完了していないか無効です。", "content": { "application/json": { "examples": { @@ -2891,10 +2891,10 @@ }, "get": { "tags": [ - "チャンク" + "Chunks" ], "summary": "チャンク一覧を取得", - "description": "ドキュメント内のチャンクのページネーションリストを返します。キーワードとステータスによるフィルタリングをサポートしています。", + "description": "ドキュメント内のチャンクのページネーションされた一覧を返します。キーワードとステータスによるフィルタリングをサポートしています。", "operationId": "listSegments", "parameters": [ { @@ -2905,7 +2905,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -2915,7 +2915,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "page", @@ -2933,7 +2933,7 @@ "type": "integer", "default": 20 }, - "description": "1 ページあたりの項目数です。サーバーの上限は `100` です。" + "description": "1 ページあたりのアイテム数。サーバーは `100` を上限とします。" }, { "name": "status", @@ -2946,7 +2946,7 @@ }, "style": "form", "explode": true, - "description": "インデックスステータスでチャンクをフィルタリングします（例：`completed`、`indexing`、`error`）。" + "description": "インデックスステータスでチャンクをフィルタリング。例：`completed`、`indexing`、`error`。" }, { "name": "keyword", @@ -2954,12 +2954,12 @@ "schema": { "type": "string" }, - "description": "検索キーワードです。" + "description": "検索キーワード。" } ], "responses": { "200": { - "description": "チャンクのリストです。", + "description": "チャンクの一覧。", "content": { "application/json": { "schema": { @@ -2967,30 +2967,30 @@ "properties": { "data": { "type": "array", + "description": "チャンクのリスト。", "items": { "$ref": "#/components/schemas/Segment" - }, - "description": "チャンクのリスト。" + } }, "doc_form": { "type": "string", - "description": "このドキュメントが使用するドキュメントチャンキングモードです。" + "description": "このドキュメントで使用されているドキュメントチャンキングモード。" }, "total": { "type": "integer", - "description": "一致するチャンクの合計数です。" + "description": "一致するチャンクの総数。" }, "has_more": { "type": "boolean", - "description": "次のページにさらに項目が存在するかどうかです。" + "description": "次のページにさらにアイテムが存在するかどうか。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1 ページあたりのアイテム数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" } } }, @@ -3050,10 +3050,10 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}": { "get": { "tags": [ - "チャンク" + "Chunks" ], - "summary": "ドキュメント内のチャンク詳細を取得", - "description": "特定のチャンクの詳細情報（内容、キーワード、インデックスステータスを含む）を取得します。", + "summary": "チャンクを取得", + "description": "特定のチャンクの詳細情報（コンテンツ、キーワード、インデックスステータスを含む）を取得します。", "operationId": "getSegmentDetail", "parameters": [ { @@ -3064,7 +3064,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3074,7 +3074,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3084,12 +3084,12 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" } ], "responses": { "200": { - "description": "チャンクの詳細です。", + "description": "チャンクの詳細。", "content": { "application/json": { "schema": { @@ -3100,7 +3100,7 @@ }, "doc_form": { "type": "string", - "description": "このドキュメントが使用するドキュメントチャンキングモードです。" + "description": "このドキュメントで使用されているドキュメントチャンキングモード。" } } }, @@ -3152,10 +3152,10 @@ }, "post": { "tags": [ - "チャンク" + "Chunks" ], - "summary": "ドキュメント内のチャンクを更新", - "description": "チャンクのコンテンツ、キーワード、または回答を更新します。変更されたチャンクのインデックス作成が再トリガーされます。", + "summary": "チャンクを更新", + "description": "チャンクのコンテンツ、キーワード、または回答を更新します。変更されたチャンクのインデックスが再トリガーされます。", "operationId": "updateSegment", "parameters": [ { @@ -3166,7 +3166,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3176,7 +3176,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3186,7 +3186,7 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" } ], "requestBody": { @@ -3204,42 +3204,42 @@ "properties": { "content": { "type": "string", - "description": "チャンクのテキスト内容です。" + "description": "チャンクのテキストコンテンツ。" }, "answer": { "type": "string", - "description": "QA モードの回答内容です。" + "description": "QA モード用の回答コンテンツ。" }, "keywords": { "type": "array", "items": { "type": "string" }, - "description": "チャンクのキーワードです。" + "description": "チャンクのキーワード。" }, "enabled": { "type": "boolean", - "description": "チャンクが有効かどうかです。" + "description": "チャンクが有効かどうか。" }, "regenerate_child_chunks": { "type": "boolean", "default": false, - "description": "子チャンクを再生成するかどうかです。" + "description": "子チャンクを再生成するかどうか。" }, "attachment_ids": { "type": "array", "items": { "type": "string" }, - "description": "添付ファイル ID です。" + "description": "添付ファイル ID。" }, "summary": { "type": "string", "nullable": true, - "description": "サマリーインデックスのサマリー内容です。" + "description": "要約インデックス用の要約コンテンツ。" } }, - "description": "更新するチャンクデータです。" + "description": "更新するチャンクデータ。" } } } @@ -3259,7 +3259,7 @@ }, "doc_form": { "type": "string", - "description": "このドキュメントが使用するドキュメントチャンキングモードです。" + "description": "このドキュメントで使用されているドキュメントチャンキングモード。" } } }, @@ -3311,9 +3311,9 @@ }, "delete": { "tags": [ - "チャンク" + "Chunks" ], - "summary": "ドキュメント内のチャンクを削除", + "summary": "チャンクを削除", "description": "ドキュメントからチャンクを完全に削除します。", "operationId": "deleteSegment", "parameters": [ @@ -3325,7 +3325,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3335,7 +3335,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3345,12 +3345,12 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" } ], "responses": { "204": { - "description": "Success." + "description": "成功。" } } } @@ -3358,10 +3358,10 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks": { "post": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを作成", - "description": "親チャンクの下に子チャンクを作成します。`hierarchical_model` チャンキングモードを使用しているドキュメントでのみ利用可能です。", + "description": "親チャンクの下に子チャンクを作成します。`hierarchical_model` チャンキングモードを使用するドキュメントでのみ利用可能です。", "operationId": "createChildChunk", "parameters": [ { @@ -3372,7 +3372,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3382,7 +3382,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3392,7 +3392,7 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" } ], "requestBody": { @@ -3407,7 +3407,7 @@ "properties": { "content": { "type": "string", - "description": "子チャンクのテキスト内容です。" + "description": "子チャンクのテキストコンテンツ。" } } } @@ -3468,10 +3468,10 @@ }, "get": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンク一覧を取得", - "description": "特定の親チャンク配下の子チャンクのページネーションリストを返します。", + "description": "特定の親チャンクの下にある子チャンクのページネーションされた一覧を返します。", "operationId": "getChildChunks", "parameters": [ { @@ -3482,7 +3482,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3492,7 +3492,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3502,7 +3502,7 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" }, { "name": "page", @@ -3522,7 +3522,7 @@ "default": 20, "minimum": 1 }, - "description": "1 ページあたりの項目数です。サーバーの上限は `100` です。" + "description": "1 ページあたりのアイテム数。サーバーは `100` を上限とします。" }, { "name": "keyword", @@ -3530,12 +3530,12 @@ "schema": { "type": "string" }, - "description": "検索キーワードです。" + "description": "検索キーワード。" } ], "responses": { "200": { - "description": "子チャンクのリストです。", + "description": "子チャンクの一覧。", "content": { "application/json": { "schema": { @@ -3543,26 +3543,26 @@ "properties": { "data": { "type": "array", + "description": "子チャンクのリスト。", "items": { "$ref": "#/components/schemas/ChildChunk" - }, - "description": "子チャンクのリスト。" + } }, "total": { "type": "integer", - "description": "子チャンクの合計数です。" + "description": "子チャンクの総数。" }, "total_pages": { "type": "integer", - "description": "合計ページ数です。" + "description": "総ページ数。" }, "page": { "type": "integer", - "description": "現在のページ番号です。" + "description": "現在のページ番号。" }, "limit": { "type": "integer", - "description": "1 ページあたりの件数です。" + "description": "1 ページあたりのアイテム数。" } } }, @@ -3598,7 +3598,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}": { "patch": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを更新", "description": "既存の子チャンクのコンテンツを更新します。", @@ -3612,7 +3612,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3622,7 +3622,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3632,7 +3632,7 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" }, { "name": "child_chunk_id", @@ -3642,7 +3642,7 @@ "type": "string", "format": "uuid" }, - "description": "子チャンク ID です。" + "description": "子チャンク ID。" } ], "requestBody": { @@ -3657,7 +3657,7 @@ "properties": { "content": { "type": "string", - "description": "子チャンクのテキスト内容です。" + "description": "子チャンクのテキストコンテンツ。" } } } @@ -3718,7 +3718,7 @@ }, "delete": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを削除", "description": "親チャンクから子チャンクを完全に削除します。", @@ -3732,7 +3732,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "document_id", @@ -3742,7 +3742,7 @@ "type": "string", "format": "uuid" }, - "description": "Document ID." + "description": "ドキュメント ID。" }, { "name": "segment_id", @@ -3752,7 +3752,7 @@ "type": "string", "format": "uuid" }, - "description": "Chunk ID." + "description": "チャンク ID。" }, { "name": "child_chunk_id", @@ -3762,12 +3762,12 @@ "type": "string", "format": "uuid" }, - "description": "子チャンク ID です。" + "description": "子チャンク ID。" } ], "responses": { "204": { - "description": "Success." + "description": "成功。" }, "400": { "description": "`invalid_param` : 子チャンクインデックスの削除に失敗しました。", @@ -3792,10 +3792,10 @@ "/datasets/{dataset_id}/retrieve": { "post": { "tags": [ - "データセット" + "Knowledge Bases" ], - "summary": "ナレッジベースからチャンクを取得 / テスト検索", - "description": "ナレッジベースに対して検索クエリを実行し、最も関連性の高いチャンクを取得します。このエンドポイントは本番環境の検索とテスト検索の両方に使用できます。", + "summary": "ナレッジベースからチャンクを検索 / 検索テスト", + "description": "ナレッジベースに対して検索クエリを実行し、最も関連性の高いチャンクを取得します。このエンドポイントは本番環境での検索と検索テストの両方に使用できます。", "operationId": "retrieveSegments", "parameters": [ { @@ -3806,7 +3806,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -3822,27 +3822,27 @@ "query": { "type": "string", "maxLength": 250, - "description": "検索クエリテキストです。" + "description": "検索クエリテキスト。" }, "retrieval_model": { "$ref": "#/components/schemas/RetrievalModel", - "description": "検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。" + "description": "検索モデル設定。このナレッジベースをクエリする際のチャンクの検索とランキング方法を制御します。" }, "external_retrieval_model": { "type": "object", - "description": "外部ナレッジベースの検索設定です。", + "description": "外部ナレッジベースの検索設定。", "properties": { "top_k": { "type": "integer", - "description": "返す結果の最大数です。" + "description": "返す結果の最大数。" }, "score_threshold": { "type": "number", - "description": "結果フィルタリング用の最小関連性スコア閾値です。" + "description": "結果をフィルタリングするための最小関連性スコアしきい値。" }, "score_threshold_enabled": { "type": "boolean", - "description": "スコア閾値フィルタリングが有効かどうかです。" + "description": "スコアしきい値フィルタリングが有効かどうか。" } } }, @@ -3852,7 +3852,7 @@ "type": "string" }, "nullable": true, - "description": "検索コンテキストに含める添付ファイル ID のリストです。" + "description": "検索コンテキストに含める添付ファイル ID のリスト。" } } } @@ -3861,7 +3861,7 @@ }, "responses": { "200": { - "description": "検索結果です。", + "description": "検索結果。", "content": { "application/json": { "schema": { @@ -3869,26 +3869,27 @@ "properties": { "query": { "type": "object", - "description": "元のクエリオブジェクトです。", + "description": "元のクエリオブジェクト。", "properties": { "content": { "type": "string", - "description": "クエリテキストです。" + "description": "クエリテキスト。" } } }, "records": { "type": "array", + "description": "一致した検索レコードのリスト。", "items": { "type": "object", "properties": { "segment": { "type": "object", - "description": "ナレッジベースから一致したチャンクです。", + "description": "ナレッジベースから一致したチャンク。", "properties": { "id": { "type": "string", - "description": "チャンクの一意識別子です。" + "description": "チャンクの一意識別子。" }, "position": { "type": "integer", @@ -3896,118 +3897,118 @@ }, "document_id": { "type": "string", - "description": "このチャンクが属するドキュメントの ID です。" + "description": "このチャンクが属するドキュメントの ID。" }, "content": { "type": "string", - "description": "チャンクのテキスト内容です。" + "description": "チャンクのテキストコンテンツ。" }, "sign_content": { "type": "string", - "description": "整合性検証用の署名付きコンテンツハッシュです。" + "description": "整合性検証用の署名付きコンテンツハッシュ。" }, "answer": { "type": "string", - "description": "回答コンテンツです。Q&A モードのドキュメントで使用されます。" + "description": "Q&A モードドキュメントで使用される回答コンテンツ。" }, "word_count": { "type": "integer", - "description": "チャンク内容の単語数です。" + "description": "チャンクコンテンツの単語数。" }, "tokens": { "type": "integer", - "description": "チャンク内容のトークン数です。" + "description": "チャンクコンテンツの token 数。" }, "keywords": { "type": "array", - "description": "キーワードベースの検索のためにこのチャンクに関連付けられたキーワードです。", + "description": "キーワードベースの検索に関連付けられたキーワード。", "items": { "type": "string" } }, "index_node_id": { "type": "string", - "description": "ベクトルストア内のインデックスノードの ID です。" + "description": "ベクトルストア内のインデックスノードの ID。" }, "index_node_hash": { "type": "string", - "description": "インデックスされたコンテンツのハッシュです。変更の検出に使用されます。" + "description": "変更を検出するために使用されるインデックス済みコンテンツのハッシュ。" }, "hit_count": { "type": "integer", - "description": "このチャンクが検索クエリでマッチした回数です。" + "description": "このチャンクが検索クエリで一致した回数。" }, "enabled": { "type": "boolean", - "description": "このチャンクが検索に対して有効かどうかです。" + "description": "チャンクが検索で有効かどうか。" }, "disabled_at": { "type": "number", "nullable": true, - "description": "チャンクが無効化されたタイムスタンプです。有効な場合は `null` です。" + "description": "チャンクが無効化されたタイムスタンプ。有効な場合は `null`。" }, "disabled_by": { "type": "string", "nullable": true, - "description": "チャンクを無効化したユーザーの ID です。有効な場合は `null` です。" + "description": "チャンクを無効化したユーザーの ID。有効な場合は `null`。" }, "status": { "type": "string", - "description": "チャンクのインデックスステータスです。" + "description": "チャンクのインデックスステータス。" }, "created_by": { "type": "string", - "description": "チャンクを作成したユーザーの ID です。" + "description": "チャンクを作成したユーザーの ID。" }, "created_at": { "type": "number", - "description": "作成タイムスタンプ（Unix エポック、秒単位）です。" + "description": "作成タイムスタンプ（Unix エポック秒）。" }, "indexing_at": { "type": "number", "nullable": true, - "description": "インデックス作成が開始されたタイムスタンプです。まだ開始されていない場合は `null` です。" + "description": "インデックスが開始されたタイムスタンプ。まだ開始されていない場合は `null`。" }, "completed_at": { "type": "number", "nullable": true, - "description": "インデックス作成が完了したタイムスタンプです。まだ完了していない場合は `null` です。" + "description": "インデックスが完了したタイムスタンプ。まだ完了していない場合は `null`。" }, "error": { "type": "string", "nullable": true, - "description": "インデックス作成が失敗した場合のエラーメッセージです。エラーなしの場合は `null` です。" + "description": "インデックスが失敗した場合のエラーメッセージ。エラーがない場合は `null`。" }, "stopped_at": { "type": "number", "nullable": true, - "description": "インデックス作成が停止されたタイムスタンプです。停止されていない場合は `null` です。" + "description": "インデックスが停止されたタイムスタンプ。停止されていない場合は `null`。" }, "document": { "type": "object", - "description": "マッチしたチャンクの親ドキュメント情報です。", + "description": "一致したチャンクの親ドキュメント情報。", "properties": { "id": { "type": "string", - "description": "ドキュメントの一意識別子です。" + "description": "ドキュメントの一意識別子。" }, "data_source_type": { "type": "string", - "description": "ドキュメントの作成方法です。" + "description": "ドキュメントの作成方法。" }, "name": { "type": "string", - "description": "ドキュメント名です。" + "description": "ドキュメント名。" }, "doc_type": { "type": "string", "nullable": true, - "description": "ドキュメントタイプの分類です。未設定の場合は `null` です。" + "description": "ドキュメントタイプの分類。設定されていない場合は `null`。" }, "doc_metadata": { "type": "object", "nullable": true, - "description": "ドキュメントのメタデータ値です。メタデータが設定されていない場合は `null` です。" + "description": "ドキュメントのメタデータ値。メタデータが設定されていない場合は `null`。" } } } @@ -4015,51 +4016,51 @@ }, "child_chunks": { "type": "array", - "description": "階層インデックスを使用している場合、チャンク内でマッチした子チャンクです。", + "description": "階層インデックスを使用している場合の、チャンク内の一致した子チャンク。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "子チャンクの一意識別子です。" + "description": "子チャンクの一意識別子。" }, "content": { "type": "string", - "description": "子チャンクのテキスト内容です。" + "description": "子チャンクのテキストコンテンツ。" }, "position": { "type": "integer", - "description": "親チャンク内の子チャンクの位置です。" + "description": "親チャンク内の子チャンクの位置。" }, "score": { "type": "number", - "description": "子チャンクの関連性スコアです。" + "description": "子チャンクの関連性スコア。" } } } }, "score": { "type": "number", - "description": "関連性スコアです。" + "description": "関連性スコア。" }, "tsne_position": { "type": "object", "nullable": true, - "description": "t-SNE 可視化の位置です。" + "description": "t-SNE 可視化位置。" }, "files": { "type": "array", - "description": "このチャンクに添付されたファイルです。", + "description": "このチャンクに添付されたファイル。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "添付ファイルの識別子です。" + "description": "添付ファイル識別子。" }, "name": { "type": "string", - "description": "元のファイル名です。" + "description": "元のファイル名。" }, "size": { "type": "integer", @@ -4075,7 +4076,7 @@ }, "source_url": { "type": "string", - "description": "添付ファイルにアクセスする URL です。" + "description": "添付ファイルにアクセスするための URL。" } } } @@ -4083,11 +4084,10 @@ "summary": { "type": "string", "nullable": true, - "description": "要約インデックス経由で取得された場合の要約コンテンツです。" + "description": "要約インデックス経由で取得された場合の要約コンテンツ。" } } - }, - "description": "一致した検索レコードのリスト。" + } } } }, @@ -4149,7 +4149,7 @@ } }, "400": { - "description": "- `dataset_not_initialized` : ナレッジベースはまだ初期化中またはインデキシング中です。しばらくお待ちください。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 → モデルプロバイダーで認証情報を完了してください。\n- `provider_quota_exceeded` : Your quota for Dify Hosted OpenAI has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials.\n- `model_currently_not_support` : Dify Hosted OpenAI trial currently not support the GPT-4 model.\n- `completion_request_error` : Completion request failed.\n- `invalid_param` : Invalid parameter value.", + "description": "- `dataset_not_initialized` : データセットはまだ初期化中またはインデックス中です。しばらくお待ちください。\n- `provider_not_initialize` : 有効なモデルプロバイダーの認証情報が見つかりません。設定 -> モデルプロバイダーでプロバイダーの認証情報を完了してください。\n- `provider_quota_exceeded` : Dify Hosted OpenAI のクォータが使い果たされました。設定 -> モデルプロバイダーで独自のプロバイダー認証情報を完了してください。\n- `model_currently_not_support` : Dify Hosted OpenAI トライアルは現在 GPT-4 モデルをサポートしていません。\n- `completion_request_error` : 補完リクエストが失敗しました。\n- `invalid_param` : 無効なパラメータ値。", "content": { "application/json": { "examples": { @@ -4206,7 +4206,7 @@ } }, "403": { - "description": "`forbidden` : 権限が不足しています。", + "description": "`forbidden` : 権限がありません。", "content": { "application/json": { "examples": { @@ -4262,9 +4262,9 @@ "/datasets/tags": { "post": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "ナレッジベースタグを作成", + "summary": "ナレッジタグを作成", "description": "ナレッジベースを整理するための新しいタグを作成します。", "operationId": "createKnowledgeTag", "requestBody": { @@ -4281,7 +4281,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "Tag name." + "description": "タグ名。" } } } @@ -4298,20 +4298,20 @@ "properties": { "id": { "type": "string", - "description": "タグ識別子です。" + "description": "タグ識別子。" }, "name": { "type": "string", - "description": "タグの表示名です。" + "description": "タグ表示名。" }, "type": { "type": "string", - "description": "タグタイプです。ナレッジベースタグの場合は常に `knowledge` です。" + "description": "タグタイプ。ナレッジベースタグの場合は常に `knowledge`。" }, "binding_count": { "type": "string", "nullable": true, - "description": "このタグにバインドされたナレッジベースの数です。" + "description": "このタグにバインドされているナレッジベースの数。" } } }, @@ -4333,14 +4333,14 @@ }, "get": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "ナレッジベースタグリストを取得", - "description": "ワークスペース内のすべてのナレッジベースタグのリストを返します。", + "summary": "ナレッジタグ一覧を取得", + "description": "ワークスペース内のすべてのナレッジベースタグの一覧を返します。", "operationId": "getKnowledgeTags", "responses": { "200": { - "description": "タグのリストです。", + "description": "タグの一覧。", "content": { "application/json": { "schema": { @@ -4350,20 +4350,20 @@ "properties": { "id": { "type": "string", - "description": "タグ識別子です。" + "description": "タグ識別子。" }, "name": { "type": "string", - "description": "タグの表示名です。" + "description": "タグ表示名。" }, "type": { "type": "string", - "description": "タグタイプです。ナレッジベースタグの場合は常に `knowledge` です。" + "description": "タグタイプ。ナレッジベースタグの場合は常に `knowledge`。" }, "binding_count": { "type": "string", "nullable": true, - "description": "このタグにバインドされたナレッジベースの数です。" + "description": "このタグにバインドされているナレッジベースの数。" } } } @@ -4388,9 +4388,9 @@ }, "patch": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "ナレッジベースタグを変更", + "summary": "ナレッジタグを更新", "description": "既存のナレッジベースタグの名前を変更します。", "operationId": "updateKnowledgeTag", "requestBody": { @@ -4406,13 +4406,13 @@ "properties": { "tag_id": { "type": "string", - "description": "更新するタグ ID です。" + "description": "更新するタグ ID。" }, "name": { "type": "string", "minLength": 1, "maxLength": 50, - "description": "新しいタグ名です。" + "description": "新しいタグ名。" } } } @@ -4429,20 +4429,20 @@ "properties": { "id": { "type": "string", - "description": "タグ識別子です。" + "description": "タグ識別子。" }, "name": { "type": "string", - "description": "タグの表示名です。" + "description": "タグ表示名。" }, "type": { "type": "string", - "description": "タグタイプです。ナレッジベースタグの場合は常に `knowledge` です。" + "description": "タグタイプ。ナレッジベースタグの場合は常に `knowledge`。" }, "binding_count": { "type": "string", "nullable": true, - "description": "このタグにバインドされたナレッジベースの数です。" + "description": "このタグにバインドされているナレッジベースの数。" } } }, @@ -4464,10 +4464,10 @@ }, "delete": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "ナレッジベースタグを削除", - "description": "ナレッジベースタグを完全に削除します。タグ付けされたナレッジベース自体は削除されません。", + "summary": "ナレッジタグを削除", + "description": "ナレッジベースタグを完全に削除します。タグ付けされていたナレッジベースは削除されません。", "operationId": "deleteKnowledgeTag", "requestBody": { "required": true, @@ -4481,7 +4481,7 @@ "properties": { "tag_id": { "type": "string", - "description": "削除するタグ ID です。" + "description": "削除するタグ ID。" } } } @@ -4490,7 +4490,7 @@ }, "responses": { "204": { - "description": "Success." + "description": "成功。" } } } @@ -4498,10 +4498,10 @@ "/datasets/tags/binding": { "post": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "タグをデータセットにバインド", - "description": "ナレッジベースに 1 つ以上のタグをバインドします。ナレッジベースには複数のタグを設定できます。", + "summary": "タグバインディングを作成", + "description": "1 つ以上のタグをナレッジベースにバインドします。ナレッジベースは複数のタグを持つことができます。", "operationId": "bindTagsToDataset", "requestBody": { "required": true, @@ -4520,11 +4520,11 @@ "type": "string" }, "minItems": 1, - "description": "バインドするタグ ID です。" + "description": "バインドするタグ ID。" }, "target_id": { "type": "string", - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } } } @@ -4533,7 +4533,7 @@ }, "responses": { "204": { - "description": "Success." + "description": "成功。" } } } @@ -4541,9 +4541,9 @@ "/datasets/tags/unbinding": { "post": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "タグとデータセットのバインドを解除", + "summary": "タグバインディングを削除", "description": "ナレッジベースからタグバインディングを削除します。", "operationId": "unbindTagFromDataset", "requestBody": { @@ -4559,11 +4559,11 @@ "properties": { "tag_id": { "type": "string", - "description": "バインド解除するタグ ID です。" + "description": "バインド解除するタグ ID。" }, "target_id": { "type": "string", - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } } } @@ -4572,7 +4572,7 @@ }, "responses": { "204": { - "description": "Success." + "description": "成功。" } } } @@ -4580,10 +4580,10 @@ "/datasets/{dataset_id}/tags": { "get": { "tags": [ - "タグ管理" + "Tags" ], - "summary": "ナレッジベースにバインドされたタグを取得", - "description": "特定のナレッジベースにバインドされたタグのリストを返します。", + "summary": "ナレッジベースのタグを取得", + "description": "特定のナレッジベースにバインドされているタグの一覧を返します。", "operationId": "queryDatasetTags", "parameters": [ { @@ -4594,12 +4594,12 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "responses": { "200": { - "description": "ナレッジベースにバインドされたタグです。", + "description": "ナレッジベースにバインドされているタグ。", "content": { "application/json": { "schema": { @@ -4607,24 +4607,24 @@ "properties": { "data": { "type": "array", + "description": "このナレッジベースにバインドされているタグのリスト。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "タグ識別子です。" + "description": "タグ識別子。" }, "name": { "type": "string", - "description": "タグの表示名です。" + "description": "タグ表示名。" } } - }, - "description": "このナレッジベースにバインドされたタグのリスト。" + } }, "total": { "type": "integer", - "description": "このナレッジベースにバインドされたタグの合計数です。" + "description": "このナレッジベースにバインドされているタグの総数。" } } }, @@ -4651,11 +4651,11 @@ "/datasets/{dataset_id}/metadata": { "post": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "メタデータフィールドを作成", - "description": "ナレッジベースのカスタムメタデータフィールドを作成します。メタデータフィールドを使用して、構造化された情報でドキュメントにアノテーションを付けることができます。", - "operationId": "createMetadataFieldJa", + "description": "ナレッジベース用のカスタムメタデータフィールドを作成します。メタデータフィールドは、ドキュメントに構造化された情報を注釈付けするために使用できます。", + "operationId": "createMetadataField", "parameters": [ { "name": "dataset_id", @@ -4665,7 +4665,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -4686,11 +4686,11 @@ "number", "time" ], - "description": "`string` はテキスト値、`number` は数値、`time` は日付/時刻値です。" + "description": "`string` はテキスト値、`number` は数値、`time` は日付/時刻値。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" } } } @@ -4707,15 +4707,15 @@ "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの種類です。" + "description": "メタデータフィールドタイプ。" } } }, @@ -4736,11 +4736,11 @@ }, "get": { "tags": [ - "メタデータ" + "Metadata" ], - "summary": "メタデータフィールドリストを取得", - "description": "ナレッジベースのすべてのメタデータフィールド（カスタムおよび組み込みの両方）の一覧と、各フィールドを使用しているドキュメント数を返します。", - "operationId": "listMetadataFieldsJa", + "summary": "メタデータフィールド一覧を取得", + "description": "ナレッジベースのすべてのメタデータフィールド（カスタムと組み込みの両方）の一覧と、各フィールドを使用しているドキュメントの数を返します。", + "operationId": "listMetadataFields", "parameters": [ { "name": "dataset_id", @@ -4750,12 +4750,12 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "responses": { "200": { - "description": "ナレッジベースのメタデータフィールドです。", + "description": "ナレッジベースのメタデータフィールド。", "content": { "application/json": { "schema": { @@ -4763,32 +4763,32 @@ "properties": { "doc_metadata": { "type": "array", + "description": "メタデータフィールド定義のリスト。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの種類です。" + "description": "メタデータフィールドタイプ。" }, "count": { "type": "integer", - "description": "このメタデータフィールドを使用しているドキュメント数です。" + "description": "このメタデータフィールドを使用しているドキュメントの数。" } } - }, - "description": "メタデータフィールド定義のリスト。" + } }, "built_in_field_enabled": { "type": "boolean", - "description": "このナレッジベースで組み込みメタデータフィールドが有効かどうかです。" + "description": "このナレッジベースで組み込みメタデータフィールドが有効かどうか。" } } }, @@ -4817,11 +4817,11 @@ "/datasets/{dataset_id}/metadata/{metadata_id}": { "patch": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "メタデータフィールドを更新", "description": "カスタムメタデータフィールドの名前を変更します。", - "operationId": "updateMetadataFieldJa", + "operationId": "updateMetadataField", "parameters": [ { "name": "dataset_id", @@ -4831,7 +4831,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "metadata_id", @@ -4841,7 +4841,7 @@ "type": "string", "format": "uuid" }, - "description": "メタデータフィールド ID です。" + "description": "メタデータフィールド ID。" } ], "requestBody": { @@ -4856,7 +4856,7 @@ "properties": { "name": { "type": "string", - "description": "新しいメタデータフィールド名です。" + "description": "新しいメタデータフィールド名。" } } } @@ -4873,15 +4873,15 @@ "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの種類です。" + "description": "メタデータフィールドタイプ。" } } }, @@ -4902,11 +4902,11 @@ }, "delete": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "メタデータフィールドを削除", - "description": "カスタムメタデータフィールドを完全に削除します。このフィールドを使用しているドキュメントは、該当するメタデータ値を失います。", - "operationId": "deleteMetadataFieldJa", + "description": "カスタムメタデータフィールドを完全に削除します。このフィールドを使用しているドキュメントは、そのメタデータ値を失います。", + "operationId": "deleteMetadataField", "parameters": [ { "name": "dataset_id", @@ -4916,7 +4916,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "metadata_id", @@ -4926,12 +4926,12 @@ "type": "string", "format": "uuid" }, - "description": "メタデータフィールド ID です。" + "description": "メタデータフィールド ID。" } ], "responses": { "204": { - "description": "Success." + "description": "成功。" } } } @@ -4939,11 +4939,11 @@ "/datasets/{dataset_id}/metadata/built-in": { "get": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "組み込みメタデータフィールドを取得", - "description": "システムが提供する組み込みメタデータフィールドの一覧を返します（例：ドキュメントタイプ、ソース URL）。", - "operationId": "getBuiltInMetadataFieldsJa", + "description": "システムが提供する組み込みメタデータフィールド（例：ドキュメントタイプ、ソース URL）の一覧を返します。", + "operationId": "getBuiltInMetadataFields", "parameters": [ { "name": "dataset_id", @@ -4953,12 +4953,12 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "responses": { "200": { - "description": "組み込みメタデータフィールドです。", + "description": "組み込みメタデータフィールド。", "content": { "application/json": { "schema": { @@ -4966,17 +4966,17 @@ "properties": { "fields": { "type": "array", - "description": "システム提供のメタデータフィールドのリストです。", + "description": "システム提供のメタデータフィールドのリスト。", "items": { "type": "object", "properties": { "name": { "type": "string", - "description": "組み込みフィールド識別子です。`document_name` はドキュメントタイトル、`uploader` は作成者、`upload_date` は作成日時、`last_update_date` は最終更新日時、`source` はドキュメントの出典を示します。" + "description": "組み込みフィールド識別子。`document_name` はドキュメントタイトル、`uploader` は作成者、`upload_date` は作成日時、`last_update_date` は最終更新日時、`source` はドキュメントの出所。" }, "type": { "type": "string", - "description": "フィールドのデータ型です。テキスト値の場合は `string`、日時値の場合は `time` です。" + "description": "フィールドのデータタイプ。`string` はテキスト値、`time` は日付/時刻値。" } } } @@ -5021,11 +5021,11 @@ "/datasets/{dataset_id}/metadata/built-in/{action}": { "post": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "組み込みメタデータフィールドを更新", - "description": "ナレッジベースの組み込みメタデータフィールドを有効または無効にします。", - "operationId": "toggleBuiltInMetadataFieldJa", + "description": "ナレッジベースの組み込みメタデータフィールドを有効化または無効化します。", + "operationId": "toggleBuiltInMetadataField", "parameters": [ { "name": "dataset_id", @@ -5035,7 +5035,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "action", @@ -5048,12 +5048,12 @@ "disable" ] }, - "description": "`enable` で内蔵メタデータフィールドを有効化、`disable` で無効化します。" + "description": "`enable` は組み込みメタデータフィールドを有効化、`disable` は無効化。" } ], "responses": { "200": { - "description": "組み込みメタデータフィールドの切り替えに成功しました。", + "description": "組み込みメタデータフィールドが正常に切り替えられました。", "content": { "application/json": { "schema": { @@ -5061,7 +5061,7 @@ "properties": { "result": { "type": "string", - "description": "操作結果です。" + "description": "操作結果。" } } }, @@ -5082,11 +5082,11 @@ "/datasets/{dataset_id}/documents/metadata": { "post": { "tags": [ - "メタデータ" + "Metadata" ], "summary": "ドキュメントメタデータを一括更新", - "description": "複数のドキュメントのメタデータ値を一括更新します。リクエスト内の各ドキュメントに指定されたメタデータのキーと値のペアが適用されます。", - "operationId": "batchUpdateDocumentMetadataJa", + "description": "複数のドキュメントのメタデータ値を一度に更新します。リクエスト内の各ドキュメントは、指定されたメタデータキーバリューペアを受け取ります。", + "operationId": "batchUpdateDocumentMetadata", "parameters": [ { "name": "dataset_id", @@ -5096,7 +5096,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -5120,7 +5120,7 @@ "properties": { "document_id": { "type": "string", - "description": "メタデータを更新するドキュメントの ID です。" + "description": "メタデータを更新するドキュメントの ID。" }, "metadata_list": { "type": "array", @@ -5133,11 +5133,11 @@ "properties": { "id": { "type": "string", - "description": "メタデータフィールド ID です。" + "description": "メタデータフィールド ID。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "value": { "description": "メタデータ値。文字列、数値、または `null` を指定できます。" @@ -5148,11 +5148,11 @@ "partial_update": { "type": "boolean", "default": false, - "description": "メタデータを部分的に更新し、未指定フィールドの既存の値を保持するかどうかです。" + "description": "メタデータを部分的に更新し、指定されていないフィールドの既存の値を保持するかどうか。" } } }, - "description": "ドキュメントメタデータの更新操作の配列です。各エントリはドキュメント ID をメタデータのキーと値のペアにマッピングします。" + "description": "ドキュメントメタデータ更新操作の配列。各エントリはドキュメント ID をそのメタデータキーバリューペアにマッピングします。" } } } @@ -5169,7 +5169,7 @@ "properties": { "result": { "type": "string", - "description": "操作結果です。" + "description": "操作結果。" } } }, @@ -5190,11 +5190,11 @@ "/workspaces/current/models/model-types/{model_type}": { "get": { "tags": [ - "モデル" + "Models" ], "summary": "利用可能なモデルを取得", - "description": "タイプ別に利用可能なモデルの一覧を取得します。主にナレッジベース設定用の `text-embedding` モデルと `rerank` モデルのクエリに使用します。", - "operationId": "getAvailableModelsJa", + "description": "タイプ別に利用可能なモデルの一覧を取得します。主にナレッジベース設定のための `text-embedding` および `rerank` モデルのクエリに使用されます。", + "operationId": "getAvailableModels", "parameters": [ { "name": "model_type", @@ -5211,12 +5211,12 @@ "moderation" ] }, - "description": "取得するモデルのタイプです。ナレッジベースの設定には、埋め込みモデルの場合は `text-embedding`、リランキングモデルの場合は `rerank` を使用します。" + "description": "取得するモデルのタイプ。ナレッジベース設定の場合、埋め込みモデルには `text-embedding`、リランキングモデルには `rerank` を使用します。" } ], "responses": { "200": { - "description": "指定された種類で利用可能なモデルです。", + "description": "指定されたタイプの利用可能なモデル。", "content": { "application/json": { "schema": { @@ -5224,17 +5224,17 @@ "properties": { "data": { "type": "array", - "description": "利用可能なモデルを持つモデルプロバイダーのリストです。", + "description": "利用可能なモデルを持つモデルプロバイダーのリスト。", "items": { "type": "object", "properties": { "provider": { "type": "string", - "description": "モデルプロバイダーの識別子です（例：`openai`、`cohere`）。" + "description": "モデルプロバイダー識別子。例：`openai`、`cohere`。" }, "label": { "type": "object", - "description": "プロバイダーのローカライズ表示名です。", + "description": "プロバイダーのローカライズされた表示名。", "properties": { "en_US": { "type": "string", @@ -5248,41 +5248,41 @@ }, "icon_small": { "type": "object", - "description": "プロバイダーの小アイコンの URL です。", + "description": "プロバイダーの小さいアイコンの URL。", "properties": { "en_US": { "type": "string", - "description": "小アイコン URL。" + "description": "小さいアイコン URL。" } } }, "icon_large": { "type": "object", - "description": "プロバイダーの大アイコンの URL です。", + "description": "プロバイダーの大きいアイコンの URL。", "properties": { "en_US": { "type": "string", - "description": "大アイコン URL。" + "description": "大きいアイコン URL。" } } }, "status": { "type": "string", - "description": "プロバイダーのステータスです。認証情報が設定済みで有効な場合は `active` です。" + "description": "プロバイダーのステータス。認証情報が設定されており有効な場合は `active`。" }, "models": { "type": "array", - "description": "このプロバイダーから利用可能なモデルのリストです。", + "description": "このプロバイダーから利用可能なモデルのリスト。", "items": { "type": "object", "properties": { "model": { "type": "string", - "description": "モデル識別子です。ナレッジベースの作成または更新時に `embedding_model` の値として使用します。" + "description": "モデル識別子。ナレッジベースを作成または更新する際の `embedding_model` 値として使用します。" }, "label": { "type": "object", - "description": "モデルのローカライズ表示名です。", + "description": "モデルのローカライズされた表示名。", "properties": { "en_US": { "type": "string", @@ -5296,27 +5296,27 @@ }, "model_type": { "type": "string", - "description": "モデルのタイプです。`model_type` パスパラメータと一致します。" + "description": "モデルのタイプ。`model_type` パスパラメータと一致します。" }, "features": { "type": "array", "nullable": true, - "description": "モデルがサポートする機能です。なしの場合は `null` です。", + "description": "モデルのサポートされている機能。なしの場合は `null`。", "items": { "type": "string" } }, "fetch_from": { "type": "string", - "description": "モデル定義の取得元です。`predefined-model` は組み込みモデル、`customizable-model` はユーザー設定モデルを示します。" + "description": "モデル定義の取得元。`predefined-model` は組み込みモデル、`customizable-model` はユーザー設定モデル。" }, "model_properties": { "type": "object", - "description": "`context_size` などのモデル固有のプロパティです。" + "description": "`context_size` などのモデル固有のプロパティ。" }, "status": { "type": "string", - "description": "モデルの利用可能ステータスです。使用可能な場合は `active` です。" + "description": "モデルの利用可能性ステータス。使用準備完了時は `active`。" } } } @@ -5374,11 +5374,11 @@ "/datasets/pipeline/file-upload": { "post": { "tags": [ - "ナレッジパイプライン" + "Knowledge Pipeline" ], "summary": "パイプラインファイルをアップロード", - "description": "ナレッジパイプラインで使用するファイルをアップロードします。`multipart/form-data` で単一ファイルを受け付けます。", - "operationId": "uploadPipelineFileJa", + "description": "ナレッジパイプラインで使用するファイルをアップロードします。`multipart/form-data` 経由で単一のファイルを受け付けます。", + "operationId": "uploadPipelineFile", "requestBody": { "required": true, "content": { @@ -5392,7 +5392,7 @@ "file": { "type": "string", "format": "binary", - "description": "アップロードするファイルです。" + "description": "アップロードするファイル。" } } } @@ -5409,11 +5409,11 @@ "properties": { "id": { "type": "string", - "description": "アップロードされたファイルの一意識別子です。" + "description": "アップロードされたファイルの一意識別子。" }, "name": { "type": "string", - "description": "元のファイル名です。" + "description": "元のファイル名。" }, "size": { "type": "integer", @@ -5433,7 +5433,7 @@ }, "created_at": { "type": "string", - "description": "アップロードタイムスタンプ（ISO 8601 形式）です。" + "description": "ISO 8601 形式のアップロードタイムスタンプ。" } } }, @@ -5488,7 +5488,7 @@ } }, "413": { - "description": "`file_too_large` : ファイルサイズの上限を超えています。", + "description": "`file_too_large` : ファイルサイズが超過しました。", "content": { "application/json": { "examples": { @@ -5505,7 +5505,7 @@ } }, "415": { - "description": "`unsupported_file_type` : 許可されていないファイルタイプです。", + "description": "`unsupported_file_type` : ファイルタイプは許可されていません。", "content": { "application/json": { "examples": { @@ -5527,11 +5527,11 @@ "/datasets/{dataset_id}/pipeline/datasource-plugins": { "get": { "tags": [ - "ナレッジパイプライン" + "Knowledge Pipeline" ], - "summary": "データソースプラグインリストを取得", - "description": "ナレッジパイプラインで利用可能なすべてのデータソースプラグインを一覧表示します。`is_published` クエリパラメータに応じて公開済みまたはドラフトのプラグインを返します。", - "operationId": "listDatasourcePluginsJa", + "summary": "データソースプラグイン一覧を取得", + "description": "ナレッジパイプラインで利用可能なすべてのデータソースプラグインを一覧表示します。`is_published` クエリパラメータに応じて、公開済みまたはドラフトのプラグインを返します。", + "operationId": "listDatasourcePlugins", "parameters": [ { "name": "dataset_id", @@ -5541,7 +5541,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "is_published", @@ -5550,12 +5550,12 @@ "type": "boolean", "default": true }, - "description": "公開済みまたはドラフトのデータソースプラグインのどちらを取得するかを指定します。`true` は公開済みプラグイン、`false` はドラフトプラグインを返します。" + "description": "公開済みまたはドラフトのデータソースプラグインを取得するかどうか。`true` は公開済みプラグイン、`false` はドラフトプラグインを返します。" } ], "responses": { "200": { - "description": "データソースプラグインのリストです。", + "description": "データソースプラグインの一覧。", "content": { "application/json": { "schema": { @@ -5565,15 +5565,15 @@ "properties": { "id": { "type": "string", - "description": "データソースプラグインの一意の識別子です。" + "description": "データソースプラグインの一意識別子。" }, "name": { "type": "string", - "description": "データソースプラグインの表示名です。" + "description": "データソースプラグインの表示名。" }, "type": { "type": "string", - "description": "データソースプラグインの種類です。" + "description": "データソースプラグインのタイプ。" } } } @@ -5594,7 +5594,7 @@ } }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -5616,11 +5616,11 @@ "/datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run": { "post": { "tags": [ - "ナレッジパイプライン" + "Knowledge Pipeline" ], "summary": "データソースノードを実行", - "description": "ナレッジパイプライン内の単一のデータソースノードを実行します。ノードの実行結果を含むストリーミングレスポンスを返します。", - "operationId": "runDatasourceNodeJa", + "description": "ナレッジパイプライン内の単一のデータソースノードを実行します。ノード実行結果を含むストリーミングレスポンスを返します。", + "operationId": "runDatasourceNode", "parameters": [ { "name": "dataset_id", @@ -5630,7 +5630,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" }, { "name": "node_id", @@ -5639,7 +5639,7 @@ "schema": { "type": "string" }, - "description": "実行するデータソースノードの ID です。" + "description": "実行するデータソースノードの ID。" } ], "requestBody": { @@ -5657,7 +5657,7 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "データソースノードの入力変数です。" + "description": "データソースノードの入力変数。" }, "datasource_type": { "type": "string", @@ -5667,16 +5667,16 @@ "website_crawl", "online_drive" ], - "description": "データソースの種類です。" + "description": "データソースのタイプ。" }, "credential_id": { "type": "string", "nullable": true, - "description": "データソースとの認証に使用する認証情報の ID です。" + "description": "データソースとの認証に使用する認証情報の ID。" }, "is_published": { "type": "boolean", - "description": "ノードの公開バージョンとドラフトバージョンのどちらを実行するかを指定します。`true` は公開バージョン、`false` はドラフトを実行します。" + "description": "公開済みまたはドラフトバージョンのノードを実行するかどうか。`true` は公開済みバージョン、`false` はドラフトを実行します。" } } } @@ -5685,18 +5685,18 @@ }, "responses": { "200": { - "description": "ノード実行イベントを含むストリーミングレスポンスです。", + "description": "ノード実行イベントを含むストリーミングレスポンス。", "content": { "text/event-stream": { "schema": { "type": "string", - "description": "ノード実行の進捗と結果を含む Server-Sent Events ストリームです。" + "description": "ノード実行の進捗と結果を含む Server-Sent Events ストリーム。" } } } }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -5718,11 +5718,11 @@ "/datasets/{dataset_id}/pipeline/run": { "post": { "tags": [ - "ナレッジパイプライン" + "Knowledge Pipeline" ], "summary": "パイプラインを実行", - "description": "ナレッジベースの完全なナレッジパイプラインを実行します。ストリーミングとブロッキングの両方のレスポンスモードをサポートしています。", - "operationId": "runPipelineJa", + "description": "ナレッジベースのフルナレッジパイプラインを実行します。ストリーミングとブロッキングの両方のレスポンスモードをサポートしています。", + "operationId": "runPipeline", "parameters": [ { "name": "dataset_id", @@ -5732,7 +5732,7 @@ "type": "string", "format": "uuid" }, - "description": "ナレッジベース ID です。" + "description": "ナレッジベース ID。" } ], "requestBody": { @@ -5753,7 +5753,7 @@ "inputs": { "type": "object", "additionalProperties": true, - "description": "パイプラインの入力変数です。" + "description": "パイプラインの入力変数。" }, "datasource_type": { "type": "string", @@ -5763,7 +5763,7 @@ "website_crawl", "online_drive" ], - "description": "データソースの種類です。" + "description": "データソースのタイプ。" }, "datasource_info_list": { "type": "array", @@ -5771,15 +5771,15 @@ "type": "object", "additionalProperties": true }, - "description": "パイプラインが処理するデータソース情報オブジェクトのリストです。" + "description": "パイプラインが処理するデータソース情報オブジェクトのリスト。" }, "start_node_id": { "type": "string", - "description": "パイプライン実行を開始するノードの ID です。" + "description": "パイプライン実行を開始するノードの ID。" }, "is_published": { "type": "boolean", - "description": "パイプラインの公開バージョンとドラフトバージョンのどちらを実行するかを指定します。`true` は公開バージョン、`false` はドラフトを実行します。" + "description": "公開済みまたはドラフトバージョンのパイプラインを実行するかどうか。`true` は公開済みバージョン、`false` はドラフトを実行します。" }, "response_mode": { "type": "string", @@ -5787,7 +5787,7 @@ "streaming", "blocking" ], - "description": "パイプライン実行のレスポンスモードです。`streaming` はサーバー送信イベントストリームを返し、`blocking` は完了を待って完全な結果を返します。" + "description": "パイプライン実行のレスポンスモード。`streaming` は Server-Sent Events ストリームを返し、`blocking` は待機して完全な結果を返します。" } } } @@ -5796,23 +5796,23 @@ }, "responses": { "200": { - "description": "パイプライン実行結果。フォーマットは `response_mode` に依存します：ストリーミングは `text/event-stream` を返し、ブロッキングは完全な JSON 結果を返します。", + "description": "パイプライン実行結果。形式は `response_mode` によって異なります：streaming は `text/event-stream` を返し、blocking は JSON オブジェクトを返します。", "content": { "text/event-stream": { "schema": { "type": "string", - "description": "パイプライン実行の進捗と結果を含むサーバー送信イベントストリームです。`response_mode` が `streaming` の場合に返されます。" + "description": "パイプライン実行の進捗と結果を含む Server-Sent Events ストリーム。`response_mode` が `streaming` の場合に返されます。" } }, "application/json": { "schema": { "type": "object", - "description": "パイプライン実行の完全な結果です。`response_mode` が `blocking` の場合に返されます。", + "description": "完全なパイプライン実行結果。`response_mode` が `blocking` の場合に返されます。", "additionalProperties": true }, "examples": { "success": { - "summary": "Blocking Response Example", + "summary": "ブロッキングレスポンス例", "value": { "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "workflow_run_id": "f1e2d3c4-b5a6-7890-abcd-ef0987654321", @@ -5830,7 +5830,7 @@ } }, "403": { - "description": "`forbidden` : アクセスが禁止されています。", + "description": "`forbidden` : アクセス禁止。", "content": { "application/json": { "examples": { @@ -5847,7 +5847,7 @@ } }, "404": { - "description": "`not_found` : ナレッジベースが見つかりません。", + "description": "`not_found` : データセットが見つかりません。", "content": { "application/json": { "examples": { @@ -5864,7 +5864,7 @@ } }, "500": { - "description": "`pipeline_run_error` : パイプライン実行に失敗しました。", + "description": "`pipeline_run_error` : パイプライン実行が失敗しました。", "content": { "application/json": { "examples": { @@ -5891,141 +5891,141 @@ "properties": { "id": { "type": "string", - "description": "ナレッジベースの一意識別子です。" + "description": "ナレッジベースの一意識別子。" }, "name": { "type": "string", - "description": "ナレッジベースの表示名です。ワークスペース内で一意です。" + "description": "ナレッジベースの表示名。ワークスペース内で一意です。" }, "description": { "type": "string", - "description": "ナレッジベースの目的または内容を説明するオプションのテキストです。" + "description": "ナレッジベースの目的または内容を説明するオプションのテキスト。" }, "provider": { "type": "string", - "description": "プロバイダータイプです。内部管理の場合は `vendor`、外部ナレッジベース接続の場合は `external` です。" + "description": "プロバイダータイプ。`vendor` は内部管理、`external` は外部ナレッジベース接続。" }, "permission": { "type": "string", - "description": "このナレッジベースにアクセスできるユーザーを制御します。指定可能な値：`only_me`、`all_team_members`、`partial_members`。" + "description": "このナレッジベースにアクセスできる人を制御します。可能な値：`only_me`、`all_team_members`、`partial_members`。" }, "data_source_type": { "type": "string", - "description": "ドキュメントのデータソースタイプです。まだ設定されていない場合は `null` です。" + "description": "ドキュメントのデータソースタイプ。まだ設定されていない場合は `null`。" }, "indexing_technique": { "type": "string", - "description": "`high_quality` は埋め込みモデルを使用した精密検索、`economy` はキーワードベースのインデキシングです。" + "description": "`high_quality` は埋め込みモデルを使用して精密な検索を行います。`economy` はキーワードベースのインデックスを使用します。" }, "app_count": { "type": "integer", - "description": "現在このナレッジベースを使用しているアプリケーションの数です。" + "description": "現在このナレッジベースを使用しているアプリケーションの数。" }, "document_count": { "type": "integer", - "description": "ナレッジベース内のドキュメント総数です。" + "description": "ナレッジベース内のドキュメントの総数。" }, "word_count": { "type": "integer", - "description": "全ドキュメントの合計単語数です。" + "description": "すべてのドキュメントの総単語数。" }, "created_by": { "type": "string", - "description": "ナレッジベースを作成したユーザーの ID です。" + "description": "ナレッジベースを作成したユーザーの ID。" }, "author_name": { "type": "string", - "description": "作成者の表示名です。" + "description": "作成者の表示名。" }, "created_at": { "type": "number", - "description": "作成タイムスタンプ（Unix エポック、秒単位）です。" + "description": "作成タイムスタンプ（Unix エポック秒）。" }, "updated_by": { "type": "string", - "description": "ナレッジベースを最後に更新したユーザーの ID です。" + "description": "ナレッジベースを最後に更新したユーザーの ID。" }, "updated_at": { "type": "number", - "description": "最終更新タイムスタンプ（Unix エポック、秒単位）です。" + "description": "最終更新タイムスタンプ（Unix エポック秒）。" }, "embedding_model": { "type": "string", - "description": "インデックス作成に使用される埋め込みモデルの名前です。" + "description": "インデックスに使用される埋め込みモデルの名前。" }, "embedding_model_provider": { "type": "string", - "description": "埋め込みモデルプロバイダーです。[利用可能なモデルを取得](/api-reference/モデル/利用可能なモデルを取得) で `model_type=text-embedding` を指定した際の `provider` フィールドの値を使用します。" + "description": "埋め込みモデルプロバイダー。[利用可能なモデルを取得](/api-reference/models/get-available-models)の `model_type=text-embedding` で `provider` フィールドを使用してください。" }, "embedding_available": { "type": "boolean", - "description": "設定された埋め込みモデルが現在利用可能かどうかです。" + "description": "設定された埋め込みモデルが現在利用可能かどうか。" }, "retrieval_model_dict": { "type": "object", - "description": "ナレッジベースの検索設定です。", + "description": "ナレッジベースの検索設定。", "properties": { "search_method": { "type": "string", - "description": "検索に使用する検索方法です。`keyword_search` はキーワードマッチング、`semantic_search` は埋め込みベースの類似度検索、`full_text_search` は全文インデックス検索、`hybrid_search` はセマンティックとキーワードの組み合わせ検索を示します。" + "description": "検索に使用される検索方法。`keyword_search` はキーワードマッチング、`semantic_search` は埋め込みベースの類似性、`full_text_search` は全文インデックス、`hybrid_search` はセマンティックとキーワードアプローチの組み合わせ。" }, "reranking_enable": { "type": "boolean", - "description": "リランキングが有効かどうかです。" + "description": "リランキングが有効かどうか。" }, "reranking_mode": { "type": "string", "nullable": true, - "description": "リランキングモードです。`reranking_model` はモデルベースのリランキング、`weighted_score` はスコアベースの重み付けを示します。リランキングが無効の場合は `null` です。" + "description": "リランキングモード。`reranking_model` はモデルベースのリランキング、`weighted_score` はスコアベースの重み付け。リランキングが無効な場合は `null`。" }, "reranking_model": { "type": "object", - "description": "リランキングモデルの設定です。", + "description": "リランキングモデル設定。", "properties": { "reranking_provider_name": { "type": "string", - "description": "リランキングモデルのプロバイダー名です。" + "description": "リランキングモデルのプロバイダー名。" }, "reranking_model_name": { "type": "string", - "description": "リランキングモデル名です。" + "description": "リランキングモデルの名前。" } } }, "weights": { "type": "object", "nullable": true, - "description": "ハイブリッド検索の重み設定です。", + "description": "ハイブリッド検索の重み設定。", "properties": { "weight_type": { "type": "string", - "description": "セマンティック検索とキーワード検索の重みを調整するための戦略です。" + "description": "セマンティック検索とキーワード検索の重みをバランスする戦略。" }, "vector_setting": { "type": "object", - "description": "セマンティック検索の重み設定です。", + "description": "セマンティック検索の重み設定。", "properties": { "vector_weight": { "type": "number", - "description": "セマンティック（ベクトル）検索結果に割り当てられた重みです。" + "description": "セマンティック（ベクトル）検索結果に割り当てられる重み。" }, "embedding_provider_name": { "type": "string", - "description": "ベクトル検索に使用される埋め込みモデルのプロバイダーです。" + "description": "ベクトル検索に使用される埋め込みモデルのプロバイダー。" }, "embedding_model_name": { "type": "string", - "description": "ベクトル検索に使用される埋め込みモデルの名前です。" + "description": "ベクトル検索に使用される埋め込みモデルの名前。" } } }, "keyword_setting": { "type": "object", - "description": "キーワード検索の重み設定です。", + "description": "キーワード検索の重み設定。", "properties": { "keyword_weight": { "type": "number", - "description": "キーワード検索結果に割り当てられた重みです。" + "description": "キーワード検索結果に割り当てられる重み。" } } } @@ -6033,190 +6033,190 @@ }, "top_k": { "type": "integer", - "description": "返す結果の最大数です。" + "description": "返す結果の最大数。" }, "score_threshold_enabled": { "type": "boolean", - "description": "スコア閾値フィルタリングが有効かどうかです。" + "description": "スコアしきい値フィルタリングが有効かどうか。" }, "score_threshold": { "type": "number", - "description": "結果の最小関連性スコアです。`score_threshold_enabled` が `true` の場合にのみ有効です。" + "description": "結果の最小関連性スコア。`score_threshold_enabled` が `true` の場合にのみ有効。" } } }, "summary_index_setting": { "type": "object", "nullable": true, - "description": "サマリーインデックスの設定です。", + "description": "要約インデックス設定。", "properties": { "enable": { "type": "boolean", - "description": "サマリーインデックスが有効かどうかです。" + "description": "要約インデックスが有効かどうか。" }, "model_name": { "type": "string", - "description": "要約生成に使用されるモデルの名前です。" + "description": "要約生成に使用するモデルの名前。" }, "model_provider_name": { "type": "string", - "description": "要約生成モデルのプロバイダーです。" + "description": "要約生成モデルのプロバイダー。" }, "summary_prompt": { "type": "string", - "description": "要約生成に使用されるプロンプトテンプレートです。" + "description": "要約生成に使用するプロンプトテンプレート。" } } }, "tags": { "type": "array", - "description": "このナレッジベースに関連付けられたタグです。", + "description": "このナレッジベースに関連付けられたタグ。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "タグ識別子です。" + "description": "タグ識別子。" }, "name": { "type": "string", - "description": "Tag name." + "description": "タグ名。" }, "type": { "type": "string", - "description": "タグタイプです。ナレッジベースタグの場合は常に `knowledge` です。" + "description": "タグタイプ。ナレッジベースタグの場合は常に `knowledge`。" } } } }, "doc_form": { "type": "string", - "description": "ドキュメントのチャンキングモードです。`text_model` は標準テキストチャンキング、`hierarchical_model` は親子構造、`qa_model` は QA ペア抽出を示します。" + "description": "ドキュメントのチャンキングモード。`text_model` は標準テキストチャンキング、`hierarchical_model` は親子構造、`qa_model` は QA ペア抽出。" }, "external_knowledge_info": { "type": "object", "nullable": true, - "description": "外部ナレッジベースの接続詳細です。`provider` が `external` の場合に存在します。", + "description": "外部ナレッジベースの接続詳細。`provider` が `external` の場合に存在します。", "properties": { "external_knowledge_id": { "type": "string", - "description": "外部ナレッジベースの ID です。" + "description": "外部ナレッジベースの ID。" }, "external_knowledge_api_id": { "type": "string", - "description": "外部ナレッジ API 接続の ID です。" + "description": "外部ナレッジ API 接続の ID。" }, "external_knowledge_api_name": { "type": "string", - "description": "外部ナレッジ API の表示名です。" + "description": "外部ナレッジ API の表示名。" }, "external_knowledge_api_endpoint": { "type": "string", - "description": "外部ナレッジ API のエンドポイント URL です。" + "description": "外部ナレッジ API のエンドポイント URL。" } } }, "external_retrieval_model": { "type": "object", "nullable": true, - "description": "外部ナレッジベースの検索設定です。内部ナレッジベースの場合は `null` です。", + "description": "外部ナレッジベースの検索設定。内部ナレッジベースの場合は `null`。", "properties": { "top_k": { "type": "integer", - "description": "外部ナレッジベースから返す結果の最大数です。" + "description": "外部ナレッジベースから返す結果の最大数。" }, "score_threshold": { "type": "number", - "description": "最小関連性スコアのしきい値です。" + "description": "最小関連性スコアしきい値。" }, "score_threshold_enabled": { "type": "boolean", - "description": "スコア閾値フィルタリングが有効かどうかです。" + "description": "スコアしきい値フィルタリングが有効かどうか。" } } }, "doc_metadata": { "type": "array", - "description": "ナレッジベースのメタデータフィールド定義です。", + "description": "ナレッジベースのメタデータフィールド定義。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの値の種類です。" + "description": "メタデータフィールドの値タイプ。" } } } }, "built_in_field_enabled": { "type": "boolean", - "description": "組み込みメタデータフィールド（例：`document_name`、`uploader`）が有効かどうかです。" + "description": "組み込みメタデータフィールド（例：`document_name`、`uploader`）が有効かどうか。" }, "pipeline_id": { "type": "string", "nullable": true, - "description": "カスタム処理パイプラインが設定されている場合のパイプライン ID です。" + "description": "カスタム処理パイプラインが設定されている場合のパイプライン ID。" }, "runtime_mode": { "type": "string", "nullable": true, - "description": "ランタイム処理モードです。" + "description": "ランタイム処理モード。" }, "chunk_structure": { "type": "string", "nullable": true, - "description": "チャンク構造の設定です。" + "description": "チャンク構造設定。" }, "icon_info": { "type": "object", "nullable": true, - "description": "ナレッジベースのアイコン表示設定です。", + "description": "ナレッジベースのアイコン表示設定。", "properties": { "icon_type": { "type": "string", - "description": "アイコンの種類です。" + "description": "アイコンのタイプ。" }, "icon": { "type": "string", - "description": "アイコン識別子または絵文字です。" + "description": "アイコン識別子または絵文字。" }, "icon_background": { "type": "string", - "description": "アイコンの背景色です。" + "description": "アイコンの背景色。" }, "icon_url": { "type": "string", - "description": "カスタムアイコン画像の URL です。" + "description": "カスタムアイコン画像の URL。" } } }, "is_published": { "type": "boolean", - "description": "ナレッジベースが公開済みかどうかです。" + "description": "ナレッジベースが公開されているかどうか。" }, "total_documents": { "type": "integer", - "description": "ドキュメントの合計数です。" + "description": "ドキュメントの総数。" }, "total_available_documents": { "type": "integer", - "description": "有効で利用可能なドキュメントの数です。" + "description": "有効で利用可能なドキュメントの数。" }, "enable_api": { "type": "boolean", - "description": "このナレッジベースで API アクセスが有効かどうかです。" + "description": "このナレッジベースで API アクセスが有効かどうか。" }, "is_multimodal": { "type": "boolean", - "description": "マルチモーダルコンテンツ処理が有効かどうかです。" + "description": "マルチモーダルコンテンツ処理が有効かどうか。" } } }, @@ -6225,108 +6225,108 @@ "properties": { "id": { "type": "string", - "description": "ドキュメントの一意識別子です。" + "description": "ドキュメントの一意識別子。" }, "position": { "type": "integer", - "description": "リスト内のドキュメントの表示位置です。" + "description": "リスト内のドキュメントの表示位置。" }, "data_source_type": { "type": "string", - "description": "ドキュメントの作成方法です。ファイルアップロードの場合は `upload_file`、Notion インポートの場合は `notion_import` です。" + "description": "ドキュメントの作成方法。`upload_file` はファイルアップロード、`notion_import` は Notion インポート。" }, "data_source_info": { "type": "object", - "description": "生のデータソース情報です。`data_source_type` によって異なります。" + "description": "生のデータソース情報、`data_source_type` によって異なります。" }, "data_source_detail_dict": { "type": "object", - "description": "ファイル詳細を含む詳細なデータソース情報です。" + "description": "ファイル詳細を含む詳細なデータソース情報。" }, "dataset_process_rule_id": { "type": "string", - "description": "このドキュメントに適用された処理ルールの ID です。" + "description": "このドキュメントに適用された処理ルールの ID。" }, "name": { "type": "string", - "description": "ドキュメント名です。" + "description": "ドキュメント名。" }, "created_from": { "type": "string", - "description": "ドキュメントの作成元です。API で作成した場合は `api`、UI で作成した場合は `web` です。" + "description": "ドキュメントの作成元。`api` は API 作成、`web` は UI 作成。" }, "created_by": { "type": "string", - "description": "ドキュメントを作成したユーザーの ID です。" + "description": "ドキュメントを作成したユーザーの ID。" }, "created_at": { "type": "number", - "description": "作成タイムスタンプ（Unix エポック、秒単位）です。" + "description": "作成タイムスタンプ（Unix エポック秒）。" }, "tokens": { "type": "integer", - "description": "ドキュメント内の合計トークン数です。" + "description": "ドキュメント内の総 token 数。" }, "indexing_status": { "type": "string", - "description": "現在のインデックスステータスです。`waiting` はキュー待ち、`parsing` はコンテンツ抽出中、`cleaning` はノイズ除去中、`splitting` はチャンキング中、`indexing` はベクトル構築中、`completed` は準備完了、`error` は失敗、`paused` は手動一時停止を示します。" + "description": "現在のインデックスステータス。`waiting` はキュー待ち、`parsing` はコンテンツ抽出中、`cleaning` はノイズ除去中、`splitting` はチャンキング中、`indexing` はベクトル構築中、`completed` は準備完了、`error` は失敗、`paused` は手動で一時停止。" }, "error": { "type": "string", "nullable": true, - "description": "インデックス作成が失敗した場合のエラーメッセージです。エラーなしの場合は `null` です。" + "description": "インデックスが失敗した場合のエラーメッセージ。エラーがない場合は `null`。" }, "enabled": { "type": "boolean", - "description": "このドキュメントが検索に対して有効かどうかです。" + "description": "ドキュメントが検索で有効かどうか。" }, "disabled_at": { "type": "number", "nullable": true, - "description": "ドキュメントが無効化されたタイムスタンプです。有効な場合は `null` です。" + "description": "ドキュメントが無効化されたタイムスタンプ。有効な場合は `null`。" }, "disabled_by": { "type": "string", "nullable": true, - "description": "ドキュメントを無効化したユーザーの ID です。有効な場合は `null` です。" + "description": "ドキュメントを無効化したユーザーの ID。有効な場合は `null`。" }, "archived": { "type": "boolean", - "description": "ドキュメントがアーカイブ済みかどうかです。" + "description": "ドキュメントがアーカイブされているかどうか。" }, "display_status": { "type": "string", - "description": "`indexing_status` と `enabled` 状態から導出されたユーザー向け表示ステータスです。" + "description": "`indexing_status` と `enabled` 状態から導出されたユーザー向け表示ステータス。" }, "word_count": { "type": "integer", - "description": "ドキュメントの合計単語数です。" + "description": "ドキュメントの総単語数。" }, "hit_count": { "type": "integer", - "description": "ドキュメントが検索クエリでマッチした回数です。" + "description": "ドキュメントが検索クエリで一致した回数。" }, "doc_form": { "type": "string", - "description": "ドキュメントのチャンキングモードです。`text_model` は標準テキストチャンキング、`hierarchical_model` は親子構造、`qa_model` は QA ペア抽出を示します。" + "description": "ドキュメントのチャンキングモード。`text_model` は標準テキストチャンキング、`hierarchical_model` は親子構造、`qa_model` は QA ペア抽出。" }, "doc_metadata": { "type": "array", - "description": "このドキュメントに割り当てられたメタデータ値です。", + "description": "このドキュメントに割り当てられたメタデータ値。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "メタデータフィールドの識別子です。" + "description": "メタデータフィールド識別子。" }, "name": { "type": "string", - "description": "メタデータフィールド名です。" + "description": "メタデータフィールド名。" }, "type": { "type": "string", - "description": "メタデータフィールドの値の種類です。" + "description": "メタデータフィールドの値タイプ。" }, "value": { "type": "string", @@ -6338,11 +6338,11 @@ "summary_index_status": { "type": "string", "nullable": true, - "description": "このドキュメントの要約インデックスのステータスです。要約インデックスが設定されていない場合は `null` です。" + "description": "このドキュメントの要約インデックスのステータス。要約インデックスが設定されていない場合は `null`。" }, "need_summary": { "type": "boolean", - "description": "このドキュメントに要約を生成する必要があるかどうかです。" + "description": "このドキュメントに要約を生成する必要があるかどうか。" } } }, @@ -6351,7 +6351,7 @@ "properties": { "id": { "type": "string", - "description": "チャンクの一意識別子です。" + "description": "チャンクの一意識別子。" }, "position": { "type": "integer", @@ -6359,121 +6359,121 @@ }, "document_id": { "type": "string", - "description": "このチャンクが属するドキュメントの ID です。" + "description": "このチャンクが属するドキュメントの ID。" }, "content": { "type": "string", - "description": "チャンクのテキスト内容です。" + "description": "チャンクのテキストコンテンツ。" }, "sign_content": { "type": "string", - "description": "整合性検証用の署名付きコンテンツハッシュです。" + "description": "整合性検証用の署名付きコンテンツハッシュ。" }, "answer": { "type": "string", - "description": "回答コンテンツです。Q&A モードのドキュメントで使用されます。" + "description": "Q&A モードドキュメントで使用される回答コンテンツ。" }, "word_count": { "type": "integer", - "description": "チャンク内容の単語数です。" + "description": "チャンクコンテンツの単語数。" }, "tokens": { "type": "integer", - "description": "チャンク内容のトークン数です。" + "description": "チャンクコンテンツの token 数。" }, "keywords": { "type": "array", - "description": "キーワードベースの検索のためにこのチャンクに関連付けられたキーワードです。", + "description": "キーワードベースの検索に関連付けられたキーワード。", "items": { "type": "string" } }, "index_node_id": { "type": "string", - "description": "ベクトルストア内のインデックスノードの ID です。" + "description": "ベクトルストア内のインデックスノードの ID。" }, "index_node_hash": { "type": "string", - "description": "インデックスされたコンテンツのハッシュです。変更の検出に使用されます。" + "description": "変更を検出するために使用されるインデックス済みコンテンツのハッシュ。" }, "hit_count": { "type": "integer", - "description": "このチャンクが検索クエリでマッチした回数です。" + "description": "このチャンクが検索クエリで一致した回数。" }, "enabled": { "type": "boolean", - "description": "このチャンクが検索に対して有効かどうかです。" + "description": "チャンクが検索で有効かどうか。" }, "disabled_at": { "type": "number", "nullable": true, - "description": "チャンクが無効化されたタイムスタンプです。有効な場合は `null` です。" + "description": "チャンクが無効化されたタイムスタンプ。有効な場合は `null`。" }, "disabled_by": { "type": "string", "nullable": true, - "description": "チャンクを無効化したユーザーの ID です。有効な場合は `null` です。" + "description": "チャンクを無効化したユーザーの ID。有効な場合は `null`。" }, "status": { "type": "string", - "description": "チャンクの現在のインデックスステータスです（例：`completed`、`indexing`、`error`）。" + "description": "チャンクの現在のインデックスステータス。例：`completed`、`indexing`、`error`。" }, "created_by": { "type": "string", - "description": "チャンクを作成したユーザーの ID です。" + "description": "チャンクを作成したユーザーの ID。" }, "created_at": { "type": "number", - "description": "作成タイムスタンプ（Unix エポック、秒単位）です。" + "description": "作成タイムスタンプ（Unix エポック秒）。" }, "updated_at": { "type": "number", - "description": "最終更新タイムスタンプ（Unix エポック、秒単位）です。" + "description": "最終更新タイムスタンプ（Unix エポック秒）。" }, "updated_by": { "type": "string", - "description": "このチャンクを最後に更新したユーザーの ID です。" + "description": "チャンクを最後に更新したユーザーの ID。" }, "indexing_at": { "type": "number", "nullable": true, - "description": "インデックス作成が開始されたタイムスタンプです。まだ開始されていない場合は `null` です。" + "description": "インデックスが開始されたタイムスタンプ。まだ開始されていない場合は `null`。" }, "completed_at": { "type": "number", "nullable": true, - "description": "インデックス作成が完了したタイムスタンプです。まだ完了していない場合は `null` です。" + "description": "インデックスが完了したタイムスタンプ。まだ完了していない場合は `null`。" }, "error": { "type": "string", "nullable": true, - "description": "インデックス作成が失敗した場合のエラーメッセージです。エラーなしの場合は `null` です。" + "description": "インデックスが失敗した場合のエラーメッセージ。エラーがない場合は `null`。" }, "stopped_at": { "type": "number", "nullable": true, - "description": "インデックス作成が停止されたタイムスタンプです。停止されていない場合は `null` です。" + "description": "インデックスが停止されたタイムスタンプ。停止されていない場合は `null`。" }, "child_chunks": { "type": "array", - "description": "このチャンクに属する子チャンクです。階層モードのドキュメントにのみ存在します。", + "description": "このチャンクに属する子チャンク。階層モードドキュメントでのみ存在します。", "items": { "$ref": "#/components/schemas/ChildChunk" } }, "attachments": { "type": "array", - "description": "このチャンクに添付されたファイルです。", + "description": "このチャンクに添付されたファイル。", "items": { "type": "object", "properties": { "id": { "type": "string", - "description": "添付ファイルの識別子です。" + "description": "添付ファイル識別子。" }, "name": { "type": "string", - "description": "元のファイル名です。" + "description": "元のファイル名。" }, "size": { "type": "integer", @@ -6489,7 +6489,7 @@ }, "source_url": { "type": "string", - "description": "添付ファイルにアクセスする URL です。" + "description": "添付ファイルにアクセスするための URL。" } } } @@ -6497,7 +6497,7 @@ "summary": { "type": "string", "nullable": true, - "description": "AI が生成したチャンクコンテンツの要約です。要約インデックスが有効でない場合は `null` です。" + "description": "チャンクコンテンツの AI 生成要約。要約インデックスが有効でない場合は `null`。" } } }, @@ -6506,35 +6506,35 @@ "properties": { "id": { "type": "string", - "description": "子チャンクの一意識別子です。" + "description": "子チャンクの一意識別子。" }, "segment_id": { "type": "string", - "description": "この子チャンクが属する親チャンクの ID です。" + "description": "この子チャンクが属する親チャンクの ID。" }, "content": { "type": "string", - "description": "子チャンクのテキスト内容です。" + "description": "子チャンクのテキストコンテンツ。" }, "position": { "type": "integer", - "description": "親チャンク内の子チャンクの位置です。" + "description": "親チャンク内の子チャンクの位置。" }, "word_count": { "type": "integer", - "description": "子チャンク内容の単語数です。" + "description": "子チャンクコンテンツの単語数。" }, "type": { "type": "string", - "description": "子チャンクの作成方法です。システム生成の場合は `automatic`、手動作成の場合は `custom` です。" + "description": "子チャンクの作成方法。`automatic` はシステム生成、`custom` は手動作成。" }, "created_at": { "type": "number", - "description": "作成タイムスタンプ（Unix エポック、秒単位）です。" + "description": "作成タイムスタンプ（Unix エポック秒）。" }, "updated_at": { "type": "number", - "description": "最終更新タイムスタンプ（Unix エポック、秒単位）です。" + "description": "最終更新タイムスタンプ（Unix エポック秒）。" } } }, @@ -6549,7 +6549,7 @@ "properties": { "search_method": { "type": "string", - "description": "検索に使用される検索メソッドです。", + "description": "検索に使用される検索方法。", "enum": [ "keyword_search", "semantic_search", @@ -6559,19 +6559,19 @@ }, "reranking_enable": { "type": "boolean", - "description": "リランキングが有効かどうかです。" + "description": "リランキングが有効かどうか。" }, "reranking_model": { "type": "object", - "description": "リランキングモデルの設定です。", + "description": "リランキングモデル設定。", "properties": { "reranking_provider_name": { "type": "string", - "description": "リランキングモデルのプロバイダー名です。" + "description": "リランキングモデルのプロバイダー名。" }, "reranking_model_name": { "type": "string", - "description": "リランキングモデル名です。" + "description": "リランキングモデルの名前。" } } }, @@ -6582,29 +6582,29 @@ "weighted_score" ], "nullable": true, - "description": "リランキングモードです。`reranking_enable` が `true` の場合は必須です。" + "description": "リランキングモード。`reranking_enable` が `true` の場合に必要です。" }, "top_k": { "type": "integer", - "description": "返す結果の最大数です。" + "description": "返す結果の最大数。" }, "score_threshold_enabled": { "type": "boolean", - "description": "スコア閾値フィルタリングが有効かどうかです。" + "description": "スコアしきい値フィルタリングが有効かどうか。" }, "score_threshold": { "type": "number", "nullable": true, - "description": "結果の最小関連性スコアです。`score_threshold_enabled` が `true` の場合にのみ有効です。" + "description": "結果の最小関連性スコア。`score_threshold_enabled` が `true` の場合にのみ有効。" }, "weights": { "type": "object", "nullable": true, - "description": "ハイブリッド検索の重み設定です。", + "description": "ハイブリッド検索の重み設定。", "properties": { "weight_type": { "type": "string", - "description": "セマンティック検索とキーワード検索の重みを調整するための戦略です。", + "description": "セマンティック検索とキーワード検索の重みをバランスする戦略。", "enum": [ "semantic_first", "keyword_first", @@ -6613,29 +6613,29 @@ }, "vector_setting": { "type": "object", - "description": "セマンティック検索の重み設定です。", + "description": "セマンティック検索の重み設定。", "properties": { "vector_weight": { "type": "number", - "description": "セマンティック（ベクトル）検索結果に割り当てられた重みです。" + "description": "セマンティック（ベクトル）検索結果に割り当てられる重み。" }, "embedding_provider_name": { "type": "string", - "description": "ベクトル検索に使用される埋め込みモデルのプロバイダーです。" + "description": "ベクトル検索に使用される埋め込みモデルのプロバイダー。" }, "embedding_model_name": { "type": "string", - "description": "ベクトル検索に使用される埋め込みモデルの名前です。" + "description": "ベクトル検索に使用される埋め込みモデルの名前。" } } }, "keyword_setting": { "type": "object", - "description": "キーワード検索の重み設定です。", + "description": "キーワード検索の重み設定。", "properties": { "keyword_weight": { "type": "number", - "description": "キーワード検索結果に割り当てられた重みです。" + "description": "キーワード検索結果に割り当てられる重み。" } } } @@ -6649,8 +6649,8 @@ "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 キーの漏洩は深刻な結果につながる可能性があります。**" } } } -} +} \ No newline at end of file diff --git a/ja/use-dify/knowledge/connect-external-knowledge-base.mdx b/ja/use-dify/knowledge/connect-external-knowledge-base.mdx index c671f1964..c02515b3e 100644 --- a/ja/use-dify/knowledge/connect-external-knowledge-base.mdx +++ b/ja/use-dify/knowledge/connect-external-knowledge-base.mdx @@ -1,134 +1,85 @@ --- title: 外部ナレッジベースと連携 +description: API接続を通じて外部ナレッジソースをDifyアプリケーションと統合し、カスタムRAGシステムやサードパーティナレッジサービスを活用します sidebarTitle: 概要 --- - ⚠️ このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/use-dify/knowledge/connect-external-knowledge-base)を参照してください。 + ⚠️ このドキュメントはAIによって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/use-dify/knowledge/connect-external-knowledge-base)を参照してください。 -> この文書では、Difyプラットフォームとは独立したナレッジベースを総称して **「外部ナレッジベース」** と呼びます。 +チームが独自のRAGシステムを維持している場合や、[AWS Bedrock](https://aws.amazon.com/bedrock/)などのサードパーティナレッジサービスにコンテンツをホスティングしている場合、Difyの組み込みナレッジベースにコンテンツを移行する代わりに、これらの外部ソースをDifyに接続できます。 -## 機能概要 +これにより、AIアプリケーションは既存のインフラストラクチャから直接情報を取得でき、検索ロジックとコンテンツ管理の完全な制御を維持できます。 -高度なコンテンツ検索の要件を持つ上級開発者にとって、Difyプラットフォームに組み込まれたナレッジベース機能とテキスト検索・取得メカニズムには**制約があり、検索結果を簡単に変更することができません。** - -テキスト検索と取得の精度に高い要求を持ち、内部資料の管理ニーズを満たすために、一部のチームは独自にRAGアルゴリズムを開発し、個人のテキスト取得システムを維持したり、コンテンツをクラウドプロバイダのナレッジベースサービス（例：[AWS Bedrock](https://aws.amazon.com/bedrock/)）に統合したりしています。 - -中立的なLLMアプリケーション開発プラットフォームであるDifyは、開発者にさまざまな選択肢を提供することを目指しています。 - -**外部ナレッジベースに接続する**機能を使うことで、Difyプラットフォームと外部ナレッジベースを接続できます。APIサービスを通じて、AIアプリケーションはより多くの情報源からデータを取得できるようになります。具体的には： - -- Difyプラットフォームは、クラウドサービスプロバイダのナレッジベースにホスティングされているテキストコンテンツを直接取得でき、開発者はDify内のナレッジベースに再度コンテンツを転送する必要がありません。 -- Difyプラットフォームは、独自に構築したナレッジベース内のアルゴリズムで処理されたテキストコンテンツを直接取得でき、開発者は独自のナレッジベースの情報検索メカニズムに焦点を当て、情報取得の精度を継続的に最適化できます。 - - - + + ![外部ナレッジベースのアーキテクチャ](https://assets-docs.dify.ai/2025/03/f5fb91d18740c1e2d3938d4d106c4d3c.png) -以下は外部ナレッジベースに接続するための詳細な手順です： - - - - Difyとの接続を成功させるためには、外部ナレッジベースがDifyが作成した[外部ナレッジベースAPI仕様](/ja/use-dify/knowledge/external-knowledge-api)を慎重に読み、APIサービスを構築する必要があります。 - - - > 現在、Difyは外部ナレッジベースに対する最適化や変更をサポートしておらず、検索権限のみを有しています。開発者は外部ナレッジベースを自己管理する必要があります。 - - **"ナレッジベース"** ページに移動し、右上の **"外部ナレッジベースAPI"** をクリックし、 **"外部ナレッジベースAPIを追加"** を選択します。 - - ページの指示に従い、以下の内容を順番に入力してください： - - * ナレッジベースの名前：カスタム名を設定でき、接続された異なる外部ナレッジAPIを区別するために使用します。 - * APIインターフェースアドレス：外部ナレッジベースの接続アドレス（例：`api-endpoint/retrieval`）；詳細な説明は[外部ナレッジベースAPI](/ja/use-dify/knowledge/external-knowledge-api)を参照してください。 - * APIキー：外部ナレッジベース接続のためのキー；詳細な説明は[外部ナレッジベースAPI](/ja/use-dify/knowledge/external-knowledge-api)を参照してください。 - - - - - - - **"ナレッジベース"** ページに移動し、追加したナレッジベースカードの下にある **"外部ナレッジベースに接続"** をクリックして、パラメーター設定ページに移動します。 +**外部ナレッジベースへの接続は3つのステップで行います**： - - - +1. [DifyがクエリできるAPIサービスを構築する](#step-1-build-the-retrieval-api)。 +2. [DifyにAPIエンドポイントを登録する](#step-2-register-an-external-knowledge-api)。 +3. [登録されたAPIを通じて特定のナレッジソースを接続する](#step-3-create-an-external-knowledge-base)。 - 以下のパラメータを入力してください： +アプリケーションが実行されると、Difyはエンドポイントに検索リクエストを送信し、返されたチャンクをLLMレスポンスのコンテキストとして使用します。 - - **ナレッジベースの名称と説明** - - **外部ナレッジベースAPI**: 第二ステップで関連付けられた外部ナレッジベースAPIを選択します。DifyはAPI接続を通じて、外部ナレッジベースに保存されているテキスト内容を呼び出します。 - - **外部ナレッジベースID**: 関連付ける特定の外部ナレッジベースIDを指定します。詳細については[外部ナレッジベースAPI](/ja/use-dify/knowledge/external-knowledge-api)を参照してください。 - - **召回設定の調整** + +Difyは外部ナレッジベースへの検索アクセスのみを持ち、外部コンテンツの変更や管理はできません。ナレッジベースとその検索ロジックは独立して維持してください。 + - **Top K:** ユーザーが質問を発起した際に、外部知識APIに関連性の高いコンテンツ片を要求します。このパラメータは、ユーザーの質問との類似度が高いテキスト片をフィルタリングするために使用されます。デフォルト値は3で、数値が大きいほど関連性のあるテキスト片が多く召回されます。 +## Step 1: 検索APIの構築 - **スコア閾値:** テキスト片フィルタリングの類似度閾値で、設定されたスコアを超えるテキスト片のみが召回されます。デフォルト値は0.5です。数値が高いほど、テキストと質問要求の類似度が高く、召回されるテキストの数が少なくなり、結果的により精度が高まります。 +[外部ナレッジベースAPI仕様](/ja/use-dify/knowledge/external-knowledge-api)を実装するAPIサービスを構築します。サービスには、検索クエリを受け取り、類似度スコア付きのマッチするテキストチャンクを返す単一の`POST`エンドポイントが必要です。 - - - +## Step 2: 外部ナレッジベースAPIを登録する - - - 接続が確立された後、開発者は **「召回テスト」** で可能な質問キーワードをシミュレーションし、外部ナレッジベースから召回されたテキスト片をプレビューできます。召回結果に満足できない場合は、召回パラメータの変更や外部ナレッジベースの検索設定の調整を試みてください。 +外部ナレッジベースAPIは、エンドポイントURLと認証資格情報を保存します。複数のナレッジベースで1つのAPI接続を共有できます。 - - - - - - - **Chatbot / エージェント型アプリ** +1. **ナレッジ**に移動し、右上の**外部ナレッジベースAPI**をクリックし、**外部ナレッジベースAPIを追加**をクリックします。 - Chatbot / エージェント型アプリの編成ページにある **「コンテキスト」** で、`EXTERNAL`ラベルの付いた外部ナレッジベースを選択します。 +2. 以下のフィールドを入力します： - - - + - **名前**：このAPI接続を他と区別するためのラベル。 + - **APIエンドポイント**：外部ナレッジサービスのベースURL。Difyはリクエスト送信時に自動的に`/retrieval`を追加します。詳細については、[外部ナレッジベースAPI仕様](/ja/use-dify/knowledge/external-knowledge-api)を参照してください。 + - **APIキー**：サービスの認証資格情報。Difyはこれを`Authorization`ヘッダーにBearerトークンとして送信します。 - - **チャットフロー / ワークフロー型アプリ** +保存時にDifyはエンドポイントにテストリクエストを送信して接続を検証します。 - チャットフロー / ワークフロー型アプリに **「知識検索」** ノードを追加し、`EXTERNAL`ラベルの付いた外部ナレッジベースを選択します。 +## Step 3: 外部ナレッジベースを作成する - -
- +APIを登録したら、外部ナレッジソースをDifyに接続します。これにより、外部システムにリンクされたナレッジベースがDifyに作成されます。 - - - **「ナレッジベース」**ページでは、外部ナレッジベースのカードの右上に**EXTERNAL**ラベルが表示されます。変更が必要なナレッジベースに入って、**「設定」**をクリックして以下の内容を変更します： +1. **ナレッジ**に移動し、**外部ナレッジベースに接続**をクリックします。 - * **ナレッジベースの名称と説明** - * **可視範囲**: 「自分だけ」、「全チームメンバー」、「一部のチームメンバー」の3つの権限範囲を提供します。権限のない人はそのナレッジベースにアクセスできません。ナレッジベースを他のメンバーに公開することを選択した場合、他のメンバーもそのナレッジベースの閲覧、編集、および削除権限を持つことになります。 - * **召回設定** + + ![外部ナレッジベースに接続](/images/connect-to-external-knowledge-base.png) + - **Top K:** ユーザーが質問をした際に、外部知識APIに関連性の高いコンテンツ片を要求します。このパラメータは、ユーザーの質問との類似度が高いテキスト片をフィルタリングするために使用されます。デフォルト値は3で、数値が大きいほど関連性のあるテキスト片が多く召回されます。 +2. 以下のフィールドを入力します： + - **外部ナレッジベース名**と**ナレッジベースの説明**（オプション）。 + - **外部ナレッジベースAPI**：登録したAPI接続を選択します。DifyはこのAPIを通じてすべての検索リクエストをルーティングします。 + - **外部ナレッジベースID**：外部システム内の特定のナレッジソースの識別子で、APIに`knowledge_id`フィールドとして渡されます。 - **スコア閾値:** テキスト片フィルタリングの類似度閾値で、設定されたスコアを超えるテキスト片のみが召回されます。デフォルト値は0.5です。数値が高いほど、テキストと質問要求の類似度が高く、召回されるテキストの数が少なくなり、結果的により精度が高まります。 + これは外部サービスが異なるナレッジベースを区別するために使用するIDです。例えば、BedrockナレッジベースのARNや、独自のシステムで定義したIDなどです。 - 外部ナレッジベースに関連付けられた **「外部ナレッジベースAPI」** と **「外部知識ID」** は変更できません。変更が必要な場合は、新しい「外部ナレッジベースAPI」を関連付けて再接続してください。 + + **外部ナレッジベースAPI**と**外部ナレッジベースID**は作成後に変更できません。別のAPIやナレッジソースを使用するには、新しい外部ナレッジベースを作成してください。 + - - + - **検索設定**： + - **Top K**：クエリごとに取得するチャンクの最大数。値が大きいほど多くの結果が返されますが、関連性の低いコンテンツが含まれる可能性があります。 + - **スコアしきい値**：返されるチャンクの最小類似度スコア。これを有効にすると、関連性の低い結果をフィルタリングできます。厳密な関連性にはより高い値を、より広いマッチを含めるにはより低い値を使用します。 -### 接続例 -#### LlamaCloud + 無効にすると、スコアに関係なくTop K制限までのすべての結果が返されます。 -DifyはLlamaCloudプラグインを公式に提供しており、LlamaCloudナレッジベースに簡単に接続することができます。 +作成後、外部ナレッジベースは組み込みナレッジベースと同様にアプリケーションで使用できます。詳細については、[アプリケーション内でナレッジを統合する](/ja/use-dify/knowledge/integrate-knowledge-within-application)を参照してください。 -**プラグインのインストール** +## 接続例 -1. Difyの[マーケットプレイス](https://marketplace.dify.ai/)にアクセスし、`LlamaCloud`を検索します -2. 指示に従ってLlamaCloudプラグインをインストールおよび設定します -3. Difyプラットフォームでプラグインを有効にします -4. プラグイン設定ウィザードに従って、LlamaCloudのAPIキーやその他の必要な情報を入力します -5. 設定が完了すると、ナレッジベースリストに接続された外部ナレッジベースが表示されます +### LlamaCloud -LlamaCloudプラグインを使用すると、カスタムAPIを作成することなく、DifyプラットフォームでLlamaCloudの強力な検索機能を直接利用できます。 +Difyマーケットプレイスの[LlamaCloudプラグイン](https://marketplace.dify.ai/plugin/langgenius/llamacloud)は、カスタムAPIを構築することなくLlamaCloudナレッジベースに接続できます。プラグインをインストールし、設定ウィザードに従ってLlamaCloud APIキーを入力してください。 -詳細については、プラグインの[GitHubリポジトリ](https://github.com/langgenius/dify-official-plugins/tree/main/extensions/llamacloud)を参照してください。 - -**ビデオチュートリアル** - -以下の動画では、LlamaCloudプラグインを使用して外部ナレッジベースに接続する方法を詳しく説明しています： +以下の動画では、LlamaCloudプラグインのセットアップについて説明しています：