diff --git a/README.md b/README.md index 497f9cc..69e9aa2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dify x OpenAPI -[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.4.2-blue)](https://github.com/langgenius/dify) +[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.4.3-blue)](https://github.com/langgenius/dify) [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Package Manager: uv](https://img.shields.io/badge/package%20manager-uv-black)](https://github.com/astral-sh/uv) @@ -39,7 +39,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic > [!tip] > This indicates that the API has passed at least one test case request. If you find any API errors, feel free to submit an issue or PR! -- Knowledge Base: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.2/web/app/(commonLayout)/datasets/template) +- Knowledge Base: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.3/web/app/(commonLayout)/datasets/template) - [x] POST /datasets - Create empty knowledge base - [x] POST /datasets/{dataset_id} - Update knowledge base - [x] GET /datasets/{dataset_id}/documents - Get document list @@ -70,7 +70,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic - [x] POST /datasets/{dataset_id}/tags - Query dataset bound tags - [x] POST /datasets/{dataset_id}/retrieval - Retrieve with metadata filtering conditions -- Chat Application: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- Chat Application: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /chat-messages - Send conversation message - [x] POST /files/upload - Upload file - [x] POST /messages/{message_id}/feedbacks - Message feedback @@ -83,7 +83,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic - [x] GET /info - Get application basic information - [x] GET /parameters - Get application parameters -- Advanced Chat Application: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- Advanced Chat Application: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /audio-to-text - Speech to text - [x] POST /text-to-audio - Text to speech - [x] GET /apps/annotations - Get annotation list @@ -99,10 +99,10 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic - [x] GET /parameters - Get application parameters -- Text Generation Application: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- Text Generation Application: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /completion-messages - Send message -- Workflow Application: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- Workflow Application: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /workflows/run - Execute workflow - [x] GET /workflows/run/{workflow_run_id} - Get workflow execution status - [x] POST /workflows/tasks/{task_id}/stop - Stop response diff --git a/README.zh.md b/README.zh.md index 3c9e2f7..65e982f 100644 --- a/README.zh.md +++ b/README.zh.md @@ -1,6 +1,6 @@ # Dify x OpenAPI -[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.4.2-blue)](https://github.com/langgenius/dify) +[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.4.3-blue)](https://github.com/langgenius/dify) [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Package Manager: uv](https://img.shields.io/badge/package%20manager-uv-black)](https://github.com/astral-sh/uv) @@ -41,7 +41,7 @@ > [!tip] > 这里指至少可以通过一次测试用例请求, 如果你发现有哪些API错误, 欢迎提issue或者pr! -- 知识库: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.2/web/app/(commonLayout)/datasets/template) +- 知识库: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.3/web/app/(commonLayout)/datasets/template) - [x] POST /datasets - 创建空知识库 - [x] POST /datasets/{dataset_id} - 更新知识库 - [x] GET /datasets/{dataset_id}/documents - 获取文档列表 @@ -72,7 +72,7 @@ - [x] POST /datasets/{dataset_id}/tags - 查询知识库已绑定的标签 - [x] POST /datasets/{dataset_id}/retrieval - 带元数据过滤条件的检索 -- 聊天应用: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- 聊天应用: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /chat-messages - 发送对话消息 - [x] POST /files/upload - 上传文件 - [x] POST /messages/{message_id}/feedbacks - 消息反馈 @@ -85,7 +85,7 @@ - [x] GET /info - 获取应用基本信息 - [x] GET /parameters - 获取应用参数 -- 高级聊天应用: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- 高级聊天应用: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /audio-to-text - 语音转文字 - [x] POST /text-to-audio - 文字转语音 - [x] GET /apps/annotations - 获取标注列表 @@ -100,10 +100,10 @@ - [x] GET /info - 获取应用基本信息 - [x] GET /parameters - 获取应用参数（包含文字转语音设置） -- 文本生成应用: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- 文本生成应用: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /completion-messages - 发送消息 -- 工作流应用: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.2/web/app/components/develop/template) +- 工作流应用: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.4.3/web/app/components/develop/template) - [x] POST /workflows/run - 执行工作流 - [x] GET /workflows/run/{workflow_run_id} - 获取工作流执行状态 - [x] POST /workflows/tasks/{task_id}/stop - 停止响应 diff --git a/libs/dify b/libs/dify index 1e03c97..2440ac4 160000 --- a/libs/dify +++ b/libs/dify @@ -1 +1 @@ -Subproject commit 1e03c97663a2df7d23831ff5cf2862d1ca8b2faa +Subproject commit 2440ac43b191691548936587a58ae7b12ea1f866 diff --git a/misc/official_api_doc_changes/1.4.2__1.4.3.diff b/misc/official_api_doc_changes/1.4.2__1.4.3.diff new file mode 100644 index 0000000..8f4037b --- /dev/null +++ b/misc/official_api_doc_changes/1.4.2__1.4.3.diff @@ -0,0 +1,177 @@ +diff --git a/web/app/components/develop/template/template.zh.mdx b/web/app/components/develop/template/template.zh.mdx +index 9e65a4bd9..4af5a2805 100755 +--- a/web/app/components/develop/template/template.zh.mdx ++++ b/web/app/components/develop/template/template.zh.mdx +@@ -266,7 +266,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + + ### Request Body + - `user` (string) Required +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 + ### Response + - `result` (string) 固定返回 success + +@@ -485,6 +485,8 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + - `name` (string) 应用名称 + - `description` (string) 应用描述 + - `tags` (array[string]) 应用标签 ++ - `mode` (string) 应用模式 ++ - 'author_name' (string) 作者名称 + + + +@@ -501,7 +503,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + "tags": [ + "tag1", + "tag2" +- ] ++ ], ++ "mode": "chat", ++ "author_name": "Dify" + } + ``` + +diff --git a/web/app/components/develop/template/template_advanced_chat.zh.mdx b/web/app/components/develop/template/template_advanced_chat.zh.mdx +index 3e268d6e6..fa3ad3f37 100755 +--- a/web/app/components/develop/template/template_advanced_chat.zh.mdx ++++ b/web/app/components/develop/template/template_advanced_chat.zh.mdx +@@ -56,7 +56,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + + + 用户标识，用于定义终端用户的身份，方便检索、统计。 +- 由开发者定义规则，需保证用户标识在应用内唯一。 ++ 由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 + + + （选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。 +@@ -402,7 +402,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + + ### Request Body + - `user` (string) Required +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 + ### Response + - `result` (string) 固定返回 success + +@@ -1173,7 +1173,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + "tags": [ + "tag1", + "tag2" +- ] ++ ], ++ "mode": "advanced-chat", ++ "author_name": "Dify" + } + ``` + +diff --git a/web/app/components/develop/template/template_chat.zh.mdx b/web/app/components/develop/template/template_chat.zh.mdx +index 9c1a168bf..325470ac6 100644 +--- a/web/app/components/develop/template/template_chat.zh.mdx ++++ b/web/app/components/develop/template/template_chat.zh.mdx +@@ -56,7 +56,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + + + 用户标识，用于定义终端用户的身份，方便检索、统计。 +- 由开发者定义规则，需保证用户标识在应用内唯一。 ++ 由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 + + + （选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。 +@@ -306,7 +306,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + 要上传的文件。 + + +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。 + + + +@@ -373,7 +373,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + + ### Request Body + - `user` (string) Required +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 + ### Response + - `result` (string) 固定返回 success + +@@ -425,7 +425,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + 点赞 like, 点踩 dislike, 撤销点赞 null + + +- 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 ++ 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 + + + 消息反馈的具体信息。 +@@ -1162,6 +1162,8 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + - `name` (string) 应用名称 + - `description` (string) 应用描述 + - `tags` (array[string]) 应用标签 ++ - `mode` (string) 应用模式 ++ - 'author_name' (string) 作者名称 + + + +@@ -1178,7 +1180,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx' + "tags": [ + "tag1", + "tag2" +- ] ++ ], ++ "mode": "chat", ++ "author_name": "Dify" + } + ``` + +diff --git a/web/app/components/develop/template/template_workflow.zh.mdx b/web/app/components/develop/template/template_workflow.zh.mdx +index fe59988ed..d599cb503 100644 +--- a/web/app/components/develop/template/template_workflow.zh.mdx ++++ b/web/app/components/develop/template/template_workflow.zh.mdx +@@ -59,7 +59,7 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等 + 由于 Cloudflare 限制，请求会在 100 秒超时无返回后中断。 + - `user` (string) Required + 用户标识，用于定义终端用户的身份，方便检索、统计。 +- 由开发者定义规则，需保证用户标识在应用内唯一。 ++ 由开发者定义规则，需保证用户标识在应用内唯一。API 无法访问 WebApp 创建的会话。 + + + ### Response +@@ -394,7 +394,7 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等 + - `task_id` (string) 任务 ID，可在流式返回 Chunk 中获取 + ### Request Body + - `user` (string) Required +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 + ### Response + - `result` (string) 固定返回 "success" + +@@ -443,7 +443,7 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等 + 要上传的文件。 + + +- 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。 ++ 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。 + + + +@@ -615,6 +615,8 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等 + - `name` (string) 应用名称 + - `description` (string) 应用描述 + - `tags` (array[string]) 应用标签 ++ - `mode` (string) 应用模式 ++ - 'author_name' (string) 作者名称 + + + +@@ -631,7 +633,9 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等 + "tags": [ + "tag1", + "tag2" +- ] ++ ], ++ "mode": "workflow", ++ "author_name": "Dify" + } + ``` + diff --git a/pyproject.toml b/pyproject.toml index 1fac1f4..60a6cd4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "dify-openapi" -version = "1.4.2" +version = "1.4.3" description = "a client for testing and validating dify openapi schema" readme = "README.md" authors = [{ name = "straydragon", email = "straydragonl@foxmail.com" }] diff --git a/schema/app_advanced_chat.en.yaml b/schema/app_advanced_chat.en.yaml index 79f735d..8723ad6 100644 --- a/schema/app_advanced_chat.en.yaml +++ b/schema/app_advanced_chat.en.yaml @@ -6,8 +6,8 @@ info: Chat applications support session persistence, allowing previous chat history to be used as context for responses, suitable for chat/customer service AI, etc. All API requests require an application-level API-Key in the Authorization HTTP Header. It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client side to prevent API-Key leakage and financial loss. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_advanced_chat.en.mdx - version: 1.4.2 + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_advanced_chat.en.mdx + version: 1.4.3 servers: - url: 'https://api.dify.ai/v1' description: Dify API Server @@ -544,6 +544,12 @@ paths: items: type: string description: Application tags + mode: + type: string + description: Application mode + author_name: + type: string + description: Author name /parameters: get: operationId: getApplicationParametersByAppAdvancedChat diff --git a/schema/app_advanced_chat.zh.yaml b/schema/app_advanced_chat.zh.yaml index 12772ae..192d9d4 100644 --- a/schema/app_advanced_chat.zh.yaml +++ b/schema/app_advanced_chat.zh.yaml @@ -6,8 +6,8 @@ info: 对话应用支持会话持久化，可将之前的聊天记录作为上下文进行回答，可适用于聊天/客服 AI 等。 所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。 强烈建议开发者把 API-Key 放在后端存储，而非分享或者放在客户端存储，以免 API-Key 泄露，导致财产损失。 - 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_advanced_chat.zh.mdx - version: 1.4.2 + 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_advanced_chat.zh.mdx + version: 1.4.3 servers: - url: https://api.dify.ai/v1 @@ -345,7 +345,7 @@ paths: - blocking: 阻塞模式，等待执行完毕后返回结果 user: type: string - description: 用户标识 + description: 用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 conversation_id: type: string description: 会话 ID @@ -406,7 +406,7 @@ paths: properties: user: type: string - description: 用户标识，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 responses: "200": description: 成功响应 @@ -556,6 +556,12 @@ paths: items: type: string description: 应用标签 + mode: + type: string + description: 应用模式 + author_name: + type: string + description: 作者名称 /parameters: get: @@ -694,7 +700,7 @@ paths: description: 点赞 like, 点踩 dislike, 撤销点赞 null user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 content: type: string description: 消息反馈的具体信息。 @@ -800,7 +806,7 @@ paths: required: true schema: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 responses: "200": description: 成功响应 @@ -836,7 +842,7 @@ paths: required: true schema: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 - name: first_id in: query required: false @@ -932,7 +938,7 @@ paths: required: true schema: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 - name: last_id in: query required: false @@ -1024,7 +1030,7 @@ paths: properties: user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 responses: "204": description: 成功响应，无内容 @@ -1059,7 +1065,7 @@ paths: description: （选填）自动生成标题，默认 false。 user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 responses: "200": description: 成功响应 @@ -1107,7 +1113,7 @@ paths: required: true schema: type: string - description: 用户标识符，由开发人员定义的规则，在应用程序内必须唯一。 + description: 用户标识符，由开发人员定义的规则，在应用程序内必须唯一。服务 API 不会共享 WebApp 创建的对话。 - name: last_id in: query required: false diff --git a/schema/app_chat.en.yaml b/schema/app_chat.en.yaml index 0b1d794..6653c03 100644 --- a/schema/app_chat.en.yaml +++ b/schema/app_chat.en.yaml @@ -5,8 +5,8 @@ info: Dify API provides a series of interfaces for conversation functionality. It supports conversational applications. All API requests require an application-level API-Key in the Authorization HTTP Header. - official raw document: https://github.com/langgenius/dify/blob/1.4.1/web/app/components/develop/template/template_chat.en.mdx - version: 1.4.2 + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_chat.en.mdx + version: 1.4.3 servers: - url: 'https://api.dify.ai/v1' description: Dify API Server @@ -447,7 +447,7 @@ paths: Note: Blocking mode is not allowed in Agent mode user: type: string - description: 'User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application.' + description: 'User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp.' conversation_id: type: string description: '(Optional) Conversation ID. Required when continuing a conversation based on previous chat history, must pass the conversation_id from previous messages' @@ -749,7 +749,7 @@ paths: type: string - name: user in: query - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp.' required: true schema: type: string @@ -896,7 +896,7 @@ paths: description: 'Rating: like, dislike, or null to cancel' user: type: string - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp.' content: type: string description: Specific feedback information for the message @@ -995,7 +995,7 @@ paths: required: true schema: type: string - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp.' responses: '200': description: Successful response @@ -1087,6 +1087,12 @@ paths: items: type: string description: Application tags + mode: + type: string + description: Application mode + author_name: + type: string + description: Author name '/chat-messages/{task_id}/stop': post: operationId: stopChatResponseByAppChat @@ -1110,7 +1116,7 @@ paths: properties: user: type: string - description: 'User identifier, must be consistent with the user passed in the message sending interface' + description: 'User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp.' responses: '200': description: Successfully stopped the response @@ -1176,7 +1182,7 @@ paths: description: 'Text content for speech generation. If message_id is not provided, this field will be used' user: type: string - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp.' responses: '200': description: Successful response diff --git a/schema/app_chat.zh.yaml b/schema/app_chat.zh.yaml index 97c9acf..ebf723f 100644 --- a/schema/app_chat.zh.yaml +++ b/schema/app_chat.zh.yaml @@ -5,8 +5,8 @@ info: Dify API 提供了一系列接口用于对话功能。 支持对话型应用。 所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。 - 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_chat.zh.mdx - version: 1.4.2 + 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_chat.zh.mdx + version: 1.4.3 servers: - url: https://api.dify.ai/v1 @@ -457,7 +457,7 @@ paths: 注：Agent模式下不允许blocking user: type: string - description: 用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。 + description: 用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 conversation_id: type: string description: （选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id @@ -877,7 +877,7 @@ paths: description: 点赞 like, 点踩 dislike, 撤销点赞 null user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 content: type: string description: 消息反馈的具体信息 @@ -977,7 +977,7 @@ paths: required: true schema: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 responses: "200": description: 成功响应 @@ -1070,6 +1070,12 @@ paths: items: type: string description: 应用标签 + mode: + type: string + description: 应用模式 + author_name: + type: string + description: 作者名称 /chat-messages/{task_id}/stop: post: @@ -1094,7 +1100,7 @@ paths: properties: user: type: string - description: 用户标识，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 responses: "200": description: 成功响应 @@ -1161,7 +1167,7 @@ paths: description: 语音生成内容。如果没有传 message_id 的话，则会使用这个字段的内容 user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。 responses: "200": description: 成功响应 diff --git a/schema/app_generation.en.yaml b/schema/app_generation.en.yaml index f5c34bf..3f6e9db 100644 --- a/schema/app_generation.en.yaml +++ b/schema/app_generation.en.yaml @@ -5,8 +5,8 @@ info: Dify API provides a series of interfaces for text generation functionality. It supports text generation applications. All API requests require an application-level API-Key in the Authorization HTTP Header. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template.en.mdx - version: 1.4.2 + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template.en.mdx + version: 1.4.3 servers: - url: 'https://api.dify.ai/v1' description: Dify API Server @@ -289,7 +289,7 @@ paths: - blocking: Blocking mode, returns result after execution is complete user: type: string - description: User identifier + description: 'User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application' files: type: array items: @@ -427,7 +427,7 @@ paths: description: File to upload user: type: string - description: 'User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface' + description: 'User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp' required: - file - user @@ -537,6 +537,12 @@ paths: items: type: string description: Application tags + mode: + type: string + description: Application mode + author_name: + type: string + description: Author name /parameters: get: operationId: getApplicationParametersByAppGeneration @@ -715,7 +721,7 @@ paths: properties: user: type: string - description: 'User identifier, must be consistent with the user passed in the message sending interface' + description: 'User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp' responses: '200': description: Successfully stopped the response @@ -760,7 +766,7 @@ paths: description: 'Like (like), dislike (dislike), or cancel rating (null)' user: type: string - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp' content: type: string description: Specific feedback information @@ -864,7 +870,7 @@ paths: description: 'Text content for speech generation. If message_id is not provided, this field will be used' user: type: string - description: 'User identifier, defined by developer rules, must be unique within the application' + description: 'User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp' streaming: type: boolean description: Whether to use streaming mode to return audio data diff --git a/schema/app_generation.zh.yaml b/schema/app_generation.zh.yaml index 7a6a392..e4cd29b 100644 --- a/schema/app_generation.zh.yaml +++ b/schema/app_generation.zh.yaml @@ -5,8 +5,8 @@ info: Dify API 提供了一系列接口用于文本生成功能。 支持文本生成型应用。 所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。 - 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template.zh.mdx - version: 1.4.2 + 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template.zh.mdx + version: 1.4.3 servers: - url: https://api.dify.ai/v1 @@ -303,7 +303,7 @@ paths: - blocking: 阻塞模式，等待执行完毕后返回结果 user: type: string - description: 用户标识 + description: 用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一 files: type: array items: @@ -442,7 +442,7 @@ paths: description: 要上传的文件 user: type: string - description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话 required: - file - user @@ -553,6 +553,12 @@ paths: items: type: string description: 应用标签 + mode: + type: string + description: 应用模式 + author_name: + type: string + description: 作者名称 /parameters: get: @@ -731,7 +737,7 @@ paths: properties: user: type: string - description: 用户标识，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话 responses: "200": description: 成功响应 @@ -773,7 +779,7 @@ paths: description: 点赞 like, 点踩 dislike, 撤销点赞 null user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话 content: type: string description: 消息反馈的具体信息 @@ -878,7 +884,7 @@ paths: description: 语音生成内容。如果没有传 message_id 的话，则会使用这个字段的内容 user: type: string - description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一 + description: 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话 streaming: type: boolean description: 是否使用流式模式返回音频数据 diff --git a/schema/app_workflow.en.yaml b/schema/app_workflow.en.yaml index b940933..3570092 100644 --- a/schema/app_workflow.en.yaml +++ b/schema/app_workflow.en.yaml @@ -6,8 +6,8 @@ info: Workflow applications have no session support and are suitable for translation/article writing/summarization AI, etc. All API requests require an application-level API-Key in the Authorization HTTP Header. It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client to prevent API-Key leakage and financial loss. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_workflow.en.mdx - version: 1.4.2 + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_workflow.en.mdx + version: 1.4.3 servers: - url: 'https://api.dify.ai/v1' description: Dify API Server @@ -397,7 +397,7 @@ paths: type: string description: | User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. responses: '200': description: Successful response @@ -589,7 +589,7 @@ paths: properties: user: type: string - description: 'User identifier, must be consistent with the user passed in the message sending interface' + description: 'User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp.' responses: '200': description: Successfully stopped the response @@ -848,6 +848,12 @@ paths: items: type: string description: Application tags + mode: + type: string + description: Application mode + author_name: + type: string + description: Author name '400': $ref: '#/components/responses/Error400' '401': diff --git a/schema/app_workflow.zh.yaml b/schema/app_workflow.zh.yaml index 7553e66..28f7710 100644 --- a/schema/app_workflow.zh.yaml +++ b/schema/app_workflow.zh.yaml @@ -6,8 +6,8 @@ info: Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等等。 所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。 强烈建议开发者把 API-Key 放在后端存储，而非分享或者放在客户端存储，以免 API-Key 泄露，导致财产损失。 - 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_workflow.zh.mdx - version: 1.4.2 + 官方原始文档见: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_workflow.zh.mdx + version: 1.4.3 servers: - url: https://api.dify.ai/v1 @@ -407,7 +407,7 @@ paths: type: string description: | 用户标识，用于定义终端用户的身份，方便检索、统计。 - 由开发者定义规则，需保证用户标识在应用内唯一。 + 由开发者定义规则，需保证用户标识在应用内唯一。API 无法访问 WebApp 创建的会话。 responses: "200": @@ -600,7 +600,7 @@ paths: properties: user: type: string - description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。 responses: '200': description: 成功停止响应 @@ -776,7 +776,7 @@ paths: description: 要上传的文件 user: type: string - description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致 + description: 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。 responses: '201': description: 成功上传文件 @@ -858,6 +858,12 @@ paths: items: type: string description: 应用标签 + mode: + type: string + description: 应用模式 + author_name: + type: string + description: 作者名称 '400': $ref: "#/components/responses/Error400" '401': diff --git a/schema/knowledge_base.en.yaml b/schema/knowledge_base.en.yaml index 2d3a5f6..79eae41 100644 --- a/schema/knowledge_base.en.yaml +++ b/schema/knowledge_base.en.yaml @@ -4,7 +4,7 @@ info: description: | Dify Knowledge Base API provides a series of interfaces for managing knowledge bases, documents, and retrieval functions. All API requests require a knowledge base level API-Key in the Authorization HTTP Header. - version: 1.4.2 + version: 1.4.3 servers: - url: 'https://api.dify.ai/v1' description: Dify API Server diff --git a/schema/knowledge_base.zh.yaml b/schema/knowledge_base.zh.yaml index 86c0889..7106378 100644 --- a/schema/knowledge_base.zh.yaml +++ b/schema/knowledge_base.zh.yaml @@ -4,7 +4,7 @@ info: description: | Dify 知识库 API 提供了一系列接口用于管理知识库、文档和检索功能。 所有 API 请求都需要在 Authorization HTTP Header 中包含知识库级 API-Key。 - version: 1.4.2 + version: 1.4.3 servers: - url: https://api.dify.ai/v1 diff --git a/schema/overlays/app_advanced_chat.en.overlay.yaml b/schema/overlays/app_advanced_chat.en.overlay.yaml index b814e8a..708af01 100644 --- a/schema/overlays/app_advanced_chat.en.overlay.yaml +++ b/schema/overlays/app_advanced_chat.en.overlay.yaml @@ -1,7 +1,7 @@ overlay: 1.0.0 info: title: "English translation overlay for Dify API - Advanced Chat Application" - version: "1.4.2" + version: "1.4.3" extends: ../app_advanced_chat.zh.yaml actions: - target: $.info @@ -12,7 +12,7 @@ actions: Chat applications support session persistence, allowing previous chat history to be used as context for responses, suitable for chat/customer service AI, etc. All API requests require an application-level API-Key in the Authorization HTTP Header. It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client side to prevent API-Key leakage and financial loss. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_advanced_chat.en.mdx + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_advanced_chat.en.mdx - target: $.servers[0] update: @@ -199,6 +199,14 @@ actions: - target: $.components.schemas.UploadedFile.properties.created_by.description update: "Uploader ID" + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.mode.description + update: "Application mode" + + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.author_name.description + update: "Author name" + + + - target: $.components.schemas.UploadedFile.properties.created_at.description update: "Upload time" diff --git a/schema/overlays/app_chat.en.overlay.yaml b/schema/overlays/app_chat.en.overlay.yaml index d8b9b7e..bf844d3 100644 --- a/schema/overlays/app_chat.en.overlay.yaml +++ b/schema/overlays/app_chat.en.overlay.yaml @@ -11,7 +11,7 @@ actions: Dify API provides a series of interfaces for conversation functionality. It supports conversational applications. All API requests require an application-level API-Key in the Authorization HTTP Header. - official raw document: https://github.com/langgenius/dify/blob/1.4.1/web/app/components/develop/template/template_chat.en.mdx + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_chat.en.mdx - target: $.servers[0] update: @@ -332,7 +332,7 @@ actions: - target: $.paths['/chat-messages'].post.requestBody.content['application/json'].schema.properties.user update: - description: "User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application." + description: "User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp." - target: $.paths['/chat-messages'].post.requestBody.content['application/json'].schema.properties.conversation_id update: @@ -560,7 +560,7 @@ actions: update: "ID of the conversation to retrieve variables from" - target: $.paths['/conversations/{conversation_id}/variables'].get.parameters[1].description - update: "User identifier, defined by developer rules, must be unique within the application" + update: "User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp." - target: $.paths['/conversations/{conversation_id}/variables'].get.parameters[2].description update: "(Optional) ID of the last record on the current page, default null" @@ -645,7 +645,7 @@ actions: update: "Rating: like, dislike, or null to cancel" - target: $.paths['/messages/{message_id}/feedbacks'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, defined by developer rules, must be unique within the application" + update: "User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp." - target: $.paths['/messages/{message_id}/feedbacks'].post.requestBody.content['application/json'].schema.properties.content.description update: "Specific feedback information for the message" @@ -715,7 +715,7 @@ actions: update: "Message ID" - target: $.paths['/messages/{message_id}/suggested'].get.parameters[1].description - update: "User identifier, defined by developer rules, must be unique within the application" + update: "User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp." - target: $.paths['/messages/{message_id}/suggested'].get.responses['200'].description update: "Successful response" @@ -770,6 +770,14 @@ actions: update: description: "Application tags" + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.mode + update: + description: "Application mode" + + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.author_name + update: + description: "Author name" + - target: $.paths['/parameters'].get update: summary: "Get Application Parameters" @@ -844,7 +852,7 @@ actions: update: "Task ID, can be obtained from the streaming response chunks" - target: $.paths['/chat-messages/{task_id}/stop'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, must be consistent with the user passed in the message sending interface" + update: "User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp." - target: $.paths['/chat-messages/{task_id}/stop'].post.responses['200'].description update: "Successfully stopped the response" @@ -887,7 +895,7 @@ actions: - target: $.paths['/text-to-audio'].post.requestBody.content['application/json'].schema.properties.user update: - description: "User identifier, defined by developer rules, must be unique within the application" + description: "User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp." - target: $.paths['/text-to-audio'].post.responses['200'].description update: "Successful response" diff --git a/schema/overlays/app_generation.en.overlay.yaml b/schema/overlays/app_generation.en.overlay.yaml index 46be7a1..3e95615 100644 --- a/schema/overlays/app_generation.en.overlay.yaml +++ b/schema/overlays/app_generation.en.overlay.yaml @@ -11,7 +11,7 @@ actions: Dify API provides a series of interfaces for text generation functionality. It supports text generation applications. All API requests require an application-level API-Key in the Authorization HTTP Header. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template.en.mdx + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template.en.mdx - target: $.servers[0] update: @@ -192,7 +192,7 @@ actions: - target: $.paths['/completion-messages'].post.requestBody.content['application/json'].schema.properties.user update: - description: "User identifier" + description: "User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application" - target: $.paths['/completion-messages'].post.responses['200'].description update: "Successful response" @@ -262,7 +262,7 @@ actions: - target: $.paths['/files/upload'].post.requestBody.content['multipart/form-data'].schema.properties.user update: - description: "User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface" + description: "User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp" - target: $.paths['/files/upload'].post.responses['200'].description update: "Successful response" @@ -295,6 +295,14 @@ actions: update: description: "Application tags" + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.mode + update: + description: "Application mode" + + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.author_name + update: + description: "Author name" + - target: $.paths['/parameters'].get update: summary: "Get Application Parameters" @@ -496,7 +504,7 @@ actions: update: "Task ID, can be obtained from the streaming response chunks" - target: $.paths['/completion-messages/{task_id}/stop'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, must be consistent with the user passed in the message sending interface" + update: "User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp" - target: $.paths['/completion-messages/{task_id}/stop'].post.responses['200'].description update: "Successfully stopped the response" @@ -516,7 +524,7 @@ actions: update: "Like (like), dislike (dislike), or cancel rating (null)" - target: $.paths['/messages/{message_id}/feedbacks'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, defined by developer rules, must be unique within the application" + update: "User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp" - target: $.paths['/messages/{message_id}/feedbacks'].post.requestBody.content['application/json'].schema.properties.content.description update: "Specific feedback information" @@ -586,7 +594,7 @@ actions: update: "Text content for speech generation. If message_id is not provided, this field will be used" - target: $.paths['/text-to-audio'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, defined by developer rules, must be unique within the application" + update: "User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp" - target: $.paths['/text-to-audio'].post.requestBody.content['application/json'].schema.properties.streaming.description update: "Whether to use streaming mode to return audio data" diff --git a/schema/overlays/app_workflow.en.overlay.yaml b/schema/overlays/app_workflow.en.overlay.yaml index f0ecc13..2dd55fe 100644 --- a/schema/overlays/app_workflow.en.overlay.yaml +++ b/schema/overlays/app_workflow.en.overlay.yaml @@ -12,7 +12,7 @@ actions: Workflow applications have no session support and are suitable for translation/article writing/summarization AI, etc. All API requests require an application-level API-Key in the Authorization HTTP Header. It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client to prevent API-Key leakage and financial loss. - official raw document: https://github.com/langgenius/dify/blob/1.4.2/web/app/components/develop/template/template_workflow.en.mdx + official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_workflow.en.mdx - target: $.servers[0] update: @@ -297,7 +297,7 @@ actions: - target: $.paths['/workflows/run'].post.requestBody.content['application/json'].schema.properties.user.description update: | User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. - target: $.paths['/workflows/run'].post.responses['200'].description update: "Successful response" @@ -444,7 +444,7 @@ actions: update: "Task ID, can be obtained from the streaming response chunks" - target: $.paths['/workflows/tasks/{task_id}/stop'].post.requestBody.content['application/json'].schema.properties.user.description - update: "User identifier, must be consistent with the user passed in the message sending interface" + update: "User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp." - target: $.paths['/workflows/tasks/{task_id}/stop'].post.responses['200'].description update: "Successfully stopped the response" @@ -736,4 +736,10 @@ actions: update: "Default language" - target: $.paths['/site'].get.responses['200'].content['application/json'].schema.properties.show_workflow_steps.description - update: "Whether to show workflow details" \ No newline at end of file + update: "Whether to show workflow details" + + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.mode.description + update: "Application mode" + + - target: $.paths['/info'].get.responses['200'].content['application/json'].schema.properties.author_name.description + update: "Author name" \ No newline at end of file diff --git a/src/dify_sdk/advanced_chat/types/get_application_info_by_app_advanced_chat_response.py b/src/dify_sdk/advanced_chat/types/get_application_info_by_app_advanced_chat_response.py index 872a984..3208d3c 100644 --- a/src/dify_sdk/advanced_chat/types/get_application_info_by_app_advanced_chat_response.py +++ b/src/dify_sdk/advanced_chat/types/get_application_info_by_app_advanced_chat_response.py @@ -22,6 +22,16 @@ class GetApplicationInfoByAppAdvancedChatResponse(UniversalBaseModel): Application tags """ + mode: typing.Optional[str] = pydantic.Field(default=None) + """ + Application mode + """ + + author_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Author name + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/dify_sdk/chat/client.py b/src/dify_sdk/chat/client.py index 78bed83..2e16949 100644 --- a/src/dify_sdk/chat/client.py +++ b/src/dify_sdk/chat/client.py @@ -82,7 +82,7 @@ def send_chat_message_by_app_chat( Note: Blocking mode is not allowed in Agent mode user : typing.Optional[str] - User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. + User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. conversation_id : typing.Optional[str] (Optional) Conversation ID. Required when continuing a conversation based on previous chat history, must pass the conversation_id from previous messages @@ -256,7 +256,7 @@ def get_conversation_variables_by_app_chat( ID of the conversation to retrieve variables from user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. last_id : typing.Optional[str] (Optional) ID of the last record on the current page, default null @@ -344,7 +344,7 @@ def send_message_feedback_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. rating : typing.Optional[str] Rating: like, dislike, or null to cancel @@ -420,7 +420,7 @@ def get_suggested_questions_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -513,7 +513,7 @@ def stop_chat_response_by_app_chat( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -589,7 +589,7 @@ def convert_text_to_audio_by_app_chat( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. @@ -943,7 +943,7 @@ async def send_chat_message_by_app_chat( Note: Blocking mode is not allowed in Agent mode user : typing.Optional[str] - User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. + User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. conversation_id : typing.Optional[str] (Optional) Conversation ID. Required when continuing a conversation based on previous chat history, must pass the conversation_id from previous messages @@ -1130,7 +1130,7 @@ async def get_conversation_variables_by_app_chat( ID of the conversation to retrieve variables from user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. last_id : typing.Optional[str] (Optional) ID of the last record on the current page, default null @@ -1224,7 +1224,7 @@ async def send_message_feedback_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. rating : typing.Optional[str] Rating: like, dislike, or null to cancel @@ -1306,7 +1306,7 @@ async def get_suggested_questions_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1410,7 +1410,7 @@ async def stop_chat_response_by_app_chat( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1494,7 +1494,7 @@ async def convert_text_to_audio_by_app_chat( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. diff --git a/src/dify_sdk/chat/raw_client.py b/src/dify_sdk/chat/raw_client.py index b84fdc4..9cb5b4e 100644 --- a/src/dify_sdk/chat/raw_client.py +++ b/src/dify_sdk/chat/raw_client.py @@ -86,7 +86,7 @@ def send_chat_message_by_app_chat( Note: Blocking mode is not allowed in Agent mode user : typing.Optional[str] - User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. + User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. conversation_id : typing.Optional[str] (Optional) Conversation ID. Required when continuing a conversation based on previous chat history, must pass the conversation_id from previous messages @@ -361,7 +361,7 @@ def get_conversation_variables_by_app_chat( ID of the conversation to retrieve variables from user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. last_id : typing.Optional[str] (Optional) ID of the last record on the current page, default null @@ -488,7 +488,7 @@ def send_message_feedback_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. rating : typing.Optional[str] Rating: like, dislike, or null to cancel @@ -595,7 +595,7 @@ def get_suggested_questions_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -772,7 +772,7 @@ def stop_chat_response_by_app_chat( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -886,7 +886,7 @@ def convert_text_to_audio_by_app_chat( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. @@ -1371,7 +1371,7 @@ async def send_chat_message_by_app_chat( Note: Blocking mode is not allowed in Agent mode user : typing.Optional[str] - User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. + User identifier for defining end user identity, facilitating retrieval and statistics. Defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. conversation_id : typing.Optional[str] (Optional) Conversation ID. Required when continuing a conversation based on previous chat history, must pass the conversation_id from previous messages @@ -1646,7 +1646,7 @@ async def get_conversation_variables_by_app_chat( ID of the conversation to retrieve variables from user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. last_id : typing.Optional[str] (Optional) ID of the last record on the current page, default null @@ -1773,7 +1773,7 @@ async def send_message_feedback_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. rating : typing.Optional[str] Rating: like, dislike, or null to cancel @@ -1880,7 +1880,7 @@ async def get_suggested_questions_by_app_chat( Message ID user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2057,7 +2057,7 @@ async def stop_chat_response_by_app_chat( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier for defining end user identity, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2171,7 +2171,7 @@ async def convert_text_to_audio_by_app_chat( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API will not share conversations created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. diff --git a/src/dify_sdk/chat/types/get_application_info_by_app_chat_response.py b/src/dify_sdk/chat/types/get_application_info_by_app_chat_response.py index 8644feb..29cd019 100644 --- a/src/dify_sdk/chat/types/get_application_info_by_app_chat_response.py +++ b/src/dify_sdk/chat/types/get_application_info_by_app_chat_response.py @@ -22,6 +22,16 @@ class GetApplicationInfoByAppChatResponse(UniversalBaseModel): Application tags """ + mode: typing.Optional[str] = pydantic.Field(default=None) + """ + Application mode + """ + + author_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Author name + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/dify_sdk/generation/client.py b/src/dify_sdk/generation/client.py index 4641794..85f0c5c 100644 --- a/src/dify_sdk/generation/client.py +++ b/src/dify_sdk/generation/client.py @@ -77,7 +77,7 @@ def send_completion_message_by_app_generation( - blocking: Blocking mode, returns result after execution is complete user : typing.Optional[str] - User identifier + User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application files : typing.Optional[typing.Sequence[FileInput]] @@ -117,7 +117,7 @@ def upload_file_by_app_generation( See core.File for more documentation user : str - User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -198,7 +198,7 @@ def stop_completion_response_by_app_generation( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -240,7 +240,7 @@ def send_message_feedback_by_app_generation( Like (like), dislike (dislike), or cancel rating (null) user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp content : typing.Optional[str] Specific feedback information @@ -322,7 +322,7 @@ def convert_text_to_audio_by_app_generation( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp streaming : typing.Optional[bool] Whether to use streaming mode to return audio data @@ -647,7 +647,7 @@ async def send_completion_message_by_app_generation( - blocking: Blocking mode, returns result after execution is complete user : typing.Optional[str] - User identifier + User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application files : typing.Optional[typing.Sequence[FileInput]] @@ -691,7 +691,7 @@ async def upload_file_by_app_generation( See core.File for more documentation user : str - User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -781,7 +781,7 @@ async def stop_completion_response_by_app_generation( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -826,7 +826,7 @@ async def send_message_feedback_by_app_generation( Like (like), dislike (dislike), or cancel rating (null) user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp content : typing.Optional[str] Specific feedback information @@ -914,7 +914,7 @@ async def convert_text_to_audio_by_app_generation( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp streaming : typing.Optional[bool] Whether to use streaming mode to return audio data diff --git a/src/dify_sdk/generation/raw_client.py b/src/dify_sdk/generation/raw_client.py index 3cd8f72..1d0bb39 100644 --- a/src/dify_sdk/generation/raw_client.py +++ b/src/dify_sdk/generation/raw_client.py @@ -81,7 +81,7 @@ def send_completion_message_by_app_generation( - blocking: Blocking mode, returns result after execution is complete user : typing.Optional[str] - User identifier + User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application files : typing.Optional[typing.Sequence[FileInput]] @@ -183,7 +183,7 @@ def upload_file_by_app_generation( See core.File for more documentation user : str - User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -345,7 +345,7 @@ def stop_completion_response_by_app_generation( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -403,7 +403,7 @@ def send_message_feedback_by_app_generation( Like (like), dislike (dislike), or cancel rating (null) user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp content : typing.Optional[str] Specific feedback information @@ -517,7 +517,7 @@ def convert_text_to_audio_by_app_generation( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp streaming : typing.Optional[bool] Whether to use streaming mode to return audio data @@ -956,7 +956,7 @@ async def send_completion_message_by_app_generation( - blocking: Blocking mode, returns result after execution is complete user : typing.Optional[str] - User identifier + User identifier, used to define the identity of the end user for easy retrieval and statistics. Developer-defined rules must ensure that the user identifier is unique within the application files : typing.Optional[typing.Sequence[FileInput]] @@ -1058,7 +1058,7 @@ async def upload_file_by_app_generation( See core.File for more documentation user : str - User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. Service API does not share sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1220,7 +1220,7 @@ async def stop_completion_response_by_app_generation( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, used to define the identity of the end user, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1278,7 +1278,7 @@ async def send_message_feedback_by_app_generation( Like (like), dislike (dislike), or cancel rating (null) user : str - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp content : typing.Optional[str] Specific feedback information @@ -1392,7 +1392,7 @@ async def convert_text_to_audio_by_app_generation( Text content for speech generation. If message_id is not provided, this field will be used user : typing.Optional[str] - User identifier, defined by developer rules, must be unique within the application + User identifier, defined by developer rules, must be unique within the application. Service API does not share sessions created by WebApp streaming : typing.Optional[bool] Whether to use streaming mode to return audio data diff --git a/src/dify_sdk/generation/types/get_application_info_by_app_generation_response.py b/src/dify_sdk/generation/types/get_application_info_by_app_generation_response.py index dd86070..9e3fa89 100644 --- a/src/dify_sdk/generation/types/get_application_info_by_app_generation_response.py +++ b/src/dify_sdk/generation/types/get_application_info_by_app_generation_response.py @@ -22,6 +22,16 @@ class GetApplicationInfoByAppGenerationResponse(UniversalBaseModel): Application tags """ + mode: typing.Optional[str] = pydantic.Field(default=None) + """ + Application mode + """ + + author_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Author name + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/dify_sdk/workflow/client.py b/src/dify_sdk/workflow/client.py index 04330b1..d119525 100644 --- a/src/dify_sdk/workflow/client.py +++ b/src/dify_sdk/workflow/client.py @@ -71,7 +71,7 @@ def run_workflow( user : str User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -135,7 +135,7 @@ def stop_workflow( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -352,7 +352,7 @@ async def run_workflow( user : str User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -425,7 +425,7 @@ async def stop_workflow( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/dify_sdk/workflow/raw_client.py b/src/dify_sdk/workflow/raw_client.py index 79086b0..9085e38 100644 --- a/src/dify_sdk/workflow/raw_client.py +++ b/src/dify_sdk/workflow/raw_client.py @@ -75,7 +75,7 @@ def run_workflow( user : str User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -254,7 +254,7 @@ def stop_workflow( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -812,7 +812,7 @@ async def run_workflow( user : str User identifier, used to define the identity of the end user, for easy retrieval and statistics. - Rules defined by the developer, the user identifier must be unique within the application. + Rules defined by the developer, the user identifier must be unique within the application. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -991,7 +991,7 @@ async def stop_workflow( Task ID, can be obtained from the streaming response chunks user : str - User identifier, must be consistent with the user passed in the message sending interface + User identifier, must be consistent with the user passed in the message sending interface. API cannot access sessions created by WebApp. request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/dify_sdk/workflow/types/get_app_info_response.py b/src/dify_sdk/workflow/types/get_app_info_response.py index c6a60b1..f0b5291 100644 --- a/src/dify_sdk/workflow/types/get_app_info_response.py +++ b/src/dify_sdk/workflow/types/get_app_info_response.py @@ -22,6 +22,16 @@ class GetAppInfoResponse(UniversalBaseModel): Application tags """ + mode: typing.Optional[str] = pydantic.Field(default=None) + """ + Application mode + """ + + author_name: typing.Optional[str] = pydantic.Field(default=None) + """ + Author name + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/tests/knowledge_base/test_datasets_api.py b/tests/knowledge_base/test_datasets_api.py index 17e8e8d..2f74e2d 100644 --- a/tests/knowledge_base/test_datasets_api.py +++ b/tests/knowledge_base/test_datasets_api.py @@ -126,7 +126,7 @@ async def test_datasets_workflow(kb_client: KnowledgeBaseClient, test_text_file: async def test_metadata_filtering_conditions(kb_client: KnowledgeBaseClient, test_text_file: Path): - """测试元数据过滤条件功能 (1.4.2新增)""" + """测试元数据过滤条件功能 """ # 1. 创建测试数据集 dataset = await kb_client.dataset.create_empty_dataset( @@ -206,7 +206,7 @@ async def test_metadata_filtering_conditions(kb_client: KnowledgeBaseClient, tes async def test_multiple_metadata_conditions(kb_client: KnowledgeBaseClient): - """测试多个元数据过滤条件 (1.4.2新增)""" + """测试多个元数据过滤条件 """ # 创建测试数据集 dataset = await kb_client.dataset.create_empty_dataset( diff --git a/tests/knowledge_base/test_segments_api.py b/tests/knowledge_base/test_segments_api.py index 3b96436..9130ac8 100644 --- a/tests/knowledge_base/test_segments_api.py +++ b/tests/knowledge_base/test_segments_api.py @@ -202,7 +202,7 @@ async def test_segments_workflow( async def test_get_segment_detail_basic( kb_client: KnowledgeBaseClient, dataset_for_seg1: Dataset, document_for_seg1: Document ): - """测试获取文档分段详情功能 (1.4.2新增)""" + """测试获取文档分段详情功能 """ dataset_id = str(dataset_for_seg1.id) document_id = str(document_for_seg1.id) diff --git a/tests/knowledge_base/test_tags_api.py b/tests/knowledge_base/test_tags_api.py index 4aa2855..8763f10 100644 --- a/tests/knowledge_base/test_tags_api.py +++ b/tests/knowledge_base/test_tags_api.py @@ -1,5 +1,5 @@ """ -测试知识库标签管理 API 的完整工作流程 (1.4.2新功能) +测试知识库标签管理 API 的完整工作流程 """ import pytest diff --git a/uv.lock b/uv.lock index 037bc6f..b85e13f 100644 --- a/uv.lock +++ b/uv.lock @@ -158,7 +158,7 @@ wheels = [ [[package]] name = "dify-openapi" -version = "1.4.2" +version = "1.4.3" source = { editable = "." } dependencies = [ { name = "httpx" },