o Zh $@sddlmZddlZddlZddlmZddlmZmZm Z m Z m Z m Z ddl mZddlmZddlmZddlmZmZmZdd lmZmZGd d d eZdS) ) annotationsN)Path)AnyDictListOptionalTupleUnion)CallbackManagerForRetrieverRun)Document) BaseRetriever)convert_to_secret_strget_from_dict_or_envpre_init) ConfigDict SecretStrc@seZdZUdZded< dZded< eddZed@dAd d Z e d@dBddZ e d@dCddZ e dDddZ  dEdFd!d"ZdGd$d%ZdHd*d+ZdId.d/ZdJd2d3ZdKd6d7ZdLd;d<ZdMd>d?ZdS)NNeuralDBRetrieverz0Document retriever that uses ThirdAI's NeuralDB.r thirdai_keyNrdbZforbid)extra Optional[str]returnNonecCsJzddlm}tjd||ptdWdSty$tdw)Nr) licensingzthirdai.neural_db THIRDAI_KEYz{Could not import thirdai python package and neuraldb dependencies. Please install it with `pip install thirdai[neural_db]`.) thirdair importlibutil find_specactivateosgetenv ImportError)rrr#f/var/www/html/lang_env/lib/python3.10/site-packages/langchain_community/retrievers/thirdai_neuraldb.py_verify_thirdai_librarys   z)NeuralDBRetriever._verify_thirdai_library model_kwargsdictcKs.t|ddlm}|||jdi|dS)a Create a NeuralDBRetriever from scratch. To use, set the ``THIRDAI_KEY`` environment variable with your ThirdAI API key, or pass ``thirdai_key`` as a named parameter. Example: .. code-block:: python from langchain_community.retrievers import NeuralDBRetriever retriever = NeuralDBRetriever.from_scratch( thirdai_key="your-thirdai-key", ) retriever.insert([ "/path/to/doc.pdf", "/path/to/doc.docx", "/path/to/doc.csv", ]) documents = retriever.invoke("AI-driven music therapy") r neural_dbrrNr#)rr%rr)NeuralDB)clsrr&ndbr#r#r$ from_scratch*s  zNeuralDBRetriever.from_scratch checkpointUnion[str, Path]cCs*t|ddlm}|||j|dS)a! Create a NeuralDBRetriever with a base model from a saved checkpoint To use, set the ``THIRDAI_KEY`` environment variable with your ThirdAI API key, or pass ``thirdai_key`` as a named parameter. Example: .. code-block:: python from langchain_community.retrievers import NeuralDBRetriever retriever = NeuralDBRetriever.from_checkpoint( checkpoint="/path/to/checkpoint.ndb", thirdai_key="your-thirdai-key", ) retriever.insert([ "/path/to/doc.pdf", "/path/to/doc.docx", "/path/to/doc.csv", ]) documents = retriever.invoke("AI-driven music therapy") rr(r*)rr%rr)r+from_checkpoint)r,r/rr-r#r#r$r1Ls  z!NeuralDBRetriever.from_checkpointvaluesrcCstt|dd|d<|S)z'Validate ThirdAI environment variables.rr)r r)r,r2r#r#r$validate_environmentsosz'NeuralDBRetriever.validate_environmentsTsources List[Any]trainbool fast_modekwargscKs(||}|jjd|||d|dS)asInserts files / document sources into the retriever. Args: train: When True this means that the underlying model in the NeuralDB will undergo unsupervised pretraining on the inserted files. Defaults to True. fast_mode: Much faster insertion with a slight drop in performance. Defaults to True. )r4r6Zfast_approximationNr#)_preprocess_sourcesrinsert)selfr4r6r8r9r#r#r$r;{s  zNeuralDBRetriever.insertlistcCsddlm}|s |Sg}|D]D}t|ts||q|dr+|||q|dr;|||q|drK|| |qt d|d|S)zChecks if the provided sources are string paths. If they are, convert to NeuralDB document objects. Args: sources: list of either string paths to PDF, DOCX or CSV files, or NeuralDB document objects. rr(z.pdfz.docxz.csvzCould not automatically load z. Only files with .pdf, .docx, or .csv extensions can be loaded automatically. For other formats, please use the appropriate document object from the ThirdAI library.) rr) isinstancestrappendlowerendswithZPDFZDOCXZCSV RuntimeError)r<r4r-Zpreprocessed_sourcesdocr#r#r$r:s"    z%NeuralDBRetriever._preprocess_sourcesqueryr? document_idintcC|j||dS)a!The retriever upweights the score of a document for a specific query. This is useful for fine-tuning the retriever to user behavior. Args: query: text to associate with `document_id` document_id: id of the document to associate query with. N)rZtext_to_result)r<rErFr#r#r$upvoteszNeuralDBRetriever.upvotequery_id_pairsList[Tuple[str, int]]cC|j|dS)aGiven a batch of (query, document id) pairs, the retriever upweights the scores of the document for the corresponding queries. This is useful for fine-tuning the retriever to user behavior. Args: query_id_pairs: list of (query, document id) pairs. For each pair in this list, the model will upweight the document id for the query. N)rZtext_to_result_batch)r<rJr#r#r$ upvote_batchs zNeuralDBRetriever.upvote_batchsourcetargetcCrH)a=The retriever associates a source phrase with a target phrase. When the retriever sees the source phrase, it will also consider results that are relevant to the target phrase. Args: source: text to associate to `target`. target: text to associate `source` to. N)r associate)r<rNrOr#r#r$rPs zNeuralDBRetriever.associate text_pairsList[Tuple[str, str]]cCrL)a.Given a batch of (source, target) pairs, the retriever associates each source phrase with the corresponding target phrase. Args: text_pairs: list of (source, target) text pairs. For each pair in this list, the source will be associated with the target. N)rassociate_batch)r<rQr#r#r$rSsz!NeuralDBRetriever.associate_batch run_managerr List[Document]c Ks`zd|vr d|d<|jjdd|i|}dd|DWSty/}ztd||d}~ww) zRetrieve {top_k} contexts with your retriever for a given query Args: query: Query to submit to the model top_k: The max number of context results to retrieve. Defaults to 10. Ztop_k rEc Ss8g|]}t|j|j|j|j|j|j|dddqS))id upvote_idsrNmetadatascorecontext)Z page_contentrZ)r textrXrYrNrZr[r\).0refr#r#r$ s z=NeuralDBRetriever._get_relevant_documents..z"Error while retrieving documents: Nr#)rsearch Exception ValueError)r<rErTr9Z referenceser#r#r$_get_relevant_documentss  z)NeuralDBRetriever._get_relevant_documentspathcCrL)zSaves a NeuralDB instance to disk. Can be loaded into memory by calling NeuralDB.from_checkpoint(path) Args: path: path on disk to save the NeuralDB instance to. N)rsave)r<rfr#r#r$rgszNeuralDBRetriever.save)N)rrrr)rrr&r'rr)r/r0rrrr)r2rrr)TT) r4r5r6r7r8r7r9r'rr)r4r=rr=)rEr?rFrGrr)rJrKrr)rNr?rOr?rr)rQrRrr)rEr?rTr r9rrrU)rfr?rr)__name__ __module__ __qualname____doc____annotations__rrZ model_config staticmethodr% classmethodr.r1rr3r;r:rIrMrPrSrergr#r#r#r$rs:   !"   r) __future__rrr pathlibrtypingrrrrrr Zlangchain_core.callbacksr Zlangchain_core.documentsr Zlangchain_core.retrieversr Zlangchain_core.utilsr rrZpydanticrrrr#r#r#r$s