Skip to content

Commit e72ef1b

Browse files
author
dominik
committed
📝 (ChromadbRM.md): Update the return type description in the documentation
The return type description for the search function in the ChromadbRM documentation was updated to provide more detailed information about the structure of the returned object. This change will help developers understand the structure of the returned object and how to use it in their code.
1 parent 48663a2 commit e72ef1b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

‎docs/api/retrieval_model_clients/ChromadbRM.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Search the chromadb collection for the top `k` passages matching the given query
3434
- `k` (_Optional[int]_, _optional_): The number of results to retrieve. If not specified, defaults to the value set during initialization.
3535

3636
**Returns:**
37-
- `dspy.Prediction`: Contains the retrieved passages, each represented as a `dotdict` with a `long_text` attribute.
37+
- `dspy.Prediction`: Contains the retrieved passages, each represented as a `dotdict` with schema `[{"id": str, "score": float, "long_text": str, "metadatas": dict }]`
3838

3939
### Quickstart with OpenAI Embeddings
4040

0 commit comments

Comments
 (0)