Selaa lähdekoodia

Docs: Miscellaneous (#8198)

### What problem does this PR solve?

### Type of change

- [x] Documentation Update
tags/v0.19.1
writinwaters 4 kuukautta sitten
vanhempi
commit
d331866a12
No account linked to committer's email address
2 muutettua tiedostoa jossa 30 lisäystä ja 17 poistoa
  1. 13
    1
      docs/faq.mdx
  2. 17
    16
      docs/guides/dataset/autokeyword_autoquestion.mdx

+ 13
- 1
docs/faq.mdx Näytä tiedosto

@@ -127,7 +127,19 @@ The corresponding APIs are now available. See the [RAGFlow HTTP API Reference](.

### Do you support stream output?

Yes, we do.
Yes, we do. Stream output is enabled by default in the chat assistant and agent. Note that you cannot disable stream output via RAGFlow's UI. To disable stream output in responses, use RAGFlow's Python or RESTful APIs:

Python:

- [Create chat completion](./references/python_api_reference.md#create-chat-completion)
- [Converse with chat assistant](./references/python_api_reference.md#converse-with-chat-assistant)
- [Converse with agent](./references/python_api_reference.md#converse-with-agent)

RESTful:

- [Create chat completion](./references/http_api_reference.md#create-chat-completion)
- [Converse with chat assistant](./references/http_api_reference.md#converse-with-chat-assistant)
- [Converse with agent](./references/http_api_reference.md#converse-with-agent)

---


+ 17
- 16
docs/guides/dataset/autokeyword_autoquestion.mdx Näytä tiedosto

@@ -10,44 +10,45 @@ Use a chat model to generate keywords and questions from each chunk in the knowl

---

When selecting a chunking method, you can also enable auto-keyword or auto-question generation to increase retrieval rates. This feature uses a chat model to produce a specified number of keywords and questions from each created chunk, generating a layer of higher-level information from the original content.
When selecting a chunking method, you can also enable auto-keyword or auto-question generation to increase retrieval rates. This feature uses a chat model to produce a specified number of keywords and questions from each created chunk, generating a layer of "higher-level information" from the original content.

:::tip NOTE
Enabling this feature increases document indexing time, as all created chunks will be sent to the chat model for keyword or question generation.
:::caution WARNING
Enabling this feature increases document indexing time and uses extra tokens, as all created chunks will be sent to the chat model for keyword or question generation.
:::

## What is Auto-keyword?

Auto-keyword refers to the auto-keyword generation feature of RAGFlow. It uses a chat model to generate set of keywords or synonyms generated from each chunk to correct errors and enhance retrieval accuracy. This feature is implemented as a slider under **Page rank** on the **Configuration** page of your knowledge base.
Auto-keyword refers to the auto-keyword generation feature of RAGFlow. It uses a chat model to generate a set of keywords or synonyms from each chunk to correct errors and enhance retrieval accuracy. This feature is implemented as a slider under **Page rank** on the **Configuration** page of your knowledge base.

Values:
**Values**:

- 0: (Default) Disabled.
- Between 3 and 5 (invlusive): Recommended if you have chunks of approximately 1,000 characters.
- Maximum: 30. If your chunk size increases, you can increase the value accordingly. Please note, as the value increases, the marginal benefit decreases.
- 30 (maximum)

:::tip NOTE
An Auto-keyword value must be an integer. If you set it to a non-integer, say 1.7, it will be rounded down to the nearest integer, which in this case is 1.
- If your chunk size increases, you can increase the value accordingly. Please note, as the value increases, the marginal benefit decreases.
- An Auto-keyword value must be an integer. If you set it to a non-integer, say 1.7, it will be rounded down to the nearest integer, which in this case is 1.
:::

## What is Auto-question?

Auto-question is a feature of RAGFlow that automatically generates questions from chunks of data using a chat model. These questions (e.g. who, what, and why) also help correct errors and improve the matching of user queries. You can find this feature as a slider under **Page rank** on the **Configuration** page of your knowledge base.
Auto-question is a feature of RAGFlow that automatically generates questions from chunks of data using a chat model. These questions (e.g. who, what, and why) also help correct errors and improve the matching of user queries. The feature usually works with FAQ retrieval scenarios involving product manuals or policy documents. And you can find this feature as a slider under **Page rank** on the **Configuration** page of your knowledge base.

Values:
**Values**:

- 0: (Default) Disabled.
- 1 or 2: Recommended if you have chunks of approximately 1,000 characters.
- Maximum: 10. Can also be used to correct bad cases.
- Typical use cases: Scenarios requiring FAQ retrieval, such as product manuals and policy documents.
- 10 (maximum)

:::tip NOTE
An Auto-question value must be an integer. If you set it to a non-integer, say 1.7, it will be rounded down to the nearest integer, which in this case is 1.
- If your chunk size increases, you can increase the value accordingly. Please note, as the value increases, the marginal benefit decreases.
- An Auto-question value must be an integer. If you set it to a non-integer, say 1.7, it will be rounded down to the nearest integer, which in this case is 1.
:::

## Some tips from the community
## Tips from the community

The corresponding values relate closely to the chunking size in your knowledge base. However, if you are new to this feature and unsure which values to start with, here are some suggested values gathered from our community:
The Auto-keyword or Auto-question values relate closely to the chunking size in your knowledge base. However, if you are new to this feature and unsure which value(s) to start with, the following are some value settings we gathered from our community. While they may not be accurate, they provide a starting point at the very least.

```mdx-code-block
<APITable>
@@ -62,8 +63,8 @@ The corresponding values relate closely to the chunking size in your knowledge b
| Multi-repository layered new documents + old archive | Many | Adjust as appropriate |Adjust as appropriate |
| Social media comment pool: multilingual & mixed spelling | Very large volume of short text | 8–12 | 0 |
| Operational logs for troubleshooting | Very large volume of short text | 3–6 | 0 |
| Marketing asset library: Multilingual product descriptions | Medium | 6–10 | 1–2 |
| Training Courses / eBooks | Large | 2–5 | 1–2 |
| Marketing asset library: multilingual product descriptions | Medium | 6–10 | 1–2 |
| Training courses / eBooks | Large | 2–5 | 1–2 |
| Maintenance manual: equipment diagrams + steps | Medium | 3–7 | 1–2 |

```mdx-code-block

Loading…
Peruuta
Tallenna