hhlddlmZmZmZddlmZddlmZddlm Z ddl m Z m Z Gdde e Z dS) )AnyListOptional)CallbackManagerForRetrieverRun)Document) BaseRetriever) BaseModelFieldceZdZUdZdZeeed< eddZ ee ed<eddZ ee ed <edd Z ee ed <ddZde d eefdZde ded eefdZdS)NeedleRetrieveraY NeedleRetriever retrieves relevant documents or context from a Needle collection based on a search query. Setup: Install the `needle-python` library and set your Needle API key. .. code-block:: bash pip install needle-python export NEEDLE_API_KEY="your-api-key" Key init args: - `needle_api_key` (Optional[str]): The API key for authenticating with Needle. - `collection_id` (str): The ID of the Needle collection to search in. - `client` (Optional[NeedleClient]): An optional instance of the NeedleClient. - `top_k` (Optional[int]): Maximum number of results to return. Usage: .. code-block:: python from langchain_community.retrievers.needle import NeedleRetriever retriever = NeedleRetriever( needle_api_key="your-api-key", collection_id="your-collection-id", top_k=10 # optional ) results = retriever.retrieve("example query") for doc in results: print(doc.page_content) NclientzNeedle API Key) descriptionneedle_api_key.z,The ID of the Needle collection to search in collection_idz*Maximum number of search results to return)defaultrtop_kreturnc ddlm}n#t$rtdwxYw|js||j|_dSdS)z Initialize the NeedleClient with the provided API key. If a client instance is already provided, this method does nothing. r) NeedleClientz0Please install with `pip install needle-python`.)api_keyN) needle.v1r ImportErrorr r)selfrs b/var/www/FlaskApp/flask-venv/lib/python3.11/site-packages/langchain_community/retrievers/needle.py_initialize_clientz"NeedleRetriever._initialize_client6s  R . . . . . . . R R RPQQ Q R{ D&,t/BCCCDKKK D Ds #queryc||jtd|jj|j||j}d|D}|S)z Search the Needle collection for relevant documents. Args: query (str): The search query used to find relevant documents. Returns: List[Document]: A list of documents matching the search query. Nz4NeedleClient is not initialized. Provide an API key.)rtextrc8g|]}t|jS)) page_content)rcontent).0results r z6NeedleRetriever._search_collection..Us%LLL&fn555LLL)rr ValueError collectionssearchrr)rrresultsdocss r_search_collectionz"NeedleRetriever._search_collectionDss !!! ; STT T+)00,5 1  MLGLLL r% run_managerc,||S)z Retrieve relevant documents based on the query. Args: query (str): The query string used to search the collection. Returns: List[Document]: A list of documents relevant to the query. )r+)rrr,s r_get_relevant_documentsz'NeedleRetriever._get_relevant_documentsXs&&u---r%)rN)__name__ __module__ __qualname____doc__r rr__annotations__r rstrrrintrrrr+rr.r%rr r s0  D!FHSM   ,$)E$r<s&&&&&&&&&&CCCCCC------333333%%%%%%%%\.\.\.\.\.mY\.\.\.\.\.r%