mBNj%ddlZddlZddlmZmZmZmZmZddlm Z ddl m Z m Z ddl mZmZmZmZddlmZmZddlmZmZmZmZmZdd lmZmZd d lmZm Z m!Z!d d l"m#Z#d d l$m%Z%d dl&m'Z'd dl(m)Z)d dl*m+Z+d dl,m-Z-d dl.m/Z/dZ0dZ1dZ2dZ3dZ4dZ5dZ6dZ7dZ8dZ9dZ:dZ;dZd"Z?d#Z@d$ZAd%ZBd&ZCd'ZDd(ZEd)ZFd*ZGd+ZHd,ZId-ZJd.ZKd/ZLd0ZMd1ZNd2ZOd3ZPd4ZQd5ZRd6ZSd7ZTd8ZUd9ZVd:ZWd;ZXdZZGd?d@eZZ[y)AN)AnyDictListOptionalUnion) pairs_to_dict) NEVER_DECODEPipeline)CombineResultsMethodHybridCursorQueryHybridPostProcessingConfig HybridQuery)HybridCursorResult HybridResult)check_protocol_versiondecode_field_valuedeprecated_functionexperimental_method str_if_bytes)get_legacy_responsesget_protocol_version)AggregateRequestAggregateResultCursor)Document)Field)IndexDefinition)ProfileInformation)Query)Result)SuggestionParserNUMERICz FT.CREATEzFT.ALTERz FT.SEARCHzFT.ADDz FT.ADDHASHz FT.DROPINDEXz FT.EXPLAINz FT.EXPLAINCLIzFT.DELz FT.AGGREGATEz FT.PROFILEz FT.CURSORz FT.SPELLCHECKz FT.DICTADDz FT.DICTDELz FT.DICTDUMPzFT.MGETz FT.CONFIGz FT.TAGVALSz FT.ALIASADDzFT.ALIASUPDATEz FT.ALIASDELzFT.INFOz FT.SUGADDz FT.SUGDELz FT.SUGLENz FT.SUGGETz FT.SYNUPDATEz FT.SYNDUMPz FT.HYBRID NOOFFSETSNOFIELDSNOHLNOFREQS MAXTEXTFIELDS TEMPORARY STOPWORDSSKIPINITIALSCAN WITHSCORESFUZZY WITHPAYLOADSceZdZdZeeeeee hZ dZ dZ e ddZe dZdZdZd Zd Zd Zd Zd ZdZdZdZehdZe dZdZdZdZdZdZ dZ!dZ"dZ#dZ$e dZ%e dZ&dZ'dZ(d Z)d!Z*d"Z+e dd#Z,e d$Z-d%Z.e d&Z/d'Z0d(Z1d)Z2d*Z3dd+Z4 dd,e5e6d-e7d.e7d/e8e5e9d0e8e:d1e7d2e7d3e7fd4Z;d,e dd8Z? dd9Z@eAd:d;< dd=e9d>e7d?eBd@e8e7dAe7dBe7dCe8e9dDe7d,e5e9fdEZCeAd:d;<ddFZDeAd:dG<ddHZEddIe8eFe9eGffdJZHeAd:dG<dKZIdLZJdMe8eFe9et|jt|j@t |jt|jBt|jt|jDt|jFi|_$tK|j6|_&|jN|jLt<|jP|jLt<|jR|jLt<|jT|jLt<y)aBuild the per-protocol module callback maps. Called from ``Search.__init__``, ``Pipeline.__init__`` and ``AsyncPipeline.__init__`` so the mapping lives in a single place rather than being duplicated across all three classes. N)+INFO_CMD _parse_info SEARCH_CMD _parse_search HYBRID_CMD_parse_hybrid_search AGGREGATE_CMD_parse_aggregate PROFILE_CMD_parse_profileSPELLCHECK_CMD_parse_spellcheck CONFIG_CMD_parse_config_get SYNDUMP_CMD_parse_syndump_RESP2_MODULE_CALLBACKS!_parse_hybrid_search_resp3_native_RESP3_MODULE_CALLBACKS_parse_info_resp3_to_legacy_parse_search_resp3_parse_hybrid_search_resp3_parse_aggregate_resp3_parse_profile_resp3_parse_spellcheck_resp3!_parse_config_get_resp3_to_legacy_parse_syndump_resp3'_RESP3_TO_RESP2_LEGACY_MODULE_CALLBACKS&_pipeline_parse_search_resp3_to_legacy-_pipeline_parse_hybrid_search_resp3_to_legacy)_RESP3_TO_RESP2_LEGACY_PIPELINE_CALLBACKS_parse_info_unified_parse_hybrid_search_unified_parse_profile_unified_parse_config_get_unified_parse_syndump_unified_RESP2_UNIFIED_MODULE_CALLBACKSdict_RESP3_UNIFIED_MODULE_CALLBACKS_parse_info_resp3_parse_config_get_resp3_parse_profile_resp3_unified"_parse_hybrid_search_resp3_unified)selfs o/Users/ahmed/devFolder/Ultron/claude-voice/.venv/lib/python3.12/site-packages/redis/commands/search/commands.py_init_module_callbacksz%SearchCommands._init_module_callbacks^s d&& ** 11 400 ,, D22 .. ,, ( $ >>( $ d66 00 77 466 22 D88 >> 22 8 4 CC JJ: 6 d.. ** 99 400 44 D22 66 44 0 ,04  8 80 ,:>9O9O,,X6;?;W;W,,Z8  - - ,,[9  3 3 ,,Z8c ||jvrd|vr|St|j}t|j}|rx|dvr0|tk(r t |S|j j|}nt|dr|jj|}n_|jj|}nCt|dr|jj|}n|jj|}||S||fi|S)Nquery)3rd) _QUERY_REQUIRED_CMDSrclientrr;r rEgetrrNrCrYrW)r^cmdreskwargsprotocollegacycbs r__parse_resultszSearchCommands._parse_resultss $++ +v0EJ' 4%dkk2 8#+%-c221155c:'!4AAEEcJ1155c:%h299==cB99==cB :J#   raNct|ts|S|j||j|j|SN) isinstancerXrhencode)mappingkeydefaults r_ _resp3_getzSearchCommands._resp3_gets3'4(N{{3 CJJL' BCCract|ts|Sg}|jD]0\}}|jt ||j|2|Srq)rrrXitemsappendr)rtflatruvalues r__flatten_resp3_mappingz%SearchCommands._flatten_resp3_mappingsN'4(N!--/JC KK S) * KK * rac |jd}|t|ts|S|j|ddg}|j|dgD]}|j |j|d|j r!|j |j|d|j r!|j |j|d|jr|j |j|j|di|S) zDConvert RESP3 FT.SEARCH pipeline output to raw RESP2 pipeline shape.rc total_resultsrresultsidscorepayloadextra_attributes) rhrrrXrwrz _with_scores_with_payloads _no_contentr})r^rjrkrcoutputitems r_rOz5SearchCommands._pipeline_parse_search_resp3_to_legacys 7# = 3 5J//#:;OOCB7D MM$//$5 6!! doodG<=## doodI>?$$ //.@"E8 rac t|ts|S|jDcic]\}}t||}}}d|vr$d|j dd|j dgS|j dgDcgc]%}t|tr|j |n|'}}d|j ddd|d|j dgd|j ddgScc}}wcc}w) zDConvert RESP3 FT.HYBRID pipeline output to raw RESP2 pipeline shape.cursorSEARCHVSIMrrrwarningsexecution_time)rrrXryrrhr})r^rjrkrur|rrs r_rPzz SearchCommands._parse_spellcheck8s !8 K+s+ q0@;1$q>q>!$$JUUV+IW%(%(;+K A '5< +s A)c B|r|Dcic] }|d|d c}SiScc}wNrrr^rjrkkvss r_r@z SearchCommands._parse_config_get]s-25#.#3AA#.=2=.sc htdt|dDcic]}||||dzc}Scc}wNrrr)ranger)r^rjrkis r_rBzSearchCommands._parse_syndump`s:,1!SXq,AB,AqAAE ",ABBBs/>typeWEIGHTPHONETIC SEPARATOR attribute identifierci}g}tj}d}|t|krbt||}||vr+|dzt|krt||dz||<|dz }n|j ||dz }|t|krb||d<|S)aCConvert a RESP2 flat attribute list into a RESP3-style dict. RESP2 format: ``[identifier, name, attribute, alias, type, TEXT, WEIGHT, 1, SORTABLE, NOSTEM]``. RESP3 format: ``{"identifier": name, "attribute": alias, "type": "TEXT", "WEIGHT": "1", "flags": ["SORTABLE", "NOSTEM"]}``. rrrflags)r1_INFO_ATTR_PAIR_KEYSrrrz) attr_listrr pair_keysrrus r__normalize_info_attributez(SearchCommands._normalize_info_attributeks"77 #i. y|,CiAEC N$:*9QU+;<s Q S!Q#i.  w rac tt|}tt||}d|vrJt |dt r7|dDcgc]%}t |t r|j |n|'c}|d<|Scc}w)zParse FT.INFO into the unified shape with ``attributes`` as a list of dicts so RESP2 output matches RESP3 output. attributes)rrrXrrrlistr)r^rjrkrinfoattrs r_rRz"SearchCommands._parse_info_unifiedss #CBK  4 JtL/A4$H!.".D9C48N..t4TXX."D  "s*A6c t|d}d|vr%tt|dt|dS|jd i|}g}|dD]S}t|d}|j |j D cic]\}} ||j | ||c} }Utt|d||d t|d  Scc} }w) NTrrrrrrrrrrr) rrr_hybrid_field_encodingsrzry_decode_hybrid_field_valuerr) r^rjrkrrrrrrur|s r_rSz+SearchCommands._parse_hybrid_search_unifieds $7 v %!$Xh%7!8"8F#34  7$66@@(* +H%hDAI NN'0oo&7&7 U88_UU&7 ,h78j) *:!;<   s>C c l|d}t|tr!|j|d||j}n5t |d|j |d|j |j}|d}t|tr(|r&t|dttfr t|d}|t|fS)zParse FT.PROFILE into ``(result, ProfileInformation)`` with the profile_data normalised to a dict on >= 7.9.0 servers. rcrrrrTr) rrrrrr"rrrrstrbytesrr )r^rjrkrcr profile_datas r_rTz%SearchCommands._parse_profile_unifiedsw e- .//Au}}MFA%%% +!00!.. F1v |T *<?S%L9(4HL),777rac f|siS|Dcic]}t|dt|dc}Scc}wr)rrs r_rUz(SearchCommands._parse_config_get_unifieds9IFIJcs SV$l3q6&::cJJJs".c |siStdt|dDcic]U}t||t||dztr||dzDcgc] }t|c}nt||dzWc}}Scc}wcc}}wr)rrrrrr)r^rjrkrss r_rVz%SearchCommands._parse_syndump_unifiedsI 1c#h*  + Q #a!e*d+=@AJ"GJq<?J"Gc!a%j) *+   "G s2BA<"B<Bc |jd}tj||jddt|ddt|ddS) z4Parse RESP3 FT.SEARCH response into a Result object.rcrrrFrN)rrr)rhr" from_resp3getattr)r^rjrkrcs r_rGz"SearchCommands._parse_search_resp3sM 7#  ZZ A.~u=#E+EtL   rac Z|jd}|jdd}d}|r+t|tr|d}t|dkDr|dnd}n|}|i}|j Dcic]\}}t ||}}}|jdgD cgc] } t | } } |jdd} g} |jd gD]} | j Dcic]\}}t ||} }}| jd i}g}|j D]'\}}|j ||j |)| j |d}|r%t|tr ||_|}n t|}t| |d| | Scc}}wcc} wcc}}w) zAParse RESP3 FT.AGGREGATE response into an AggregateResult object.rcrFrrNwarningrrr)totalr) rhrrrrryrrzrcidr)r^rjrkrcr cursor_iddatakvwrrrows result_item extra_attrsr{rs r_rIz%SearchCommands._parse_aggregate_resp3s 7#ZZ e4  *S$/q6D"%c(Q,AAID <D04zz|<|tq! Q"|<-1XXi-DE-DLO-DE!,88Ir2K:E:K:K:MN:M$!Q<?A-:MKN%//*   ; Qs D)D/ c 8|jDcic]\}}t||}}}d|vr%tt|dt|dS|jd i|}g}|j dgD]}t |trW|j|jD cic]+\}} t||j| t||-c} }jt|d} |j| jD cic]\}} ||j| ||c} }tt|j dd ||j d gt|j d d  Scc}}wcc} }wcc} }w)z=Parse RESP3 FT.HYBRID into the approved unified HybridResult.rrrrrTrrrrrrr) ryrrrrrhrrrXrzrrrr) r^rjrkrrrrrrur|rs r_r]z1SearchCommands._parse_hybrid_search_resp3_unified0s.1iik:kda|A!k: v %!$S]!3"3v;/  7$66@@(* 2.H(D) +3..*: +;JC%S)4+J+J!<#4o,+; *(E  +4//*; +   ?;sF -0F F c i}dD]4}|j|}t|dd}|s$|j|6|xsdS)N)rcpost_processingr)rhrupdate)rk encodings source_namesourcesource_encodingss r_rz&SearchCommands._hybrid_field_encodingsXsN 7KZZ ,F&v/I4P   !12 8  D rac,|r||vr|St|||Srq)r)r|rurs r_rz)SearchCommands._decode_hybrid_field_valuebs #_"<L!%o>>rac |jDcic]\}}t||}}}d|vr|Sd|vrb|dDcgc]L}t|tr-|jDcic]\}}t||c}}n t |dNc}}}|d<d|vr|dDcgc] }t|c}|d<|Scc}}wcc}}wcc}}}wcc}w)a[Normalise RESP3 FT.HYBRID map keys while preserving native shape. ``protocol=3`` + ``legacy_responses=True`` keeps the RESP3 dict surface, but HYBRID uses ``NEVER_DECODE`` so result values mirror legacy RESP2 bytes. Decode only structural keys so callers can use the same native RESP3 key names as before. rrTrr)ryrrrrXr)r^rjrkrrrrs r_rDz0SearchCommands._parse_hybrid_search_resp3_nativehs/2iik:kda|A!k: v J    N +DdD)15 = 1a!# ="4T:;+ C N  8;JH1|AHC O ; >Is#B>(C (C>C $CC c t|ts|j|fi|S|jDcic]\}}t ||}}}i}|j di}|jD]f\}}|s g} |D]O} | jD]:\} } t | } | jdr| dd} | j| | d<Q| sb| ||<h|Scc}}w)a#Parse RESP3 FT.SPELLCHECK response into unified format. RESP3 format: {"results": {"term": [{"suggestion": score}, ...], ...}} Unified format (matches RESP2 parsed output): {"term": [{"score": score_str, "suggestion": suggestion}, ...], ...} rz.0Nr) rrrXr>ryrrhrendswithrz)r^rjrkrrrrterm suggestionsterm_correctionssuggestion_dictrr score_strs r_rKz&SearchCommands._parse_spellcheck_resp3s#t$)4))#88 8/2iik:kda|A!k: '')R(!( D+! #.)8)>)>)@%J!$E I ))$/$-crN %++"+:F*A$/ $4 D!'"1(/;sCc |d}|jd}||jd}||jd}||jd}||jd}|jd}||jd}||jd }||jd }||jd }t|trt||d }t|tr(|j ||t |j }n3tj||jddt|dd}|j|}||fS)zExtract ``(result, profile_data_dict)`` from a RESP3 FT.PROFILE response. ``profile_data_dict`` has its keys/values normalised to strings but is otherwise left as the native RESP3 dict. rcResultssResultsrsresultsrProfilesProfileprofilesprofiler)rrrcrrrF)rr) rhrrrrrrIboolrr"rr_to_string_recursive)r^rjrkrc results_datarrs r__extract_resp3_profile_partsz+SearchCommands._extract_resp3_profile_partsse wwwy)  77:.L  779-L  77:.L  771:Lwwy)  77:.L  779-L  77:.L  771:L lD )!$\!2'L e- .00Ed5==6I1F&&J2#E>5AF 00> |##rac t|tr|j|fi|S|j|fi|\}}t|trd|vxsd|v}|j ||}|t |fS)aParse RESP3 FT.PROFILE response into ``(result, ProfileInformation)``. RESP3 format (aligned, RediSearch >= MOD-6816): {"Results": {search/aggregate result dict}, "Profile": {profile information dict}} Older RediSearch versions may return a list (same as RESP2) even when the connection uses RESP3. In that case we delegate to the RESP2 ``_parse_profile`` parser. Shards Coordinator)flat_top)rrrr<rrX_resp3_profile_dict_to_listr )r^rjrkrrrs r_rJz#SearchCommands._parse_profile_resp3s c4 &4&&s5f5 5@t@@OO  lD )</P=L3PH;;x<L),777rac t|tr|j|fi|S|j|fi|\}}t|trd|vsd|vs|j |}|t |fS)aParse RESP3 FT.PROFILE for the unified shape. Redis < 7.9.0 returns RESP2 profile data as nested list-of-pairs, while RESP3 returns the same data as a dict. Convert that pre-7.9 RESP3 dict back to the RESP2 list shape so the unified surface is protocol-independent. Redis >= 7.9.0 coordinator profiles contain ``Shards``/``Coordinator`` keys and stay as dicts, matching the RESP2 unified parser. rr)rrrrTrrXrr )r^rjrkrrs r_r\z+SearchCommands._parse_profile_resp3_unifieds| c4 .4..s=f= =@t@@OO lD )  $ (E;;LIL),777rac2ddfd |dS)a*Convert a RESP3 profile dict into the RESP2 wire list shape. Pre-7.9.0 servers serialise the RESP2 profile as a list of ``[key, value]`` pairs at the top level, with nested structures as flat alternating key-value lists. Post-7.9.0 servers serialise the top level itself as a flat ``[key, value, key, value]`` list (with ``"Shards"``/``"Coordinator"`` keys). ``flat_top`` selects between these two top-level shapes; nested dicts always use the flat alternating form. Key structural difference: when a dict value is a list of dicts (e.g. ``"Child iterators": [{...}, {...}]``), RESP2 expands each dict as a separate sibling element in the parent flat list rather than keeping them nested inside a single value. cTt|txr|xrt|dtS)Nr)rrrrX)objs r__is_list_of_dictszESearchCommands._resp3_profile_dict_to_list.._is_list_of_dictss$c4(MSMZA5M Mrac8t|tr|rp sng}|jD]W\}}|g}|r|D]}|j|n|j||j|Y|Sg}|jD]T\}}|j||r|D]}|j|>|j|V|St|tr|Dcgc] }| c}S|Scc}wrq)rrrXryrzr) r  top_levelrrrentryr_convertr rs r_rz._converts#t$XF # 1!",Q/() % Xd^ <)*"LL!5 e,!,"MF # 1 a(,Q/() & htn =)*#MM(1+6 !,"MC&36734377J8sDT)rFr)rrrr s `@@r_rz*SearchCommands._resp3_profile_dict_to_list s$ N 6--rac|t|tr t|St|trR|j Dcic]6\}}t|tr t|n|t j |8c}}St|tr#|Dcgc]}t j |c}S|Scc}}wcc}w)zRecursively convert bytes keys/values to strings in nested structures. Non-bytes scalars (int, float, None, bool) pass through unchanged. )rrrrrXryr1rr)r rrrs r_rz#SearchCommands._to_string_recursive>s c5 !$ $ c4  IIK (DAq$.a#7 QQ"77:;(   c4 JMN#$N77=#N N Os ;B3B9c $|j|S)z;Parse RESP3 FT.INFO response, normalising bytes to strings.rrs r_rZz SearchCommands._parse_info_resp3Qs((--racg}|jdxsg}|jD]-\}}|dk(r |j||j|/|j||S)zConvert a RESP3-style attribute dict back into the RESP2 flat list (key-value pairs followed by bare flag tokens). r)rhryrzextend) attr_dictr{rrrs r__flatten_info_attributez&SearchCommands._flatten_info_attributeUsd  g&,"OO%DAqG| KKN KKN & E rac |j|}|jd}t|tr4|Dcgc]%}t|tr|j |n|'c}|d<|Scc}w)zParse RESP3 FT.INFO into the legacy RESP2 flat shape so ``legacy_responses=True`` on a RESP3 wire matches RESP2 output. r)rrhrrrrXr)r^rjrkrattrsrs r_rFz*SearchCommands._parse_info_resp3_to_legacydsw((-& eT """!D7At6L,,T2RVV!"D  "s*A)c |siS|jDcic]\}}t|t|c}}Scc}}w)zAParse RESP3 FT.CONFIG GET response, normalising bytes to strings.)ryr)r^rjrkrrs r_r[z&SearchCommands._parse_config_get_resp3qs9I=@YY[I[TQ Qa0[IIIs;c |r t|SiS)z>Parse RESP3 FT.CONFIG GET back to the RESP2 legacy dict shape.)rXrs r_rLz0SearchCommands._parse_config_get_resp3_to_legacywstCy'R'rac ,|siS|j|S)z>Parse RESP3 FT.SYNDUMP response, normalising bytes to strings.rrs r_rMz#SearchCommands._parse_syndump_resp3{sI((--rac(|j||S)zT Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)r^r s r_ batch_indexerzSearchCommands.batch_indexers  * ==rafieldsno_term_offsetsno_field_flags stopwords definition no_highlightno_term_frequenciesskip_initial_scanc 6t|jg} || |jz } |r| jt|6t |t r&| jt| j||r| jt|r| jt|r| jt| r| jt| r| jt|Kt |tttfr0| t t#|gz } t#|dkDr| t|z } | jd | tt%j&d|Dz } |j,| S#t($r| |j+z } Y-wxYw)a Creates the search index. The index must not already exist. For more information, see https://redis.io/commands/ft.create/ Args: fields: A list of Field objects. no_term_offsets: If `true`, term offsets will not be saved in the index. no_field_flags: If true, field flags that allow searching in specific fields will not be saved. stopwords: If provided, the index will be created with this custom stopword list. The list can be empty. definition: If provided, the index will be created with this custom index definition. max_text_fields: If true, indexes will be encoded as if there were more than 32 text fields, allowing for additional fields beyond 32. temporary: Creates a lightweight temporary index which will expire after the specified period of inactivity. The internal idle timer is reset whenever the index is searched or added to. no_highlight: If true, disables highlighting support. Also implied by `no_term_offsets`. no_term_frequencies: If true, term frequencies will not be saved in the index. skip_initial_scan: If true, the initial scan and indexing will be skipped. rSCHEMAc3<K|]}|jywrq redis_args.0fs r_ z.SearchCommands.create_index..*J6a1<<>6) CREATE_CMD index_nameargsrzr)rrrr*r%r'r&r(r,rtuplesetr+r itertoolschain TypeErrorr/execute_command) r^r#r$r%r&r'max_text_fields temporaryr(r)r*r8s r_ create_indexzSearchCommands.create_indexsSNDOO,  ! JOO #D  KK &  Z 3%? KK " KK "  KK "  KK   KK !  KK  KK (  Z D%;M%N YI/ /D9~!Y' H ( D*J6*JKL LD$t##T** ( F%%' 'D (s%E99FFct|jddg} |ttjd|Dz }|j|S#t $r||j z }Y-wxYw)a Alter the existing search index by adding new fields. The index must already exist. ### Parameters: - **fields**: a list of Field objects to add for the index For more information see `FT.ALTER `_. r,ADDc3<K|]}|jywrqr.r0s r_r3z2SearchCommands.alter_schema_add..r4r5) ALTER_CMDr7rr;r<r=r/r>)r^r#r8s r_alter_schema_addzSearchCommands.alter_schema_addsr4??He< ( D*J6*JKL LD$t##T** ( F%%' 'D (s%A A)(A)delete_documentsct|jg}t|tr|durdnd}|r|j ||j |S)ai Drop the index if it exists. Replaced `drop_index` in RediSearch 2.0. Default behavior was changed to not delete the indexed documents. ### Parameters: - **delete_documents**: If `True`, all documents will be deleted. For more information see `FT.DROPINDEX `_. TDD) DROPINDEX_CMDr7rrrrzr>)r^rGr8 delete_strs r_ dropindexzSearchCommands.dropindexsXt/*D16F$6N    KK ##t##T**rac  |s| rd}t|j||g} |r| jd|"| jd| j||r7| jd|r| jd| r| jd|r| d|gz } | jd| tt j | j z } ||j| S|j| S) zS Internal add_document used for both batch and single doc indexing TNOSAVEPAYLOADREPLACEPARTIALNOCREATELANGUAGEFIELDS)ADD_CMDr7rzrr;r<ryr>) r^doc_idconnnosaverrreplacepartiallanguage no_creater#r8s r_ _add_documentzSearchCommands._add_documents" iG&%8  KK !   KK " KK  KK " I& J'  Z* *D H Y__flln566  '4''. .#t##T**ract|j||g}|r|jd|r|d|gz }||j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing rQrT) ADDHASH_CMDr7rzr>)r^rWrXrr\rZr8s r__add_document_hashz!SearchCommands._add_document_hash$scT__fe<  KK "  Z* *D  '4''. .#t##T**raz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreasonrWrYrrrZr[r\r]c :|j|fd|||||||d| S)a Add a single document to the index. Args: doc_id: the id of the saved document. nosave: if set to true, we just index the document, and don't save a copy of it. This means that searches will just return ids. score: the document ranking, between 0.0 and 1.0 payload: optional inner-index payload we can save for fast access in scoring functions replace: if True, and the document already is in the index, we perform an update and reindex the document partial: if True, the fields specified will be added to the existing document. This has the added benefit that any fields specified with `no_index` will not be reindexed again. Implies `replace` language: Specify the language used for document tokenization. no_create: if True, the document is only updated and reindexed if it already exists. If the document does not exist, an error will be returned. Implies `replace` fields: kwargs dictionary of the document fields to be saved and/or indexed. NOTE: Geo points should be encoded as strings of "lon,lat" N)rXrYrrrZr[r\r])r^) r^rWrYrrrZr[r\r]r#s r_ add_documentzSearchCommands.add_document8sDV"t!!       rac.|j|d|||S)a Add a hash document to the index. ### Parameters - **doc_id**: the document's id. This has to be an existing HASH key in Redis that will hold the fields the index needs. - **score**: the document ranking, between 0.0 and 1.0 - **replace**: if True, and the document already is in the index, we perform an update and reindex the document - **language**: Specify the language used for document tokenization. N)rXrr\rZ)ra)r^rWrr\rZs r_add_document_hashz SearchCommands.add_document_hashps' && UXw'  razdeprecated since redisearch 2.0ct|j|g}|r|jd||j|S|j|S)a Delete a document from index Returns 1 if the document was deleted, 0 if not ### Parameters - **delete_actual_document**: if set to True, RediSearch also delete the actual document if it is in the index rI)DEL_CMDr7rzr>)r^rWrXdelete_actual_documentr8s r_delete_documentzSearchCommands.delete_documentsO&1 ! KK   '4''. .#t##T**rarc |jj|}|jDcic]%\}}t|t |t||'}}} |d=t dd|i|Scc}}w#t $rYwxYw) Load a single document by id - **field_encodings**: optional dict mapping field names to encodings. If a field's encoding is ``None`` the raw bytes value is preserved (useful for binary data such as vectors). rrrghgetallryrrKeyErrorrr^rrr#rrs r_ load_documentzSearchCommands.load_documents$$R(  &1 O/<?OT T&   t (2(((    s*A-A33 A?>A?cF|jt|jg|S)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )r>MGET_CMDr7)r^idss r_rhzSearchCommands.gets"$t##HdooDDDracn|jt|j}|jt|S) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. r>r3r7ror^rjs r_rzSearchCommands.infos-""8T__=""8S11ra query_paramsc|gSg}t|dkDrh|jd|jt|dz|jD]'\}}|j||j|)|S)NrPARAMSr)rrzry)r^r{r8rur|s r_get_params_argszSearchCommands.get_params_argssy  I | q KK ! KKL)A- .*002 U C  E"3 rac|jg}t|tr t|}t|tst dt |||j z }||j|z }||fS)NzBad query type )r7rrrr! ValueErrorrget_argsr~)r^rcr{r8s r__mk_query_argszSearchCommands._mk_query_argsss  eS !%LE%'tE{m<= =    $$\22U{rarcc|j||\}}tj}i}tt |j ds d|t <t|tr ||d<d|d<|jtg|i|}t|tr|S|jt||tj|z dzS)  Search the index for a given query, and return a result of documents ### Parameters - **query**: the search query. Either a text for simple queries with default parameters, or a Query object for complex queries. See RediSearch's documentation on query format For more information see `FT.SEARCH `_. r{rdTrcrr@@rcr rtime monotonicrrrgr rrr r>r5ror^rcr{r8stoptionsrjs r_searchzSearchCommands.searchs ))%l)K e ^^ %&:4;;&GK$(GL ! dH %$GG "#GJ "d"":@@@ c8 $J"" 5DNN4Dr4IV3S#  racombine_methodrparams_substitutiontimeoutrreturncH|j}i}t|g} | j|j|r| j|j|r$| j|j ||d<|r | j|j ||r| jd|f|r$d|d<| j|j d|t <||d<|j| i|} t| tr| S|jt| fi|S)M Execute a hybrid search using both text and vector queries Args: - **query**: HybridQuery object Contains the text and vector queries - **combine_method**: CombineResultsMethod object Contains the combine method and parameters - **post_processing**: HybridPostProcessingConfig object Contains the post processing configuration - **params_substitution**: Dict[str, Union[str, int, float, bytes]] Contains the parameters substitution - **timeout**: int - contains the timeout in milliseconds - **cursor**: HybridCursorQuery object - contains the cursor configuration For more information see `FT.SEARCH `. rTIMEOUTTrrc r7r7rr build_argsr~r r>rrr ro r^rcrrrrrindexrpiecesrjs r_ hybrid_searchzSearchCommands.hybrid_searchs8e$ enn&'  MM.113 4  MM/446 7)8G% &  MM$../BC D  MM9g. /  $GH  MM&++- . !%  "d""F6g6 c8 $J"t"":s>g>>rac\|j||\}}|jtg|S)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rr> EXPLAIN_CMD)r^rcr{r8 query_texts r_explainzSearchCommands.explain@s6 ..u<.Pj#t##K7$77ractd)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r^rcs r_ explain_clizSearchCommands.explain_cliLs!"GHHract|tr9t|j}t|j g|j z}nCt|tr'd}td|j g|j z}n td|||j|z }|j|}|jt|||S) Issue an aggregation query. ### Parameters **query**: This can be either an `AggregateRequest`, or a `Cursor` An `AggregateResult` object is returned. You can access the rows from its `rows` property, which will always yield the rows of the result. For more information see `FT.AGGREGATE `_. TREAD Bad queryr rrrrrr9r7rr CURSOR_CMDrr~r>ror^rcr{rriraws r_ aggregatezSearchCommands.aggregateOs" e- .emm,J $//2U5E5E5GGC v &Jvt7%:J:J:LLC[%0 0 t##L11"d""C("" 3e #  rarrc|r1t|tr |d|_|}nt|d}|d}nd}t|tr|jr |d}|dd}nd}|dd}t |||S)Nrrr)rrrrr _with_schemar)r^rrcrrschemars r_rz$SearchCommands._get_aggregate_resultos %(F Aa&CF e- .53E3EVFqr7DFqr7DtVV44ralimitedctj}t|jdg}|r|j d|j dt |t rd|d<||jz }nHt |tr-d|d<||jz }||j|z }n td|j|}|jt||tj|z dz S) a Performs a search or aggregate command and collects performance information. ### Parameters **query**: This can be either an `AggregateRequest` or `Query`. **limited**: If set to True, removes details of reader iterator. **query_params**: Define one or more value parameters. Each parameter has a name and a value. rJLIMITEDQUERY AGGREGATErrz5Must provide AggregateRequest object or Query object.rr)rrr;r7rzrrrrr!rr~rr>ro)r^rcrr{rrirjs r_rzSearchCommands.profiles*^^ DOOR0  JJy ! 7 e- . CF 5##% %C u %CF 5>># #C 4'' 5 5CTU U"d""C("" ET^^5E5Jf4T#  ract|j|g}|r|jd|g|r|jdd|g|r|jdd|g|j|}|j t|S)a Issue a spellcheck query Args: query: search query. distance: the maximal Levenshtein distance for spelling suggestions (default: 1, max: 4). include: specifies an inclusion custom dictionary. exclude: specifies an exclusion custom dictionary. For more information see `FT.SPELLCHECK `_. DISTANCETERMSINCLUDEEXCLUDEr=r7rr>ror^rcdistanceincludeexcluderirjs r_ spellcheckzSearchCommands.spellchecksyt6  JJ H- .  JJG4 5  JJG4 5"d""C("">377ranametermscRt|g}|j||j|S)zAdds terms to a dictionary. ### Parameters - **name**: Dictionary name. - **terms**: List of items for adding to the dictionary. For more information see `FT.DICTADD `_. ) DICT_ADD_CMDrr>r^rrris r_dict_addzSearchCommands.dict_add-T" 5#t##S))racRt|g}|j||j|S)aDeletes terms from a dictionary. ### Parameters - **name**: Dictionary name. - **terms**: List of items for removing from the dictionary. For more information see `FT.DICTDEL `_. ) DICT_DEL_CMDrr>rs r_dict_delzSearchCommands.dict_delrrac0t|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDr>)r^rris r_ dict_dumpzSearchCommands.dict_dumps!d##t##S))ra8.0.0Ddeprecated since Redis 8.0, call config_set from core module insteadoptionr|c>td||g}|j|}|dk(S)Set runtime configuration option. ### Parameters - **option**: the name of the configuration option. - **value**: a value for the configuration option. For more information see `FT.CONFIG SET `_. SETOKr?r>r^rr|rirs r_ config_setzSearchCommands.config_sets.5&%0"d""C(d{raDdeprecated since Redis 8.0, call config_get from core module insteadc^td|g}|j|}|jt|S)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETr?r>ror^rrirjs r_ config_getzSearchCommands.config_gets55&)"d""C("":s33ratagfieldcD|jt|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )r> TAGVALS_CMDr7)r^rs r_tagvalszSearchCommands.tagvalss##K(KKraaliascD|jt||jS)z Alias a search index - will fail if alias already exists ### Parameters - **alias**: Name of the alias to create For more information see `FT.ALIASADD `_. )r> ALIAS_ADD_CMDr7r^rs r_aliasaddzSearchCommands.aliasadd$s##M5$//JJracD|jt||jS)z Updates an alias - will fail if alias does not already exist ### Parameters - **alias**: Name of the alias to create For more information see `FT.ALIASUPDATE `_. )r>ALIAS_UPDATE_CMDr7rs r_ aliasupdatezSearchCommands.aliasupdate1s##$4eT__MMrac.|jt|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )r> ALIAS_DEL_CMDrs r_aliasdelzSearchCommands.aliasdel>s##M599rach|jd}|D]}t||j|jg}|j dr|j d|j r,|j d|j |j |j||jdS)aJ Add suggestion terms to the AutoCompleter engine. Each suggestion has a score and string. If kwargs["increment"] is true and the terms are already in the server's dictionary, we increment their scores. For more information see `FT.SUGADD `_. F transaction incrementINCRrP pipelineSUGADD_COMMANDstringrrhrzrr>executer^rurrkpipesugr8s r_sugaddzSearchCommands.sugaddJs}}}/C"CSYY?Dzz+& F#{{ I& CKK( D $ '||~b!!raruc.|jt|S)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )r>SUGLEN_COMMAND)r^rus r_suglenzSearchCommands.suglenas ##NC88rarc0|jt||S)z Delete a string from the AutoCompleter index. Returns 1 if the string was found and deleted, 0 otherwise. For more information see `FT.SUGDEL `_. )r>SUGDEL_COMMAND)r^rurs r_sugdelzSearchCommands.sugdelis##NC@@raprefixfuzzynumr with_payloadsct||d|g}|r|jt|r|jt|r|jt|j |}g} |s| St |||} | D cgc]} | c} Scc} w)t Get a list of suggestions from the AutoCompleter, for a given prefix. Parameters: prefix : str The prefix we are searching. **Must be valid ascii or utf-8** fuzzy : bool If set to true, the prefix search is done in fuzzy mode. **NOTE**: Running fuzzy searches on short (<3 letters) prefixes can be very slow, and even scan the entire index. with_scores : bool If set to true, we also return the (refactored) score of each suggestion. This is normally not needed, and is NOT the original score inserted into the index. with_payloads : bool Return suggestion payloads num : int The maximum number of results we return. Note that we might return less. The algorithm trims irrelevant suggestions. Returns: list: A list of Suggestion objects. If with_scores was False, the score of all suggestions is 1. For more information see `FT.SUGGET `_. MAXSUGGET_COMMANDrzr.r-r/r>r#) r^rurrrrrr8rjrparserrs r_suggetzSearchCommands.suggetrsPVUC8  KK   KK #  KK %"d""D)N!+}cB!"6a6"""s7 Bgroupid skipinitialct|j|g}|r|jdg|j||j|S)a Updates a synonym group. The command is used to create or update a synonym group with additional terms. Only documents which were indexed after the update will be affected. Parameters: groupid : Synonym group id. skipinitial : bool If set to true, we do not scan and index. terms : The terms. For more information see `FT.SYNUPDATE `_. r,) SYNUPDATE_CMDr7rr>)r^r r rris r_ synupdatezSearchCommands.synupdatesF$doow7  JJ)* + 5#t##S))racn|jt|j}|jt|S)a Dumps the contents of a synonym group. The command is used to dump the synonyms data structure. Returns a list of synonym terms and their synonym group ids. For more information see `FT.SYNDUMP `_. )r>rAr7rorzs r_syndumpzSearchCommands.syndumps-"";@"";44rarqr)d) FFNNFNFFF)NF?NFFNF)NrNF)FrNFFNF)rNF)NFNNNNN)FNNNNF FF)v__name__ __module__ __qualname____doc__ frozensetr5r9rr7r;rfr`ro staticmethodrwr}rOrPr4r6r8r:r<r>r@rBrrrRrSrTrUrVrGrIrHr]rrrDrKrrJr\rrrZrrFr[rLrMr"rrrrrrrArrFrMr^rarrrfrhrlrrrsrhrrrr~rr!rrrr r r rrr rrrrrrrr9r"rr rrrrrrrrrrrrrrr#r rrrrar_r1r1Rs% ]J KHM ^!.DD * 2!  ,V 2#J>C%N.  68<K   +S^ :& P!!?? 2$P/$b888(/./.f$.   J (. >!&$)-04"$)"'D+U D+D+ D+ DI& D+ _- D+D+"D+ D+L+uUDK-?'@+(+$+8(+VDI+( T "&"&3 3 3  3 $ 3  3 3 3-3 3 s)3 3 j T  "1RS+T+&)$sCx.1I)*1RS ET E 2 $T#uS#ue5K/L*L%MN #+DeCeU@DRV!%.27?7?!!567?""<= 7? &d3c3u6L0M+M&NO 7? # 7?*+7? |/9 :7?7?xLP 8S%Z  8tCsC/E)F$FGH 8IsEz!2I LP %v-. tCsC/E)F$FGH @55 %&6&> ?5MQ52KO ) U,,-) ) tCsC/E)F$FGH )  eFO+,.@@A   ) V88 *S *$s) * *S *$s) * *c *U  S T   U 4 4 4  4 L L Kc K N N :c :".9#9#9A#AsAsA!#6# 6#6# 6#  6#  6#6#  6#p**4*c*0 5rar1ceZdZdZ d!deeefdeeeeee e e fffdZ e d"dedeedeedeeeeee e e ffd ee d eed eeeeffd Z d!deeefdeeeeee e e fffd Zd#dZedddeded efdZeddded efdZd!deeeeffdZdZ d$dededede deded e!e"fd Z#y)%AsyncSearchCommandscK|jt|jd{}|jt|S7w)rxNryrzs r_rzAsyncSearchCommands.infos:((4??CC""8S11Ds$AAANrcr{cK|j||\}}tj}i}tt |j ds d|t <t|tr ||d<d|d<|jtg|i|d{}t|tr|S|jt||tj|z dz S7Gw) rrrdTrcrrNrrrrs r_rzAsyncSearchCommands.searchs ))%l)K e ^^ %&:4;;&GK$(GL ! dH %$GG "#GJ (D((FdFgFF c8 $J"" 5DNN4Dr4IV3S#  GsB CCACrrrrrrcdK|j}i}t|g} | j|j|r| j|j|r$| j|j ||d<|r | j|j ||r| jd|f|r$d|d<| j|j d|t <||d<|j| i|d{} t| tr| S|jt| fi|S7.w)rrrTrrcNrrs r_rz!AsyncSearchCommands.hybrid_searchs8e$ enn&'  MM.113 4  MM/446 7)8G% &  MM$../BC D  MM9g. /  $GH  MM&++- . !%  (D((&g>> =sC=D0?D./D0cKt|tr9t|j}t|j g|j z}nCt|tr'd}td|j g|j z}n td|||j|z }|j|d{}|jt|||S7w)rTrrNrrrs r_rzAsyncSearchCommands.aggregate8s" e- .emm,J $//2U5E5E5GGC v &Jvt7%:J:J:LLC[%0 0 t##L11(D((#.."" 3e #  /sB3C5C6CcKt|j|g}|r|jd|g|r|jdd|g|r|jdd|g|j|d{}|j t|S7w)a Issue a spellcheck query ### Parameters **query**: search query. **distance***: the maximal Levenshtein distance for spelling suggestions (default: 1, max: 4). **include**: specifies an inclusion custom dictionary. **exclude**: specifies an exclusion custom dictionary. For more information see `FT.SPELLCHECK `_. rrrrNrrs r_rzAsyncSearchCommands.spellcheckXst6  JJ H- .  JJG4 5  JJG4 5(D((#.."">377/sA'B)B*Brrrbrr|cZKtd||g}|j|d{}|dk(S7 w)rrNrrrs r_rzAsyncSearchCommands.config_setts:5&%0(D((#..d{/s +) +rc~Ktd|g}i}|j|d{}|jt|S7w)rrNrrs r_rzAsyncSearchCommands.config_getsF5&)(D((#.."":s33/s =;=rc K|jj|d{}|jDcic]%\}}t|t |t||'}}} |d=t dd|i|S7Ucc}}w#t $rY wxYww)rnNrrrorrs r_rsz!AsyncSearchCommands.load_documents{{**2..  &1 O/<?OT T&   t (2(((/    sDBA7B*A9#B'A?*B9B? B B B  BcK|jd}|D]}t||j|jg}|j dr|j d|j r,|j d|j |j |j||jd{dS7w)aI Add suggestion terms to the AutoCompleter engine. Each suggestion has a score and string. If kwargs["increment"] is true and the terms are already in the server's dictionary, we increment their scores. For more information see `FT.SUGADD `_. FrrrrPNrrrs r_rzAsyncSearchCommands.sugadds}}}/C"CSYY?Dzz+& F#{{ I& CKK( D $ 'lln$b))$sB4C6B>7Crurrrrrc,Kt||d|g}|r|jt|r|jt|r|jt|j |d{}g} |s| St |||} | D cgc]} | c} S7'cc} ww)rrNr) r^rurrrrrr8retrr rs r_r zAsyncSearchCommands.suggetsPVUC8  KK   KK #  KK %(D(($//N!+}cB!"6a6"" 0 #s$A#B%B &B B BBrqrrr)$rrrrrrr!rrrrrrrrr r r rrr rrrrrrrrrrrsrrr#r rrar_r r s  2LP! S%Z ! tCsC/E)F$FGH! F:>@DRV!%.27?7?!!567?""<= 7? &d3c3u6L0M+M&NO 7? # 7?*+7? |/9 :7?7?xLP _f,- tCsC/E)F$FGH @88U s 3 4   U 4s 4s 4  4)xS#X7O)**6!#6# 6#6# 6#  6#  6#6#  6#rar )\r;rtypingrrrrrredis._parsers.helpersr redis.clientr r "redis.commands.search.hybrid_queryr r r r#redis.commands.search.hybrid_resultrr redis.utilsrrrrrhelpersrr aggregationrrrdocumentrfieldrindex_definitionrprofile_informationr rcr!rr"rr#r$r6rEr5rVr`rKrEXPLAINCLI_CMDrjr9r;rr=rrrrur?rrrrr3rrrr rrAr7r%r&r'r(r)r*r+r,r-r.r/r1r rrar_r9sF 330/ QA -3(                     #          #   z5z5z3k#.k#ra