Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Correct inputs field type in API documentation #11198

Merged
merged 1 commit into from
Nov 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Chat applications support session persistence, allowing previous chat history to
- `title` (string) name of node
- `index` (int) Execution sequence number, used to display Tracing Node sequence
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
- `inputs` (array[object]) Contents of all preceding node variables used in the node
- `inputs` (object) Contents of all preceding node variables used in the node
- `created_at` (timestamp) timestamp of start, e.g., 1705395332
- `event: node_finished` node execution ends, success or failure in different states in the same event
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
Expand All @@ -174,7 +174,7 @@ Chat applications support session persistence, allowing previous chat history to
- `title` (string) name of node
- `index` (int) Execution sequence number, used to display Tracing Node sequence
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
- `inputs` (array[object]) Contents of all preceding node variables used in the node
- `inputs` (object) Contents of all preceding node variables used in the node
- `process_data` (json) Optional node process data
- `outputs` (json) Optional content of output
- `status` (string) status of execution, `running` / `succeeded` / `failed` / `stopped`
Expand Down Expand Up @@ -564,7 +564,7 @@ Chat applications support session persistence, allowing previous chat history to
- `data` (array[object]) Message list
- `id` (string) Message ID
- `conversation_id` (string) Conversation ID
- `inputs` (array[object]) User input parameters.
- `inputs` (object) User input parameters.
- `query` (string) User input / question content.
- `message_files` (array[object]) Message files
- `id` (string) ID
Expand Down Expand Up @@ -664,7 +664,7 @@ Chat applications support session persistence, allowing previous chat history to
- `data` (array[object]) List of conversations
- `id` (string) Conversation ID
- `name` (string) Conversation name, by default, is generated by LLM.
- `inputs` (array[object]) User input parameters.
- `inputs` (object) User input parameters.
- `status` (string) Conversation status
- `introduction` (string) Introduction
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
Expand Down Expand Up @@ -794,7 +794,7 @@ Chat applications support session persistence, allowing previous chat history to
### Response
- `id` (string) Conversation ID
- `name` (string) Conversation name
- `inputs` array[object] User input parameters
- `inputs` (object) User input parameters
- `status` (string) Conversation status
- `introduction` (string) Introduction
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `title` (string) ノードの名前
- `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
- `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
- `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容
- `inputs` (object) ノードで使用されるすべての前のノード変数の内容
- `created_at` (timestamp) 開始のタイムスタンプ、例:1705395332
- `event: node_finished` ノード実行が終了、成功または失敗は同じイベント内で異なる状態で示されます
- `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
Expand All @@ -174,7 +174,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `title` (string) ノードの名前
- `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
- `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
- `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容
- `inputs` (object) ノードで使用されるすべての前のノード変数の内容
- `process_data` (json) オプションのノードプロセスデータ
- `outputs` (json) オプションの出力内容
- `status` (string) 実行の状態、`running` / `succeeded` / `failed` / `stopped`
Expand Down Expand Up @@ -564,7 +564,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `data` (array[object]) メッセージリスト
- `id` (string) メッセージID
- `conversation_id` (string) 会話ID
- `inputs` (array[object]) ユーザー入力パラメータ。
- `inputs` (object) ユーザー入力パラメータ。
- `query` (string) ユーザー入力/質問内容。
- `message_files` (array[object]) メッセージファイル
- `id` (string) ID
Expand Down Expand Up @@ -664,7 +664,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `data` (array[object]) 会話のリスト
- `id` (string) 会話ID
- `name` (string) 会話名、デフォルトではLLMによって生成されます。
- `inputs` (array[object]) ユーザー入力パラメータ。
- `inputs` (object) ユーザー入力パラメータ。
- `introduction` (string) 紹介
- `created_at` (timestamp) 作成タイムスタンプ、例:1705395332
- `updated_at` (timestamp) 更新タイムスタンプ、例:1705395332
Expand Down Expand Up @@ -793,7 +793,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
### 応答
- `id` (string) 会話ID
- `name` (string) 会話名
- `inputs` array[object] ユーザー入力パラメータ
- `inputs` (object) ユーザー入力パラメータ
- `status` (string) 会話状態
- `introduction` (string) 紹介
- `created_at` (timestamp) 作成タイムスタンプ、例:1705395332
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `title` (string) 节点名称
- `index` (int) 执行序号,用于展示 Tracing Node 顺序
- `predecessor_node_id` (string) 前置节点 ID,用于画布展示执行路径
- `inputs` (array[object]) 节点中所有使用到的前置节点变量内容
- `inputs` (object) 节点中所有使用到的前置节点变量内容
- `created_at` (timestamp) 开始时间
- `event: node_finished` node 执行结束,成功失败同一事件中不同状态
- `task_id` (string) 任务 ID,用于请求跟踪和下方的停止响应接口
Expand All @@ -173,7 +173,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `node_id` (string) 节点 ID
- `index` (int) 执行序号,用于展示 Tracing Node 顺序
- `predecessor_node_id` (string) optional 前置节点 ID,用于画布展示执行路径
- `inputs` (array[object]) 节点中所有使用到的前置节点变量内容
- `inputs` (object) 节点中所有使用到的前置节点变量内容
- `process_data` (json) Optional 节点过程数据
- `outputs` (json) Optional 输出内容
- `status` (string) 执行状态 `running` / `succeeded` / `failed` / `stopped`
Expand Down Expand Up @@ -570,7 +570,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `data` (array[object]) 消息列表
- `id` (string) 消息 ID
- `conversation_id` (string) 会话 ID
- `inputs` (array[object]) 用户输入参数。
- `inputs` (object) 用户输入参数。
- `query` (string) 用户输入 / 提问内容。
- `message_files` (array[object]) 消息文件
- `id` (string) ID
Expand Down Expand Up @@ -699,7 +699,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `data` (array[object]) 会话列表
- `id` (string) 会话 ID
- `name` (string) 会话名称,默认由大语言模型生成。
- `inputs` (array[object]) 用户输入参数。
- `inputs` (object) 用户输入参数。
- `status` (string) 会话状态
- `introduction` (string) 开场白
- `created_at` (timestamp) 创建时间
Expand Down Expand Up @@ -830,7 +830,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
### Response
- `id` (string) 会话 ID
- `name` (string) 会话名称
- `inputs` array[object] 用户输入参数
- `inputs` (object) 用户输入参数
- `status` (string) 会话状态
- `introduction` (string) 开场白
- `created_at` (timestamp) 创建时间
Expand Down
6 changes: 3 additions & 3 deletions web/app/components/develop/template/template_chat.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ Chat applications support session persistence, allowing previous chat history to
- `data` (array[object]) Message list
- `id` (string) Message ID
- `conversation_id` (string) Conversation ID
- `inputs` (array[object]) User input parameters.
- `inputs` (object) User input parameters.
- `query` (string) User input / question content.
- `message_files` (array[object]) Message files
- `id` (string) ID
Expand Down Expand Up @@ -698,7 +698,7 @@ Chat applications support session persistence, allowing previous chat history to
- `data` (array[object]) List of conversations
- `id` (string) Conversation ID
- `name` (string) Conversation name, by default, is a snippet of the first question asked by the user in the conversation.
- `inputs` (array[object]) User input parameters.
- `inputs` (object) User input parameters.
- `status` (string) Conversation status
- `introduction` (string) Introduction
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
Expand Down Expand Up @@ -828,7 +828,7 @@ Chat applications support session persistence, allowing previous chat history to
### Response
- `id` (string) Conversation ID
- `name` (string) Conversation name
- `inputs` array[object] User input parameters
- `inputs` (object) User input parameters
- `status` (string) Conversation status
- `introduction` (string) Introduction
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
Expand Down
6 changes: 3 additions & 3 deletions web/app/components/develop/template/template_chat.ja.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `data` (array[object]) メッセージリスト
- `id` (string) メッセージID
- `conversation_id` (string) 会話ID
- `inputs` (array[object]) ユーザー入力パラメータ。
- `inputs` (object) ユーザー入力パラメータ。
- `query` (string) ユーザー入力/質問内容。
- `message_files` (array[object]) メッセージファイル
- `id` (string) ID
Expand Down Expand Up @@ -698,7 +698,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `data` (array[object]) 会話のリスト
- `id` (string) 会話ID
- `name` (string) 会話名、デフォルトでは、ユーザーが会話で最初に尋ねた質問のスニペットです。
- `inputs` (array[object]) ユーザー入力パラメータ。
- `inputs` (object) ユーザー入力パラメータ。
- `introduction` (string) 紹介
- `created_at` (timestamp) 作成タイムスタンプ、例:1705395332
- `updated_at` (timestamp) 更新タイムスタンプ、例:1705395332
Expand Down Expand Up @@ -827,7 +827,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
### 応答
- `id` (string) 会話ID
- `name` (string) 会話名
- `inputs` array[object] ユーザー入力パラメータ
- `inputs` (object) ユーザー入力パラメータ
- `status` (string) 会話状態
- `introduction` (string) 紹介
- `created_at` (timestamp) 作成タイムスタンプ、例:1705395332
Expand Down
6 changes: 3 additions & 3 deletions web/app/components/develop/template/template_chat.zh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `data` (array[object]) 消息列表
- `id` (string) 消息 ID
- `conversation_id` (string) 会话 ID
- `inputs` (array[object]) 用户输入参数。
- `inputs` (object) 用户输入参数。
- `query` (string) 用户输入 / 提问内容。
- `message_files` (array[object]) 消息文件
- `id` (string) ID
Expand Down Expand Up @@ -713,7 +713,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `data` (array[object]) 会话列表
- `id` (string) 会话 ID
- `name` (string) 会话名称,默认为会话中用户最开始问题的截取。
- `inputs` (array[object]) 用户输入参数。
- `inputs` (object) 用户输入参数。
- `status` (string) 会话状态
- `introduction` (string) 开场白
- `created_at` (timestamp) 创建时间
Expand Down Expand Up @@ -844,7 +844,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
### Response
- `id` (string) 会话 ID
- `name` (string) 会话名称
- `inputs` array[object] 用户输入参数
- `inputs` (object) 用户输入参数
- `status` (string) 会话状态
- `introduction` (string) 开场白
- `created_at` (timestamp) 创建时间
Expand Down
4 changes: 2 additions & 2 deletions web/app/components/develop/template/template_workflow.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Workflow applications offers non-session support and is ideal for translation, a
- `title` (string) name of node
- `index` (int) Execution sequence number, used to display Tracing Node sequence
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
- `inputs` (array[object]) Contents of all preceding node variables used in the node
- `inputs` (object) Contents of all preceding node variables used in the node
- `created_at` (timestamp) timestamp of start, e.g., 1705395332
- `event: node_finished` node execution ends, success or failure in different states in the same event
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
Expand All @@ -126,7 +126,7 @@ Workflow applications offers non-session support and is ideal for translation, a
- `title` (string) name of node
- `index` (int) Execution sequence number, used to display Tracing Node sequence
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
- `inputs` (array[object]) Contents of all preceding node variables used in the node
- `inputs` (object) Contents of all preceding node variables used in the node
- `process_data` (json) Optional node process data
- `outputs` (json) Optional content of output
- `status` (string) status of execution, `running` / `succeeded` / `failed` / `stopped`
Expand Down
4 changes: 2 additions & 2 deletions web/app/components/develop/template/template_workflow.ja.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `title` (string) ノードの名前
- `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
- `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
- `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容
- `inputs` (object) ノードで使用されるすべての前のノード変数の内容
- `created_at` (timestamp) 開始のタイムスタンプ、例:1705395332
- `event: node_finished` ノード実行終了、同じイベントで異なる状態で成功または失敗
- `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
Expand All @@ -126,7 +126,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- `title` (string) ノードの名前
- `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
- `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
- `inputs` (array[object]) ノードで使用されるすべての前のノード変数の内容
- `inputs` (object) ノードで使用されるすべての前のノード変数の内容
- `process_data` (json) オプションのノードプロセスデータ
- `outputs` (json) オプションの出力内容
- `status` (string) 実行のステータス、`running` / `succeeded` / `failed` / `stopped`
Expand Down
4 changes: 2 additions & 2 deletions web/app/components/develop/template/template_workflow.zh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等
- `title` (string) 节点名称
- `index` (int) 执行序号,用于展示 Tracing Node 顺序
- `predecessor_node_id` (string) 前置节点 ID,用于画布展示执行路径
- `inputs` (array[object]) 节点中所有使用到的前置节点变量内容
- `inputs` (object) 节点中所有使用到的前置节点变量内容
- `created_at` (timestamp) 开始时间
- `event: node_finished` node 执行结束,成功失败同一事件中不同状态
- `task_id` (string) 任务 ID,用于请求跟踪和下方的停止响应接口
Expand All @@ -122,7 +122,7 @@ Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等
- `node_id` (string) 节点 ID
- `index` (int) 执行序号,用于展示 Tracing Node 顺序
- `predecessor_node_id` (string) optional 前置节点 ID,用于画布展示执行路径
- `inputs` (array[object]) 节点中所有使用到的前置节点变量内容
- `inputs` (object) 节点中所有使用到的前置节点变量内容
- `process_data` (json) Optional 节点过程数据
- `outputs` (json) Optional 输出内容
- `status` (string) 执行状态 `running` / `succeeded` / `failed` / `stopped`
Expand Down