chore: update api docs (#9832)

This commit is contained in:
KVOJJJin
2024-10-25 15:03:24 +08:00
committed by GitHub
parent 7a0d0d9b96
commit 303bafb3ac
8 changed files with 94 additions and 21 deletions

View File

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