jyapayne/dify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: fix some api desc (#24715)

Browse source 
Co-authored-by: zhuqingchao <zhuqingchao@xiaomi.com>
This commit is contained in:
ZalterCitty 2025-08-28 20:47:12 +08:00 • committed by GitHub
commit a174ee419e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 129 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

17
web/app/components/develop/template/template.en.mdx
View file

@ -53,11 +53,18 @@ The text generation application offers non-session support and is ideal for tran
The rules are defined by the developer and need to ensure that the user identifier is unique within the application. The Service API does not share conversations created by the WebApp.
</Property>
<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.
- `type` (string) Supported type: `image` (currently only supports image type)
- `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`)
- `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`)
File list, suitable for inputting files combined with text understanding and answering questions, available only when the model supports Vision/Video capability.
- `type` (string) Supported type:
- `document` Supported types include: 'TXT', 'MD', 'MARKDOWN', 'MDX', 'PDF', 'HTML', 'XLSX', 'XLS', 'VTT', 'PROPERTIES', 'DOC', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB'
- `image` Supported types include: 'JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG'
- `audio` Supported types include: 'MP3', 'M4A', 'WAV', 'WEBM', 'MPGA'
- `video` Supported types include: 'MP4', 'MOV', 'MPEG', 'WEBM'
- `custom` Supported types include: other file types
- `transfer_method` (string) Transfer method:
- `remote_url`: File URL.
- `local_file`: Upload file.
- `url` File URL. (Only when transfer method is `remote_url`).
- `upload_file_id` Upload file ID. (Only when transfer method is `local_file`).
</Property>
</Properties>