a
    •˜ëj  ã                   @  sÀ   d Z ddlmZ ddlZddlmZmZ ddlmZ ddl	m
Z
 ddlmZ ddlmZ dd	lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ e e¡ZG dd„ dee
ƒZdS )zDHypothetical Document Embeddings.

https://arxiv.org/abs/2212.10496
é    )ÚannotationsN)ÚAnyÚOptional)ÚCallbackManagerForChainRun)Ú
Embeddings)ÚBaseLanguageModel)ÚStrOutputParser)ÚBasePromptTemplate)ÚRunnable)Ú
ConfigDict)ÚChain)Ú
PROMPT_MAP)ÚLLMChainc                	   @  sÆ   e Zd ZU dZded< ded< eddd�Zed	d
œdd„ƒZed	d
œdd„ƒZ	d	ddœdd„Z
dddœdd„Zdddœdd„Zd+ddddœd d!„Zed,d"dd#d$d%d d&œd'd(„ƒZedd
œd)d*„ƒZdS )-ÚHypotheticalDocumentEmbedderzrGenerate hypothetical document for query, and then embed that.

    Based on https://arxiv.org/abs/2212.10496
    r   Úbase_embeddingsr
   Ú	llm_chainTZforbid)Zarbitrary_types_allowedÚextraz	list[str])Úreturnc                 C  s   | j j ¡ d S )z Input keys for Hyde's LLM chain.Úrequired)r   Zinput_schemaZmodel_json_schema©Úself© r   úY/mnt/bigstor/www/usecases/.venv/lib/python3.9/site-packages/langchain/chains/hyde/base.pyÚ
input_keys(   s    z'HypotheticalDocumentEmbedder.input_keysc                 C  s   t | jtƒr| jjS dgS )z!Output keys for Hyde's LLM chain.Útext)Ú
isinstancer   r   Úoutput_keysr   r   r   r   r   -   s    z(HypotheticalDocumentEmbedder.output_keyszlist[list[float]])Útextsr   c                 C  s   | j  |¡S )zCall the base embeddings.)r   Úembed_documents)r   r   r   r   r   r   4   s    z,HypotheticalDocumentEmbedder.embed_documentszlist[float])Ú
embeddingsr   c                   sl   z ddl }t| |¡jdd�ƒW S  tyf   t d¡ |sDg  Y S t|ƒ‰ ‡ fdd„t|Ž D ƒ Y S 0 dS )z)Combine embeddings into final embeddings.r   N)Zaxisa*  NumPy not found in the current Python environment. HypotheticalDocumentEmbedder will use a pure Python implementation for internal calculations, which may significantly impact performance, especially for large datasets. For optimal speed and efficiency, consider installing NumPy: pip install numpyc                   s   g | ]}t |ƒˆ  ‘qS r   )Úsum)Ú.0Z
dim_values©Znum_vectorsr   r   Ú
<listcomp>I   ó    zCHypotheticalDocumentEmbedder.combine_embeddings.<locals>.<listcomp>)	ÚnumpyÚlistÚarrayÚmeanÚImportErrorÚloggerÚwarningÚlenÚzip)r   r   Únpr   r"   r   Úcombine_embeddings8   s    ÿz/HypotheticalDocumentEmbedder.combine_embeddingsÚstr)r   r   c                 C  sR   | j d }| j ||i¡}t| jtƒr8|| jd  g}n|g}|  |¡}|  |¡S )z1Generate a hypothetical document and embedded it.r   )r   r   Úinvoker   r   r   r   r/   )r   r   Úvar_nameÚresultZ	documentsr   r   r   r   Úembed_queryK   s    

z(HypotheticalDocumentEmbedder.embed_queryNzdict[str, Any]z$Optional[CallbackManagerForChainRun]zdict[str, str])ÚinputsÚrun_managerr   c                 C  s$   |p
t  ¡ }| jj|d| ¡ id�S )zCall the internal llm chain.Ú	callbacks)Úconfig)r   Zget_noop_managerr   r1   Z	get_child)r   r5   r6   Z_run_managerr   r   r   Ú_callV   s
    
þz"HypotheticalDocumentEmbedder._callr   zOptional[str]zOptional[BasePromptTemplate]r   )Úllmr   Ú
prompt_keyÚcustom_promptÚkwargsr   c           	      K  sf   |dur|}n6|dur(|t v r(t | }ndtt  ¡ ƒ› d�}t|ƒ‚||B tƒ B }| f ||dœ|¤ŽS )zILoad and use LLMChain with either a specific prompt key or custom prompt.NzHMust specify prompt_key if custom_prompt not provided. Should be one of Ú.)r   r   )r   r&   ÚkeysÚ
ValueErrorr   )	Úclsr:   r   r;   r<   r=   ÚpromptÚmsgr   r   r   r   Úfrom_llmb   s    


ÿÿz%HypotheticalDocumentEmbedder.from_llmc                 C  s   dS )NZ
hyde_chainr   r   r   r   r   Ú_chain_typez   s    z(HypotheticalDocumentEmbedder._chain_type)N)NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Ú__annotations__r   Zmodel_configÚpropertyr   r   r   r/   r4   r9   ÚclassmethodrD   rE   r   r   r   r   r      s,   
þ ý  ûr   )rI   Ú
__future__r   ÚloggingÚtypingr   r   Zlangchain_core.callbacksr   Zlangchain_core.embeddingsr   Zlangchain_core.language_modelsr   Zlangchain_core.output_parsersr   Zlangchain_core.promptsr	   Zlangchain_core.runnablesr
   Zpydanticr   Zlangchain.chains.baser   Zlangchain.chains.hyde.promptsr   Zlangchain.chains.llmr   Ú	getLoggerrF   r*   r   r   r   r   r   Ú<module>   s   
