o ¾¿iÖ3ã@s$ddlmZddlmZmZmZmZmZddlm Z zddlm Z Wne y1ddl m Z Ynwddl mZmZddlmZmZe Gdd„dƒƒZGd d „d eƒZe Gd d „d ƒƒZGd d„dƒZGdd„deƒZe Gdd„dƒƒZe Gdd„dƒƒZe Gdd„deƒƒZe Gdd„dƒƒZdS)é)ÚEnum)ÚAnyÚDictÚListÚOptionalÚUnion)Ú experimental)ÚSelf)ÚLimitÚReducer)ÚFilterÚ SortbyFieldc @sxeZdZ  ddedeedeeddfdd„Zdefdd „Zdeddfd d „Zd eddfd d„Zde efdd„Z dS)ÚHybridSearchQueryNÚ query_stringÚscorerÚyield_score_asÚreturncCs||_||_||_dS)aB Create a new hybrid search query object. Args: query_string: The query string. scorer: Scoring algorithm for text search query. Allowed values are "TFIDF", "TFIDF.DOCNORM", "DISMAX", "DOCSCORE", "BM25", "BM25STD", "BM25STD.TANH", "HAMMING", etc. For more information about supported scoring algorithms, see https://redis.io/docs/latest/develop/ai/search-and-query/advanced-concepts/scoring/ yield_score_as: The name of the field to yield the score as. N)Ú _query_stringÚ_scorerÚ_yield_score_as)Úselfrrr©rúV/home/ubuntu/.local/lib/python3.10/site-packages/redis/commands/search/hybrid_query.pyÚ__init__s zHybridSearchQuery.__init__cCó|jS)z-Return the query string of this query object.)r©rrrrr'ózHybridSearchQuery.query_stringcCó ||_|S)ab Scoring algorithm for text search query. Allowed values are "TFIDF", "TFIDF.DOCNORM", "DISMAX", "DOCSCORE", "BM25", "BM25STD", "BM25STD.TANH", "HAMMING", etc. For more information about supported scoring algorithms, see https://redis.io/docs/latest/develop/ai/search-and-query/advanced-concepts/scoring/ )r)rrrrrr+ó zHybridSearchQuery.scorerÚaliascCr)z- Yield the score as a field. ©r©rrrrrr7óz HybridSearchQuery.yield_score_ascCs:d|jg}|jr| d|jf¡|jr| d|jf¡|S)NÚSEARCHÚSCORERÚYIELD_SCORE_AS)rrÚextendr©rÚargsrrrÚget_args>s zHybridSearchQuery.get_args)NN) Ú__name__Ú __module__Ú __qualname__Ústrrrrrrrr)rrrrrs üþýü û rc@óeZdZdZdZdS)ÚVectorSearchMethodsÚKNNÚRANGEN)r*r+r,r0r1rrrrr/Gór/c@sÀeZdZ    ddedeeefdeedeeee fdeddeed dfd d „Z d efd d „Z d eeeffdd„Z ded dfdd„Z ddd„Zded dfdd„Zd eefdd„ZdS)ÚHybridVsimQueryNÚvector_field_nameÚ vector_dataÚvsim_search_methodÚvsim_search_method_paramsÚfilterr rrcCs>||_||_|r|r|j|fi|¤Žnd|_||_||_dS)a5 Create a new hybrid vsim query object. Args: vector_field_name: Vector field name. vector_data: Vector data for the search. vsim_search_method: Search method that will be used for the vsim search. vsim_search_method_params: Search method parameters. Use the param names for keys and the values for the values. Example for KNN: {"K": 10, "EF_RUNTIME": 100} where K is mandatory and defines the number of results and EF_RUNTIME is optional and definesthe exploration factor. Example for RANGE: {"RADIUS": 10, "EPSILON": 0.1} where RADIUS is mandatory and defines the radius of the search and EPSILON is optional and defines the accuracy of the search. yield_score_as: The name of the field to yield the score as. filter: If defined, a filter will be applied on the vsim query results. N)Ú _vector_fieldÚ _vector_dataÚvsim_method_paramsÚ_vsim_method_paramsÚ_filterr)rr4r5r6r7r8rrrrrNs zHybridVsimQuery.__init__cCr)z2Return the vector field name of this query object.)r9rrrrÚ vector_fieldvrzHybridVsimQuery.vector_fieldcCr)z,Return the vector data of this query object.)r:rrrrr5zrzHybridVsimQuery.vector_dataÚmethodcKsL|jg}|r!| t| ¡ƒd¡| ¡D] \}}| ||f¡q||_|S)aB Add search method parameters to the query. Args: method: Vector search method name. Supported values are "KNN" or "RANGE". kwargs: Search method parameters. Use the param names for keys and the values for the values. Example: {"K": 10, "EF_RUNTIME": 100}. é)ÚvalueÚappendÚlenÚitemsr&r<)rr?Úkwargsr;ÚkeyrArrrr;~s z"HybridVsimQuery.vsim_method_paramsÚfltÚ HybridFiltercCr)z‚ Add a filter to the query. Args: flt: A HybridFilter object, used on a corresponding field. ©r=)rrGrrrr8”szHybridVsimQuery.filterrcCr)z@ Return the score as a field with name `alias`. r r!rrrržr"zHybridVsimQuery.yield_score_ascCsNd|j|jg}|jr| |j¡|jr| |jj¡|jr%| d|jf¡|S)NÚVSIMr%)r9r:r<r&r=r(rr'rrrr)¥s zHybridVsimQuery.get_args)NNNN)rGrHrr3)r*r+r,r-rÚbytesrr/rrrr>r5r;r8rrr)rrrrr3Ls<ùþ ýüûúù ø(þ ü  r3c@s4eZdZdededdfdd„Zdeefdd„ZdS) Ú HybridQueryÚ search_queryÚvector_similarity_queryrNcCó||_||_dS)zô Create a new hybrid query object. Args: search_query: HybridSearchQuery object containing the text query. vector_similarity_query: HybridVsimQuery object containing the vector similarity query. N)Ú _search_queryÚ_vector_similarity_query)rrMrNrrrr²s zHybridQuery.__init__cCs(g}| |j ¡¡| |j ¡¡|S)N)r&rPr)rQr'rrrr)ÁszHybridQuery.get_args) r*r+r,rr3rrr-r)rrrrrL±sþý ürLc@r.)ÚCombinationMethodsÚRRFÚLINEARN)r*r+r,rSrTrrrrrRÈr2rRc@s8eZdZdeddfdd„Zdeeeeffdd„Z dS)ÚCombineResultsMethodr?rNcKrO)aý Create a new combine results method object. Args: method: The combine method to use - RRF or LINEAR. kwargs: Additional combine parameters. For RRF, the following parameters are supported(at least one should be provided): WINDOW: Limits fusion scopeLimits fusion scope. CONSTANT: Controls decay of rank influence. YIELD_SCORE_AS: The name of the field to yield the calculated score as. For LINEAR, supported parameters (at least one should be provided): ALPHA: The weight of the first query. BETA: The weight of the second query. YIELD_SCORE_AS: The name of the field to yield the calculated score as. The additional parameters are not validated and are passed as is to the server. The supported format is to provide the parameter names and values like the following: CombineResultsMethod(CombinationMethods.RRF, WINDOW=3, CONSTANT=0.5) CombineResultsMethod(CombinationMethods.LINEAR, ALPHA=0.5, BETA=0.5) N)Ú_methodÚ_kwargs)rr?rErrrrÏs zCombineResultsMethod.__init__cCsPd|jjg}|jr&| t|j ¡ƒd¡|j ¡D] \}}| ||f¡q|S)NÚCOMBINEr@)rVrArWrBrCrDr&)rr(rFrArrrr)çs zCombineResultsMethod.get_args) r*r+r,rRrrrr-Úintr)rrrrrUÍsrUc@sœeZdZddd„Zdedefdd„Zdeededefd d „Z defd d „Z d ddefdd„Z dddefdd„Z de de defdd„Zdeefdd„ZdS)ÚHybridPostProcessingConfigrNcCs(g|_g|_g|_g|_d|_d|_dS)zK Create a new hybrid post processing configuration object. N)Ú_load_statementsÚ_apply_statementsÚ_groupby_statementsÚ_sortby_fieldsr=Ú_limitrrrrròs  z#HybridPostProcessingConfig.__init__ÚfieldscGs6|rd |¡}| d¡}|j dt|ƒg|¢R¡|S)z= Add load statement parameters to the query. ú ÚLOAD)ÚjoinÚsplitr[r&rC)rr`Ú fields_strÚ fields_listrrrÚloadýs   zHybridPostProcessingConfig.loadÚreducerscGs„t|tƒr|gn|}dtt|ƒƒg|¢}|D]#}| d|jtt|jƒƒf¡| |j¡|jdur9| d|jf¡q|j |¡|S)al Specify by which fields to group the aggregation. Args: fields: Fields to group by. This can either be a single string or a list of strings. In both cases, the field should be specified as `@field`. reducers: One or more reducers. Reducers may be found in the `aggregation` module. ÚGROUPBYÚREDUCENÚAS)Ú isinstancer-rCr&ÚNAMEr(Ú_aliasr])rr`rhÚretÚreducerrrrÚgroup_bys   € z#HybridPostProcessingConfig.group_bycKsNg}| ¡D]\}}d|g}|dur| d|f¡| |¡q|j |¡|S)aO Specify one or more projection expressions to add to each result. Args: kwexpr: One or more key-value pairs for a projection. The key is the alias for the projection, and the value is the projection expression itself, for example `apply(square_root="sqrt(@foo)")`. ÚAPPLYNrk)rDr&r\)rÚkwexprÚ apply_argsrÚexprrorrrÚapplys   z HybridPostProcessingConfig.applyÚsortbyr cGsg|¢|_|S)z5 Add sortby parameters to the query. )r^)rrwrrrÚsort_by2s z"HybridPostProcessingConfig.sort_byr8rHcCr)zí Add a numeric or string filter to the query. Currently, only one of each filter is supported by the engine. Args: filter: A NumericFilter or GeoFilter object, used on a corresponding field. rI)rr8rrrr89rz!HybridPostProcessingConfig.filterÚoffsetÚnumcCst||ƒ|_|S)z4 Add limit parameters to the query. )r r_)rryrzrrrÚlimitEs z HybridPostProcessingConfig.limitcCs¢g}|jr | |j¡|jr| |j¡|jr| |j¡|jr:g}|jD]}| |j¡q%| dt|ƒg|¢R¡|jrD| |jj¡|jrO| |j  ¡¡|S)NÚSORTBY) r[r&r]r\r^r(rCr=r_Ú build_args)rr(Ú sortby_argsÚfrrrr}Ls"    z%HybridPostProcessingConfig.build_args)rN)r*r+r,rr-r rgrr rqrvrxr8rYr{r}rrrrrZðs    rZc@seZdZdeddfdd„ZdS)rHÚ conditionsrNcCs|g}tj|dg|¢RŽdS)zn Create a new hybrid filter object. Args: conditions: Filter conditions. ÚFILTERN)r r)rr€r(rrrrcs zHybridFilter.__init__)r*r+r,r-rrrrrrHas þýrHc@s,eZdZd dededdfdd„Zdd „ZdS) ÚHybridCursorQueryrÚcountÚmax_idlerNcCrO)zÆ Create a new hybrid cursor query object. Args: count: Number of results to return per cursor iteration. max_idle: Maximum idle time for the cursor. N)rƒr„)rrƒr„rrrrss zHybridCursorQuery.__init__cCs:dg}|jr|dt|jƒg7}|jr|dt|jƒg7}|S)NÚ WITHCURSORÚCOUNTÚMAXIDLE)rƒr-r„r'rrrr}~s zHybridCursorQuery.build_args)rr)r*r+r,rYrr}rrrrr‚qs r‚N)ÚenumrÚtypingrrrrrÚ redis.utilsrr Ú ImportErrorÚtyping_extensionsÚ!redis.commands.search.aggregationr r Úredis.commands.search.queryr r rr/r3rLrRrUrZrHr‚rrrrÚs2   ÿ7d"p