### What problem does this PR solve?

Fix typos in the documents

### Type of change

- [x] Bug Fix (non-breaking change which fixes an issue)

---------

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
Co-authored-by: writinwaters <93570324+writinwaters@users.noreply.github.com>
This commit is contained in:
Jin Hai
2025-01-27 15:45:16 +08:00
committed by GitHub
parent ce8658aa84
commit d970d0ef39
13 changed files with 51 additions and 51 deletions

View File

@ -52,7 +52,7 @@ As mentioned earlier, the **Begin** component is indispensable for an agent. Sti
1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
3. On the **agent template** page, hover over the **Interperter** card and click **Use this template**.
3. On the **agent template** page, hover over the **Interpreter** card and click **Use this template**.
4. Name your new agent and click **OK** to enter the workflow editor.
5. Click on the **Begin** component to display its **Configuration** window.

View File

@ -26,7 +26,7 @@ An **Iteration** component is essential when a workflow loop is required and the
Each **Iteration** component includes an internal **IterationItem** component. The **IterationItem** component serves as both the starting point and input node of the workflow within the **Iteration** component. It manages the loop of the workflow for all text segments created from the input.
:::tip NOTE
The **IterationItem** component is visible *only* to the comonents encapsulated by the current **Iteration** components.
The **IterationItem** component is visible *only* to the components encapsulated by the current **Iteration** components.
:::
![Iterationitem](https://github.com/user-attachments/assets/97117ceb-76c4-432e-aa86-48f253bcb886)

View File

@ -380,7 +380,7 @@ The status of a Docker container status does not necessarily reflect the status
### How to increase the length of RAGFlow responses?
1. Right click the desired dialog to display the **Chat Configuration** window.
1. Right-click the desired dialog to display the **Chat Configuration** window.
2. Switch to the **Model Setting** tab and adjust the **Max Tokens** slider to get the desired length.
3. Click **OK** to confirm your change.
@ -414,8 +414,8 @@ See [here](../guides/deploy_local_llm.mdx) for more information.
This error occurs because there are too many chunks matching your search criteria. Try reducing the **TopN** and increasing **Similarity threshold** to fix this issue:
1. Click **Chat** in the middle top of the page.
2. Right click the desired conversation > **Edit** > **Prompt Engine**
3. Reduce the **TopN** and/or raise **Silimarity threshold**.
2. Right-click the desired conversation > **Edit** > **Prompt Engine**
3. Reduce the **TopN** and/or raise **Similarity threshold**.
4. Click **OK** to confirm your changes.
![topn](https://github.com/infiniflow/ragflow/assets/93570324/7ec72ab3-0dd2-4cff-af44-e2663b67b2fc)

View File

@ -1256,7 +1256,7 @@ curl --request POST \
- `"vector_similarity_weight"`: (*Body parameter*), `float`
The weight of vector cosine similarity. Defaults to `0.3`. If x represents the weight of vector cosine similarity, then (1 - x) is the term similarity weight.
- `"top_k"`: (*Body parameter*), `integer`
The number of chunks engaged in vector cosine computaton. Defaults to `1024`.
The number of chunks engaged in vector cosine computation. Defaults to `1024`.
- `"rerank_id"`: (*Body parameter*), `integer`
The ID of the rerank model.
- `"keyword"`: (*Body parameter*), `boolean`

View File

@ -688,8 +688,8 @@ A `Chunk` object contains the following attributes:
from ragflow_sdk import RAGFlow
rag_object = RAGFlow(api_key="<YOUR_API_KEY>", base_url="http://<YOUR_BASE_URL>:9380")
dataset = rag_object.list_datasets(id="123")
dtaset = dataset[0]
datasets = rag_object.list_datasets(id="123")
dataset = datasets[0]
doc = dataset.list_documents(id="wdfxb5t547d")
doc = doc[0]
chunk = doc.add_chunk(content="xxxxxxx")
@ -859,7 +859,7 @@ The weight of vector cosine similarity. Defaults to `0.3`. If x represents the v
##### top_k: `int`
The number of chunks engaged in vector cosine computaton. Defaults to `1024`.
The number of chunks engaged in vector cosine computation. Defaults to `1024`.
##### rerank_id: `str`
@ -1325,7 +1325,7 @@ In streaming mode, not all responses include a reference, as this depends on the
##### question: `str`, *Required*
The question to start an AI-powered conversation. Defalut to `""`
The question to start an AI-powered conversation. Default to `""`
##### stream: `bool`