Commit Graph

631 Commits

Author SHA1 Message Date
Tianzhi Jin
1d8dd0457d Correct external knowledge api documentation link (#500)
* Correct external knowledge api documentation link

* Found and fixed another link

Found and fixed another instance of the same wrong link while reviewing @invzhi's fix in pr#500

---------

Co-authored-by: Riskey <36894937+RiskeyL@users.noreply.github.com>
2025-10-31 17:44:27 +08:00
sunshinesDL
4e47eb05c1 Update chunking-and-cleaning-text.mdx (#345)
* Update chunking-and-cleaning-text.mdx

原文中 '通用模式' 小节中,关于 '分段标识符' 的解释中描述如下:
`分段标识符,默认值为 \n,即按照文章段落进行分块。你可以遵循正则表达式语法自定义分块规则,系统将在文本出现分段标识符时自动执行分段。例如 的含义是按照句子进行分段。下图是不同语法的文本分段效果:`
`例如` 后好像缺少了转义字符,这里补充正则表达式 `(?<=[.!?])\s+` 以查找句子结束标点(., !, ?)后的空白字符,从而按照句子分段。
此外,在 "父子模式" 小节中,以下内容好像也遗漏了转义字符:
`在子分段内填写以下分段设置:
分段标识符,默认值为 ,即按照句子进行分段。你可以遵循正则表达式语法自定义分块规则,系统将在文本出现分段标识符时自动执行分段。`
这里补充 `\.|\!|\?` 作为按句子分段的标识符,供作者审核。

* correct, update, and remove expired content

---------

Co-authored-by: Riskey <riskey47@dify.ai>
2025-10-31 17:43:10 +08:00
Tianyi Jing
b20d35bc48 fix: url of 0222-tool-oauth (#495)
Signed-off-by: jingfelix <jingfelix@outlook.com>
2025-10-31 16:43:25 +08:00
vitalplayer
c170ef8613 Update docs-contribution.mdx (#446)
Docs: add replace inappropriate words
2025-10-31 16:35:19 +08:00
Riskey
53c4c93b1e add docs for trigger (#504)
* draft

* draft

* draft

* refine dev docs

* almost

* update

* remove sys.file and sys.query; add sys.timestamp

* update the end node to output

* modify the introduction section of variable

* fix typo

* adjust image size

* remove unnecessary list

* feedback fix

* remove example

* feedback fix & add en/ja dev docs

* correct description

* fix typos

* replace UI text

* refinements & add zh-ja translation

* feedback fixes

* fix punctuation

* refine heading-reference

* typo

* adjust casing & remove sys.timestamp from chatflow

* Docs tools: 2 succeeded, some failed

Rename operation failed: - Lang 'zh': File 'dify-docs/plugin-dev-zh/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0222-datasource-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0222-tool-oauth.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0222-trigger-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'en': File 'dify-docs/plugin-dev-en/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0222-datasource-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'en': File 'dify-docs/plugin-dev-en/0222-tool-oauth.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'en': File 'dify-docs/plugin-dev-en/0222-trigger-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0222-datasource-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0222-trigger-plugin.mdx' - Skipped (non-compliant):
Missing/empty critical frontmatter fields for renaming: dimensions.type.primary, dimensions.type.detail, dimensions.level, standard_title, language (expected for metadata, though not used in filename suffix anymore).

---------

Co-authored-by: Riskey <riskey47@dify.ai>
Co-authored-by: alterxyz <88554920+alterxyz@users.noreply.github.com>
2025-10-30 21:11:33 +08:00
Riskey
c975dd5571 further refinements (#503)
Co-authored-by: Riskey <riskey47@dify.ai>
2025-10-30 17:47:19 +08:00
Riskey
6ffdbd3f17 draft (#494)
Co-authored-by: Riskey <riskey47@dify.ai>
2025-10-30 17:28:02 +08:00
Chenhe Gu
d9fb3dc2b1 remove general docs from footer addition (#498) 2025-10-28 15:34:56 -07:00
David Liu
8784682ce4 Update variable-assigner.mdx (#476)
align to new link.
2025-10-21 20:11:18 +08:00
Hsiaoming Yang
397256d928 Remove pyenv from documentation (#477)
`uv` will automatically install the required python, `pyenv` is not needed.
2025-10-21 20:09:51 +08:00
lyzno1
129ee6bfc6 docs: update Node.js and package manager requirements in contribution guides (#436) 2025-10-21 20:09:44 +08:00
Koya Masuda
99f3366781 fix: correct "Github" to "GitHub" in multiple documents and update deprecation notices (#487)
Co-authored-by: Koya Masuda <71430401+koya-masuda@users.noreply.github.com>
2025-10-21 20:08:33 +08:00
Dhruv Gorasiya
9e0858aea4 Weaviate Migration Guide upgrading to Client v4 and Server 1.27+ (#485)
* Weaviate Migration Guide upgrading to Client v4 and Server 1.27+

* Update weaviate-v4-migration.mdx

* Final weaviate migration docs
2025-10-21 20:06:13 +08:00
Hanqing Zhao
6e1454eccc Merge pull request #481 from langgenius/fix-blank-code-page
Fix blank code page & do some refinements
2025-10-11 13:43:39 +08:00
Riskey
287f4ed5ae grammar fix 2025-10-11 13:38:15 +08:00
Riskey
aa8add1062 typo 2025-10-11 12:05:03 +08:00
Riskey
c785efaf69 updates 2025-10-11 11:43:18 +08:00
Riskey
c13c061be3 fix the blank zh pages and refine 2025-10-10 18:57:25 +08:00
Riskey
de587fb570 Add data source plugin dev docs (#474) 2025-09-30 21:07:13 +08:00
Junyan Qin (Chin)
fe4d97fae3 doc: zh_hans draft for plugin multilingual readme std (#472)
* doc: zh_hans draft for plugin multilingual readme std

* Docs tools: Successfully completed 3 operations

* Documentation edits made through Mintlify web editor

* Docs tools: 2 succeeded, some failed

Rename operation failed: - Lang 'zh': File 'dify-docs/plugin-dev-zh/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'

* Documentation edits made through Mintlify web editor

* Docs tools: 2 succeeded, some failed

Rename operation failed: - Lang 'zh': File 'dify-docs/plugin-dev-zh/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'

* Documentation edits made through Mintlify web editor

* Docs tools: 2 succeeded, some failed

Rename operation failed: - Lang 'zh': File 'dify-docs/plugin-dev-zh/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'zh': File 'dify-docs/plugin-dev-zh/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'en': File 'dify-docs/plugin-dev-en/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0211-getting-started-dify-tool.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'
- Lang 'ja': File 'dify-docs/plugin-dev-ja/0411-multilingual-readme.mdx' - Renaming error: Unexpected error: 'str' object has no attribute 'get'

* Documentation edits made through Mintlify web editor

---------

Co-authored-by: alterxyz <88554920+alterxyz@users.noreply.github.com>
Co-authored-by: Riskey <36894937+RiskeyL@users.noreply.github.com>
2025-09-30 10:41:57 +08:00
Chenhe Gu
95ab596360 Merge pull request #469 from HanqingZ/fix/modify-knowledge-pipeline 2025-09-26 19:29:26 +09:00
Hanqing Zhao
273cc42f39 Modify knowledge pipeline 2025-09-26 18:23:03 +08:00
Zhedong Cen
30407e71e1 Fix incorrect link (#462) 2025-09-22 13:36:59 +08:00
Steve Rao
9f02b6734b Fix formatting and links in integrate-aliyun.mdx (#449) 2025-09-22 13:36:52 +08:00
heyszt
b6f94cdc5d fix aliyun doc typo (#456) 2025-09-22 13:35:55 +08:00
Chenhe Gu
b364830067 updates to RAG API (#463)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor
2025-09-11 21:10:24 +08:00
Chenhe Gu
f7c52afa1e Merge pull request #458 from langgenius/oauth-zh-docs
Add zh docs and update some formatting in en docs for oauth support
2025-09-09 11:31:00 +09:00
alterxyz
a0eb58b8fd Docs tools: Successfully completed 3 operations 2025-09-09 02:22:00 +00:00
Riskey
2ea5bb9bd4 Documentation edits made through Mintlify web editor 2025-09-09 10:16:25 +08:00
Riskey
7e5d2700d4 Documentation edits made through Mintlify web editor 2025-09-09 10:13:47 +08:00
Riskey
14a142fa65 Documentation edits made through Mintlify web editor 2025-09-09 10:10:33 +08:00
Riskey
df91b11e94 Documentation edits made through Mintlify web editor 2025-09-09 10:07:51 +08:00
Riskey
5bc7403330 Documentation edits made through Mintlify web editor 2025-09-09 10:04:03 +08:00
Riskey
c291cb773f Documentation edits made through Mintlify web editor 2025-09-09 09:58:46 +08:00
Riskey
e3131c3f1f Documentation edits made through Mintlify web editor 2025-09-09 09:57:59 +08:00
Riskey
9d6a5dbcec Documentation edits made through Mintlify web editor 2025-09-09 09:57:27 +08:00
Riskey
cceb8e6cf6 Documentation edits made through Mintlify web editor 2025-09-09 09:55:28 +08:00
Riskey
30932e9fce Documentation edits made through Mintlify web editor 2025-09-09 09:55:15 +08:00
Riskey
a3e93a407c Documentation edits made through Mintlify web editor 2025-09-09 09:54:56 +08:00
Riskey
343772062f Documentation edits made through Mintlify web editor 2025-09-09 09:53:27 +08:00
Riskey
fd348d56c8 Documentation edits made through Mintlify web editor 2025-09-08 19:55:17 +08:00
Riskey
067d183683 Documentation edits made through Mintlify web editor 2025-09-08 19:53:18 +08:00
Riskey
990005b882 Documentation edits made through Mintlify web editor 2025-09-08 19:47:08 +08:00
Riskey
e005ab1a14 Documentation edits made through Mintlify web editor 2025-09-08 19:29:19 +08:00
Riskey
3f76b9d2de Documentation edits made through Mintlify web editor 2025-09-08 19:24:11 +08:00
Riskey
6580509c93 Documentation edits made through Mintlify web editor 2025-09-08 19:23:49 +08:00
Chenhe Gu
185c08d863 Merge pull request #454 from langgenius/multi-credential/siqi
refine images and fix a broken link
2025-09-07 18:22:13 +09:00
Riskey
00fe4f7477 refine images and fix a broken link 2025-09-05 22:14:46 +08:00
lyzno1
95ace3d9af Add file-preview API to OpenAPI specifications (#435)
* feat(en): add file-preview API to OpenAPI specifications

- Add GET /files/{file_id}/preview endpoint to chat, chatflow, and workflow APIs
- Support file preview and download with as_attachment parameter
- Include proper error handling (400, 403, 404, 500)
- Update Files tag descriptions to include preview operations
- Maintain unique operationIds for each API type
- Align with existing API patterns and template specifications

Resolves: #389

* feat(ja-jp): add file-preview API to Japanese OpenAPI specifications

- Add GET /files/{file_id}/preview endpoint to chat, chatflow, and workflow APIs
- Use Japanese descriptions and maintain "Ja"/"Jp" operationId suffixes
- Support file preview and download with as_attachment parameter
- Include proper error handling with Japanese error messages
- Update Files tag descriptions to include preview operations
- Maintain consistency with existing Japanese API patterns

Related: #389

* feat(zh-hans): add file-preview API to Chinese OpenAPI specifications

- Add GET /files/{file_id}/preview endpoint to chat, chatflow, and workflow APIs
- Use Chinese descriptions and maintain "Cn" operationId suffixes
- Support file preview and download with as_attachment parameter
- Include proper error handling with Chinese error messages
- Update Files tag descriptions to include preview operations
- Maintain consistency with existing Chinese API patterns

Related: #389
2025-09-05 19:05:59 +08:00
Chenhe Gu
666afb9ed7 Merge pull request #451 from langgenius/multi-credential/siqi
Add docs for multi-credential-management
2025-09-05 19:28:13 +09:00