1033 lines
34 KiB
Plaintext
Executable File
1033 lines
34 KiB
Plaintext
Executable File
import { CodeGroup } from '../code.tsx'
|
||
import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
|
||
|
||
# 文本生成型应用 API
|
||
|
||
文本生成应用无会话支持，适合用于翻译/文章写作/总结 AI 等等。
|
||
|
||
<div>
|
||
### 基础 URL
|
||
<CodeGroup title="Code" targetCode={props.appDetail.api_base_url} />
|
||
|
||
### 鉴权
|
||
|
||
|
||
Service API 使用 `API-Key` 进行鉴权。
|
||
<i>**强烈建议开发者把 `API-Key` 放在后端存储，而非分享或者放在客户端存储，以免 `API-Key` 泄露，导致财产损失。**</i>
|
||
所有 API 请求都应在 **`Authorization`** HTTP Header 中包含您的 `API-Key`，如下所示：
|
||
|
||
<CodeGroup title="Code" targetCode='Authorization: Bearer {API_KEY}' />
|
||
</div>
|
||
|
||
---
|
||
|
||
<Heading
|
||
url='/completion-messages'
|
||
method='POST'
|
||
title='发送消息'
|
||
name='#Create-Completion-Message'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
发送请求给文本生成型应用。
|
||
|
||
### Request Body
|
||
|
||
<Properties>
|
||
<Property name='inputs' type='object' key='inputs'>
|
||
(选填)允许传入 App 定义的各变量值。
|
||
inputs 参数包含了多组键值对（Key/Value pairs），每组的键对应一个特定变量，每组的值则是该变量的具体值。
|
||
文本生成型应用要求至少传入一组键值对。
|
||
- `query` (string) 必填
|
||
用户输入的文本内容。
|
||
</Property>
|
||
<Property name='response_mode' type='string' key='response_mode'>
|
||
- `streaming` 流式模式（推荐）。基于 SSE（**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**）实现类似打字机输出方式的流式返回。
|
||
- `blocking` 阻塞模式，等待执行完毕后返回结果。（请求若流程较长可能会被中断）。
|
||
<i>由于 Cloudflare 限制，请求会在 100 秒超时无返回后中断。</i>
|
||
</Property>
|
||
<Property name='user' type='string' key='user'>
|
||
用户标识，用于定义终端用户的身份，方便检索、统计。
|
||
由开发者定义规则，需保证用户标识在应用内唯一。
|
||
</Property>
|
||
<Property name='files' type='array[object]' key='files'>
|
||
文件列表，适用于传入文件结合文本理解并回答问题，仅当模型支持 Vision/Video 能力时可用。
|
||
- `type` (string) 支持类型：
|
||
- `document` 具体类型包含：'TXT', 'MD', 'MARKDOWN', 'MDX', 'PDF', 'HTML', 'XLSX', 'XLS', 'VTT', 'PROPERTIES', 'DOC', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB'
|
||
- `image` 具体类型包含：'JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG'
|
||
- `audio` 具体类型包含：'MP3', 'M4A', 'WAV', 'WEBM', 'MPGA'
|
||
- `video` 具体类型包含：'MP4', 'MOV', 'MPEG', 'WEBM'
|
||
- `custom` 具体类型包含：其他文件类型
|
||
- `transfer_method` (string) 传递方式:
|
||
- `remote_url`: 文件地址。
|
||
- `local_file`: 上传文件。
|
||
- `url` 文件地址。（仅当传递方式为 `remote_url` 时）。
|
||
- `upload_file_id` 上传文件 ID。（仅当传递方式为 `local_file `时）。
|
||
</Property>
|
||
</Properties>
|
||
|
||
### Response
|
||
<Properties>
|
||
当 `response_mode` 为 `blocking` 时，返回 ChatCompletionResponse object。
|
||
当 `response_mode` 为 `streaming`时，返回 ChunkChatCompletionResponse object 流式序列。
|
||
|
||
### ChatCompletionResponse
|
||
返回完整的 App 结果，`Content-Type` 为 `application/json`。
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `mode` (string) App 模式，固定为 chat
|
||
- `answer` (string) 完整回复内容
|
||
- `metadata` (object) 元数据
|
||
- `usage` (Usage) 模型用量信息
|
||
- `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
|
||
- `created_at` (int) 消息创建时间戳，如：1705395332
|
||
|
||
### ChunkChatCompletionResponse
|
||
返回 App 输出的流式块，`Content-Type` 为 `text/event-stream`。
|
||
每个流式块均为 data: 开头，块之间以 `\n\n` 即两个换行符分隔，如下所示：
|
||
<CodeGroup>
|
||
```streaming {{ title: 'Response' }}
|
||
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` 不同，结构也不同：
|
||
- `event: message` LLM 返回文本块事件，即：完整的文本以分块的方式输出。
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `answer` (string) LLM 返回文本块内容
|
||
- `created_at` (int) 创建时间戳，如：1705395332
|
||
- `event: message_end` 消息结束事件，收到此事件则代表文本流式返回结束。
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `metadata` (object) 元数据
|
||
- `usage` (Usage) 模型用量信息
|
||
- `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
|
||
- `event: tts_message` TTS 音频流事件，即：语音合成输出。内容是Mp3格式的音频块，使用 base64 编码后的字符串，播放的时候直接解码即可。(开启自动播放才有此消息)
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `audio` (string) 语音合成之后的音频块使用 Base64 编码之后的文本内容，播放的时候直接 base64 解码送入播放器即可
|
||
- `created_at` (int) 创建时间戳，如：1705395332
|
||
- `event: tts_message_end` TTS 音频流结束事件，收到这个事件表示音频流返回结束。
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `audio` (string) 结束事件是没有音频的，所以这里是空字符串
|
||
- `created_at` (int) 创建时间戳，如：1705395332
|
||
- `event: message_replace` 消息内容替换事件。
|
||
开启内容审查和审查输出内容时，若命中了审查条件，则会通过此事件替换消息内容为预设回复。
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `answer` (string) 替换内容（直接替换 LLM 所有回复文本）
|
||
- `created_at` (int) 创建时间戳，如：1705395332
|
||
- `event: error`
|
||
流式输出过程中出现的异常会以 stream event 形式输出，收到异常事件后即结束。
|
||
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
|
||
- `message_id` (string) 消息唯一 ID
|
||
- `status` (int) HTTP 状态码
|
||
- `code` (string) 错误码
|
||
- `message` (string) 错误消息
|
||
- `event: ping` 每 10s 一次的 ping 事件，保持连接存活。
|
||
|
||
### Errors
|
||
- 404，对话不存在
|
||
- 400，`invalid_param`，传入参数异常
|
||
- 400，`app_unavailable`，App 配置不可用
|
||
- 400，`provider_not_initialize`，无可用模型凭据配置
|
||
- 400，`provider_quota_exceeded`，模型调用额度不足
|
||
- 400，`model_currently_not_support`，当前模型不可用
|
||
- 400，`completion_request_error`，文本生成失败
|
||
- 500，服务内部异常
|
||
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/completion-messages"
|
||
targetCode={`curl -X POST '${props.appDetail.api_base_url}/completion-messages' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{
|
||
"inputs": {"query": "Hello, world!"},
|
||
"response_mode": "streaming",
|
||
"user": "abc-123"
|
||
}'`}
|
||
/>
|
||
### blocking
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"id": "0b089b9a-24d9-48cc-94f8-762677276261",
|
||
"answer": "how are you?",
|
||
"created_at": 1679586667
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
### streaming
|
||
<CodeGroup title="Response">
|
||
```streaming {{ title: 'Response' }}
|
||
data: {"id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " I", "created_at": 1679586595}
|
||
data: {"id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " I", "created_at": 1679586595}
|
||
data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"}
|
||
data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
|
||
---
|
||
<Heading
|
||
url='/files/upload'
|
||
method='POST'
|
||
title='上传文件'
|
||
name='#files-upload'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。
|
||
支持 png, jpg, jpeg, webp, gif 格式。
|
||
<i>上传的文件仅供当前终端用户使用。</i>
|
||
|
||
### Request Body
|
||
该接口需使用 `multipart/form-data` 进行请求。
|
||
<Properties>
|
||
<Property name='file' type='file' key='file'>
|
||
要上传的文件。
|
||
</Property>
|
||
<Property name='user' type='string' key='user'>
|
||
用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。
|
||
</Property>
|
||
</Properties>
|
||
|
||
### Response
|
||
成功上传后，服务器会返回文件的 ID 和相关信息。
|
||
- `id` (uuid) ID
|
||
- `name` (string) 文件名
|
||
- `size` (int) 文件大小（byte）
|
||
- `extension` (string) 文件后缀
|
||
- `mime_type` (string) 文件 mime-type
|
||
- `created_by` (uuid) 上传人 ID
|
||
- `created_at` (timestamp) 上传时间
|
||
|
||
### Errors
|
||
- 400，`no_file_uploaded`，必须提供文件
|
||
- 400，`too_many_files`，目前只接受一个文件
|
||
- 400，`unsupported_preview`，该文件不支持预览
|
||
- 400，`unsupported_estimate`，该文件不支持估算
|
||
- 413，`file_too_large`，文件太大
|
||
- 415，`unsupported_file_type`，不支持的扩展名，当前只接受文档类文件
|
||
- 503，`s3_connection_failed`，无法连接到 S3 服务
|
||
- 503，`s3_permission_denied`，无权限上传文件到 S3
|
||
- 503，`s3_file_too_large`，文件超出 S3 大小限制
|
||
</Col>
|
||
<Col sticky>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/files/upload"
|
||
targetCode={`curl -X POST '${props.appDetail.api_base_url}/files/upload' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--form 'file=@localfile;type=image/[png|jpeg|jpg|webp|gif]' \\
|
||
--form 'user=abc-123'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
|
||
"name": "example.png",
|
||
"size": 1024,
|
||
"extension": "png",
|
||
"mime_type": "image/png",
|
||
"created_by": 123,
|
||
"created_at": 1577836800,
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/files/:file_id/preview'
|
||
method='GET'
|
||
title='文件预览'
|
||
name='#file-preview'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
预览或下载已上传的文件。此端点允许您访问先前通过文件上传 API 上传的文件。
|
||
|
||
<i>文件只能在属于请求应用程序的消息范围内访问。</i>
|
||
|
||
### 路径参数
|
||
- `file_id` (string) 必需
|
||
要预览的文件的唯一标识符，从文件上传 API 响应中获得。
|
||
|
||
### 查询参数
|
||
- `as_attachment` (boolean) 可选
|
||
是否强制将文件作为附件下载。默认为 `false`（在浏览器中预览）。
|
||
|
||
### 响应
|
||
返回带有适当浏览器显示或下载标头的文件内容。
|
||
- `Content-Type` 根据文件 MIME 类型设置
|
||
- `Content-Length` 文件大小（以字节为单位，如果可用）
|
||
- `Content-Disposition` 如果 `as_attachment=true` 则设置为 "attachment"
|
||
- `Cache-Control` 用于性能的缓存标头
|
||
- `Accept-Ranges` 对于音频/视频文件设置为 "bytes"
|
||
|
||
### 错误
|
||
- 400, `invalid_param`, 参数输入异常
|
||
- 403, `file_access_denied`, 文件访问被拒绝或文件不属于当前应用程序
|
||
- 404, `file_not_found`, 文件未找到或已被删除
|
||
- 500, 服务内部错误
|
||
|
||
</Col>
|
||
<Col sticky>
|
||
### 请求示例
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/files/:file_id/preview"
|
||
targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview' \\
|
||
--header 'Authorization: Bearer {api_key}'`}
|
||
/>
|
||
|
||
### 作为附件下载
|
||
<CodeGroup
|
||
title="下载请求"
|
||
tag="GET"
|
||
label="/files/:file_id/preview?as_attachment=true"
|
||
targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview?as_attachment=true' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--output downloaded_file.png`}
|
||
/>
|
||
|
||
### 响应标头示例
|
||
<CodeGroup title="Response Headers">
|
||
```http {{ title: 'Headers - 图片预览' }}
|
||
Content-Type: image/png
|
||
Content-Length: 1024
|
||
Cache-Control: public, max-age=3600
|
||
```
|
||
</CodeGroup>
|
||
|
||
### 文件下载响应标头
|
||
<CodeGroup title="Download Response Headers">
|
||
```http {{ title: 'Headers - 文件下载' }}
|
||
Content-Type: image/png
|
||
Content-Length: 1024
|
||
Content-Disposition: attachment; filename*=UTF-8''example.png
|
||
Cache-Control: public, max-age=3600
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/completion-messages/:task_id/stop'
|
||
method='POST'
|
||
title='停止响应'
|
||
name='#Stop'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
仅支持流式模式。
|
||
### Path
|
||
- `task_id` (string) 任务 ID，可在流式返回 Chunk 中获取
|
||
|
||
### Request Body
|
||
- `user` (string) Required
|
||
用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。
|
||
### Response
|
||
- `result` (string) 固定返回 success
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/completion-messages/:task_id/stop"
|
||
targetCode={`curl -X POST '${props.appDetail.api_base_url}/completion-messages/:task_id/stop' \\
|
||
-H 'Authorization: Bearer {api_key}' \\
|
||
-H 'Content-Type: application/json' \\
|
||
--data-raw '{ "user": "abc-123"}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"result": "success"
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/messages/:message_id/feedbacks'
|
||
method='POST'
|
||
title='消息反馈（点赞）'
|
||
name='#feedbacks'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
消息终端用户反馈、点赞，方便应用开发者优化输出预期。
|
||
|
||
### Path Params
|
||
<Properties>
|
||
<Property name='message_id' type='string' key='message_id'>
|
||
消息 ID
|
||
</Property>
|
||
</Properties>
|
||
|
||
### Request Body
|
||
|
||
<Properties>
|
||
<Property name='rating' type='string' key='rating'>
|
||
点赞 like, 点踩 dislike, 撤销点赞 null
|
||
</Property>
|
||
<Property name='user' type='string' key='user'>
|
||
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
|
||
</Property>
|
||
<Property name='content' type='string' key='content'>
|
||
消息反馈的具体信息。
|
||
</Property>
|
||
</Properties>
|
||
|
||
### Response
|
||
- `result` (string) 固定返回 success
|
||
</Col>
|
||
<Col sticky>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/messages/:message_id/feedbacks"
|
||
targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{
|
||
"rating": "like",
|
||
"user": "abc-123",
|
||
"content": "message feedback information"
|
||
}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"result": "success"
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
|
||
---
|
||
<Heading
|
||
url='/app/feedbacks'
|
||
method='GET'
|
||
title='Get feedbacks of application'
|
||
name='#app-feedbacks'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
Get application's feedbacks.
|
||
|
||
### Query
|
||
<Properties>
|
||
<Property name='page' type='string' key='page'>
|
||
（optional）pagination，default：1
|
||
</Property>
|
||
</Properties>
|
||
|
||
<Properties>
|
||
<Property name='limit' type='string' key='limit'>
|
||
（optional） records per page default：20
|
||
</Property>
|
||
</Properties>
|
||
|
||
### Response
|
||
- `data` (List) return apps feedback list.
|
||
</Col>
|
||
<Col sticky>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/app/feedbacks"
|
||
targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"data": [
|
||
{
|
||
"id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25",
|
||
"app_id": "f252d396-fe48-450e-94ec-e184218e7346",
|
||
"conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d",
|
||
"message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11",
|
||
"rating": "like",
|
||
"content": "message feedback information-3",
|
||
"from_source": "user",
|
||
"from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5",
|
||
"from_account_id": null,
|
||
"created_at": "2025-04-24T09:24:38",
|
||
"updated_at": "2025-04-24T09:24:38"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/text-to-audio'
|
||
method='POST'
|
||
title='文字转语音'
|
||
name='#text-to-audio'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
文字转语音。
|
||
|
||
### Request Body
|
||
|
||
<Properties>
|
||
<Property name='message_id' type='str' key='message_id'>
|
||
Dify 生成的文本消息，那么直接传递生成的message-id 即可，后台会通过 message_id 查找相应的内容直接合成语音信息。如果同时传 message_id 和 text，优先使用 message_id。
|
||
</Property>
|
||
<Property name='text' type='str' key='text'>
|
||
语音生成内容。如果没有传 message-id的话，则会使用这个字段的内容
|
||
</Property>
|
||
<Property name='user' type='string' key='user'>
|
||
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/text-to-audio"
|
||
targetCode={`curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{
|
||
"message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290",
|
||
"text": "你好Dify",
|
||
"user": "abc-123"
|
||
}'`}
|
||
/>
|
||
|
||
<CodeGroup title="headers">
|
||
```json {{ title: 'headers' }}
|
||
{
|
||
"Content-Type": "audio/wav"
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/info'
|
||
method='GET'
|
||
title='获取应用基本信息'
|
||
name='#info'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
用于获取应用的基本信息
|
||
### Response
|
||
- `name` (string) 应用名称
|
||
- `description` (string) 应用描述
|
||
- `tags` (array[string]) 应用标签
|
||
- `mode` (string) 应用模式
|
||
- 'author_name' (string) 作者名称
|
||
</Col>
|
||
<Col>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/info"
|
||
targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\
|
||
-H 'Authorization: Bearer {api_key}'`}
|
||
/>
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"name": "My App",
|
||
"description": "This is my app.",
|
||
"tags": [
|
||
"tag1",
|
||
"tag2"
|
||
],
|
||
"mode": "chat",
|
||
"author_name": "Dify"
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/parameters'
|
||
method='GET'
|
||
title='获取应用参数'
|
||
name='#parameters'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。
|
||
|
||
### Response
|
||
- `opening_statement` (string) 开场白
|
||
- `suggested_questions` (array[string]) 开场推荐问题列表
|
||
- `suggested_questions_after_answer` (object) 启用回答后给出推荐问题。
|
||
- `enabled` (bool) 是否开启
|
||
- `speech_to_text` (object) 语音转文本
|
||
- `enabled` (bool) 是否开启
|
||
- `retriever_resource` (object) 引用和归属
|
||
- `enabled` (bool) 是否开启
|
||
- `annotation_reply` (object) 标记回复
|
||
- `enabled` (bool) 是否开启
|
||
- `user_input_form` (array[object]) 用户输入表单配置
|
||
- `text-input` (object) 文本输入控件
|
||
- `label` (string) 控件展示标签名
|
||
- `variable` (string) 控件 ID
|
||
- `required` (bool) 是否必填
|
||
- `default` (string) 默认值
|
||
- `paragraph` (object) 段落文本输入控件
|
||
- `label` (string) 控件展示标签名
|
||
- `variable` (string) 控件 ID
|
||
- `required` (bool) 是否必填
|
||
- `default` (string) 默认值
|
||
- `select` (object) 下拉控件
|
||
- `label` (string) 控件展示标签名
|
||
- `variable` (string) 控件 ID
|
||
- `required` (bool) 是否必填
|
||
- `default` (string) 默认值
|
||
- `options` (array[string]) 选项值
|
||
- `file_upload` (object) 文件上传配置
|
||
- `document` (object) 文档设置
|
||
当前仅支持文档类型：`txt`, `md`, `markdown`, `pdf`, `html`, `xlsx`, `xls`, `docx`, `csv`, `eml`, `msg`, `pptx`, `ppt`, `xml`, `epub`。
|
||
- `enabled` (bool) 是否启用
|
||
- `number_limits` (int) 文档数量限制，默认为 3
|
||
- `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
|
||
- `image` (object) 图片设置
|
||
当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。
|
||
- `enabled` (bool) 是否启用
|
||
- `number_limits` (int) 图片数量限制，默认为 3
|
||
- `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
|
||
- `audio` (object) 音频设置
|
||
当前仅支持音频类型：`mp3`, `m4a`, `wav`, `webm`, `amr`。
|
||
- `enabled` (bool) 是否启用
|
||
- `number_limits` (int) 音频数量限制，默认为 3
|
||
- `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
|
||
- `video` (object) 视频设置
|
||
当前仅支持视频类型：`mp4`, `mov`, `mpeg`, `mpga`。
|
||
- `enabled` (bool) 是否启用
|
||
- `number_limits` (int) 视频数量限制，默认为 3
|
||
- `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
|
||
- `custom` (object) 自定义设置
|
||
- `enabled` (bool) 是否启用
|
||
- `number_limits` (int) 自定义数量限制，默认为 3
|
||
- `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
|
||
- `system_parameters` (object) 系统参数
|
||
- `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>
|
||
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/parameters"
|
||
targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\
|
||
--header 'Authorization: Bearer {api_key}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"introduction": "nice to meet you",
|
||
"user_input_form": [
|
||
{
|
||
"text-input": {
|
||
"label": "a",
|
||
"variable": "a",
|
||
"required": true,
|
||
"max_length": 48,
|
||
"default": ""
|
||
}
|
||
},
|
||
{
|
||
// ...
|
||
}
|
||
],
|
||
"file_upload": {
|
||
"image": {
|
||
"enabled": true,
|
||
"number_limits": 3,
|
||
"transfer_methods": [
|
||
"remote_url",
|
||
"local_file"
|
||
]
|
||
}
|
||
},
|
||
"system_parameters": {
|
||
"file_size_limit": 15,
|
||
"image_file_size_limit": 10,
|
||
"audio_file_size_limit": 50,
|
||
"video_file_size_limit": 100
|
||
}
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/site'
|
||
method='GET'
|
||
title='获取应用 WebApp 设置'
|
||
name='#site'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
用于获取应用的 WebApp 设置
|
||
### Response
|
||
- `title` (string) WebApp 名称
|
||
- `chat_color_theme` (string) 聊天颜色主题，hex 格式
|
||
- `chat_color_theme_inverted` (bool) 聊天颜色主题是否反转
|
||
- `icon_type` (string) 图标类型，`emoji`-表情，`image`-图片
|
||
- `icon` (string) 图标，如果是 `emoji` 类型，则是 emoji 表情符号，如果是 `image` 类型，则是图片 URL
|
||
- `icon_background` (string) hex 格式的背景色
|
||
- `icon_url` (string) 图标 URL
|
||
- `description` (string) 描述
|
||
- `copyright` (string) 版权信息
|
||
- `privacy_policy` (string) 隐私政策链接
|
||
- `custom_disclaimer` (string) 自定义免责声明
|
||
- `default_language` (string) 默认语言
|
||
- `show_workflow_steps` (bool) 是否显示工作流详情
|
||
- `use_icon_as_answer_icon` (bool) 是否使用 WebApp 图标替换聊天中的 🤖
|
||
</Col>
|
||
<Col>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/meta"
|
||
targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\
|
||
-H 'Authorization: Bearer {api_key}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"title": "My App",
|
||
"chat_color_theme": "#ff4a4a",
|
||
"chat_color_theme_inverted": false,
|
||
"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,
|
||
"use_icon_as_answer_icon": false,
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
___
|
||
|
||
<Heading
|
||
url='/apps/annotations'
|
||
method='GET'
|
||
title='获取标注列表'
|
||
name='#annotation_list'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='page' type='string' key='page'>
|
||
页码
|
||
</Property>
|
||
<Property name='limit' type='string' key='limit'>
|
||
每页数量
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/apps/annotations"
|
||
targetCode={`curl --location --request GET '${props.apiBaseUrl}/apps/annotations?page=1&limit=20' \\\n--header 'Authorization: Bearer {api_key}'`}
|
||
>
|
||
```bash {{ title: 'cURL' }}
|
||
curl --location --request GET '${props.apiBaseUrl}/apps/annotations?page=1&limit=20' \
|
||
--header 'Authorization: Bearer {api_key}'
|
||
```
|
||
</CodeGroup>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"data": [
|
||
{
|
||
"id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
|
||
"question": "What is your name?",
|
||
"answer": "I am Dify.",
|
||
"hit_count": 0,
|
||
"created_at": 1735625869
|
||
}
|
||
],
|
||
"has_more": false,
|
||
"limit": 20,
|
||
"total": 1,
|
||
"page": 1
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/apps/annotations'
|
||
method='POST'
|
||
title='创建标注'
|
||
name='#create_annotation'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='question' type='string' key='question'>
|
||
问题
|
||
</Property>
|
||
<Property name='answer' type='string' key='answer'>
|
||
答案内容
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/apps/annotations"
|
||
targetCode={`curl --location --request POST '${props.apiBaseUrl}/apps/annotations' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{"question": "What is your name?","answer": "I am Dify."}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
|
||
"question": "What is your name?",
|
||
"answer": "I am Dify.",
|
||
"hit_count": 0,
|
||
"created_at": 1735625869
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/apps/annotations/{annotation_id}'
|
||
method='PUT'
|
||
title='更新标注'
|
||
name='#update_annotation'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='annotation_id' type='string' key='annotation_id'>
|
||
标注 ID
|
||
</Property>
|
||
<Property name='question' type='string' key='question'>
|
||
问题
|
||
</Property>
|
||
<Property name='answer' type='string' key='answer'>
|
||
答案内容
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="PUT"
|
||
label="/apps/annotations/{annotation_id}"
|
||
targetCode={`curl --location --request PUT '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{"question": "What is your name?","answer": "I am Dify."}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
|
||
"question": "What is your name?",
|
||
"answer": "I am Dify.",
|
||
"hit_count": 0,
|
||
"created_at": 1735625869
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/apps/annotations/{annotation_id}'
|
||
method='DELETE'
|
||
title='删除标注'
|
||
name='#delete_annotation'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='annotation_id' type='string' key='annotation_id'>
|
||
标注 ID
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="PUT"
|
||
label="/apps/annotations/{annotation_id}"
|
||
targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json'`}
|
||
>
|
||
```bash {{ title: 'cURL' }}
|
||
curl --location --request DELETE '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \
|
||
--header 'Authorization: Bearer {api_key}'
|
||
```
|
||
</CodeGroup>
|
||
|
||
<CodeGroup title="Response">
|
||
```text {{ title: 'Response' }}
|
||
204 No Content
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/apps/annotation-reply/{action}'
|
||
method='POST'
|
||
title='标注回复初始设置'
|
||
name='#initial_annotation_reply_settings'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='action' type='string' key='action'>
|
||
动作，只能是 'enable' 或 'disable'
|
||
</Property>
|
||
<Property name='embedding_provider_name' type='string' key='embedding_provider_name'>
|
||
指定的嵌入模型提供商，必须先在系统内设定好接入的模型，对应的是 provider 字段
|
||
</Property>
|
||
<Property name='embedding_model_name' type='string' key='embedding_model_name'>
|
||
指定的嵌入模型，对应的是 model 字段
|
||
</Property>
|
||
<Property name='score_threshold' type='number' key='score_threshold'>
|
||
相似度阈值，当相似度大于该阈值时，系统会自动回复，否则不回复
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
嵌入模型的提供商和模型名称可以通过以下接口获取：v1/workspaces/current/models/model-types/text-embedding，具体见：通过 API 维护知识库。使用的 Authorization 是 Dataset 的 API Token。
|
||
该接口是异步执行，所以会返回一个 job_id，通过查询 job 状态接口可以获取到最终的执行结果。
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="POST"
|
||
label="/apps/annotation-reply/{action}"
|
||
targetCode={`curl --location --request POST '${props.apiBaseUrl}/apps/annotation-reply/{action}' \\
|
||
--header 'Authorization: Bearer {api_key}' \\
|
||
--header 'Content-Type: application/json' \\
|
||
--data-raw '{"score_threshold": 0.9, "embedding_provider_name": "zhipu", "embedding_model_name": "embedding_3"}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
|
||
"job_status": "waiting"
|
||
}
|
||
```
|
||
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|
||
---
|
||
|
||
<Heading
|
||
url='/apps/annotation-reply/{action}/status/{job_id}'
|
||
method='GET'
|
||
title='查询标注回复初始设置任务状态'
|
||
name='#initial_annotation_reply_settings_task_status'
|
||
/>
|
||
<Row>
|
||
<Col>
|
||
### Query
|
||
<Properties>
|
||
<Property name='action' type='string' key='action'>
|
||
动作，只能是 'enable' 或 'disable'，并且必须和标注回复初始设置接口的动作一致
|
||
</Property>
|
||
<Property name='job_id' type='string' key='job_id'>
|
||
任务 ID，从标注回复初始设置接口返回的 job_id
|
||
</Property>
|
||
</Properties>
|
||
</Col>
|
||
<Col sticky>
|
||
<CodeGroup
|
||
title="Request"
|
||
tag="GET"
|
||
label="/apps/annotations"
|
||
targetCode={`curl --location --request GET '${props.apiBaseUrl}/apps/annotation-reply/{action}/status/{job_id}' \\
|
||
--header 'Authorization: Bearer {api_key}'`}
|
||
/>
|
||
|
||
<CodeGroup title="Response">
|
||
```json {{ title: 'Response' }}
|
||
{
|
||
"job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
|
||
"job_status": "waiting",
|
||
"error_msg": ""
|
||
}
|
||
```
|
||
</CodeGroup>
|
||
</Col>
|
||
</Row>
|