Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Update RAGatouilleRM.md

arnavsinghvi1185cd24835e12
diff --git a/docs/api/retrieval_model_clients/RAGatouilleRM.md b/docs/api/retrieval_model_clients/RAGatouilleRM.md
index f3fb785fb..4780b106a 100644
--- a/docs/api/retrieval_model_clients/RAGatouilleRM.md
+++ b/docs/api/retrieval_model_clients/RAGatouilleRM.md
@@ -19,7 +19,7 @@ class RAGatouilleRM(dspy.Retrieve):
```
**Parameters:**
-- `index_root` (_str_): Folder path where you index is stored.
+- `index_root` (_str_): Folder path where your index is stored.
- `index_name` (_str_): Name of the index you want to retrieve from.
- `k` (_int_): The default number of passages to retrieve. Defaults to `3`.
@@ -27,7 +27,7 @@ class RAGatouilleRM(dspy.Retrieve):
#### `forward(self, query_or_queries: Union[str, List[str]], k:Optional[int]) -> dspy.Prediction`
-Enables making queries to the RAGatouille made index for retrieval. Internally, the method handles the specifics of preparing the query to obtain the response. The function handles the retrieval of the top-k passages based on the provided query.
+Enables making queries to the RAGatouille-made index for retrieval. Internally, the method handles the specifics of preparing the query to obtain the response. The function handles the retrieval of the top-k passages based on the provided query.
**Parameters:**
- `query_or_queries` (Union[str, List[str]]): Query string used for retrieval.