| | |
| | | - `inputs` (object) 必須 |
| | | アプリで定義されたさまざまな変数値の入力を許可します。 |
| | | `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の特定の値です。 |
| | | ワークフローアプリケーションは少なくとも1つのキー/値ペアの入力を必要とします。値はファイルリストである場合もあります。 |
| | | ファイルリストは、テキスト理解と質問への回答を組み合わせたファイルの入力に適しています。モデルがファイルの解析と理解機能をサポートしている場合にのみ使用できます。 |
| | | |
| | | 変数がファイルリストの場合、リストの各要素は以下の属性を持つ必要があります。 |
| | | - `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') |
| | | - `custom` (他のファイルタイプ) |
| | | - `transfer_method` (string) 転送方法、画像URLの場合は`remote_url` / ファイルアップロードの場合は`local_file` |
| | | - `url` (string) 画像URL(転送方法が`remote_url`の場合) |
| | | - `upload_file_id` (string) アップロードされたファイルID、事前にファイルアップロードAPIを通じて取得する必要があります(転送方法が`local_file`の場合) |
| | | |
| | | ワークフローアプリケーションは少なくとも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))を通じてタイプライターのような出力を実装します。 |
| | |
| | | ユーザー識別子、エンドユーザーのアイデンティティを定義するために使用されます。 |
| | | アプリケーション内で開発者によって一意に定義される必要があります。 |
| | | - `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') |
| | | - `custom` (他のファイルタイプ) |
| | | - `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オブジェクトを返します。 |
| | |
| | | 各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます。以下のように表示されます: |
| | | <CodeGroup> |
| | | ```streaming {{ title: '応答' }} |
| | | data: {"event": "text_chunk", "workflow_run_id": "b85e5fc5-751b-454d-b14e-dc5f240b0a31", "task_id": "bd029338-b068-4d34-a331-fc85478922c2", "data": {"text": "\u4e3a\u4e86", "from_variable_selector": ["1745912968134", "text"]}}\n\n |
| | | data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n |
| | | ``` |
| | | </CodeGroup> |
| | | ストリーミングチャンクの構造は`event`に応じて異なります: |
| | |
| | | - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用 |
| | | - `inputs` (object) ノードで使用されるすべての前のノード変数の内容 |
| | | - `created_at` (timestamp) 開始のタイムスタンプ、例:1705395332 |
| | | - `event: text_chunk` テキストフラグメント |
| | | - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 |
| | | - `workflow_run_id` (string) ワークフロー実行の一意のID |
| | | - `event` (string) `text_chunk`に固定 |
| | | - `data` (object) 詳細 |
| | | - `text` (string) テキスト内容 |
| | | - `from_variable_selector` (array) テキスト生成元パス(開発者がどのノードのどの変数から生成されたかを理解するための情報) |
| | | - `event: node_finished` ノード実行終了、同じイベントで異なる状態で成功または失敗 |
| | | - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用 |
| | | - `workflow_run_id` (string) ワークフロー実行の一意のID |
| | |
| | | ```json {{ title: 'ファイル変数の例' }} |
| | | { |
| | | "inputs": { |
| | | "{variable_name}": |
| | | [ |
| | | { |
| | | "{variable_name}": { |
| | | "transfer_method": "local_file", |
| | | "upload_file_id": "{upload_file_id}", |
| | | "type": "{document_type}" |
| | | } |
| | | ] |
| | | } |
| | | } |
| | | } |
| | | ``` |
| | |
| | | |
| | | data = { |
| | | "inputs": { |
| | | "orig_mail": [{ |
| | | "orig_mail": { |
| | | "transfer_method": "local_file", |
| | | "upload_file_id": file_id, |
| | | "type": "document" |
| | | }] |
| | | } |
| | | }, |
| | | "response_mode": response_mode, |
| | | "user": user |
| | |
| | | "error": null, |
| | | "total_steps": 3, |
| | | "total_tokens": 0, |
| | | "created_at": 1705407629, |
| | | "finished_at": 1727807631, |
| | | "created_at": "Thu, 18 Jul 2024 03:17:40 -0000", |
| | | "finished_at": "Thu, 18 Jul 2024 03:18:10 -0000", |
| | | "elapsed_time": 30.098514399956912 |
| | | } |
| | | ``` |
| | |
| | | </CodeGroup> |
| | | </Col> |
| | | </Row> |
| | | ——— |
| | | |
| | | <Heading |
| | | url='/site' |
| | | method='GET' |
| | | title='アプリのWebApp設定を取得' |
| | | name='#site' |
| | | /> |
| | | <Row> |
| | | <Col> |
| | | アプリのWebApp設定を取得するために使用します。 |
| | | ### 応答 |
| | | - `title` (string) WebApp名 |
| | | - `icon_type` (string) アイコンタイプ、`emoji`-絵文字、`image`-画像 |
| | | - `icon` (string) アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像URL |
| | | - `icon_background` (string) 16進数形式の背景色 |
| | | - `icon_url` (string) アイコンのURL |
| | | - `description` (string) 説明 |
| | | - `copyright` (string) 著作権情報 |
| | | - `privacy_policy` (string) プライバシーポリシーのリンク |
| | | - `custom_disclaimer` (string) カスタム免責事項 |
| | | - `default_language` (string) デフォルト言語 |
| | | - `show_workflow_steps` (bool) ワークフローの詳細を表示するかどうか |
| | | </Col> |
| | | <Col> |
| | | <CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\\n-H 'Authorization: Bearer {api_key}'`}> |
| | | ```bash {{ title: 'cURL' }} |
| | | curl -X GET '${props.appDetail.api_base_url}/site' \ |
| | | -H 'Authorization: Bearer {api_key}' |
| | | ``` |
| | | |
| | | </CodeGroup> |
| | | |
| | | <CodeGroup title="Response"> |
| | | ```json {{ title: 'Response' }} |
| | | { |
| | | "title": "My App", |
| | | "icon_type": "emoji", |
| | | "icon": "😄", |
| | | "icon_background": "#FFEAD5", |
| | | "icon_url": null, |
| | | "description": "This is my app.", |
| | | "copyright": "all rights reserved", |
| | | "privacy_policy": "", |
| | | "custom_disclaimer": "All generated by AI", |
| | | "default_language": "en-US", |
| | | "show_workflow_steps": false, |
| | | } |
| | | ``` |
| | | </CodeGroup> |
| | | </Col> |
| | | </Row> |
| | | ___ |
| | | |