AI/dify
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/langgenius/dify.git synced 2025-06-30 00:35:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: update api docs (#9832)

Browse Source
This commit is contained in:
KVOJJJin 2024-10-25 15:03:24 +08:00 committed by GitHub
parent 7a0d0d9b96
commit 303bafb3ac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 94 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
web/app/components/develop/template/template.en.mdx
View File

@ -432,7 +432,10 @@ The text generation application offers non-session support and is ideal for tran
- `number_limits` (int) Image number limit, default is 3 - `number_limits` (int) Image number limit, default is 3
- `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one - `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one
- `system_parameters` (object) System parameters - `system_parameters` (object) System parameters
- `image_file_size_limit` (string) Image file upload size limit (MB) - `file_size_limit` (int) Document upload size limit (MB)
- `image_file_size_limit` (int) Image file upload size limit (MB)
- `audio_file_size_limit` (int) Audio file upload size limit (MB)
- `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -484,7 +487,10 @@ The text generation application offers non-session support and is ideal for tran
} }
}, },
"system_parameters": { "system_parameters": {
"image_file_size_limit": "10" "file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

11
web/app/components/develop/template/template.zh.mdx
View File

@ -406,7 +406,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `number_limits` (int) 图片数量限制，默认 3 - `number_limits` (int) 图片数量限制，默认 3
- `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个 - `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个
- `system_parameters` (object) 系统参数 - `system_parameters` (object) 系统参数
- `image_file_size_limit` (string) 图片文件上传大小限制（MB） - `file_size_limit` (int) 文档上传大小限制 (MB)
- `image_file_size_limit` (int) 图片文件上传大小限制（MB）
- `audio_file_size_limit` (int) 音频文件上传大小限制 (MB)
- `video_file_size_limit` (int) 视频文件上传大小限制 (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -446,6 +449,12 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
"local_file" "local_file"
] ]
} }
},
"system_parameters": {
"file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

18
web/app/components/develop/template/template_advanced_chat.en.mdx
View File

@ -63,8 +63,12 @@ Chat applications support session persistence, allowing previous chat history to
Conversation ID, to continue the conversation based on previous chat records, it is necessary to pass the previous message's conversation_id. Conversation ID, to continue the conversation based on previous chat records, it is necessary to pass the previous message's conversation_id.
</Property> </Property>
<Property name='files' type='array[object]' key='files'> <Property name='files' type='array[object]' key='files'>
File list, suitable for inputting files (images) combined with text understanding and answering questions, available only when the model supports Vision capability. File list, suitable for inputting files combined with text understanding and answering questions, available only when the model supports Vision capability.
- `type` (string) Supported type: `image` (currently only supports image type) - `type` (string) Supported type:
- `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) Transfer method, `remote_url` for image URL / `local_file` for file upload - `transfer_method` (string) Transfer method, `remote_url` for image URL / `local_file` for file upload
- `url` (string) Image URL (when the transfer method is `remote_url`) - `url` (string) Image URL (when the transfer method is `remote_url`)
- `upload_file_id` (string) Uploaded file ID, which must be obtained by uploading through the File Upload API in advance (when the transfer method is `local_file`) - `upload_file_id` (string) Uploaded file ID, which must be obtained by uploading through the File Upload API in advance (when the transfer method is `local_file`)
@ -972,7 +976,10 @@ Chat applications support session persistence, allowing previous chat history to
- `number_limits` (int) Image number limit, default is 3 - `number_limits` (int) Image number limit, default is 3
- `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one - `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one
- `system_parameters` (object) System parameters - `system_parameters` (object) System parameters
- `image_file_size_limit` (string) Image file upload size limit (MB) - `file_size_limit` (int) Document upload size limit (MB)
- `image_file_size_limit` (int) Image file upload size limit (MB)
- `audio_file_size_limit` (int) Audio file upload size limit (MB)
- `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -1024,7 +1031,10 @@ Chat applications support session persistence, allowing previous chat history to
} }
}, },
"system_parameters": { "system_parameters": {
"image_file_size_limit": "10" "file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

19
web/app/components/develop/template/template_advanced_chat.zh.mdx
View File

@ -61,8 +61,12 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
（选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。 （选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。
</Property> </Property>
<Property name='files' type='array[object]' key='files'> <Property name='files' type='array[object]' key='files'>
上传的文件。 文件列表，适用于传入文件结合文本理解并回答问题，仅当模型支持 Vision 能力时可用。
- `type` (string) 支持类型：图片 `image`（目前仅支持图片格式） 。 - `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) 传递方式: - `transfer_method` (string) 传递方式:
- `remote_url`: 图片地址。 - `remote_url`: 图片地址。
- `local_file`: 上传文件。 - `local_file`: 上传文件。
@ -1003,7 +1007,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `number_limits` (int) 图片数量限制，默认 3 - `number_limits` (int) 图片数量限制，默认 3
- `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个 - `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个
- `system_parameters` (object) 系统参数 - `system_parameters` (object) 系统参数
- `image_file_size_limit` (string) 图片文件上传大小限制（MB） - `file_size_limit` (int) Document upload size limit (MB)
- `image_file_size_limit` (int) Image file upload size limit (MB)
- `audio_file_size_limit` (int) Audio file upload size limit (MB)
- `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -1043,6 +1050,12 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
"local_file" "local_file"
] ]
} }
},
"system_parameters": {
"file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

10
web/app/components/develop/template/template_chat.en.mdx
View File

@ -1007,7 +1007,10 @@ Chat applications support session persistence, allowing previous chat history to
- `number_limits` (int) Image number limit, default is 3 - `number_limits` (int) Image number limit, default is 3
- `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one - `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one
- `system_parameters` (object) System parameters - `system_parameters` (object) System parameters
- `image_file_size_limit` (string) Image file upload size limit (MB) - `file_size_limit` (int) Document upload size limit (MB)
- `image_file_size_limit` (int) Image file upload size limit (MB)
- `audio_file_size_limit` (int) Audio file upload size limit (MB)
- `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -1059,7 +1062,10 @@ Chat applications support session persistence, allowing previous chat history to
} }
}, },
"system_parameters": { "system_parameters": {
"image_file_size_limit": "10" "file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

11
web/app/components/develop/template/template_chat.zh.mdx
View File

@ -1017,7 +1017,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- `number_limits` (int) 图片数量限制，默认 3 - `number_limits` (int) 图片数量限制，默认 3
- `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个 - `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个
- `system_parameters` (object) 系统参数 - `system_parameters` (object) 系统参数
- `image_file_size_limit` (string) 图片文件上传大小限制（MB） - `file_size_limit` (int) 文档上传大小限制 (MB)
- `image_file_size_limit` (int) 图片文件上传大小限制（MB）
- `audio_file_size_limit` (int) 音频文件上传大小限制 (MB)
- `video_file_size_limit` (int) 视频文件上传大小限制 (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -1057,6 +1060,12 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
"local_file" "local_file"
] ]
} }
},
"system_parameters": {
"file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

18
web/app/components/develop/template/template_workflow.en.mdx
View File

@ -53,8 +53,12 @@ Workflow applications offers non-session support and is ideal for translation, a
User identifier, used to define the identity of the end-user for retrieval and statistics. User identifier, used to define the identity of the end-user for retrieval and statistics.
Should be uniquely defined by the developer within the application. Should be uniquely defined by the developer within the application.
- `files` (array[object]) Optional - `files` (array[object]) Optional
File list, suitable for inputting files (images) combined with text understanding and answering questions, available only when the model supports Vision capability. File list, suitable for inputting files combined with text understanding and answering questions, available only when the model supports Vision capability.
- `type` (string) Supported type: `image` (currently only supports image type) - `type` (string) Supported type:
- `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) Transfer method, `remote_url` for image URL / `local_file` for file upload - `transfer_method` (string) Transfer method, `remote_url` for image URL / `local_file` for file upload
- `url` (string) Image URL (when the transfer method is `remote_url`) - `url` (string) Image URL (when the transfer method is `remote_url`)
- `upload_file_id` (string) Uploaded file ID, which must be obtained by uploading through the File Upload API in advance (when the transfer method is `local_file`) - `upload_file_id` (string) Uploaded file ID, which must be obtained by uploading through the File Upload API in advance (when the transfer method is `local_file`)
@ -367,7 +371,10 @@ Workflow applications offers non-session support and is ideal for translation, a
- `number_limits` (int) Image number limit, default is 3 - `number_limits` (int) Image number limit, default is 3
- `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one - `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one
- `system_parameters` (object) System parameters - `system_parameters` (object) System parameters
- `image_file_size_limit` (string) Image file upload size limit (MB) - `file_size_limit` (int) Document upload size limit (MB)
- `image_file_size_limit` (int) Image file upload size limit (MB)
- `audio_file_size_limit` (int) Audio file upload size limit (MB)
- `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -406,7 +413,10 @@ Workflow applications offers non-session support and is ideal for translation, a
} }
}, },
"system_parameters": { "system_parameters": {
"image_file_size_limit": "10" "file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```

18
web/app/components/develop/template/template_workflow.zh.mdx
View File

@ -51,8 +51,12 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
用户标识，用于定义终端用户的身份，方便检索、统计。 用户标识，用于定义终端用户的身份，方便检索、统计。
由开发者定义规则，需保证用户标识在应用内唯一。 由开发者定义规则，需保证用户标识在应用内唯一。
- `files` (array[object]) Optional - `files` (array[object]) Optional
文件列表，适用于传入文件（图片）结合文本理解并回答问题，仅当模型支持 Vision 能力时可用。 文件列表，适用于传入文件结合文本理解并回答问题，仅当模型支持 Vision 能力时可用。
- `type` (string) 支持类型：图片 `image`（目前仅支持图片格式）。 - `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) 传递方式，`remote_url` 图片地址 / `local_file` 上传文件 - `transfer_method` (string) 传递方式，`remote_url` 图片地址 / `local_file` 上传文件
- `url` (string) 图片地址（仅当传递方式为 `remote_url` 时） - `url` (string) 图片地址（仅当传递方式为 `remote_url` 时）
- `upload_file_id` (string) (string) 上传文件 ID（仅当传递方式为 `local_file` 时） - `upload_file_id` (string) (string) 上传文件 ID（仅当传递方式为 `local_file` 时）
@ -363,7 +367,10 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
- `number_limits` (int) 图片数量限制，默认 3 - `number_limits` (int) 图片数量限制，默认 3
- `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个 - `transfer_methods` (array[string]) 传递方式列表，remote_url , local_file，必选一个
- `system_parameters` (object) 系统参数 - `system_parameters` (object) 系统参数
- `image_file_size_limit` (string) 图片文件上传大小限制（MB） - `file_size_limit` (int) 文档上传大小限制 (MB)
- `image_file_size_limit` (int) 图片文件上传大小限制（MB）
- `audio_file_size_limit` (int) 音频文件上传大小限制 (MB)
- `video_file_size_limit` (int) 视频文件上传大小限制 (MB)
</Col> </Col>
<Col sticky> <Col sticky>
@ -402,7 +409,10 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
} }
}, },
"system_parameters": { "system_parameters": {
"image_file_size_limit": "10" "file_size_limit": 15,
"image_file_size_limit": 10,
"audio_file_size_limit": 50,
"video_file_size_limit": 100
} }
} }
``` ```