o Zh @s<ddlmZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZddlZddlmZmZddlmZddlm Z ddl!m"Z"ddl#m$Z$dd l%m&Z&dd l'm(Z(dd l)m*Z*m+Z+dd l,m-Z-e.Z/e rdd l0m1Z1ddl2m3Z3ddl4m5Z5m6Z6ddl7m8Z8ddl7m5Z9ddl:m;Z;mZ>m?Z?e&ddddZ@e&ddddZAe&ddddZBe&ddddZCdZD               dcddd=d>ZEGd?d@d@e(ZFGdAdBdBe$ZGdedFdGZHdfdIdJZI K LdgdhdSdTZJ K LdgdhdUdVZKdidZd[ZLdjdkdadbZMdS)l) annotationsN) TYPE_CHECKINGAnyCallableClassVar CollectionDictIterableListLiteralOptionalTupleTypeUnioncast)#AsyncCallbackManagerForRetrieverRunCallbackManagerForRetrieverRun)Document) Embeddings)LangChainException) BaseRetriever) get_from_env) VectorStore) ConfigDictmodel_validator)maximal_marginal_relevance)TokenCredential)AsyncTokenCredential) SearchClientSearchItemPaged)AsyncSearchItemPagedr) CorsOptionsScoringProfile SearchFieldSemanticConfiguration VectorSearchZAZURESEARCH_FIELDS_IDid)keyZenv_keydefaultZAZURESEARCH_FIELDS_CONTENTcontentZ!AZURESEARCH_FIELDS_CONTENT_VECTORZcontent_vectorZAZURESEARCH_FIELDS_TAGmetadatai"langchain-comm-python-azure-searchFendpointstr index_namer( Optional[str]azure_ad_access_tokensemantic_configuration_namefieldsOptional[List[SearchField]] vector_searchOptional[VectorSearch]semantic_configurationsCOptional[Union[SemanticConfiguration, List[SemanticConfiguration]]]scoring_profilesOptional[List[ScoringProfile]]default_scoring_profiledefault_fields user_agent cors_optionsOptional[CorsOptions]async_bool additional_search_client_optionsOptional[Dict[str, Any]]azure_credentialOptional[TokenCredential]azure_async_credentialOptional[AsyncTokenCredential]return&Union[SearchClient, AsyncSearchClient]c0 sddlmm}m}ddlm}ddlm}m}ddl m}ddl m }ddl m }ddl m}ddlm}m}m}m}m}m}m} m}!m}"m}#m}$m}%m}&Gfd d d |}'|p[i}| p_g} |dur||d kru|}(|(d |(})n||}(|(})n|dur|'|}(|(})n |p|}(|p|})|d0||(| d |}*z|*j|dWn|yd|durdd|Ddd| Dfddt !t !D}+t"|+dkrd1fdd d#fdd|+D},t$d|+d|,n| }|dur&|#|d|$j%|ddd |%j&d!d"|d#|$j'||%j&d$d"g|&d%dd&|&d'd#d&gd(}|r9t(|t)s2|g}|"||d)}-n|rP|||!| t*d*gd+d,}.|"|.gd-}-nd}-|||||-|| | d.}/|*+|/Ynw| st|d0|||(| d/|S|d0|||)| d/|S)2Nr) AccessTokenAzureKeyCredentialr)ResourceNotFoundError)DefaultAzureCredentialInteractiveBrowserCredential)rMr!)SearchIndexClient) #ExhaustiveKnnAlgorithmConfigurationExhaustiveKnnParametersHnswAlgorithmConfigurationHnswParameters SearchIndexr% SemanticFieldSemanticPrioritizedFieldsSemanticSearchr&VectorSearchAlgorithmKindVectorSearchAlgorithmMetricVectorSearchProfilecs.eZdZdfdd ZdddddddZdS)z6_get_search_client..AzureBearerTokenCredentialtokenr.cs|ttd|_dS)Ni)inttime_token)selfr[rJc/var/www/html/lang_env/lib/python3.10/site-packages/langchain_community/vectorstores/azuresearch.py__init__sz?_get_search_client..AzureBearerTokenCredential.__init__NF)claims tenant_id enable_caescopesrdr0rerfrAkwargsrrHrJc_s|jSN)r^)r_rdrerfrgrhrararb get_tokensz@_get_search_client..AzureBearerTokenCredential.get_token)r[r.) rgr.rdr0rer0rfrArhrrHrJ)__name__ __module__ __qualname__rcrjrar`rarbAzureBearerTokenCredentials rnZ INTERACTIVEz!https://search.azure.com/.default)r- credentialr=namecSi|]}|j|jqSrarqtype).0frararb z&_get_search_client..cSrrrars)rudfrararbrwrxcsi|] \}}||qSrararur(value)mandatory_fieldsrarbrwsxr.rHc s:|d|dd|d|d|d S)Nz current type: 'MISSINGz'. It has to be 'z#' or you can point to a different 'z;' field name by using the env variable 'AZURESEARCH_FIELDS_')getupper)r}) fields_typesr|rarbfmt_errsz#_get_search_client..fmt_err csg|]}|qSrararur})rrarb z&_get_search_client..z2You need to specify at least the following fields z; or provide alternative field names in the env variables. r)ii)mZef_constructionZ ef_searchmetric)rqkind parametersZdefault_exhaustive_knn)r myHnswProfile)rqZalgorithm_configuration_nameZmyExhaustiveKnnProfile)Z algorithmsZprofiles)configurationsZdefault_configuration_name) field_name)Zcontent_fields)rqZprioritized_fields)r)rqr3r5semantic_searchr9r;r>)r-r/ror=ra)r}r.rHr.),azure.core.credentialsrJrKrZazure.core.exceptionsrLZazure.identityrMrNZazure.identity.aioazure.search.documentsrazure.search.documents.aioZazure.search.documents.indexesrO%azure.search.documents.indexes.modelsrPrQrRrSrTr%rUrVrWr&rXrYrZrrjZ get_indexsetitemslenjoin ValueErrorZHNSWZCOSINEZEXHAUSTIVE_KNN isinstancelistFIELDS_CONTENTZ create_index)0r-r/r(r1r2r3r5r7r9r;r<r=r>r@rBrDrFrKrrLrMrNZAsyncDefaultAzureCredentialrAsyncSearchClientrOrPrQrRrSrTr%rUrVrWr&rXrYrZrnroZasync_credentialZ index_clientZmissing_fieldserrorrZsemantic_configurationindexra)rJrrr|rb_get_search_clientSs     <          !   arc@sLeZdZdZ        ddddddddd$d%Zdd(d)Zedd+d,Zdd/d0Z ddd1dd9d:Z ddd1dd;d<Z ddd1dd?d@Z ddd1ddAdBZ dddEdFZ dddGdHZ IdddJddOdPZdIdQddSdTZ IdddJddUdVZdIdQddWdXZ IdddYdd\d]Z IdddYdd^d_Z Iddd`ddbdcZ Iddd`ddddeZ I dddfdgZ I dddhdiZ I j kddd`ddodpZ I j kddd`ddqdrZdddsdtZ IdddudvZ I dddwdxZ I dddydzZ IdddYdd{d|Z IdddYdd}d~Z I j kddd`dddZ! I j kddd`dddZ"dd`dddZ#dd`dddZ$ IddddZ% IddddZ& I dddYdddZ' I dddYdddZ( Iddd`dddZ) Iddd`dddZ*e+   ddddZ,e+   ddddZ-e+ dddddddddZ.e+ dddddddddZ/dddZ0dS) AzureSearchz&`Azure Cognitive Search` vector store.hybridN)vector_search_dimensionsrBr1rDrFazure_search_endpointr.azure_search_keyr0r/embedding_functionUnion[Callable, Embeddings] search_typer2r3r4r5r6r7r8r9r:r;r>r?r Optional[int]rBrCr1rDrErFrGrhrc Kszddlm}m}m}m}Wnty}ztd|d}~ww ||_t|jtr0|jj |_ n|j|_ |t |j ddd|t |j d|t ||jd| pRt| ddd |t|j dg}d }d |vro|d ro|d |d 7}t|||||||| | | ||| ||d |_t|||||||| | | ||| d||d|_||_||_|r|n||_||_||_||_||_||_||_| |_| |_| |_ ||_!||_"| |_#dS)Nr)SearchableFieldr$SearchFieldDataType SimpleFieldzeUnable to import azure.search.documents. Please install with `pip install -U azure-search-documents`.T)rqrtr(Z filterablersTextr)rqrtZ searchablerZvector_search_profile_nameZ langchainr= ) r2r3r5r7r9r;r<r=r>rBrD) r2r3r5r7r9r;r<r=r>r@rDrF)$rrr$rr ImportErrorrrr embed_query FIELDS_IDStringrFIELDS_CONTENT_VECTORrSinglerFIELDS_METADATArclient async_clientrr2r3Z_azure_search_endpointZ_azure_search_keyZ _index_nameZ_semantic_configuration_name_fieldsZ_vector_searchZ_semantic_configurationsZ_scoring_profilesZ_default_scoring_profileZ_default_fieldsZ _user_agentZ _cors_options)r_rrr/rrr2r3r5r7r9r;r>rrBr1rDrFrhrr$rrer<r=rararbrc s     zAzureSearch.__init__rHNonec Cst|dr |jr |jt|drZ|jr\zt}|r)||jWdS||jWdSt yYt }t |z||jW|YdS|wwdSdS)Nrr) hasattrrcloserasyncioget_event_loop is_running create_taskrun_until_complete RuntimeErrornew_event_loopset_event_loop)r_looprararb__del__s    zAzureSearch.__del__Optional[Embeddings]cCst|jtr |jSdSri)rrrr_rararb embeddingss zAzureSearch.embeddingstext List[float]cs*|jr |j|IdHStt|j|Sri)r aembed_queryrrr)r_rrararb _aembed_queryszAzureSearch._aembed_querykeystexts Iterable[str] metadatasOptional[List[dict]]rOptional[List[str]] List[str]c stjtr#z jt|}Wnty"fdd|D}Yn wfdd|D}t|dkr9tdgS|sMd|vrMt|dt|krM|d}j t ||||dS)z$Add texts data to an existing index.csg|]}j|qSra)rrrrrarbrsz)AzureSearch.add_texts..cg|]}|qSrarrrrarbrrxrNothing to insert, skipping.idsr) rrrZembed_documentsrNotImplementedErrorrloggerdebugadd_embeddingszipr_rrrrhrrarrb add_textss     zAzureSearch.add_textscstjtr*z jt|IdH}Wnty)fdd|DIdH}Yn wfdd|D}t|dkr@tdgS|sTd|vrTt|dt|krT|d}j t ||||dIdHS)Ncs g|] }j|IdHqSri)rrrrrarbrsz*AzureSearch.aadd_texts..crrarrrrarbrrxrrrr) rrrZaembed_documentsrrrrraadd_embeddingsrrrarrb aadd_textss       zAzureSearch.aadd_textstext_embeddings!Iterable[Tuple[str, List[float]]]c s8g}g}t|D]u\}\}}|r||} ntt} tt| dd} |r,||ni} ddt| t |t t j |t j dtt| i} | rWfdd| D} | | || || t|tkr}jj|d} td d | Ds{t| g}qt|d kr|Sjj|d} td d | Dr|St| ) $Add embeddings to an existing index.utf-8ascii@search.actionuploadZdtypec*i|]\}}|ddjDvr||qS)cSg|]}|jqSrarprrararbr$z9AzureSearch.add_embeddings...r3rukvrrarbrw! z.AzureSearch.add_embeddings.. documentscs|]}|jVqdSriZ succeededrurrararb -z-AzureSearch.add_embeddings..rcsrrirrrararbr9r) enumerater.uuiduuid4base64urlsafe_b64encodebytesdecoderrrnparrayfloat32tolistrjsondumpsrupdateappendrMAX_UPLOAD_BATCH_SIZErupload_documentsallrr_rrrrdatair embeddingr(r+docZadditional_fieldsresponserarrbrsB         zAzureSearch.add_embeddingsc sDg}g}t|D]w\}\}}|r||ntt} tt| dd} |r,||ni} ddt| t |t t j |t j dtt| i} | rWfdd| D} | | || || t|tkrjj|dId H} td d | Ds~t| g}q t|d kr|Sjj|dId H} td d | Dr|St| )rrrrrrcr)cSrrarprrararbr]rz:AzureSearch.aadd_embeddings...rrrrarbrwZrz/AzureSearch.aadd_embeddings..rNcsrrirrrararbrfrz.AzureSearch.aadd_embeddings..rcsrrirrrararbrrr)rr.rrrrrrrrrrrrrrrrrrr rr rr r rr rarrbr>s@       zAzureSearch.aadd_embeddingsrrAcKs*|r|jdd|D}t|dkSdS)Delete by vector ID. Args: ids: List of ids to delete. Returns: bool: True if deletion is successful, False otherwise. cSsg|]}t|iqSra)rrurrararbrrz&AzureSearch.delete..rF)rdelete_documentsrr_rrhresrararbdeletews  zAzureSearch.deletecs2|r|jdd|DIdH}t|dkSdS)rcSsg|]}d|iqS)r'rarrararbrrz'AzureSearch.adelete..NrF)rrrrrararbadeletes   zAzureSearch.adeleter)rqueryrr\List[Document]cKs|p|j}|dkr|j|fd|i|}|S|dkr'|j|fd|i|}|S|dkr8|j|fd|i|}|Std|dN similarityrrsemantic_hybridsearch_type of not allowed.)rr5 hybrid_searchsemantic_hybrid_searchrr_rrrrhdocsrararbsimilarity_searchs zAzureSearch.similarity_search)rList[Tuple[Document, float]]cKsx|d|j}|dkr|j|fd|i|S|dkr%|j|fd|i|S|dkr4|j|fd|i|Std|d)$Run similarity search with distance.rrrrrrr )poprvector_search_with_scorehybrid_search_with_score!semantic_hybrid_search_with_scorerr_rrrhrrararbsimilarity_search_with_scoresz(AzureSearch.similarity_search_with_scorecs|p|j}|dkr|j|fd|i|IdH}|S|dkr.|j|fd|i|IdH}|S|dkrB|j|fd|i|IdH}|Std|dr)ravector_searchahybrid_searchasemantic_hybrid_searchrr#rararbasimilarity_searchs zAzureSearch.asimilarity_searchcs|d|j}|dkr|j|fd|i|IdHS|dkr,|j|fd|i|IdHS|dkr>|j|fd|i|IdHStd|d) r'rrrNrrrr )rravector_search_with_scoreahybrid_search_with_score"asemantic_hybrid_search_with_scorerr,rararbasimilarity_search_with_scoresz)AzureSearch.asimilarity_search_with_scorescore_thresholdr7Optional[float]c 4|j|fd|i|}dur|Sfdd|DS)Nrcg|] }|dkr|qSrarr6rarbrzGAzureSearch.similarity_search_with_relevance_scores..r)r_rrr7rhresultrar6rb'similarity_search_with_relevance_scores z3AzureSearch.similarity_search_with_relevance_scoresc<|j|fd|i|IdH}dur|Sfdd|DS)Nrcr:r;rarr6rarbrr=zHAzureSearch.asimilarity_search_with_relevance_scores..r2r?rar6rb(asimilarity_search_with_relevance_scoresz4AzureSearch.asimilarity_search_with_relevance_scores)filtersrGcKs|j|||d}dd|DS)\ Returns the most similar indexed documents to the query text. Args: query (str): The query text for which to find similar documents. k (int): The number of documents to return. Default is 4. Returns: List[Document]: A list of documents that are most similar to the query text. rrGcSg|]\}}|qSrararur_rararbrrz-AzureSearch.vector_search..r>r_rrrGrhdocs_and_scoresrararbr5s zAzureSearch.vector_searchcs&|j|||dIdH}dd|DS)rHrINcSrJrararKrararbrrz.AzureSearch.avector_search..rDrMrararbr.s   zAzureSearch.avector_searchcKs,||}|j|d|fd|i|}t|S)Return docs most similar to query. Args: query (str): Text to look up documents similar to. k (int, optional): Number of Documents to return. Defaults to 4. filters (str, optional): Filtering expression. Defaults to None. Returns: List[Tuple[Document, float]]: List of Documents most similar to the query and score for each rGr_simple_search_results_to_documentsr_rrrGrhrresultsrararbr)s z$AzureSearch.vector_search_with_scorecs@||IdH}|j|d|fd|i|IdH}t|IdHS)rONrPrGr_asimple_search_aresults_to_documentsrTrararbr21s z%AzureSearch.avector_search_with_score?fetch_k lambda_multfloatc Ks:||}|j|d|fd|i|}t|t|||dS)"Perform a search and return results that are reordered by MMR. Args: query (str): Text to look up documents similar to. k (int, optional): How many results to give. Defaults to 4. fetch_k (int, optional): Total results to select k from. Defaults to 20. lambda_mult: Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5 filters (str, optional): Filtering expression. Defaults to None. Returns: List[Tuple[Document, float]]: List of Documents most similar to the query and score for each rPrGquery_embeddingr\rrrR0_reorder_results_with_maximal_marginal_relevancerr r_rrr[r\rGrhrrUrararb(max_marginal_relevance_search_with_scoreJs z4AzureSearch.max_marginal_relevance_search_with_scorec sN||IdH}|j|d|fd|i|IdH}t|t|||dIdHS)r^NrPrGr_rrW1_areorder_results_with_maximal_marginal_relevancerrrcrararb)amax_marginal_relevance_search_with_scorels  z5AzureSearch.amax_marginal_relevance_search_with_scorecK$|j|fd|i|}dd|DS)rHrcSrJrararKrararbrrz-AzureSearch.hybrid_search..r*r_rrrhrNrararbr!s zAzureSearch.hybrid_searchc,|j|fd|i|IdH}dd|DS)rHrNcSrJrararKrararbrrz.AzureSearch.ahybrid_search..r3rjrararbr/s zAzureSearch.ahybrid_searchcKs,||}|j|||fd|i|}t|S)!Return docs most similar to query with a hybrid query. Args: query: Text to look up documents similar to. k: Number of Documents to return. Defaults to 4. Returns: List of Documents most similar to the query and score for each rGrQrTrararbr*s z$AzureSearch.hybrid_search_with_scorecs@||IdH}|j|||fd|i|IdH}t|IdHS)rmNrGrVrTrararbr3s z%AzureSearch.ahybrid_search_with_scorec r9)Nrcr:r;rarr6rarbrr=zCAzureSearch.hybrid_search_with_relevance_scores..rir?rar6rb#hybrid_search_with_relevance_scoresrBz/AzureSearch.hybrid_search_with_relevance_scorescrC)Nrcr:r;rarr6rarbrr=zDAzureSearch.ahybrid_search_with_relevance_scores..rlr?rar6rb$ahybrid_search_with_relevance_scoresrFz0AzureSearch.ahybrid_search_with_relevance_scoresc Ks:||}|j|||fd|i|}t|t|||dS)Return docs most similar to query with a hybrid query and reorder results by MMR. Args: query (str): Text to look up documents similar to. k (int, optional): Number of Documents to return. Defaults to 4. fetch_k (int, optional): Total results to select k from. Defaults to 20. lambda_mult: Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5 filters (str, optional): Filtering expression. Defaults to None. Returns: List of Documents most similar to the query and score for each rGr_rarcrararb/hybrid_max_marginal_relevance_search_with_scores z;AzureSearch.hybrid_max_marginal_relevance_search_with_scorec sN||IdH}|j|||fd|i|IdH}t|t|||dIdHS)rpNrGr_rercrararb0ahybrid_max_marginal_relevance_search_with_score"s  z.,semantic_hybrid_search_with_score_and_rerankrjrararbr"sz"AzureSearch.semantic_hybrid_searchcrk)rrNcSrrararKrararbrrxz7AzureSearch.asemantic_hybrid_search..-asemantic_hybrid_search_with_score_and_rerankrjrararbr0s z#AzureSearch.asemantic_hybrid_searchscore score_type"Literal['score', 'reranker_score']c sN|j|fd|i|}|dkrfdd|DS|dkr%fdd|DSdS) Returns the most similar indexed documents to the query text. Args: query (str): The query text for which to find similar documents. k (int): The number of documents to return. Default is 4. score_type: Must either be "score" or "reranker_score". Defaulted to "score". filters: Filtering expression. Returns: List[Tuple[Document, float]]: A list of documents and their corresponding scores. rrc*g|]\}}}dus|kr||fqSrirarurrrLr6rarbr zAAzureSearch.semantic_hybrid_search_with_score..reranker_scorec*g|]\}}}dus|kr||fqSrirarurrLrr6rarbrrNrr_rrrr7rhrNrar6rbr+s   z-AzureSearch.semantic_hybrid_search_with_scorecsV|j|fd|i|IdH}|dkrfdd|DS|dkr)fdd|DSdS)rrNrcrrirarr6rarbrrzBAzureSearch.asemantic_hybrid_search_with_score..rcrrirarr6rarbrrrrrar6rbr4s"   z.AzureSearch.asemantic_hybrid_search_with_score#List[Tuple[Document, float, float]]c sddlm}|jjd ||tj||tjd|t dg|d|j dd|d|}| p/g}i|D] }|j |j d|j<q4fd d |D} | S) LReturn docs most similar to query with a hybrid query. Args: query: Text to look up documents similar to. k: Number of Documents to return. Defaults to 4. filters: Filtering expression. Returns: List of Documents most similar to the query and score for each rrvrrxsemantic extractiverzr{r|Z query_typer2Z query_captionZ query_answerr}r highlightsc sg|]^}t|tit|vrt|tinit|vr"t|tndd|D|drE|digdj |digdj dni|tddddt |dt |d fqS) cSi|] \}}|tkr||qSrarrrararbrw< zWAzureSearch.semantic_hybrid_search_with_score_and_rerank...@search.captionsrrrPZcaptionsZanswersZ page_contentr+ @search.score@search.reranker_score rr(rrrrloadsrrrrr]rur@Zsemantic_answers_dictrarbr/sL*     % zLAzureSearch.semantic_hybrid_search_with_score_and_rerank..Nra)r~rwrrrrrrrrr2 get_answersrrr() r_rrrGrhrwrUsemantic_answerssemantic_answerr$rarrbrs8   *,z8AzureSearch.semantic_hybrid_search_with_score_and_rerankc sddlm}||IdH}|jjd ||tj|tjd|t dg|d|j dd|d|IdH}| IdHp;g}i|D] } | j | j d | j<q@fd d |2IdH} | S) rrrvNrrxrrrrc sg|zb3dHW}t|tit|vrt|tinit|vr't|tndd|D|drJ|digdj |digdj dni|tddddt |d t |d fq6S) NcSrrarrrararbrwrzXAzureSearch.asemantic_hybrid_search_with_score_and_rerank...rrrrPrrrrrrrrarbrsN*     % zMAzureSearch.asemantic_hybrid_search_with_score_and_rerank..ra)r~rwrrrrrrrrr2rrrr() r_rrrGrhrwryrUrrr$rarrbr]s<   * ,z9AzureSearch.asemantic_hybrid_search_with_score_and_rerankrPlangchain-indexclsType[AzureSearch]rc Ks4|||||f||d| } | j||fi| | SN)r3r1)r rrrrrrr1r/r3rh azure_searchrararb from_textss zAzureSearch.from_textsc s<|||||f||d| } | j||fi| IdH| Sr)rrrararb afrom_textss zAzureSearch.afrom_texts)rrr/r3c sdt|\}} | durtdt| d} |d|||||| d|} | j||fi|IdH| SNz0Cannot create AzureSearch from empty embeddings.r<)rrr/rr3rra)_peekrrr rrrrrrr/r3rhZfirst_text_embeddingrrrararbafrom_embeddingss"   zAzureSearch.afrom_embeddingsc Ks\t|\}} | durtdt| d} |d|||||| d|} | j||fi|| Sr)rrrrrrararbfrom_embeddingss   zAzureSearch.from_embeddingsAzureSearchVectorStoreRetrievercKsN|d|j}||d<|ddpg}||tdd|i|d|iS)aReturn AzureSearchVectorStoreRetriever initialized from this VectorStore. Args: search_type (Optional[str]): Overrides the type of search that the Retriever should perform. Defaults to `self.search_type`. Can be "similarity", "hybrid", or "semantic_hybrid". search_kwargs (Optional[Dict]): Keyword arguments to pass to the search function. Can include things like: score_threshold: Minimum relevance threshold for similarity_score_threshold fetch_k: Amount of documents to pass to MMR algorithm (Default: 20) lambda_mult: Diversity of results returned by MMR; 1 for minimum diversity and 0 for maximum. (Default: 0.5) filter: Filter by document metadata Returns: AzureSearchVectorStoreRetriever: Retriever class for VectorStore. rtagsN vectorstorera)rrr(extendZ_get_retriever_tagsr)r_rhrrrararb as_retriever&s zAzureSearch.as_retriever)rNNNNNNN)$rr.rr0r/r.rrrr.r2r0r3r4r5r6r7r8r9r:r;r0r>r?rrrBrCr1r0rDrErFrGrhr)rHr)rHr)rr.rHrri) rrrrrrrhrrHr)rrrrrrrHr)rrrhrrHrA)r) rr.rr\rr0rhrrHr)rr.rr\rhrrHr&) rr.rr\r7r8rhrrHr&) rr.rr\rGr0rhrrHr)rN) rr.rr\rGr0rhrrHr&)rrYrZ)rr.rr\r[r\r\r]rGr0rhrrHr&)rr.rr\rhrrHr) rrrsr.rr\rGr0rhrrHrt) rrrsr.rr\rGr0rhrrHr)rr) rr.rr\rrr7r8rhrrHr&) rr.rr\rGr0rhrrHr)NrPrPNrN)rrrrrrrrrr.rr.r1r0r/r.r3r4rhrrHr)rrrrrrrrrr.rr.r/r.r3r4rhrrHr)rhrrHr)1rkrlrm__doc__rcrpropertyrrrrrrrrr%r-r1r5rArEr5r.r)r2rdrgr!r/r*r3rnrorqrrrRrWr"r0r+r4rr classmethodrrrrrrarararbrsZ }   !!@ 9   % '   (.*%  *(XXrc@seZdZUdZded< dZded< dZded < iZd ed < d Zd ed<e ddZ e dde d$ddZ d%ddZd&d!d"Zd#S)'rz-Retriever that uses `Azure Cognitive Search`.rrrr.rrr\rdict search_kwargs)rsimilarity_score_thresholdrhybrid_score_thresholdrsemantic_hybrid_score_thresholdzClassVar[Collection[str]]allowed_search_typesT)Zarbitrary_types_allowedbefore)modevaluesrrHrcCs4d|vr|d}||jvrtd|d|j|S)zValidate search type.rrz not allowed. Valid values are: )rr)rrrrararbvalidate_search_typecs z4AzureSearchVectorStoreRetriever.validate_search_typer run_managerrrhrcKs.i|j|}|jdkr|jj|fd|ji|}|S|jdkr4dd|jj|fd|ji|D}|S|jdkrH|jj|fd|ji|}|S|jdkradd|jj|fd|ji|D}|S|jd kru|jj|fd|ji|}|S|jd krd d|jj |fd|ji|D}|St d |jd )NrrrcSrJrararKrararbr{zKAzureSearchVectorStoreRetriever._get_relevant_documents..rrcSrJrararKrararbrrrrcSrJrararKrararbrrrr ) rrrr5rrAr!rnr"r+r)r_rrrhparamsr$rararb_get_relevant_documentspsX      z7AzureSearchVectorStoreRetriever._get_relevant_documentsrcs\i|j|}|jdkr|jj|fd|ji|IdH}|S|jdkr=|jj|fd|ji|IdH}dd|D}|S|jdkrT|jj|fd|ji|IdH}|S|jdkrr|jj|fd|ji|IdH}dd|D}|S|jd kr|jj|fd|ji|IdH}|S|jd krd d|jj |fd|ji|IdHD}|St d |jd )NrrrcSrJrararKrararbrrzLAzureSearchVectorStoreRetriever._aget_relevant_documents..rrcSrJrararKrararbrrrrcSrJrararKrararbrrrr ) rrrr.rrEr/ror0r4r)r_rrrhrr$rNrararb_aget_relevant_documentssf           z8AzureSearchVectorStoreRetriever._aget_relevant_documentsN)rrrHr)rr.rrrhrrHr)rr.rrrhrrHr)rkrlrmr__annotations__rrrrrZ model_configrrrrrrarararbrAs&       'rrUSearchItemPaged[Dict]r&cCsdd|D}|S)NcSs g|] }t|t|dfqSr_result_to_documentr]rrararbrs  z)_results_to_documents..rarUr$rararbrSsrSAsyncSearchItemPaged[Dict]csdd|2IdH}|S)Ncs,g|z3dHW}t|t|dfq6SNrrrrararbrs z*_aresults_to_documents..rarrararbrXs  rXrZrr` np.ndarrayr\r]rr\c spdd|2IdH}ttt|\}}}t||||d}g} |D]} | dkr*| S| || || fq!| S)Ncs2g|z3dHW}t|t|d|tfq6Srrr]rrrararbrs zE_areorder_results_with_maximal_marginal_relevance..rr\maprrrr  rUr`r\rr$rZscoresZvectorsZ new_orderingretr}rararbrfs rfc Cspdd|D}|s gSttt|\}}}t||||d}g} |D]} | dkr*| S| || || fq!| S)NcSs&g|]}t|t|d|tfqSrrrrararbrs zD_reorder_results_with_maximal_marginal_relevance..rrrrrararbrbs rbr@rrcCsvt|vrt|ttr|t}nt|t}n dd|D}t|vr-t|ti}ni}t|t i||dS)NcSs"i|] \}}|ttfvr||qSra)rrrzrararbrw(s  z'_result_to_document..r) rrrrrrrr(rr)r@Zfields_metadataZ fields_idrararbr s$ riterabler r) Optional[Any]Tuple[Iterable, Any]cCsDzt|}t|}t|g|}||fWSty!||fYSwri)iternext itertoolschain StopIteration)rr)iteratorr{rararbr;s   r)NNNNNNNNNr,NFNNN)$r-r.r/r.r(r0r1r0r2r0r3r4r5r6r7r8r9r:r;r0r<r4r=r0r>r?r@rArBrCrDrErFrGrHrI)rUrrHr&)rUrrHr&)rZr) rUrr`rr\r]rr\rHr&)r@rrHrri)rr r)rrHr)N __future__rrrrrloggingr]rtypingrrrrrrr r r r r rrrnumpyrZlangchain_core.callbacksrrZlangchain_core.documentsrZlangchain_core.embeddingsrZlangchain_core.exceptionsrZlangchain_core.retrieversrZlangchain_core.utilsrZlangchain_core.vectorstoresrZpydanticrrZ&langchain_community.vectorstores.utilsr getLoggerrrrZazure.core.credentials_asyncrrrrrr rrr"r#r$r%r&rrrrr rrrrSrXrfrbrrrarararbs @             K.   $ #