Skip to content

Commit 3cbba67

Browse files
committed
doc: update README
Signed-off-by: Xin Liu <[email protected]>
1 parent e91c2a1 commit 3cbba67

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ The embeddings returned are like below:
220220

221221
#### `/v1/create/rag` endpoint
222222

223-
`/v1/create/rag` endpoint provides users a one-click way to convert a text or markdown file to embeddings directly. The effect of the endpoint is equivalent to running `/v1/files` + `/v1/chunks` + `/v1/embeddings` sequently.
223+
`/v1/create/rag` endpoint provides users a one-click way to convert a text or markdown file to embeddings directly. The effect of the endpoint is equivalent to running `/v1/files` + `/v1/chunks` + `/v1/embeddings` sequently. Note that the `--chunk-capacity` CLI option is required for the endpoint. The default value of the option is `100`. You can set it to different values while starting LlamaEdge-RAG API server.
224224

225225
<details> <summary> Example </summary>
226226

@@ -372,6 +372,8 @@ To check the CLI options of the `rag-api-server` wasm app, you can run the follo
372372
Max number of retrieved result [default: 3]
373373
--qdrant-score-threshold <QDRANT_SCORE_THRESHOLD>
374374
Minimal score threshold for the search result [default: 0.4]
375+
--chunk-capacity <CHUNK_CAPACITY>
376+
Maximum number of tokens each chunk contains [default: 100]
375377
--log-prompts
376378
Print prompt strings to stdout
377379
--log-stat

0 commit comments

Comments
 (0)