+#hWdZddlmZmZmZddlZddlZddlZddlm Z  ddl ZejjejjejjfZ ddlZddlmcmZddlmZmZddlmZddlmZGd d ej:Zy#e$rejejfZYWwxYw#e$r edwxYw) z Retriever model for chromadb )ListOptionalUnionN)dotdict) EmbeddableEmbeddingFunction)Settings)embedding_functionszcThe chromadb library is required to use ChromadbRM. Install it with `pip install dspy-ai[chromadb]`c veZdZdZej ddfdededeee dee jde f fd Z ddededee jd e jfd Zej"ej$ed deed eeefdZ ddeeeefdee d ej2fdZxZS) ChromadbRMa} A retrieval module that uses chromadb to return the top passages for a given query. Assumes that the chromadb index has been created and populated with the following metadata: - documents: The text of the passage Args: collection_name (str): chromadb collection name persist_directory (str): chromadb persist directory embedding_function (Optional[EmbeddingFunction[Embeddable]]): Optional function to use to embed documents. Defaults to DefaultEmbeddingFunction. k (int, optional): The number of top passages to retrieve. Defaults to 7. client(Optional[chromadb.Client]): Optional chromadb client provided by user, default to None Returns: dspy.Prediction: An object containing the retrieved passages. Examples: Below is a code snippet that shows how to use this as the default retriever: ```python llm = dspy.OpenAI(model="gpt-3.5-turbo") # using default chromadb client retriever_model = ChromadbRM('collection_name', 'db_path') dspy.settings.configure(lm=llm, rm=retriever_model) # to test the retriever with "my query" retriever_model("my query") ``` Use provided chromadb client ```python import chromadb llm = dspy.OpenAI(model="gpt-3.5-turbo") # say you have a chromadb running on a different port client = chromadb.HttpClient(host='localhost', port=8889) retriever_model = ChromadbRM('collection_name', 'db_path', client=client) dspy.settings.configure(lm=llm, rm=retriever_model) # to test the retriever with "my query" retriever_model("my query") ``` Below is a code snippet that shows how to use this in the forward() function of a module ```python self.retrieve = ChromadbRM('collection_name', 'db_path', k=num_passages) ``` Ncollection_namepersist_directoryembedding_functionclientkc\|j|||||_t| |y)N)r)r)_init_chromadbefsuper__init__)selfrrrrr __class__s V/var/www/html/sandstorm/venv/lib/python3.12/site-packages/dspy/retrieve/chromadb_rm.pyrzChromadbRM.__init__Ps2 O->vN$ 1returnc|r||_n%tjt|d|_|jj ||_y)a<Initialize chromadb and return the loaded index. Args: collection_name (str): chromadb collection name persist_directory (str): chromadb persist directory client (chromadb.Client): chromadb client provided by user Returns: collection per collection_name T)r is_persistent)nameN)_chromadb_clientchromadbClientr get_or_create_collection_chromadb_collection)rrrrs rrzChromadbRM._init_chromadb_sR $*D !$,OO&7"&% D ! %)$9$9$R$R %S% !r)max_timequeriesc$|j|S)zReturn query vector after creating embedding using OpenAI Args: queries (list): List of query strings to embed. Returns: List[List[float]]: List of embeddings corresponding to each query. )r)rr's r_get_embeddingszChromadbRM._get_embeddings|swwwrquery_or_queriesc t|tr|gn|}|Dcgc]}|s| }}|j|}| |jn|}|jj d||d|}t |dd|dd|dd|dd}|D cgc]\} } } } t| | | | d}} } } } |Scc}wcc} } } } w) zSearch with db for self.k top passages for query Args: query_or_queries (Union[str, List[str]]): The query or queries to search for. Returns: dspy.Prediction: An object containing the retrieved passages. )query_embeddings n_resultsidsr distances documents metadatas)idscore long_textr1) isinstancestrr)rr$queryzipr) rr*rkwargsr'q embeddingsresultszipped_resultsr2distdocmetas rforwardzChromadbRM.forwards*C0 !  &+1++))'2 iDFFQ1$++11 '1 7=  EN1  K  # K  # K  # % xFGG`s`bdhjmos7"t#TXZ[GG,GsB8B8B= )N)__name__ __module__ __qualname____doc__rDefaultEmbeddingFunctionr7rrrr!r"intr Collectionrbackoff on_exceptionexpoERRORSrfloatr)rdspy PredictionrB __classcell__)rs@rr r "s++f (B ' ' ),0   % j ) )   &-1    )      :W   tCy  T$u+5F    KO %c49n 5:B3- rr )rFtypingrrrrJopenairO dsp.utilsr openai.errorerrorRateLimitErrorServiceUnavailableErrorAPIErrorrM Exceptionr!"chromadb.utils.embedding_functionsutilsr rchromadb.api.typesrrchromadb.configr chromadb.utils ImportErrorRetriever r5rrrbs)( 6ll))6<<+O+OQWQ]Q]QfQf gF 33)2HH%6##V__ 5F6 m sAB&!CB=<B=C