diff --git a/web/app/components/develop/doc.tsx b/web/app/components/develop/doc.tsx index ce5471676d..d3076c4e74 100644 --- a/web/app/components/develop/doc.tsx +++ b/web/app/components/develop/doc.tsx @@ -5,12 +5,16 @@ import { useTranslation } from 'react-i18next' import { RiListUnordered } from '@remixicon/react' import TemplateEn from './template/template.en.mdx' import TemplateZh from './template/template.zh.mdx' +import TemplateJa from './template/template.ja.mdx' import TemplateAdvancedChatEn from './template/template_advanced_chat.en.mdx' import TemplateAdvancedChatZh from './template/template_advanced_chat.zh.mdx' +import TemplateAdvancedChatJa from './template/template_advanced_chat.ja.mdx' import TemplateWorkflowEn from './template/template_workflow.en.mdx' import TemplateWorkflowZh from './template/template_workflow.zh.mdx' +import TemplateWorkflowJa from './template/template_workflow.ja.mdx' import TemplateChatEn from './template/template_chat.en.mdx' import TemplateChatZh from './template/template_chat.zh.mdx' +import TemplateChatJa from './template/template_chat.ja.mdx' import I18n from '@/context/i18n' import { LanguagesSupported } from '@/i18n/language' @@ -57,7 +61,6 @@ const Doc = ({ appDetail }: IDocProps) => { // Run after component has rendered setTimeout(extractTOC, 0) }, [appDetail, locale]) - return (
@@ -98,16 +101,52 @@ const Doc = ({ appDetail }: IDocProps) => {
{(appDetail?.mode === 'chat' || appDetail?.mode === 'agent-chat') && ( - locale !== LanguagesSupported[1] ? : + (() => { + switch (locale) { + case LanguagesSupported[1]: + return + case LanguagesSupported[7]: + return + default: + return + } + })() )} {appDetail?.mode === 'advanced-chat' && ( - locale !== LanguagesSupported[1] ? : + (() => { + switch (locale) { + case LanguagesSupported[1]: + return + case LanguagesSupported[7]: + return + default: + return + } + })() )} {appDetail?.mode === 'workflow' && ( - locale !== LanguagesSupported[1] ? : + (() => { + switch (locale) { + case LanguagesSupported[1]: + return + case LanguagesSupported[7]: + return + default: + return + } + })() )} {appDetail?.mode === 'completion' && ( - locale !== LanguagesSupported[1] ? : + (() => { + switch (locale) { + case LanguagesSupported[1]: + return + case LanguagesSupported[7]: + return + default: + return + } + })() )}
diff --git a/web/app/components/develop/template/template.ja.mdx b/web/app/components/develop/template/template.ja.mdx new file mode 100755 index 0000000000..a6ab109229 --- /dev/null +++ b/web/app/components/develop/template/template.ja.mdx @@ -0,0 +1,551 @@ +import { CodeGroup } from '../code.tsx' +import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '../md.tsx' + +# Completion アプリ API + +テキスト生成アプリケーションはセッションレスをサポートし、翻訳、記事作成、要約AI等に最適です。 + +
+ ### ベースURL + + ```javascript + ``` + + + ### 認証 + + サービスAPIは`API-Key`認証を使用します。 + **APIキーの漏洩による重大な結果を避けるため、APIキーはサーバーサイドに保存し、クライアントサイドでは共有や保存しないことを強く推奨します。** + + すべてのAPIリクエストで、以下のように`Authorization` HTTPヘッダーにAPIキーを含めてください： + + + ```javascript + Authorization: Bearer {API_KEY} + + ``` + +
+ +--- + + + + + テキスト生成アプリケーションにリクエストを送信します。 + + ### リクエストボディ + + + + + アプリで定義された各種変数値を入力できます。 + `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の具体的な値となります。 + テキスト生成アプリケーションでは、少なくとも1つのキー/値ペアの入力が必要です。 + - `query` (string) 必須 + 入力テキスト、処理される内容。 + + + レスポンス返却モード、以下をサポート： + - `streaming` ストリーミングモード（推奨）、SSE（[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）によるタイプライター風の出力を実装。 + - `blocking` ブロッキングモード、実行完了後に結果を返却。（処理が長い場合はリクエストが中断される可能性があります） + Cloudflareの制限により、100秒後に返却なしで中断されます。 + + + ユーザー識別子、エンドユーザーの身元を定義し、取得や統計に使用します。 + アプリケーション内で開発者が一意に定義する必要があります。 + + + ファイルリスト、モデルがVision機能をサポートしている場合のみ、テキスト理解と質問応答を組み合わせたファイル（画像）の入力に適しています。 + - `type` (string) サポートされるタイプ：`image`（現在は画像タイプのみサポート） + - `transfer_method` (string) 転送方法、画像URLの場合は`remote_url` / ファイルアップロードの場合は`local_file` + - `url` (string) 画像URL（転送方法が`remote_url`の場合） + - `upload_file_id` (string) アップロードされたファイルID、事前にファイルアップロードAPIを通じてアップロードする必要があります（転送方法が`local_file`の場合） + + + + ### レスポンス + `response_mode`が`blocking`の場合、CompletionResponseオブジェクトを返却します。 + `response_mode`が`streaming`の場合、ChunkCompletionResponseストリームを返却します。 + + ### ChatCompletionResponse + アプリの完全な結果を返却、`Content-Type`は`application/json`です。 + - `message_id` (string) 一意のメッセージID + - `mode` (string) アプリモード、固定で`chat` + - `answer` (string) 完全な応答内容 + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属のリスト + - `created_at` (int) メッセージ作成タイムスタンプ、例：1705395332 + + ### ChunkChatCompletionResponse + アプリが出力するストリームチャンクを返却、`Content-Type`は`text/event-stream`です。 + 各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます： + + ```streaming {{ title: 'Response' }} + data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n + ``` + + ストリーミングチャンクの構造は`event`によって異なります： + - `event: message` LLMがテキストチャンクを返すイベント、つまり完全なテキストがチャンク形式で出力されます。 + - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用 + - `message_id` (string) 一意のメッセージID + - `answer` (string) LLMが返したテキストチャンクの内容 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: message_end` メッセージ終了イベント、このイベントを受信するとストリーミングが終了したことを意味します。 + - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用 + - `message_id` (string) 一意のメッセージID + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属のリスト + - `event: tts_message` TTS音声ストリームイベント、つまり音声合成出力。内容はMp3形式の音声ブロックで、base64文字列としてエンコードされています。再生時は単にbase64をデコードしてプレーヤーに供給するだけです。（このメッセージは自動再生が有効な場合のみ利用可能） + - `task_id` (string) タスクID、リクエストの追跡と以下の応答停止インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 音声合成後の音声、base64テキストコンテンツとしてエンコード、再生時は単にbase64をデコードしてプレーヤーに供給 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: tts_message_end` TTS音声ストリーム終了イベント、このイベントを受信すると音声ストリームが終了したことを示します。 + - `task_id` (string) タスクID、リクエストの追跡と以下の応答停止インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 終了イベントには音声がないため、空文字列 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: message_replace` メッセージ内容置換イベント。 + 出力内容のモデレーションが有効な場合、コンテンツがフラグ付けされると、このイベントを通じてメッセージ内容が事前設定された返信に置き換えられます。 + - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用 + - `message_id` (string) 一意のメッセージID + - `answer` (string) 置換内容（LLMの返信テキストすべてを直接置換） + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: error` + ストリーミング処理中に発生した例外は、ストリームイベントの形式で出力され、エラーイベントを受信するとストリームが終了します。 + - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用 + - `message_id` (string) 一意のメッセージID + - `status` (int) HTTPステータスコード + - `code` (string) エラーコード + - `message` (string) エラーメッセージ + - `event: ping` 接続を維持するため10秒ごとのPingイベント。 + + ### エラー + - 404, 会話が存在しません + - 400, `invalid_param`, パラメータ入力異常 + - 400, `app_unavailable`, アプリ設定が利用できません + - 400, `provider_not_initialize`, 利用可能なモデル認証情報設定がありません + - 400, `provider_quota_exceeded`, モデル呼び出しクォータ不足 + - 400, `model_currently_not_support`, 現在のモデルは利用できません + - 400, `completion_request_error`, テキスト生成に失敗しました + - 500, 内部サーバーエラー + + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/completion-messages' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "inputs": { + "query": "Hello, world!" + }, + "response_mode": "streaming", + "user": "abc-123" + }' + ``` + + + ### ブロッキングモード + + ```json {{ title: 'Response' }} + { + "event": "message", + "message_id": "9da23599-e713-473b-982c-4328d4f5c78a", + "mode": "completion", + "answer": "Hello World!...", + "metadata": { + "usage": { + "prompt_tokens": 1033, + "prompt_unit_price": "0.001", + "prompt_price_unit": "0.001", + "prompt_price": "0.0010330", + "completion_tokens": 128, + "completion_unit_price": "0.002", + "completion_price_unit": "0.001", + "completion_price": "0.0002560", + "total_tokens": 1161, + "total_price": "0.0012890", + "currency": "USD", + "latency": 0.7682376249867957 + } + }, + "created_at": 1705407629 + } + ``` + + ### ストリーミングモード + + ```streaming {{ title: 'Response' }} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " I", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": "'m", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " glad", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " to", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " meet", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " you", "created_at": 1679586595} + data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}}} + data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"} + data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""} + ``` + + + + +--- + + + + メッセージ送信時に使用するファイル（現在は画像のみ対応）をアップロードし、画像とテキストのマルチモーダルな理解を可能にします。 + png、jpg、jpeg、webp、gif形式に対応しています。 + アップロードされたファイルは、現在のエンドユーザーのみが使用できます。 + + ### リクエストボディ + このインターフェースは`multipart/form-data`リクエストが必要です。 + - `file` (File) 必須 + アップロードするファイル。 + - `user` (string) 必須 + 開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。 + + ### レスポンス + アップロードが成功すると、サーバーはファイルのIDと関連情報を返します。 + - `id` (uuid) ID + - `name` (string) ファイル名 + - `size` (int) ファイルサイズ（バイト） + - `extension` (string) ファイル拡張子 + - `mime_type` (string) ファイルのMIMEタイプ + - `created_by` (uuid) エンドユーザーID + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + ### エラー + - 400, `no_file_uploaded`, ファイルを提供する必要があります + - 400, `too_many_files`, 現在は1つのファイルのみ受け付けています + - 400, `unsupported_preview`, ファイルがプレビューに対応していません + - 400, `unsupported_estimate`, ファイルが推定に対応していません + - 413, `file_too_large`, ファイルが大きすぎます + - 415, `unsupported_file_type`, サポートされていない拡張子です。現在はドキュメントファイルのみ受け付けています + - 503, `s3_connection_failed`, S3サービスに接続できません + - 503, `s3_permission_denied`, S3へのファイルアップロード権限がありません + - 503, `s3_file_too_large`, ファイルがS3のサイズ制限を超えています + - 500, 内部サーバーエラー + + + + ### リクエスト例 + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/files/upload' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@"/path/to/file"' + ``` + + + + + ### レスポンス例 + + ```json {{ title: 'Response' }} + { + "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67", + "name": "example.png", + "size": 1024, + "extension": "png", + "mime_type": "image/png", + "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13", + "created_at": 1577836800, + } + ``` + + + +--- + + + + + ストリーミングモードでのみサポートされています。 + ### パス + - `task_id` (string) タスクID、ストリーミングチャンクの返信から取得可能 + リクエストボディ + - `user` (string) 必須 + ユーザー識別子。エンドユーザーの身元を定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。 + ### レスポンス + - `result` (string) 常に"success"を返します + + + ### リクエスト例 + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/completion-messages/:task_id/stop' \ + -H 'Authorization: Bearer {api_key}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "user": "abc-123" + }' + ``` + + + ### レスポンス例 + + ```json {{ title: 'Response' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。 + + ### パス + + + メッセージID + + + + ### リクエストボディ + + + + 高評価は`like`、低評価は`dislike`、高評価の取り消しは`null` + + + 開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。 + + + + ### レスポンス + - `result` (string) 常に"success"を返します + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "rating": "like", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: 'Response' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + ページ開始時に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 + + ### クエリ + + + + 開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。 + + + + ### レスポンス + - `opening_statement` (string) 開始文 + - `suggested_questions` (array[string]) 開始時の提案質問リスト + - `suggested_questions_after_answer` (object) 回答後の提案質問を有効にします。 + - `enabled` (bool) 有効かどうか + - `speech_to_text` (object) 音声からテキスト + - `enabled` (bool) 有効かどうか + - `retriever_resource` (object) 引用と帰属 + - `enabled` (bool) 有効かどうか + - `annotation_reply` (object) 注釈付き返信 + - `enabled` (bool) 有効かどうか + - `user_input_form` (array[object]) ユーザー入力フォーム設定 + - `text-input` (object) テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `paragraph` (object) 段落テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `select` (object) ドロップダウンコントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `options` (array[string]) オプション値 + - `file_upload` (object) ファイルアップロード設定 + - `image` (object) 画像設定 + 現在は画像タイプのみ対応：`png`、`jpg`、`jpeg`、`webp`、`gif` + - `enabled` (bool) 有効かどうか + - `number_limits` (int) 画像数制限、デフォルトは3 + - `transfer_methods` (array[string]) 転送方法リスト、remote_url、local_file、いずれかを選択 + - `system_parameters` (object) システムパラメータ + - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB） + - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB） + - `audio_file_size_limit` (int) 音声ファイルアップロードサイズ制限（MB） + - `video_file_size_limit` (int) 動画ファイルアップロードサイズ制限（MB） + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: 'Response' }} + { + "opening_statement": "Hello!", + "suggested_questions_after_answer": { + "enabled": true + }, + "speech_to_text": { + "enabled": true + }, + "retriever_resource": { + "enabled": true + }, + "annotation_reply": { + "enabled": true + }, + "user_input_form": [ + { + "paragraph": { + "label": "Query", + "variable": "query", + "required": true, + "default": "" + } + } + ], + "file_upload": { + "image": { + "enabled": false, + "number_limits": 3, + "detail": "high", + "transfer_methods": [ + "remote_url", + "local_file" + ] + } + }, + "system_parameters": { + "file_size_limit": 15, + "image_file_size_limit": 10, + "audio_file_size_limit": 50, + "video_file_size_limit": 100 + } + } + ``` + + + + +--- + + + + + テキストを音声に変換します。 + + ### リクエストボディ + + + + Difyが生成したテキストメッセージの場合、生成されたmessage-idを直接渡すだけです。バックエンドはmessage-idを使用して対応するコンテンツを検索し、音声情報を直接合成します。message_idとtextの両方が同時に提供された場合、message_idが優先されます。 + + + 音声生成コンテンツ。 + + + 開発者が定義したユーザー識別子。アプリ内で一意性を確保する必要があります。 + + + + + + + + ```bash {{ title: 'cURL' }} + curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", + "text": "Hello Dify", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: 'headers' }} + { + "Content-Type": "audio/wav" + } + ``` + + + diff --git a/web/app/components/develop/template/template_advanced_chat.ja.mdx b/web/app/components/develop/template/template_advanced_chat.ja.mdx new file mode 100644 index 0000000000..b4c252e19a --- /dev/null +++ b/web/app/components/develop/template/template_advanced_chat.ja.mdx @@ -0,0 +1,1105 @@ +import { CodeGroup } from '../code.tsx' +import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '../md.tsx' + +# 高度なチャットアプリAPI + +チャットアプリケーションはセッションの持続性をサポートしており、以前のチャット履歴を応答のコンテキストとして使用できます。これは、チャットボットやカスタマーサービスAIなどに適用できます。 + +
+ ### ベースURL + + ```javascript + ``` + + + ### 認証 + + サービスAPIは`API-Key`認証を使用します。 + **APIキーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。APIキーの漏洩は深刻な結果を招く可能性があります。** + + すべてのAPIリクエストには、以下のように`Authorization`HTTPヘッダーにAPIキーを含めてください： + + + ```javascript + Authorization: Bearer {API_KEY} + + ``` + +
+ +--- + + + + + チャットアプリケーションにリクエストを送信します。 + + ### リクエストボディ + + + + ユーザー入力/質問内容 + + + アプリによって定義されたさまざまな変数値の入力を許可します。 + `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の特定の値です。 + 変数がファイルタイプの場合、以下の`files`で説明されているキーを持つオブジェクトを指定します。 + デフォルト`{}` + + + 応答の返却モードを指定します。サポートされているモード： + - `streaming` ストリーミングモード（推奨）、SSE（[サーバー送信イベント](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）を通じてタイプライターのような出力を実装します。 + - `blocking` ブロッキングモード、実行完了後に結果を返します。（プロセスが長い場合、リクエストが中断される可能性があります） + Cloudflareの制限により、リクエストは100秒後に返答なしで中断されます。 + + + ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義されるべきです。 + + + 会話ID、以前のチャット記録に基づいて会話を続けるには、以前のメッセージのconversation_idを渡す必要があります。 + + + ファイルリスト、テキストの理解と質問への回答を組み合わせたファイルの入力に適しており、モデルがビジョン機能をサポートしている場合にのみ利用可能です。 + - `type` (string) サポートされているタイプ： + - `document` ('TXT', 'MD', 'MARKDOWN', 'PDF', 'HTML', 'XLSX', 'XLS', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB') + - `image` ('JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG') + - `audio` ('MP3', 'M4A', 'WAV', 'WEBM', 'AMR') + - `video` ('MP4', 'MOV', 'MPEG', 'MPGA') + - `transfer_method` (string) 転送方法、画像URLの場合は`remote_url` / ファイルアップロードの場合は`local_file` + - `url` (string) 画像URL（転送方法が`remote_url`の場合） + - `upload_file_id` (string) アップロードされたファイルID、事前にファイルアップロードAPIを通じて取得する必要があります（転送方法が`local_file`の場合） + + + タイトルを自動生成、デフォルトは`true`。 + `false`に設定すると、会話のリネームAPIを呼び出し、`auto_generate`を`true`に設定することで非同期タイトル生成を実現できます。 + + + + ### 応答 + response_modeがブロッキングの場合、CompletionResponseオブジェクトを返します。 + response_modeがストリーミングの場合、ChunkCompletionResponseストリームを返します。 + + ### ChatCompletionResponse + 完全なアプリ結果を返します。`Content-Type`は`application/json`です。 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `mode` (string) アプリモード、`chat`として固定 + - `answer` (string) 完全な応答内容 + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `created_at` (int) メッセージ作成タイムスタンプ、例：1705395332 + + ### ChunkChatCompletionResponse + アプリによって出力されたストリームチャンクを返します。`Content-Type`は`text/event-stream`です。 + 各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます。以下のように表示されます： + + ```streaming {{ title: '応答' }} + data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n + ``` + + ストリーミングチャンクの構造は`event`に応じて異なります： + - `event: message` LLMがテキストチャンクイベントを返します。つまり、完全なテキストがチャンク形式で出力されます。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `answer` (string) LLMが返したテキストチャンク内容 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: message_file` メッセージファイルイベント、ツールによって新しいファイルが作成されました + - `id` (string) ファイル一意ID + - `type` (string) ファイルタイプ、現在は"image"のみ許可 + - `belongs_to` (string) 所属、ここでは'assistant'のみ + - `url` (string) ファイルのリモートURL + - `conversation_id` (string) 会話ID + - `event: message_end` メッセージ終了イベント、このイベントを受信するとストリーミングが終了したことを意味します。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `event: tts_message` TTSオーディオストリームイベント、つまり音声合成出力。内容はMp3形式のオーディオブロックで、base64文字列としてエンコードされています。再生時には、base64をデコードしてプレーヤーに入力するだけです。（このメッセージは自動再生が有効な場合にのみ利用可能） + - `task_id` (string) タスクID、リクエスト追跡と以下のストップ応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 音声合成後のオーディオ、base64テキストコンテンツとしてエンコードされており、再生時にはbase64をデコードしてプレーヤーに入力するだけです + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: tts_message_end` TTSオーディオストリーム終了イベント、このイベントを受信するとオーディオストリームが終了したことを示します。 + - `task_id` (string) タスクID、リクエスト追跡と以下のストップ応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 終了イベントにはオーディオがないため、これは空の文字列です + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: message_replace` メッセージ内容置換イベント。 + 出力内容のモデレーションが有効な場合、内容がフラグ付けされると、このイベントを通じてメッセージ内容がプリセットの返信に置き換えられます。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `answer` (string) 置換内容（すべてのLLM返信テキストを直接置き換えます） + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: workflow_started` ワークフローが実行を開始 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意ID + - `event` (string) `workflow_started`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意ID + - `workflow_id` (string) 関連ワークフローのID + - `sequence_number` (int) 自己増加シリアル番号、アプリ内で自己増加し、1から始まります + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `event: node_started` ノード実行が開始 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意ID + - `event` (string) `node_started`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意ID + - `node_id` (string) ノードのID + - `node_type` (string) ノードのタイプ + - `title` (string) ノードの名前 + - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用 + - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用 + - `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容 + - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332 + - `event: node_finished` ノード実行が終了、成功または失敗は同じイベント内で異なる状態で示されます + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意ID + - `event` (string) `node_finished`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意ID + - `node_id` (string) ノードのID + - `node_type` (string) ノードのタイプ + - `title` (string) ノードの名前 + - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用 + - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用 + - `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容 + - `process_data` (json) オプションのノードプロセスデータ + - `outputs` (json) オプションの出力内容 + - `status` (string) 実行の状態、`running` / `succeeded` / `failed` / `stopped` + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) オプションの使用される合計秒数 + - `execution_metadata` (json) メタデータ + - `total_tokens` (int) オプションの使用されるトークン数 + - `total_price` (decimal) オプションの合計コスト + - `currency` (string) オプション、例：`USD` / `RMB` + - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332 + - `event: workflow_finished` ワークフロー実行が終了、成功または失敗は同じイベント内で異なる状態で示されます + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意ID + - `event` (string) `workflow_finished`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行のID + - `workflow_id` (string) 関連ワークフローのID + - `status` (string) 実行の状態、`running` / `succeeded` / `failed` / `stopped` + - `outputs` (json) オプションの出力内容 + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) オプションの使用される合計秒数 + - `total_tokens` (int) オプションの使用されるトークン数 + - `total_steps` (int) デフォルト0 + - `created_at` (timestamp) 開始時間 + - `finished_at` (timestamp) 終了時間 + - `event: error` + ストリーミングプロセス中に発生する例外はストリームイベントの形式で出力され、エラーイベントを受信するとストリームが終了します。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `status` (int) HTTPステータスコード + - `code` (string) エラーコード + - `message` (string) エラーメッセージ + - `event: ping` 接続を維持するために10秒ごとにpingイベントが発生します。 + + ### エラー + - 404, 会話が存在しません + - 400, `invalid_param`, 異常なパラメータ入力 + - 400, `app_unavailable`, アプリ構成が利用できません + - 400, `provider_not_initialize`, 利用可能なモデル資格情報構成がありません + - 400, `provider_quota_exceeded`, モデル呼び出しクォータが不足しています + - 400, `model_currently_not_support`, 現在のモデルが利用できません + - 400, `completion_request_error`, テキスト生成に失敗しました + - 500, 内部サーバーエラー + + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/chat-messages' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "inputs": {}, + "query": "eh", + "response_mode": "streaming", + "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276", + "user": "abc-123" + }' + ``` + + ### ブロッキングモード + + ```json {{ title: '応答' }} + { + "event": "message", + "message_id": "9da23599-e713-473b-982c-4328d4f5c78a", + "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", + "mode": "chat", + "answer": "iPhone 13 Pro Maxの仕様は次のとおりです:...", + "metadata": { + "usage": { + "prompt_tokens": 1033, + "prompt_unit_price": "0.001", + "prompt_price_unit": "0.001", + "prompt_price": "0.0010330", + "completion_tokens": 128, + "completion_unit_price": "0.002", + "completion_price_unit": "0.001", + "completion_price": "0.0002560", + "total_tokens": 1161, + "total_price": "0.0012890", + "currency": "USD", + "latency": 0.7682376249867957 + }, + "retriever_resources": [ + { + "position": 1, + "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", + "dataset_name": "iPhone", + "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", + "document_name": "iPhone List", + "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", + "score": 0.98457545, + "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"" + } + ] + }, + "created_at": 1705407629 + } + ``` + + ### ストリーミングモード + + ```streaming {{ title: '応答' }} + data: {"event": "workflow_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "sequence_number": 1, "created_at": 1679586595}} + data: {"event": "node_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "created_at": 1679586595}} + data: {"event": "node_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "execution_metadata": {"total_tokens": 63127864, "total_price": 2.378, "currency": "USD"}, "created_at": 1679586595}} + data: {"event": "workflow_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "total_tokens": 63127864, "total_steps": "1", "created_at": 1679586595, "finished_at": 1679976595}} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595} + data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""}]}} + data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"} + data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""} + ``` + + + + + +--- + + + + メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。 + アプリケーションでサポートされている形式をサポートします。 + アップロードされたファイルは現在のエンドユーザーのみが使用できます。 + + ### リクエストボディ + このインターフェースは`multipart/form-data`リクエストを必要とします。 + - `file` (File) 必須 + アップロードするファイル。 + - `user` (string) 必須 + ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 + + ### 応答 + アップロードが成功すると、サーバーはファイルのIDと関連情報を返します。 + - `id` (uuid) ID + - `name` (string) ファイル名 + - `size` (int) ファイルサイズ（バイト） + - `extension` (string) ファイル拡張子 + - `mime_type` (string) ファイルのMIMEタイプ + - `created_by` (uuid) エンドユーザーID + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + ### エラー + - 400, `no_file_uploaded`, ファイルが提供されなければなりません + - 400, `too_many_files`, 現在は1つのファイルのみ受け付けます + - 400, `unsupported_preview`, ファイルはプレビューをサポートしていません + - 400, `unsupported_estimate`, ファイルは推定をサポートしていません + - 413, `file_too_large`, ファイルが大きすぎます + - 415, `unsupported_file_type`, サポートされていない拡張子、現在はドキュメントファイルのみ受け付けます + - 503, `s3_connection_failed`, S3サービスに接続できません + - 503, `s3_permission_denied`, S3にファイルをアップロードする権限がありません + - 503, `s3_file_too_large`, ファイルがS3のサイズ制限を超えています + - 500, 内部サーバーエラー + + + + + ### リクエスト例 + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/files/upload' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@"/path/to/file"' + ``` + + + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67", + "name": "example.png", + "size": 1024, + "extension": "png", + "mime_type": "image/png", + "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13", + "created_at": 1577836800, + } + ``` + + + +--- + + + + + ストリーミングモードでのみサポートされています。 + ### パス + - `task_id` (string) タスクID、ストリーミングチャンクの返り値から取得できます + ### リクエストボディ + - `user` (string) 必須 + ユーザー識別子、エンドユーザーの身元を定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。 + ### 応答 + - `result` (string) 常に"success"を返します + + + ### リクエスト例 + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \ + -H 'Authorization: Bearer {api_key}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "user": "abc-123" + }' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。 + + ### パス + + + メッセージID + + + + ### リクエストボディ + + + + アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null` + + + ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `result` (string) 常に"success"を返します + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "rating": "like", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + 現在のメッセージに対する次の質問の提案を取得します + + ### パスパラメータ + + + + メッセージID + + + + ### クエリ + + + ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義されるべきです。 + + + + + + + + ```bash {{ title: 'cURL' }} + curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123' \ + --header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \ + --header 'Content-Type: application/json' \ + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success", + "data": [ + "a", + "b", + "c" + ] + } + ``` + + + + +--- + + + + + スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。 + + ### クエリ + + + + 会話ID + + + ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義されるべきです。 + + + 現在のページの最初のチャット記録のID、デフォルトはnullです。 + + + 1回のリクエストで返すチャット履歴メッセージの数、デフォルトは20です。 + + + + ### 応答 + - `data` (array[object]) メッセージリスト + - `id` (string) メッセージID + - `conversation_id` (string) 会話ID + - `inputs` (array[object]) ユーザー入力パラメータ。 + - `query` (string) ユーザー入力/質問内容。 + - `message_files` (array[object]) メッセージファイル + - `id` (string) ID + - `type` (string) ファイルタイプ、画像の場合はimage + - `url` (string) プレビュー画像URL + - `belongs_to` (string) 所属、userまたはassistant + - `answer` (string) 応答メッセージ内容 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `feedback` (object) フィードバック情報 + - `rating` (string) アップボートは`like` / ダウンボートは`dislike` + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `has_more` (bool) 次のページがあるかどうか + - `limit` (int) 返された項目数、入力がシステム制限を超える場合、システム制限数を返します + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id=' + --header 'Authorization: Bearer {api_key}' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "limit": 20, + "has_more": false, + "data": [ + { + "id": "a076a87f-31e5-48dc-b452-0061adbbc922", + "conversation_id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce", + "inputs": { + "name": "dify" + }, + "query": "iphone 13 pro", + "answer": "iPhone 13 Proは2021年9月24日に発売され、6.1インチのディスプレイと1170 x 2532の解像度を備えています。Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)プロセッサ、6 GBのRAMを搭載し、128 GB、256 GB、512 GB、1 TBのストレージオプションを提供します。カメラは12 MP、バッテリー容量は3095 mAhで、iOS 15を搭載しています。", + "message_files": [], + "feedback": null, + "retriever_resources": [ + { + "position": 1, + "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", + "dataset_name": "iPhone", + "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", + "document_name": "iPhone List", + "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", + "score": 0.98457545, + "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"" + } + ], + "created_at": 1705569239, + } + ] + } + ``` + + + + +--- + + + + + 現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。 + + ### クエリ + + + + ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義されるべきです。 + + + 現在のページの最後の記録のID、デフォルトはnullです。 + + + 1回のリクエストで返す記録の数、デフォルトは最新の20件です。 + + + ピン留めされた会話のみを`true`として返し、非ピン留めを`false`として返します + + + ソートフィールド（オプション）、デフォルト：-updated_at（更新時間で降順にソート） + - 利用可能な値：created_at, -created_at, updated_at, -updated_at + - フィールドの前の記号は順序または逆順を表し、"-"は逆順を表します。 + + + + ### 応答 + - `data` (array[object]) 会話のリスト + - `id` (string) 会話ID + - `name` (string) 会話名、デフォルトではLLMによって生成されます。 + - `inputs` (array[object]) ユーザー入力パラメータ。 + - `introduction` (string) 紹介 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `has_more` (bool) + - `limit` (int) 返されたエントリ数、入力がシステム制限を超える場合、システム制限数が返されます + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "limit": 20, + "has_more": false, + "data": [ + { + "id": "10799fb8-64f7-4296-bbf7-b42bfbe0ae54", + "name": "新しいチャット", + "inputs": { + "book": "book", + "myName": "Lucy" + }, + "status": "normal", + "created_at": 1679667915 + }, + { + "id": "hSIhXBhNe8X1d8Et" + // ... + } + ] + } + ``` + + + + +--- + + + + + 会話を削除します。 + + ### パス + - `conversation_id` (string) 会話ID + + ### リクエストボディ + + + + ユーザー識別子、開発者によって定義され、アプリケーション内で一意であることを保証しなければなりません。 + + + + ### 応答 + - `result` (string) 常に"success"を返します + + + + + + ```bash {{ title: 'cURL' }} + curl -X DELETE '${props.appDetail.api_base_url}/conversations/{conversation_id}' \ + --header 'Content-Type: application/json' \ + --header 'Accept: application/json' \ + --header 'Authorization: Bearer {api_key}' \ + --data '{ + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + ### リクエストボディ + セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。 + + ### パス + - `conversation_id` (string) 会話ID + + + + 会話の名前。`auto_generate`が`true`に設定されている場合、このパラメータは省略できます。 + + + タイトルを自動生成、デフォルトは`false` + + + ユーザー識別子、開発者によって定義され、アプリケーション内で一意であることを保証しなければなりません。 + + + + ### 応答 + - `id` (string) 会話ID + - `name` (string) 会話名 + - `inputs` array[object] ユーザー入力パラメータ。 + - `introduction` (string) 紹介 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/conversations/{conversation_id}/name' \ + --header 'Content-Type: application/json' \ + --header 'Authorization: Bearer {api_key}' \ + --data-raw '{ + "name": "", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce", + "name": "チャット vs AI", + "inputs": {}, + "introduction": "", + "created_at": 1705569238 + } + ``` + + + + +--- + + + + + このエンドポイントはmultipart/form-dataリクエストを必要とします。 + + ### リクエストボディ + + + + オーディオファイル。 + サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']` + ファイルサイズ制限：15MB + + + ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `text` (string) 出力テキスト + + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/conversations/name' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@localfile;type=audio/mp3' + ``` + + + + + ```json {{ text: 'hello' }} + { + "text": "" + } + ``` + + + + +--- + + + + + テキストを音声に変換します。 + + ### リクエストボディ + + + + Difyによって生成されたテキストメッセージの場合、生成されたメッセージIDを直接渡します。バックエンドはメッセージIDを使用して対応する内容を検索し、音声情報を直接合成します。message_idとtextが同時に提供される場合、message_idが優先されます。 + + + 音声生成コンテンツ。 + + + ユーザー識別子、開発者によって定義され、アプリ内で一意であることを保証しなければなりません。 + + + + + + + + ```bash {{ title: 'cURL' }} + curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", + "text": "Hello Dify", + "user": "abc-123", + "streaming": false + }' + ``` + + + + ```json {{ title: 'ヘッダー' }} + { + "Content-Type": "audio/wav" + } + ``` + + + + +--- + + + + + ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 + + ### クエリ + + + + ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `opening_statement` (string) 開始の挨拶 + - `suggested_questions` (array[string]) 開始時の推奨質問のリスト + - `suggested_questions_after_answer` (object) 答えを有効にした後の質問を提案します。 + - `enabled` (bool) 有効かどうか + - `speech_to_text` (object) 音声からテキストへ + - `enabled` (bool) 有効かどうか + - `retriever_resource` (object) 引用と帰属 + - `enabled` (bool) 有効かどうか + - `annotation_reply` (object) 注釈返信 + - `enabled` (bool) 有効かどうか + - `user_input_form` (array[object]) ユーザー入力フォームの設定 + - `text-input` (object) テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `paragraph` (object) 段落テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `select` (object) ドロップダウンコントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `options` (array[string]) オプション値 + - `file_upload` (object) ファイルアップロード設定 + - `image` (object) 画像設定 + 現在サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif` + - `enabled` (bool) 有効かどうか + - `number_limits` (int) 画像数の制限、デフォルトは3 + - `transfer_methods` (array[string]) 転送方法のリスト、remote_url, local_file、いずれかを選択する必要があります + - `system_parameters` (object) システムパラメータ + - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB） + - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB） + - `audio_file_size_limit` (int) オーディオファイルアップロードサイズ制限（MB） + - `video_file_size_limit` (int) ビデオファイルアップロードサイズ制限（MB） + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "opening_statement": "こんにちは！", + "suggested_questions_after_answer": { + "enabled": true + }, + "speech_to_text": { + "enabled": true + }, + "retriever_resource": { + "enabled": true + }, + "annotation_reply": { + "enabled": true + }, + "user_input_form": [ + { + "paragraph": { + "label": "クエリ", + "variable": "query", + "required": true, + "default": "" + } + } + ], + "file_upload": { + "image": { + "enabled": false, + "number_limits": 3, + "detail": "high", + "transfer_methods": [ + "remote_url", + "local_file" + ] + } + }, + "system_parameters": { + "file_size_limit": 15, + "image_file_size_limit": 10, + "audio_file_size_limit": 50, + "video_file_size_limit": 100 + } + } + ``` + + + +--- + + + + + このアプリケーションのツールのアイコンを取得するために使用されます + ### クエリ + + + + ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。 + + + ### 応答 + - `tool_icons`(object[string]) ツールアイコン + - `tool_name` (string) + - `icon` (object|string) + - (object) アイコンオブジェクト + - `background` (string) 背景色（16進数形式） + - `content`(string) 絵文字 + - (string) アイコンのURL + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ + -H 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "tool_icons": { + "dalle2": "https://cloud.dify.ai/console/api/workspaces/current/tool-provider/builtin/dalle/icon", + "api_tool": { + "background": "#252525", + "content": "\ud83d\ude01" + } + } + } + ``` + + + diff --git a/web/app/components/develop/template/template_chat.ja.mdx b/web/app/components/develop/template/template_chat.ja.mdx new file mode 100644 index 0000000000..a962177f0e --- /dev/null +++ b/web/app/components/develop/template/template_chat.ja.mdx @@ -0,0 +1,1134 @@ +import { CodeGroup } from '../code.tsx' +import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '../md.tsx' + +# チャットアプリAPI + +チャットアプリケーションはセッションの持続性をサポートしており、以前のチャット履歴を応答のコンテキストとして使用できます。これは、チャットボットやカスタマーサービスAIなどに適用できます。 + +
+ ### ベースURL + + ```javascript + ``` + + + ### 認証 + + サービスAPIは`API-Key`認証を使用します。 + **APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。** + + すべてのAPIリクエストにおいて、以下のように`Authorization`HTTPヘッダーにAPIキーを含めてください： + + + ```javascript + Authorization: Bearer {API_KEY} + + ``` + +
+ +--- + + + + + チャットアプリケーションにリクエストを送信します。 + + ### リクエストボディ + + + + ユーザー入力/質問内容 + + + アプリで定義されたさまざまな変数値の入力を許可します。 + `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の特定の値です。デフォルトは`{}` + + + 応答の返却モードを指定します。サポートされているモード： + - `streaming` ストリーミングモード（推奨）、SSE（[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）を通じてタイプライターのような出力を実装します。 + - `blocking` ブロッキングモード、実行完了後に結果を返します。（プロセスが長い場合、リクエストが中断される可能性があります） + Cloudflareの制限により、100秒後に応答がない場合、リクエストは中断されます。 + 注：エージェントアシスタントモードではブロッキングモードはサポートされていません + + + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用されます。 + アプリケーション内で開発者によって一意に定義される必要があります。 + + + 会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。 + + + ファイルリスト、テキストの理解と質問への回答を組み合わせたファイル（画像）の入力に適しており、モデルがビジョン機能をサポートしている場合にのみ利用可能です。 + - `type` (string) サポートされているタイプ：`image`（現在は画像タイプのみサポート） + - `transfer_method` (string) 転送方法、画像URLの場合は`remote_url` / ファイルアップロードの場合は`local_file` + - `url` (string) 画像URL（転送方法が`remote_url`の場合） + - `upload_file_id` (string) アップロードされたファイルID、事前にファイルアップロードAPIを通じて取得する必要があります（転送方法が`local_file`の場合） + + + タイトルを自動生成します。デフォルトは`true`です。 + `false`に設定すると、会話のリネームAPIを呼び出し、`auto_generate`を`true`に設定することで非同期タイトル生成を実現できます。 + + + + ### 応答 + response_modeがブロッキングの場合、CompletionResponseオブジェクトを返します。 + response_modeがストリーミングの場合、ChunkCompletionResponseストリームを返します。 + + ### ChatCompletionResponse + 完全なアプリ結果を返します。`Content-Type`は`application/json`です。 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `mode` (string) アプリモード、`chat`として固定 + - `answer` (string) 完全な応答内容 + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `created_at` (int) メッセージ作成タイムスタンプ、例：1705395332 + + ### ChunkChatCompletionResponse + アプリによって出力されたストリームチャンクを返します。`Content-Type`は`text/event-stream`です。 + 各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます。以下のように表示されます： + + ```streaming {{ title: '応答' }} + data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n + ``` + + ストリーミングチャンクの構造は`event`に応じて異なります： + - `event: message` LLMはテキストチャンクイベントを返します。つまり、完全なテキストがチャンク形式で出力されます。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `answer` (string) LLMが返したテキストチャンク内容 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: agent_message` LLMはテキストチャンクイベントを返します。つまり、エージェントアシスタントが有効な場合、完全なテキストがチャンク形式で出力されます（エージェントモードでのみサポート） + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `answer` (string) LLMが返したテキストチャンク内容 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: tts_message` TTSオーディオストリームイベント、つまり音声合成出力。内容はMp3形式のオーディオブロックで、base64文字列としてエンコードされています。再生時には、base64をデコードしてプレーヤーに入力するだけです。（このメッセージは自動再生が有効な場合にのみ利用可能） + - `task_id` (string) タスクID、リクエスト追跡と以下の停止応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 音声合成後のオーディオ、base64テキストコンテンツとしてエンコードされており、再生時にはbase64をデコードしてプレーヤーに入力するだけです + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: tts_message_end` TTSオーディオストリーム終了イベント。このイベントを受信すると、オーディオストリームの終了を示します。 + - `task_id` (string) タスクID、リクエスト追跡と以下の停止応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 終了イベントにはオーディオがないため、これは空の文字列です + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: agent_thought` エージェントの思考、LLMの思考、ツール呼び出しの入力と出力を含みます（エージェントモードでのみサポート） + - `id` (string) エージェント思考ID、各反復には一意のエージェント思考IDがあります + - `task_id` (string) (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `position` (int) 現在のエージェント思考の位置、各メッセージには順番に複数の思考が含まれる場合があります。 + - `thought` (string) LLMが考えていること + - `observation` (string) ツール呼び出しからの応答 + - `tool` (string) 呼び出されたツールのリスト、;で区切られます + - `tool_input` (string) ツールの入力、JSON形式。例：`{"dalle3": {"prompt": "a cute cat"}}`。 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `message_files` (array[string]) message_fileイベントを参照 + - `file_id` (string) ファイルID + - `conversation_id` (string) 会話ID + - `event: message_file` メッセージファイルイベント、ツールによって新しいファイルが作成されました + - `id` (string) ファイル一意ID + - `type` (string) ファイルタイプ、現在は"image"のみ許可 + - `belongs_to` (string) 所属、ここでは'assistant'のみ + - `url` (string) ファイルのリモートURL + - `conversation_id` (string) 会話ID + - `event: message_end` メッセージ終了イベント、このイベントを受信するとストリーミングが終了したことを意味します。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `metadata` (object) メタデータ + - `usage` (Usage) モデル使用情報 + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `event: message_replace` メッセージ内容置換イベント。 + 出力内容のモデレーションが有効な場合、内容がフラグされると、このイベントを通じてメッセージ内容が事前設定された返信に置き換えられます。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `conversation_id` (string) 会話ID + - `answer` (string) 置換内容（すべてのLLM返信テキストを直接置換） + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: error` + ストリーミングプロセス中に発生した例外はストリームイベントの形式で出力され、エラーイベントを受信するとストリームが終了します。 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `message_id` (string) 一意のメッセージID + - `status` (int) HTTPステータスコード + - `code` (string) エラーコード + - `message` (string) エラーメッセージ + - `event: ping` 接続を維持するために10秒ごとにpingイベントが発生します。 + + ### エラー + - 404, 会話が存在しません + - 400, `invalid_param`, 異常なパラメータ入力 + - 400, `app_unavailable`, アプリ構成が利用できません + - 400, `provider_not_initialize`, 利用可能なモデル資格情報構成がありません + - 400, `provider_quota_exceeded`, モデル呼び出しクォータが不足しています + - 400, `model_currently_not_support`, 現在のモデルは利用できません + - 400, `completion_request_error`, テキスト生成に失敗しました + - 500, 内部サーバーエラー + + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/chat-messages' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "inputs": {}, + "query": "eh", + "response_mode": "streaming", + "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276", + "user": "abc-123" + }' + ``` + + ### ブロッキングモード + + ```json {{ title: '応答' }} + { + "event": "message", + "message_id": "9da23599-e713-473b-982c-4328d4f5c78a", + "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", + "mode": "chat", + "answer": "iPhone 13 Pro Maxの仕様は次のとおりです:...", + "metadata": { + "usage": { + "prompt_tokens": 1033, + "prompt_unit_price": "0.001", + "prompt_price_unit": "0.001", + "prompt_price": "0.0010330", + "completion_tokens": 128, + "completion_unit_price": "0.002", + "completion_price_unit": "0.001", + "completion_price": "0.0002560", + "total_tokens": 1161, + "total_price": "0.0012890", + "currency": "USD", + "latency": 0.7682376249867957 + }, + "retriever_resources": [ + { + "position": 1, + "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", + "dataset_name": "iPhone", + "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", + "document_name": "iPhone List", + "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", + "score": 0.98457545, + "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"" + } + ] + }, + "created_at": 1705407629 + } + ``` + + ### ストリーミングモード（基本アシスタント） + + ```streaming {{ title: '応答' }} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595} + data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""}]}} + data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"} + data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""} + ``` + + ### 応答例（エージェントアシスタント） + + ```streaming {{ title: '応答' }} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595} + data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595} + data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595} + data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""}]}} + data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"} + data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""} + ``` + + + + +--- + + + + メッセージ送信時に使用するためのファイルをアップロードします（現在は画像のみサポート）。画像とテキストのマルチモーダル理解を可能にします。 + png、jpg、jpeg、webp、gif形式をサポートしています。 + アップロードされたファイルは現在のエンドユーザーのみが使用できます。 + + ### リクエストボディ + このインターフェースは`multipart/form-data`リクエストを必要とします。 + - `file` (File) 必須 + アップロードするファイル。 + - `user` (string) 必須 + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + ### 応答 + アップロードが成功すると、サーバーはファイルのIDと関連情報を返します。 + - `id` (uuid) ID + - `name` (string) ファイル名 + - `size` (int) ファイルサイズ（バイト） + - `extension` (string) ファイル拡張子 + - `mime_type` (string) ファイルのMIMEタイプ + - `created_by` (uuid) エンドユーザーID + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + ### エラー + - 400, `no_file_uploaded`, ファイルが提供されなければなりません + - 400, `too_many_files`, 現在は1つのファイルのみ受け付けます + - 400, `unsupported_preview`, ファイルはプレビューをサポートしていません + - 400, `unsupported_estimate`, ファイルは推定をサポートしていません + - 413, `file_too_large`, ファイルが大きすぎます + - 415, `unsupported_file_type`, サポートされていない拡張子、現在はドキュメントファイルのみ受け付けます + - 503, `s3_connection_failed`, S3サービスに接続できません + - 503, `s3_permission_denied`, S3にファイルをアップロードする権限がありません + - 503, `s3_file_too_large`, ファイルがS3のサイズ制限を超えています + - 500, 内部サーバーエラー + + + + + ### リクエスト例 + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/files/upload' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@"/path/to/file"' + ``` + + + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67", + "name": "example.png", + "size": 1024, + "extension": "png", + "mime_type": "image/png", + "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13", + "created_at": 1577836800, + } + ``` + + + +--- + + + + + ストリーミングモードでのみサポートされています。 + ### パス + - `task_id` (string) タスクID、ストリーミングチャンクの返り値から取得できます + ### リクエストボディ + - `user` (string) 必須 + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。 + ### 応答 + - `result` (string) 常に"success"を返します + + + ### リクエスト例 + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \ + -H 'Authorization: Bearer {api_key}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "user": "abc-123" + }' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。 + + ### パス + + + メッセージID + + + + ### リクエストボディ + + + + アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null` + + + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `result` (string) 常に"success"を返します + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "rating": "like", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + 現在のメッセージに対する次の質問の提案を取得します + + ### パスパラメータ + + + + メッセージID + + + + ### クエリ + + + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義される必要があります。 + + + + + + + + ```bash {{ title: 'cURL' }} + curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested' \ + --header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \ + --header 'Content-Type: application/json' \ + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success", + "data": [ + "a", + "b", + "c" + ] + } + ``` + + + + +--- + + + + + スクロールロード形式で過去のチャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。 + + ### クエリ + + + + 会話ID + + + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義される必要があります。 + + + 現在のページの最初のチャット記録のID、デフォルトはnullです。 + + + 1回のリクエストで返すチャット履歴メッセージの数、デフォルトは20です。 + + + + ### 応答 + - `data` (array[object]) メッセージリスト + - `id` (string) メッセージID + - `conversation_id` (string) 会話ID + - `inputs` (array[object]) ユーザー入力パラメータ。 + - `query` (string) ユーザー入力/質問内容。 + - `message_files` (array[object]) メッセージファイル + - `id` (string) ID + - `type` (string) ファイルタイプ、画像の場合はimage + - `url` (string) プレビュー画像URL + - `belongs_to` (string) 所属、ユーザーまたはアシスタント + - `agent_thoughts` (array[object]) エージェントの思考（基本アシスタントの場合は空） + - `id` (string) エージェント思考ID、各反復には一意のエージェント思考IDがあります + - `message_id` (string) 一意のメッセージID + - `position` (int) 現在のエージェント思考の位置、各メッセージには順番に複数の思考が含まれる場合があります。 + - `thought` (string) LLMが考えていること + - `observation` (string) ツール呼び出しからの応答 + - `tool` (string) 呼び出されたツールのリスト、;で区切られます + - `tool_input` (string) ツールの入力、JSON形式。例：`{"dalle3": {"prompt": "a cute cat"}}`。 + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `message_files` (array[string]) message_fileイベントを参照 + - `file_id` (string) ファイルID + - `answer` (string) 応答メッセージ内容 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `feedback` (object) フィードバック情報 + - `rating` (string) アップボートは`like` / ダウンボートは`dislike` + - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト + - `has_more` (bool) 次のページがあるかどうか + - `limit` (int) 返されたアイテムの数、入力がシステム制限を超える場合、システム制限の数を返します + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id=' + --header 'Authorization: Bearer {api_key}' + ``` + + + ### 応答例（基本アシスタント） + + ```json {{ title: '応答' }} + { + "limit": 20, + "has_more": false, + "data": [ + { + "id": "a076a87f-31e5-48dc-b452-0061adbbc922", + "conversation_id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce", + "inputs": { + "name": "dify" + }, + "query": "iphone 13 pro", + "answer": "iPhone 13 Proは2021年9月24日に発売され、6.1インチのディスプレイと1170 x 2532の解像度を備えています。Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)プロセッサ、6 GBのRAMを搭載し、128 GB、256 GB、512 GB、1 TBのストレージオプションを提供します。カメラは12 MP、バッテリー容量は3095 mAhで、iOS 15を搭載しています。", + "message_files": [], + "feedback": null, + "retriever_resources": [ + { + "position": 1, + "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", + "dataset_name": "iPhone", + "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", + "document_name": "iPhone List", + "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", + "score": 0.98457545, + "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"" + } + ], + "agent_thoughts": [], + "created_at": 1705569239, + } + ] + } + ``` + + + ### 応答例（エージェントアシスタント） + + ```json {{ title: '応答' }} + { + "limit": 20, + "has_more": false, + "data": [ + { + "id": "d35e006c-7c4d-458f-9142-be4930abdf94", + "conversation_id": "957c068b-f258-4f89-ba10-6e8a0361c457", + "inputs": {}, + "query": "draw a cat", + "answer": "猫の画像を生成しました。メッセージを確認して画像を表示してください。", + "message_files": [ + { + "id": "976990d2-5294-47e6-8f14-7356ba9d2d76", + "type": "image", + "url": "http://127.0.0.1:5001/files/tools/976990d2-5294-47e6-8f14-7356ba9d2d76.png?timestamp=1705988524&nonce=55df3f9f7311a9acd91bf074cd524092&sign=z43nMSO1L2HBvoqADLkRxr7Biz0fkjeDstnJiCK1zh8=", + "belongs_to": "assistant" + } + ], + "feedback": null, + "retriever_resources": [], + "created_at": 1705988187, + "agent_thoughts": [ + { + "id": "592c84cf-07ee-441c-9dcc-ffc66c033469", + "chain_id": null, + "message_id": "d35e006c-7c4d-458f-9142-be4930abdf94", + "position": 1, + "thought": "", + "tool": "dalle2", + "tool_input": "{\"dalle2\": {\"prompt\": \"cat\"}}", + "created_at": 1705988186, + "observation": "画像はすでに作成され、ユーザーに送信されました。今すぐユーザーに確認するように伝えてください。", + "message_files": [ + "976990d2-5294-47e6-8f14-7356ba9d2d76" + ] + }, + { + "id": "73ead60d-2370-4780-b5ed-532d2762b0e5", + "chain_id": null, + "message_id": "d35e006c-7c4d-458f-9142-be4930abdf94", + "position": 2, + "thought": "猫の画像を生成しました。メッセージを確認して画像を表示してください。", + "tool": "", + "tool_input": "", + "created_at": 1705988199, + "observation": "", + "message_files": [] + } + ] + } + ] + } + ``` + + + + +--- + + + + + 現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。 + + ### クエリ + + + + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、統計のために使用されます。 + アプリケーション内で開発者によって一意に定義される必要があります。 + + + 現在のページの最後のレコードのID、デフォルトはnullです。 + + + 1回のリクエストで返すレコードの数、デフォルトは最新の20件です。 + + + ピン留めされた会話のみを`true`として返し、ピン留めされていないもののみを`false`として返します + + + ソートフィールド（オプション）、デフォルト：-updated_at（更新時間で降順にソート） + - 利用可能な値：created_at, -created_at, updated_at, -updated_at + - フィールドの前の記号は順序または逆順を表し、"-"は逆順を表します。 + + + + ### 応答 + - `data` (array[object]) 会話のリスト + - `id` (string) 会話ID + - `name` (string) 会話名、デフォルトでは、ユーザーが会話で最初に尋ねた質問のスニペットです。 + - `inputs` (array[object]) ユーザー入力パラメータ。 + - `introduction` (string) 紹介 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `has_more` (bool) + - `limit` (int) 返されたエントリの数、入力がシステム制限を超える場合、システム制限の数を返します + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "limit": 20, + "has_more": false, + "data": [ + { + "id": "10799fb8-64f7-4296-bbf7-b42bfbe0ae54", + "name": "新しいチャット", + "inputs": { + "book": "book", + "myName": "Lucy" + }, + "status": "normal", + "created_at": 1679667915 + }, + { + "id": "hSIhXBhNe8X1d8Et" + // ... + } + ] + } + ``` + + + + +--- + + + + + 会話を削除します。 + + ### パス + - `conversation_id` (string) 会話ID + + ### リクエストボディ + + + + ユーザー識別子、開発者によって定義され、アプリケーション内で一意である必要があります。 + + + + ### 応答 + - `result` (string) 常に"success"を返します + + + + + + ```bash {{ title: 'cURL' }} + curl -X DELETE '${props.appDetail.api_base_url}/conversations/{conversation_id}' \ + --header 'Content-Type: application/json' \ + --header 'Accept: application/json' \ + --header 'Authorization: Bearer {api_key}' \ + --data '{ + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + ### リクエストボディ + セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。 + + ### パス + - `conversation_id` (string) 会話ID + + + + 会話の名前。このパラメータは、`auto_generate`が`true`に設定されている場合、省略できます。 + + + タイトルを自動生成します。デフォルトは`false`です。 + + + ユーザー識別子、開発者によって定義され、アプリケーション内で一意である必要があります。 + + + + ### 応答 + - `id` (string) 会話ID + - `name` (string) 会話名 + - `inputs` array[object] ユーザー入力パラメータ。 + - `introduction` (string) 紹介 + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/conversations/{conversation_id}/name' \ + --header 'Content-Type: application/json' \ + --header 'Authorization: Bearer {api_key}' \ + --data-raw '{ + "name": "", + "user": "abc-123" + }' + ``` + + + + + ```json {{ title: '応答' }} + { + "id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce", + "name": "Chat vs AI", + "inputs": {}, + "introduction": "", + "created_at": 1705569238 + } + ``` + + + + +--- + + + + + このエンドポイントはmultipart/form-dataリクエストを必要とします。 + + ### リクエストボディ + + + + オーディオファイル。 + サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']` + ファイルサイズ制限：15MB + + + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `text` (string) 出力テキスト + + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/conversations/name' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@localfile;type=audio/mp3' + ``` + + + + + ```json {{ text: 'hello' }} + { + "text": "" + } + ``` + + + + +--- + + + + + テキストを音声に変換します。 + + ### リクエストボディ + + + + Difyによって生成されたテキストメッセージの場合、生成されたメッセージIDを直接渡します。バックエンドはメッセージIDを使用して対応するコンテンツを検索し、音声情報を直接合成します。message_idとtextが同時に提供される場合、message_idが優先されます。 + + + 音声生成コンテンツ。 + + + ユーザー識別子、開発者によって定義され、アプリ内で一意である必要があります。 + + + + + + + + ```bash {{ title: 'cURL' }} + curl --location --request POST '${props.appDetail.api_base_url}/text-to-audio' \ + --header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \ + --form 'file=Hello Dify;user=abc-123;message_id=5ad4cb98-f0c7-4085-b384-88c403be6290' + ``` + + + + + ```json {{ title: 'ヘッダー' }} + { + "Content-Type": "audio/wav" + } + ``` + + + + +--- + + + + + ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 + + ### クエリ + + + + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `opening_statement` (string) 開始文 + - `suggested_questions` (array[string]) 開始時の推奨質問のリスト + - `suggested_questions_after_answer` (object) 答えを有効にした後の質問を提案します。 + - `enabled` (bool) 有効かどうか + - `speech_to_text` (object) 音声からテキストへ + - `enabled` (bool) 有効かどうか + - `retriever_resource` (object) 引用と帰属 + - `enabled` (bool) 有効かどうか + - `annotation_reply` (object) 注釈返信 + - `enabled` (bool) 有効かどうか + - `user_input_form` (array[object]) ユーザー入力フォームの構成 + - `text-input` (object) テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `paragraph` (object) 段落テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `select` (object) ドロップダウンコントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `options` (array[string]) オプション値 + - `file_upload` (object) ファイルアップロード構成 + - `image` (object) 画像設定 + 現在サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif` + - `enabled` (bool) 有効かどうか + - `number_limits` (int) 画像数の制限、デフォルトは3 + - `transfer_methods` (array[string]) 転送方法のリスト、remote_url, local_file、いずれかを選択する必要があります + - `system_parameters` (object) システムパラメータ + - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB） + - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB） + - `audio_file_size_limit` (int) オーディオファイルアップロードサイズ制限（MB） + - `video_file_size_limit` (int) ビデオファイルアップロードサイズ制限（MB） + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "opening_statement": "こんにちは！", + "suggested_questions_after_answer": { + "enabled": true + }, + "speech_to_text": { + "enabled": true + }, + "retriever_resource": { + "enabled": true + }, + "annotation_reply": { + "enabled": true + }, + "user_input_form": [ + { + "paragraph": { + "label": "クエリ", + "variable": "query", + "required": true, + "default": "" + } + } + ], + "file_upload": { + "image": { + "enabled": false, + "number_limits": 3, + "detail": "high", + "transfer_methods": [ + "remote_url", + "local_file" + ] + } + }, + "system_parameters": { + "file_size_limit": 15, + "image_file_size_limit": 10, + "audio_file_size_limit": 50, + "video_file_size_limit": 100 + } + } + ``` + + + +--- + + + + + このアプリケーションのツールのアイコンを取得するために使用されます + ### クエリ + + + + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + + ### 応答 + - `tool_icons`(object[string]) ツールアイコン + - `tool_name` (string) + - `icon` (object|string) + - (object) アイコンオブジェクト + - `background` (string) 背景色（16進数形式） + - `content`(string) 絵文字 + - (string) アイコンのURL + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ + -H 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "tool_icons": { + "dalle2": "https://cloud.dify.ai/console/api/workspaces/current/tool-provider/builtin/dalle/icon", + "api_tool": { + "background": "#252525", + "content": "\ud83d\ude01" + } + } + } + ``` + + + diff --git a/web/app/components/develop/template/template_workflow.ja.mdx b/web/app/components/develop/template/template_workflow.ja.mdx new file mode 100644 index 0000000000..ad669430f2 --- /dev/null +++ b/web/app/components/develop/template/template_workflow.ja.mdx @@ -0,0 +1,607 @@ +import { CodeGroup } from '../code.tsx' +import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '../md.tsx' + +# ワークフローアプリAPI + +ワークフローアプリケーションは、セッションをサポートせず、翻訳、記事作成、要約AIなどに最適です。 + +
+ ### ベースURL + + ```javascript + ``` + + + ### 認証 + + サービスAPIは`API-Key`認証を使用します。 + **APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。** + + すべてのAPIリクエストにおいて、以下のように`Authorization`HTTPヘッダーにAPIキーを含めてください： + + + ```javascript + Authorization: Bearer {API_KEY} + + ``` + +
+ +--- + + + + + ワークフローを実行します。公開されたワークフローがないと実行できません。 + + ### リクエストボディ + - `inputs` (object) 必須 + アプリで定義されたさまざまな変数値の入力を許可します。 + `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の特定の値です。 + ワークフローアプリケーションは少なくとも1つのキー/値ペアの入力を必要とします。 + 変数がファイルタイプの場合、以下の`files`で説明されているキーを持つオブジェクトを指定してください。 + - `response_mode` (string) 必須 + 応答の返却モードを指定します。サポートされているモード： + - `streaming` ストリーミングモード（推奨）、SSE（[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）を通じてタイプライターのような出力を実装します。 + - `blocking` ブロッキングモード、実行完了後に結果を返します。（プロセスが長い場合、リクエストが中断される可能性があります） + Cloudflareの制限により、100秒後に応答がない場合、リクエストは中断されます。 + - `user` (string) 必須 + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用されます。 + アプリケーション内で開発者によって一意に定義される必要があります。 + - `files` (array[object]) オプション + ファイルリスト、テキストの理解と質問への回答を組み合わせたファイルの入力に適しており、モデルがビジョン機能をサポートしている場合にのみ利用可能です。 + - `type` (string) サポートされているタイプ: + - `document` ('TXT', 'MD', 'MARKDOWN', 'PDF', 'HTML', 'XLSX', 'XLS', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB') + - `image` ('JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG') + - `audio` ('MP3', 'M4A', 'WAV', 'WEBM', 'AMR') + - `video` ('MP4', 'MOV', 'MPEG', 'MPGA') + - `transfer_method` (string) 転送方法、画像URLの場合は`remote_url` / ファイルアップロードの場合は`local_file` + - `url` (string) 画像URL（転送方法が`remote_url`の場合） + - `upload_file_id` (string) アップロードされたファイルID、事前にファイルアップロードAPIを通じて取得する必要があります（転送方法が`local_file`の場合） + + ### 応答 + `response_mode`が`blocking`の場合、CompletionResponseオブジェクトを返します。 + `response_mode`が`streaming`の場合、ChunkCompletionResponseストリームを返します。 + + ### CompletionResponse + アプリの結果を返します。`Content-Type`は`application/json`です。 + - `workflow_run_id` (string) ワークフロー実行の一意のID + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `data` (object) 結果の詳細 + - `id` (string) ワークフロー実行のID + - `workflow_id` (string) 関連するワークフローのID + - `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped` + - `outputs` (json) オプションの出力内容 + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) オプションの使用時間（秒） + - `total_tokens` (int) オプションの使用トークン数 + - `total_steps` (int) デフォルト0 + - `created_at` (timestamp) 開始時間 + - `finished_at` (timestamp) 終了時間 + + ### ChunkCompletionResponse + アプリによって出力されたストリームチャンクを返します。`Content-Type`は`text/event-stream`です。 + 各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます。以下のように表示されます： + + ```streaming {{ title: '応答' }} + data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n + ``` + + ストリーミングチャンクの構造は`event`に応じて異なります： + - `event: workflow_started` ワークフローが実行を開始 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意のID + - `event` (string) `workflow_started`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意のID + - `workflow_id` (string) 関連するワークフローのID + - `sequence_number` (int) 自己増加シリアル番号、アプリ内で自己増加し、1から始まります + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + - `event: node_started` ノード実行開始 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意のID + - `event` (string) `node_started`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意のID + - `node_id` (string) ノードのID + - `node_type` (string) ノードのタイプ + - `title` (string) ノードの名前 + - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用 + - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用 + - `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容 + - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332 + - `event: node_finished` ノード実行終了、同じイベントで異なる状態で成功または失敗 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意のID + - `event` (string) `node_finished`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行の一意のID + - `node_id` (string) ノードのID + - `node_type` (string) ノードのタイプ + - `title` (string) ノードの名前 + - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用 + - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用 + - `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容 + - `process_data` (json) オプションのノードプロセスデータ + - `outputs` (json) オプションの出力内容 + - `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped` + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) オプションの使用時間（秒） + - `execution_metadata` (json) メタデータ + - `total_tokens` (int) オプションの使用トークン数 + - `total_price` (decimal) オプションの総コスト + - `currency` (string) オプション 例：`USD` / `RMB` + - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332 + - `event: workflow_finished` ワークフロー実行終了、同じイベントで異なる状態で成功または失敗 + - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 + - `workflow_run_id` (string) ワークフロー実行の一意のID + - `event` (string) `workflow_finished`に固定 + - `data` (object) 詳細 + - `id` (string) ワークフロー実行のID + - `workflow_id` (string) 関連するワークフローのID + - `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped` + - `outputs` (json) オプションの出力内容 + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) オプションの使用時間（秒） + - `total_tokens` (int) オプションの使用トークン数 + - `total_steps` (int) デフォルト0 + - `created_at` (timestamp) 開始時間 + - `finished_at` (timestamp) 終了時間 + - `event: tts_message` TTSオーディオストリームイベント、つまり音声合成出力。内容はMp3形式のオーディオブロックで、base64文字列としてエンコードされています。再生時には、base64をデコードしてプレーヤーに入力するだけです。（このメッセージは自動再生が有効な場合にのみ利用可能） + - `task_id` (string) タスクID、リクエスト追跡と以下の停止応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 音声合成後のオーディオ、base64テキストコンテンツとしてエンコードされており、再生時にはbase64をデコードしてプレーヤーに入力するだけです + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: tts_message_end` TTSオーディオストリーム終了イベント。このイベントを受信すると、オーディオストリームの終了を示します。 + - `task_id` (string) タスクID、リクエスト追跡と以下の停止応答インターフェースに使用 + - `message_id` (string) 一意のメッセージID + - `audio` (string) 終了イベントにはオーディオがないため、これは空の文字列です + - `created_at` (int) 作成タイムスタンプ、例：1705395332 + - `event: ping` 接続を維持するために10秒ごとに送信されるPingイベント。 + + ### エラー + - 400, `invalid_param`, 異常なパラメータ入力 + - 400, `app_unavailable`, アプリの設定が利用できません + - 400, `provider_not_initialize`, 利用可能なモデル資格情報の設定がありません + - 400, `provider_quota_exceeded`, モデル呼び出しのクォータが不足しています + - 400, `model_currently_not_support`, 現在のモデルは利用できません + - 400, `workflow_request_error`, ワークフロー実行に失敗しました + - 500, 内部サーバーエラー + + + + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/workflows/run' \ + --header 'Authorization: Bearer {api_key}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "inputs": {}, + "response_mode": "streaming", + "user": "abc-123" + }' + ``` + + + ### ブロッキングモード + + ```json {{ title: '応答' }} + { + "workflow_run_id": "djflajgkldjgd", + "task_id": "9da23599-e713-473b-982c-4328d4f5c78a", + "data": { + "id": "fdlsjfjejkghjda", + "workflow_id": "fldjaslkfjlsda", + "status": "succeeded", + "outputs": { + "text": "Nice to meet you." + }, + "error": null, + "elapsed_time": 0.875, + "total_tokens": 3562, + "total_steps": 8, + "created_at": 1705407629, + "finished_at": 1727807631 + } + } + ``` + + ### ストリーミングモード + + ```streaming {{ title: '応答' }} + data: {"event": "workflow_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "sequence_number": 1, "created_at": 1679586595}} + data: {"event": "node_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "created_at": 1679586595}} + data: {"event": "node_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "execution_metadata": {"total_tokens": 63127864, "total_price": 2.378, "currency": "USD"}, "created_at": 1679586595}} + data: {"event": "workflow_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "total_tokens": 63127864, "total_steps": "1", "created_at": 1679586595, "finished_at": 1679976595}} + data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"} + data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""} + ``` + + + + + +--- + + + + + ワークフロー実行IDに基づいて、ワークフロータスクの現在の実行結果を取得します。 + ### パス + - `workflow_id` (string) ワークフローID、ストリーミングチャンクの返り値から取得可能 + ### 応答 + - `id` (string) ワークフロー実行のID + - `workflow_id` (string) 関連するワークフローのID + - `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped` + - `inputs` (json) 入力内容 + - `outputs` (json) 出力内容 + - `error` (string) エラー理由 + - `total_steps` (int) タスクの総ステップ数 + - `total_tokens` (int) 使用されるトークンの総数 + - `created_at` (timestamp) 開始時間 + - `finished_at` (timestamp) 終了時間 + - `elapsed_time` (float) 使用される総秒数 + + + ### リクエスト例 + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \ + -H 'Authorization: Bearer {api_key}' \ + -H 'Content-Type: application/json' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "id": "b1ad3277-089e-42c6-9dff-6820d94fbc76", + "workflow_id": "19eff89f-ec03-4f75-b0fc-897e7effea02", + "status": "succeeded", + "inputs": "{\"sys.files\": [], \"sys.user_id\": \"abc-123\"}", + "outputs": null, + "error": null, + "total_steps": 3, + "total_tokens": 0, + "created_at": "Thu, 18 Jul 2024 03:17:40 -0000", + "finished_at": "Thu, 18 Jul 2024 03:18:10 -0000", + "elapsed_time": 30.098514399956912 + } + ``` + + + + +--- + + + + + ストリーミングモードでのみサポートされています。 + ### パス + - `task_id` (string) タスクID、ストリーミングチャンクの返り値から取得可能 + ### リクエストボディ + - `user` (string) 必須 + ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。 + ### 応答 + - `result` (string) 常に"success"を返します + + + ### リクエスト例 + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/workflows/tasks/:task_id/stop' \ + -H 'Authorization: Bearer {api_key}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "user": "abc-123" + }' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "result": "success" + } + ``` + + + + +--- + + + + + メッセージ送信時に使用するためのファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。 + ワークフローでサポートされている任意の形式をサポートします。 + アップロードされたファイルは、現在のエンドユーザーのみが使用できます。 + + ### リクエストボディ + このインターフェースは`multipart/form-data`リクエストを必要とします。 + - `file` (File) 必須 + アップロードするファイル。 + - `user` (string) 必須 + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + ### 応答 + アップロードが成功すると、サーバーはファイルのIDと関連情報を返します。 + - `id` (uuid) ID + - `name` (string) ファイル名 + - `size` (int) ファイルサイズ（バイト） + - `extension` (string) ファイル拡張子 + - `mime_type` (string) ファイルのMIMEタイプ + - `created_by` (uuid) エンドユーザーID + - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332 + + ### エラー + - 400, `no_file_uploaded`, ファイルが提供されていません + - 400, `too_many_files`, 現在は1つのファイルのみ受け付けています + - 400, `unsupported_preview`, ファイルはプレビューをサポートしていません + - 400, `unsupported_estimate`, ファイルは推定をサポートしていません + - 413, `file_too_large`, ファイルが大きすぎます + - 415, `unsupported_file_type`, サポートされていない拡張子、現在はドキュメントファイルのみ受け付けています + - 503, `s3_connection_failed`, S3サービスに接続できません + - 503, `s3_permission_denied`, S3にファイルをアップロードする権限がありません + - 503, `s3_file_too_large`, ファイルがS3のサイズ制限を超えています + - 500, 内部サーバーエラー + + + + + ### リクエスト例 + + + ```bash {{ title: 'cURL' }} + curl -X POST '${props.appDetail.api_base_url}/files/upload' \ + --header 'Authorization: Bearer {api_key}' \ + --form 'file=@"/path/to/file"' + ``` + + + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67", + "name": "example.png", + "size": 1024, + "extension": "png", + "mime_type": "image/png", + "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13", + "created_at": 1577836800, + } + ``` + + + + +--- + + + + + ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 + + ### クエリ + + + + ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。 + + + + ### 応答 + - `user_input_form` (array[object]) ユーザー入力フォームの設定 + - `text-input` (object) テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `paragraph` (object) 段落テキスト入力コントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `select` (object) ドロップダウンコントロール + - `label` (string) 変数表示ラベル名 + - `variable` (string) 変数ID + - `required` (bool) 必須かどうか + - `default` (string) デフォルト値 + - `options` (array[string]) オプション値 + - `file_upload` (object) ファイルアップロード設定 + - `image` (object) 画像設定 + 現在サポートされている画像タイプのみ：`png`, `jpg`, `jpeg`, `webp`, `gif` + - `enabled` (bool) 有効かどうか + - `number_limits` (int) 画像数の制限、デフォルトは3 + - `transfer_methods` (array[string]) 転送方法のリスト、remote_url, local_file、いずれかを選択する必要があります + - `system_parameters` (object) システムパラメータ + - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB） + - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB） + - `audio_file_size_limit` (int) オーディオファイルアップロードサイズ制限（MB） + - `video_file_size_limit` (int) ビデオファイルアップロードサイズ制限（MB） + + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ + --header 'Authorization: Bearer {api_key}' + ``` + + + + + ```json {{ title: '応答' }} + { + "user_input_form": [ + { + "paragraph": { + "label": "Query", + "variable": "query", + "required": true, + "default": "" + } + } + ], + "file_upload": { + "image": { + "enabled": false, + "number_limits": 3, + "detail": "high", + "transfer_methods": [ + "remote_url", + "local_file" + ] + } + }, + "system_parameters": { + "file_size_limit": 15, + "image_file_size_limit": 10, + "audio_file_size_limit": 50, + "video_file_size_limit": 100 + } + } + ``` + + + + +--- + + + + + ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。 + + ### クエリ + + + + 検索するキーワード + + + succeeded/failed/stopped + + + 現在のページ、デフォルトは1。 + + + 1回のリクエストで返すチャット履歴メッセージの数、デフォルトは20。 + + + + ### 応答 + - `page` (int) 現在のページ + - `limit` (int) 返されたアイテムの数、入力がシステム制限を超える場合、システム制限量を返します + - `total` (int) 合計アイテム数 + - `has_more` (bool) 次のページがあるかどうか + - `data` (array[object]) ログリスト + - `id` (string) ID + - `workflow_run` (object) ワークフロー実行 + - `id` (string) ID + - `version` (string) バージョン + - `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped` + - `error` (string) オプションのエラー理由 + - `elapsed_time` (float) 使用される総秒数 + - `total_tokens` (int) 使用されるトークン数 + - `total_steps` (int) デフォルト0 + - `created_at` (timestamp) 開始時間 + - `finished_at` (timestamp) 終了時間 + - `created_from` (string) 作成元 + - `created_by_role` (string) 作成者の役割 + - `created_by_account` (string) オプションの作成者アカウント + - `created_by_end_user` (object) エンドユーザーによって作成 + - `id` (string) ID + - `type` (string) タイプ + - `is_anonymous` (bool) 匿名かどうか + - `session_id` (string) セッションID + - `created_at` (timestamp) 作成時間 + + + + + + ```bash {{ title: 'cURL' }} + curl -X GET '${props.appDetail.api_base_url}/workflows/logs?limit=1' + --header 'Authorization: Bearer {api_key}' + ``` + + + ### 応答例 + + ```json {{ title: '応答' }} + { + "page": 1, + "limit": 1, + "total": 7, + "has_more": true, + "data": [ + { + "id": "e41b93f1-7ca2-40fd-b3a8-999aeb499cc0", + "workflow_run": { + "id": "c0640fc8-03ef-4481-a96c-8a13b732a36e", + "version": "2024-08-01 12:17:09.771832", + "status": "succeeded", + "error": null, + "elapsed_time": 1.3588523610014818, + "total_tokens": 0, + "total_steps": 3, + "created_at": 1726139643, + "finished_at": 1726139644 + }, + "created_from": "service-api", + "created_by_role": "end_user", + "created_by_account": null, + "created_by_end_user": { + "id": "7f7d9117-dd9d-441d-8970-87e5e7e687a3", + "type": "service_api", + "is_anonymous": false, + "session_id": "abc-123" + }, + "created_at": 1726139644 + } + ] + } + ``` + + +