Skip to content

Commit 5d7556d

Browse files
RiskeyLRiskey
andauthored
Refine docs based on readability, usability, and enterprise PM feedback (#619)
* Refine docs based on internal feedback * update the zh and ja docs --------- Co-authored-by: Riskey <riskey47@dify.ai>
1 parent 821b83c commit 5d7556d

15 files changed

Lines changed: 99 additions & 93 deletions

File tree

en/use-dify/knowledge/create-knowledge/import-text-data/readme.mdx

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,34 @@ When quick-creating a knowledge base, you can upload local files as its data sou
1212

1313
2. Select **Import from file** as the data source, then upload your files.
1414

15-
- Maximum file size: 15 MB
16-
1715
- Maximum number of files per upload: 5
1816

19-
<Info>
20-
On Dify Cloud, **batch uploading** is only available on [the **Professional** and **Team** plans](https://dify.ai/pricing).
21-
</Info>
17+
<Info>
18+
On Dify Cloud, **batch uploading** (up to 50 files per upload) is only available on [paid plans](https://dify.ai/pricing).
19+
</Info>
20+
21+
- Maximum file size: 15 MB
22+
23+
<Tip>
24+
For self-hosted deployments, you can adjust these two limits via the environment variables `UPLOAD_FILE_SIZE_LIMIT` and `UPLOAD_FILE_BATCH_LIMIT`.
25+
</Tip>
2226

2327
---
2428

2529
**For Images in Uploaded Files**
2630

27-
JPG, JPEG, PNG, and GIF images under 2 MB are automatically extracted as attachments to their corresponding chunks. These images can be managed independently and are returned alongside their chunks during retrieval.
31+
JPG, JPEG, PNG, and GIF images under 2 MB are automatically extracted as attachments to their corresponding chunks. These images can be managed independently and are returned alongside their chunks during retrieval.
32+
33+
Each chunk supports up to 10 image attachments; images beyond this limit will not be extracted.
2834

2935
<Tip>
30-
For self-hosted deployments, you can adjust the size limit via the environment variable `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`.
36+
For self-hosted deployments, you can adjust the following limits via environment variables:
37+
38+
- Maximum image size: `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`
39+
40+
- Maximum number of attachments per chunk: `SINGLE_CHUNK_ATTACHMENT_LIMIT`
3141
</Tip>
3242

33-
<Note>
34-
Each chunk supports up to 10 image attachments; images beyond this limit will not be extracted.
35-
36-
For self-hosted deployments, you can adjust this limit via the environment variable `SINGLE_CHUNK_ATTACHMENT_LIMIT`.
37-
</Note>
38-
3943
The above extraction rule applies to:
4044

4145
- Images embedded in DOCX files

en/use-dify/knowledge/create-knowledge/setting-indexing-methods.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ Similar to the search engines use efficient indexing algorithms to match search
1010

1111
The knowledge base offers two index methods: **High-Quality** and **Economical**, each with different retrieval setting options.
1212

13-
<Note>
14-
The original **Q\&A mode (available only for the Community Edition)** is now an optional feature under the High Quality index method.
15-
</Note>
16-
1713
<Tabs>
1814
<Tab title="High Quality">
1915

@@ -35,8 +31,12 @@ The knowledge base offers two index methods: **High-Quality** and **Economical**
3531

3632
The High-Quality index method supports three retrieval strategies: vector search, full-text search, or hybrid search. Learn more in [Configure the Retrieval Settings](#configure-the-retrieval-settings).
3733

38-
### Enable Q&A Mode (Optional, Community Edition Only)
39-
34+
### Q&A Mode
35+
36+
<Info>
37+
Q&A mode is available for self-hosted deployments only.
38+
</Info>
39+
4040
When this mode is enabled, the system segments the uploaded text and automatically generates Q\&A pairs for each segment after summarizing its content.
4141

4242
Compared with the common **Q to P** strategy (user questions matched with text paragraphs), the Q\&A mode uses a **Q to Q** strategy (questions matched with questions).

en/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -196,22 +196,22 @@ You can choose Dify's Doc Extractor to process files, or select tools based on y
196196

197197
<Accordion title="For images in documents">
198198

199-
Images in documents can be extracted using appropriate doc processors. Extracted images are attached to their corresponding chunks, can be managed independently, and are returned alongside those chunks during retrieval.
199+
Images in documents can be extracted using appropriate doc processors. Extracted images are attached to their corresponding chunks, can be managed independently, and are returned alongside those chunks during retrieval.
200+
201+
Each chunk supports up to 10 image attachments; images beyond this limit will not be extracted.
200202

201203
If no images are extracted by the selected processor, Dify will automatically extract JPG, JPEG, PNG, and GIF images under 2 MB that are referenced via accessible URLs using the following Markdown syntax:
202204

203205
- `![alt text](image_url)`
204206
- `![alt text](image_url "optional title")`
205207

206208
<Tip>
207-
For self-hosted deployments, you can adjust the size limit via the environment variable `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`.
208-
</Tip>
209+
For self-hosted deployments, you can adjust these limits via environment variables:
209210

210-
<Note>
211-
Each chunk supports up to 10 image attachments; images beyond this limit will not be extracted.
211+
- Maximum image size: `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`
212212

213-
For self-hosted deployments, you can adjust this limit via the environment variable `SINGLE_CHUNK_ATTACHMENT_LIMIT`.
214-
</Note>
213+
- Maximum number of attachments per chunk: `SINGLE_CHUNK_ATTACHMENT_LIMIT`
214+
</Tip>
215215

216216
If you select a multimodal embedding model (indicated by the **Vision** icon) in subsequent index settings, the extracted images will be embedded and indexed for retrieval.
217217

@@ -419,7 +419,7 @@ In the Economical method, each block uses 10 keywords for retrieval without call
419419
| Economical | Inverted Index | Common search engine retrieval method, matches queries with key content |
420420

421421
<Note>
422-
If candidate chunks may include image attachments, select a multimodal rerank model (indicated by the **Vision** icon). Otherwise, images will be excluded from reranking and the retrieval results.
422+
If the selected embedding model is multimodal, select a multimodal rerank model (indicated by the **Vision** icon) as well. Otherwise, retrieved images will be excluded from reranking and the retrieval results.
423423
</Note>
424424

425425
You can also refer to the table below for information on configuring chunk structure, index methods, parameters, and retrieval settings.

en/use-dify/knowledge/knowledge-request-rate-limit.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ icon: "gauge"
44
tag: "CLOUD"
55
---
66

7-
We will implement Knowledge Request Rate Limits starting **February 24, 2025**, to ensure optimal service performance and a better knowledge experience for all users.
8-
97
## What is Knowledge Request Rate Limit?
108

11-
Knowledge Request Rate Limit refers to the maximum number of actions that a workspace can perform in the knowledge base within one minute. These actions include creating datasets, managing documents, and running queries in apps or workflows.
9+
On Dify Cloud, the knowledge request rate limit refers to the maximum number of actions that a workspace can perform in the knowledge base within one minute. These actions include creating datasets, managing documents, and running queries in apps or workflows.
1210

1311
## Limitations of Different Subscription Versions
1412

en/use-dify/monitor/logs.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,17 @@ Team members can add internal notes and improved responses directly in the log i
5050
**Feedback Analysis**
5151
Identify common complaint patterns, successful interaction types, and areas needing improvement.
5252

53-
## Data Retention
53+
## Log Retention
5454

5555
<Warning>
5656
Ensure your application complies with local data privacy regulations. Publish a privacy policy and obtain user consent where required.
5757
</Warning>
5858

59-
**Free Plans:** Logs are retained for 30 days
60-
**Paid Plans:** Extended retention based on plan tier
61-
**Self-Hosted:** Configurable retention policy
59+
- **Sandbox**: Logs are retained for 30 days.
60+
61+
- **Professional & Team**: Unlimited log retention during active subscription.
62+
63+
- **Self-hosted**: Unlimited by default; configurable via environment variables `WORKFLOW_LOG_CLEANUP_ENABLED`, `WORKFLOW_LOG_RETENTION_DAYS`, and `WORKFLOW_LOG_CLEANUP_BATCH_SIZE`.
6264

6365
## Improving Applications with Logs
6466

ja/use-dify/knowledge/create-knowledge/import-text-data/readme.mdx

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,34 @@ title: ローカルファイルをアップロード
1414

1515
2. データソースとして **既存テキストをインポート** を選択し、ファイルをアップロードします。
1616

17-
- 1ファイルの最大サイズ:15 MB
17+
- 1回のアップロードで選択できるファイル数の上限:5
1818

19-
- 1回のアップロードで最大5ファイルまで
19+
<Info>
20+
Dify Cloudでは、**バッチアップロード**(1回につき最大50ファイル)は[有料プラン](https://dify.ai/jp/pricing)でのみ利用可能です。
21+
</Info>
2022

21-
<Info>
22-
Dify Cloudでは、**一括アップロード**[**Professional**および**Team**プラン](https://dify.ai/pricing)のみ対応しています。
23-
</Info>
23+
- ファイルサイズの上限:15MB
24+
25+
<Tip>
26+
セルフホスト環境では、これら2つの上限は環境変数 `UPLOAD_FILE_SIZE_LIMIT` および `UPLOAD_FILE_BATCH_LIMIT` で調整できます。
27+
</Tip>
2428

2529
---
2630

2731
**アップロードファイル内の画像について**
2832

2933
JPG、JPEG、PNG、GIF形式で2MB未満の画像は、該当するチャンクの添付ファイルとして自動抽出されます。これらの画像は個別に管理でき、検索時にチャンクと一緒に返されます。
34+
35+
1チャンクにつき最大10枚まで画像添付が可能です。超過分は抽出されません。
3036

3137
<Tip>
32-
セルフホスト環境では、環境変数 `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT` で画像サイズ上限を調整できます。
38+
セルフホスト環境では、以下の上限を環境変数で調整できます:
39+
40+
- 画像サイズの上限:`ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`
41+
42+
- 1チャンクあたりの添付画像数上限:`SINGLE_CHUNK_ATTACHMENT_LIMIT`
3343
</Tip>
3444

35-
<Note>
36-
1チャンクにつき最大10枚まで画像添付が可能です。超過分は抽出されません。
37-
38-
セルフホスト環境では、環境変数 `SINGLE_CHUNK_ATTACHMENT_LIMIT` でこの上限を調整できます。
39-
</Note>
40-
4145
抽出ルールの対象:
4246

4347
- DOCXファイルに埋め込まれた画像

ja/use-dify/knowledge/create-knowledge/setting-indexing-methods.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: インデックス方法と検索設定を指定
1010

1111
検索エンジンが効率的なインデックスアルゴリズムを通じてユーザーの質問に最も関連するウェブページコンテンツをマッチングするように、インデックス方法の適切さはLLMがナレッジベース内のコンテンツを検索する効率と回答の正確性に直接影響します。
1212

13-
**高品質****エコノミー**の2種類のインデックス方法を提供しており、それぞれ異なる検索設定オプションがあります
13+
**高品質****エコノミー**の2種類のインデックス方法を提供しており、それぞれ異なる検索設定オプションがあります
1414

1515
<Note>
1616
元のQ&Aモード(コミュニティ版のみ対応)は、高品質インデックス方法のオプションになりました。
@@ -39,7 +39,7 @@ title: インデックス方法と検索設定を指定
3939

4040
高品質インデックス方式では、ベクトル検索・全文検索・ハイブリッド検索の3つの検索戦略がサポートされています。詳細は[検索設定の指定](#検索方法の指定)をご覧ください。
4141

42-
**Q\&Aモードの有効化(オプション、コミュニティ版のみ**
42+
**Q\&Aモードの有効化(セルフホスト環境のみ対応**
4343

4444
このモードを有効にすると、システムはアップロードされたテキストを分割し、各分割のコンテンツを要約して自動的にQ\&Aマッチングペアを生成します。一般的な「Q to P」(ユーザーの質問がテキスト段落にマッチング)戦略とは異なり、QAモードでは「Q to Q」(質問が質問にマッチング)戦略を採用しています。
4545

ja/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,22 +186,22 @@ Difyのドキュメント抽出器、あるいはMarketplaceから「Dify Extrac
186186
<Accordion title="ドキュメント内の画像">
187187

188188
ドキュメント内の画像は、適切なドキュメントプロセッサを使用して抽出できます。抽出された画像は対応するチャンクに添付され、個別に管理でき、検索時にはそのチャンクと一緒に返されます。
189+
190+
各チャンクには最大10枚まで画像を添付できます。これを超える画像は抽出されません。
189191

190192
選択したプロセッサで画像が抽出されなかった場合、Difyは以下のMarkdown記法でアクセス可能なURLが参照されている2MB未満のJPG、PNG、GIF画像を自動的に抽出します:
191193

192194
- `![alt text](image_url)`
193195
- `![alt text](image_url "optional title")`
194196

195197
<Tip>
196-
セルフホスト環境では、環境変数 `ATTACHMENT_IMAGE_FILE_SIZE_LIMIT` でサイズ上限を調整できます。
198+
セルフホスト環境では、以下の上限を環境変数で調整できます:
199+
200+
- 画像サイズの上限:`ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`
201+
202+
- 1チャンクあたりの添付画像数上限:`SINGLE_CHUNK_ATTACHMENT_LIMIT`
197203
</Tip>
198204

199-
<Note>
200-
各チャンクには最大10枚まで画像を添付できます。これを超える画像は抽出されません。
201-
202-
セルフホスト環境では、環境変数 `SINGLE_CHUNK_ATTACHMENT_LIMIT` でこの上限を調整できます。
203-
</Note>
204-
205205
その後のインデックス設定で**Vision**アイコン付きのマルチモーダル埋め込みモデルを選択した場合、抽出された画像も埋め込み・インデックス化され、検索対象となります。
206206

207207
</Accordion>

ja/use-dify/knowledge/knowledge-request-rate-limit.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ tag: "CLOUD"
66

77
<Note> ⚠️ このドキュメントはAIによって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/use-dify/knowledge/knowledge-request-rate-limit)を参照してください。</Note>
88

9-
Dify クラウドサービスの安定性を維持し、すべてのユーザーにより良いナレッジベース利用体験を向上させるため、**2025 年 2 月 24 日** よりナレッジリクエストレート頻度制限(Knowledge Request Rate Limit)を導入します。
10-
119
## ナレッジベースの要求頻度制限とは?
1210

13-
ナレッジリクエスト頻度制限とは、1つのワークスペースがナレッジベースに対して1分間に実行できる最大リクエスト数のことです。この操作には、データセットの作成、ドキュメントの管理、アプリケーションやワークフローにおけるナレッジベースのクエリなどが含まれます
11+
「Dify Cloud」では、ナレッジリクエスト頻度制限とは、ワークスペースが1分間にナレッジベース内で実行できる操作の最大回数を指します。これには、データセットの作成、ドキュメントの管理、アプリやワークフローでのクエリ実行などが含まれます
1412

1513
## サブスクリプションバージョンの制限値
1614

ja/use-dify/monitor/logs.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,17 @@ AIが不適切な応答をしたり、ユーザーの意図を理解できなか
5353
**フィードバック分析**
5454
一般的な苦情パターン、成功したやり取りタイプ、改善が必要な分野を特定できます。
5555

56-
## データ保持
56+
## ログの保持期間
5757

5858
<Warning>
5959
アプリケーションが現地のデータプライバシー規制に準拠していることを確認してください。プライバシーポリシーを公開し、必要に応じ
6060
</Warning>
6161

62-
**無料プラン:** ログは30日間保持されます
63-
**有料プラン:** プラン階層に基づく延長保持
64-
**セルフホスト:** 設定可能な保持ポリシー
62+
- **Sandbox**:ログは30日間保持されます。
63+
64+
- **Professional & Team**:アクティブなサブスクリプション期間中はログ保持期間が無制限です。
65+
66+
- **セルフホスト**:デフォルトで無制限ですが、環境変数 `WORKFLOW_LOG_CLEANUP_ENABLED``WORKFLOW_LOG_RETENTION_DAYS``WORKFLOW_LOG_CLEANUP_BATCH_SIZE` で設定可能です。
6567

6668
## ログを使ったアプリケーションの改善
6769

0 commit comments

Comments
 (0)