diff --git a/README.md b/README.md index 87335f1f..42a7d5db 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,21 @@ ollama create -f Modelfile qwen2m ``` +### Query Param +```python +class QueryParam: + mode: Literal["local", "global", "hybrid", "naive"] = "global" + only_need_context: bool = False + response_type: str = "Multiple Paragraphs" + # Number of top-k items to retrieve; corresponds to entities in "local" mode and relationships in "global" mode. + top_k: int = 60 + # Number of tokens for the original chunks. + max_token_for_text_unit: int = 4000 + # Number of tokens for the relationship descriptions + max_token_for_global_context: int = 4000 + # Number of tokens for the entity descriptions + max_token_for_local_context: int = 4000 +``` ### Batch Insert ```python