ng\j%SSKrSSKrSSKJrJrJrJrJr SSKJ r SSK J r J r SSK JrJrJrJr SSKJrJr SSKJrJrJrJrJr SS KJrJr S S KJrJ r J!r! S S K"J#r# S S K$J%r% S SK&J'r' S SK(J)r) S SK*J+r+ S SK,J-r- S SK.J/r/ Sr0Sr1Sr2Sr3Sr4Sr5Sr6Sr7Sr8Sr9Sr:Sr;SrS"r?S#r@S$rAS%rBS&rCS'rDS(rES)rFS*rGS+rHS,rIS-rJS.rKS/rLS0rMS1rNS2rOS3rPS4rQS5rRS6rSS7rTS8rUS9rVS:rWS;rXS5rZ"S?S@\Z5r[g)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 WITHPAYLOADSc\rSrSrSr\"\\\\ \ 15r Sr Sr \SSj5r\S5rSrS rS rS rS rS rSrSrSrSr\"1Sk5r\S5rSrSrSrSr Sr!Sr"Sr#Sr$Sr%\S5r&\S5r'Sr(S r)S!r*S"r+S#r,\SS$j5r-\S%5r.S&r/\S'5r0S(r1S)r2S*r3S+r4SS,jr5SS-\6\7S.\8S/\8S0\9\6\:S1\9\;S2\8S3\8S4\84S5jjrSS7\84S8jjr?SS9jr@SS:jrA\B"S;S\:S?\8S@\CSA\9\8SB\8SC\8SD\9\:SE\8S-\6\:4SFjj5rD\B"S;S[UR[UR@[ UR[URB[UR[URD[URF0Ul$[KUR65Ul&URNURL['URPURL['URRURL['URTURL['g)zBuild 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 Y/home/edenadmin/noVNC/venv/lib/python3.13/site-packages/redis/commands/search/commands.py_init_module_callbacks%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 >XR;aSU;aU$[UR5n[UR5nU(aUS;a1U[:Xa [ U5$UR RU5nO[US5(aURRU5nOdURRU5nOH[US5(aURRU5nOURRU5nUcU$U"U40UD6$)Nquery)3rf) _QUERY_REQUIRED_CMDSrclientrr<r rFgetrrOrDrZrX)r_cmdreskwargsprotocollegacycbs r`_parse_resultsSearchCommands._parse_resultss ++ +v0EJ' 4%dkk2 8#+%-c221155c:'!44AAEEcJ1155c:%h2299==cB99==cB :J#   rcNc[U[5(dU$URXRUR5U55$N) isinstancerYrjencode)mappingkeydefaults r` _resp3_getSearchCommands._resp3_gets4'4((N{{3 CJJL' BCCrcc[U[5(dU$/nUR5H0up#UR[ U55 URU5 M2 U$rt)rurYitemsappendr)rwflatrxvalues r`_flatten_resp3_mapping%SearchCommands._flatten_resp3_mappingsO'4((N!--/JC KK S) * KK * rcc JURS5nUb[U[5(dU$URUSS5/nURUS/5HnUR URUS55 UR (a!UR URUS55 UR (a!UR URUS55 UR(aMUR URURUS0555 M U$) zDConvert RESP3 FT.SEARCH pipeline output to raw RESP2 pipeline shape.re total_resultsrresultsidscorepayloadextra_attributes) rjrurYrzr~ _with_scores_with_payloads _no_contentr)r_rlrmreoutputitems r`rP5SearchCommands._pipeline_parse_search_resp3_to_legacys 7# = 3 5 5J//#:;OOCB7D MM$//$5 6!! doodG<=## doodI>?$$$ //.@"E8 rcc [U[5(dU$UR5VVs0sHup4[U5U_M nnnSU;a$SUR S5SUR S5/$UR S/5Vs/sH+n[U[5(aUR U5OUPM- nnSUR SS5SUSUR S/5SUR SS5/$s snnfs snf) zDConvert RESP3 FT.HYBRID pipeline output to raw RESP2 pipeline shape.cursorSEARCHVSIMrrrwarningsexecution_time)rurYr}rrjr)r_rlrmrxrrrs r`rQq>!$$JUUV+IW(%(;+KA '5< +s Bc PU(aUVs0sH o3SUS_M sn$0$s snfNrrr_rlrmkvss r`rA SearchCommands._parse_config_get]s+25#.#3AA#.=2=.s#c j[S[U5S5Vs0sH o1UXS-_M sn$s snfNrrr)ranger)r_rlrmis r`rCSearchCommands._parse_syndump`s6,1!SXq,AB,AqAE ",ABBBs0>typeWEIGHTPHONETIC SEPARATOR attribute identifierc0n/n[RnSnU[U5:ac[X5nXS;a*US-[U5:a[XS-5X'US- nOUR U5 US- nU[U5:aMcX!S'U$)aConvert 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_KEYSrrr~) attr_listrr pair_keysrrxs r`_normalize_info_attribute(SearchCommands._normalize_info_attributeks"77 #i. y|,CAEC N$:*9U+;< Q S!Q#i.  w rcc [[U5n[[X355nSU;aW[ US[ 5(a?USVs/sH+n[ U[ 5(aUR U5OUPM- snUS'U$s snf)zrParse FT.INFO into the unified shape with ``attributes`` as a list of dicts so RESP2 output matches RESP3 output. attributes)rrrYrrulistr)r_rlrmrinfoattrs r`rS"SearchCommands._parse_info_unifiedss #CK  4 JtL/A4$H$H!.".D9C48N8N..t4TXX."D  "s 2Bc [USS9nSU;a"[[US5[US5S9$UR"S 0UD6n/nUSHQn[USS9nUR UR 5VV s0sHupXR XU5_M sn n5 MS [[US5UUS [US 5S 9$s sn nf) NTrrrrrrrrrrr) rrr_hybrid_field_encodingsr~r}_decode_hybrid_field_valuerr) r_rlrmrrrrrrxrs r`rT+SearchCommands._parse_hybrid_search_unifieds $7 v %!$Xh%7!8"8F#34  66@@(* +H%hDAI NN'0oo&7&7 88_UU&7 ,h78j) *:!;<   s7C c USn[U[5(a URUSX3R5nO6[ USUR (+USUR URS9nUSn[U[5(a/U(a([US[[45(a [USS9nU[U54$)zwParse FT.PROFILE into ``(result, ProfileInformation)`` with the profile_data normalised to a dict on >= 7.9.0 servers. rerrrrTr) rurrrr"rrrrstrbytesrr )r_rlrmrer profile_datas r`rU%SearchCommands._parse_profile_unifiedsw e- . .//A}}MFA%%% +!00!.. F1v |T * *<?S%L99(4HL),777rcc vU(d0$UVs0sHn[US5[US5_M sn$s snfr)rrs r`rV(SearchCommands._parse_config_get_unifieds9IFIJcs SV$l3q6&::cJJJs%6c &U(d0$[S[U5S5VVs0sHZn[X5[XS-[5(a!XS-Vs/sHn[U5PM snO[XS-5_M\ snn$s snfs snnfr)rrrrur)r_rlrmrss r`rW%SearchCommands._parse_syndump_unifiedsI 1c#h*  +  #!e*d++=@AJ"GJq<?J"Gca%j) *+   "G s5B B-B B c URS5n[R"UURSS5[USS5[USS5S9$) z4Parse RESP3 FT.SEARCH response into a Result object.rerrrFrN)rrr)rjr" from_resp3getattr)r_rlrmres r`rH"SearchCommands._parse_search_resp3sM 7#  ZZ A.~u=#E+EtL   rcc URS5nURSS5nSnU(a1[U[5(aUSn[U5S:aUSOSnOUnUc0nUR 5VVs0sHupx[ U5U_M nnnURS/5V s/sHn [ U 5PM n n URSS5n /n URS /5Hn U R 5VVs0sHupx[ U5U_M n nnU RS 05n/nUR 5H'upxUR U5 UR U5 M) U R U5 M SnU(a)[U[5(a XSlUnO [U5n[U USXS 9$s snnfs sn fs snnf) zAParse RESP3 FT.AGGREGATE response into an AggregateResult object.rerFrrNwarningrrr)totalr) rjrurrr}rr~rcidr)r_rlrmrer cursor_iddatakvwrrrows result_item extra_attrsrrs r`rJ%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$!<?A-:MKN%//*   ; Qs D.!D4 c BUR5VVs0sHup4[U5U_M nnnSU;a"[[US5[US5S9$UR"S 0UD6n/nUR S/5Hn[ U[5(aZURUR5VV s0sH+up[U5URU [U5U5_M- sn n5 Mr[USS9n URU R5VV s0sHupXRXU5_M sn n5 M [[UR SS 55UUR S /5[UR S S 55S 9$s snnfs sn nfs sn nf)z=Parse RESP3 FT.HYBRID into the approved unified HybridResult.rrrrrTrrrrrrr) r}rrrrrjrurYr~rrrr) r_rlrmrrrrrrxrrs r`r^1SearchCommands._parse_hybrid_search_resp3_unified0s.1iik:kda|A!k: v %!$S]!3"3v;/  66@@(* 2.H(D)) +3..*: +;JC%S)4+J+J!<#4o,+; *(E  +4//*; +   ?;sF32F F c 0nSH;nURU5n[USS5nU(dM*URU5 M= U=(d S$)N)repost_processingr)rjrupdate)rm encodings source_namesourcesource_encodingss r`r&SearchCommands._hybrid_field_encodingsXsQ 7KZZ ,F&v/I4P   !12 8  D rcc6U(aX;aU$[XU5$rt)r)rrxrs r`r)SearchCommands._decode_hybrid_field_valuebs#"<L!%o>>rcc UR5VVs0sHup4[U5U_M nnnSU;aU$SU;aiUSVVVs/sHQn[U[5(a/UR5VVs0sHup4[U5U_M snnO [ USS9PMS snnnUS'SU;a"USVs/sHn[U5PM snUS'U$s snnfs snnfs snnnfs snf)a3Normalise 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)r}rrurYr)r_rlrmrrrrs r`rE0SearchCommands._parse_hybrid_search_resp3_nativehs/2iik:kda|A!k: v J    N +DdD))15 = a!# ="4T:;+ C N  8;JH1|AHC O ; >Is#C.C4C C3C#Cc [U[5(dUR"U40UD6$UR5VVs0sHup4[ U5U_M nnn0nUR S05nUR5HxupxU(dM/n UHUn U R5H>up[ U 5n U RS5(aU SSn U RXS.5 M@ MW U (dMtXU'Mz U$s snnf)zParse 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) rurYr?r}rrjrendswithr~)r_rlrmrrrrterm suggestionsterm_correctionssuggestion_dictrr score_strs r`rL&SearchCommands._parse_spellcheck_resp3s#t$$))#88 8/2iik:kda|A!k: '')R(!( D! #.)8)>)>)@%J!$E I ))$//$-crN %++"+F*A$/ $4D!'"1(/;sC9c USnURS5nUcURS5nUcURS5nUcURS5nUcURS5nURS5nUcURS5nUcURS 5nUcURS 5nUcURS 5n[U[5(a[U5US .n[U[5(a$UR XC[ UR5S 9nO1[R"UURSS5[USS5S9nURU5nXe4$)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. reResultssResultsrsresultsrProfilesProfileprofilesprofiler)rrrerrrF)rr) rjrurrrrJboolrr"rr_to_string_recursive)r_rlrmre results_datarrs r`_extract_resp3_profile_parts+SearchCommands._extract_resp3_profile_partssg wwwy)  77:.L  779-L  77:.L  771:Lwwy)  77:.L  779-L  77:.L  771:L lD ) )!$\!2'L e- . .00d5==6I1F&&J2#E>5AF 00> ##rcc [U[5(aUR"U40UD6$UR"U40UD6up4[U[5(a SU;=(d SU;nUR XES9nU[ U54$)axParse 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)rurr=r rY_resp3_profile_dict_to_listr )r_rlrmrrr%s r`rK#SearchCommands._parse_profile_resp3s c4 &&s5f5 5#@@OO lD ) )</P=L3PH;;<L),777rcc [U[5(aUR"U40UD6$UR"U40UD6up4[U[5(aSU;dSU;dUR U5nU[ U54$)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. r#r$)rurrUr rYr&r )r_rlrmrrs r`r]+SearchCommands._parse_profile_resp3_unifieds| c4 ..s=f= =#@@OO lD ) )  $ (E;;LIL),777rcc0^^^SmSUUU4SjjmT"USS9$)aConvert 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. ch[U[5=(a U=(a [US[5$)Nr)rurrY)objs r`_is_list_of_dictsESearchCommands._resp3_profile_dict_to_list.._is_list_of_dictss$c4(MSMZA5M Mrcc>[U[5(aU(a}T (dv/nUR5H^up4U/nT"U5(a!UHnURT"U55 M OURT"U55 URU5 M` U$/nUR5H\up4URU5 T"U5(a"UHnURT"U55 M MEURT"U55 M^ U$[U[5(aUVs/sH nT"U5PM sn$U$s snfrt)rurYr}r~r) r, top_levelrrrentryr_convertr-r%s r`r2._converts#t$$XF # !",Q//() % Xd^ <)*"LL!5 e,!,"MF #  a(,Q//() & htn =)*#MM(1+6 !,"MC&&36734377J8s(D?T)r0Fr)rr%r2r-s `@@r`r&*SearchCommands._resp3_profile_dict_to_list s"$ N  6--rcc[U[5(a [U5$[U[5(aYUR 5VVs0sH;up[U[5(a [U5OU[ R U5_M= snn$[U[5(a&UVs/sHn[ R U5PM sn$U$s snnfs snf)zRecursively convert bytes keys/values to strings in nested structures. Non-bytes scalars (int, float, None, bool) pass through unchanged. )rurrrYr}r1rr)r,rrrs r`r#SearchCommands._to_string_recursive>s c5 ! !$ $ c4  IIK (DA$.a#7#7 QQ"77:;(   c4 JMN#$N77=#N N Os AC (Cc $URU5$)z;Parse RESP3 FT.INFO response, normalising bytes to strings.rrs r`r[ SearchCommands._parse_info_resp3Qs((--rcc/nURS5=(d /nUR5H/up4US:XaM URU5 URU5 M1 URU5 U$)zsConvert a RESP3-style attribute dict back into the RESP2 flat list (key-value pairs followed by bare flag tokens). r)rjr}r~extend) attr_dictrrrrs r`_flatten_info_attribute&SearchCommands._flatten_info_attributeUsb  g&,"OO%DAG| KKN KKN & E rcc URU5nURS5n[U[5(a<UVs/sH+n[U[5(aUR U5OUPM- snUS'U$s snf)zxParse RESP3 FT.INFO into the legacy RESP2 flat shape so ``legacy_responses=True`` on a RESP3 wire matches RESP2 output. r)rrjrurrYr>)r_rlrmrattrsrs r`rG*SearchCommands._parse_info_resp3_to_legacyds}((-& eT " """!D7At6L6L,,T2RVV!"D  "s2A6c U(d0$UR5VVs0sHup4[U5[U5_M snn$s snnf)zAParse RESP3 FT.CONFIG GET response, normalising bytes to strings.)r}r)r_rlrmrrs r`r\&SearchCommands._parse_config_get_resp3qs7I=@YY[I[TQ Qa0[IIIs!Ac *U(a [U5$0$)z>Parse RESP3 FT.CONFIG GET back to the RESP2 legacy dict shape.)rYrs r`rM0SearchCommands._parse_config_get_resp3_to_legacywstCy'R'rcc 6U(d0$URU5$)z>Parse RESP3 FT.SYNDUMP response, normalising bytes to strings.r9rs r`rN#SearchCommands._parse_syndump_resp3{sI((--rcc URXS9$)zD Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)r_rJs r` batch_indexerSearchCommands.batch_indexers   ==rcfieldsno_term_offsetsno_field_flags stopwords definition no_highlightno_term_frequenciesskip_initial_scanc [UR/n UbXR- n U(aU R[5 Ub;[ U[ 5(a&U R[5 U RU5 U(aU R[5 U(aU R[5 U(aU R[5 U (aU R[5 U (aU R[5 UbQ[ U[[[45(a1U [ [#U5/- n [#U5S:aU [U5- n U RS5 U [[$R&"SU565- n UR,"U 6$![(a XR+5- n N-f=f)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@# UHoR5v M g7frt redis_args.0fs r` .SearchCommands.create_index..*J6a<<>>6) CREATE_CMD index_nameargsr~r)rurr*r%r'r&r(r,rtuplesetr+r itertoolschain TypeErrorrZexecute_command) r_rNrOrPrQrRmax_text_fields temporaryrSrTrUrds r` create_indexSearchCommands.create_indexsSNDOO,  ! OO #D  KK &  Z 3%?%? KK " KK "  KK "  KK   KK !  KK  KK (  Z D%;M%N%N YI/ /D9~!Y' H ( D*J6*JKL LD##T** ( %%' 'D (s0&F%%GGc[URSS/nU[[R"SU565- nUR"U6$![ a X!R 5- nN-f=f)z 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 `_. rWADDc3@# UHoR5v M g7frtrYr[s r`r^2SearchCommands.alter_schema_add..r`ra) ALTER_CMDrcrrgrhrirZrj)r_rNrds r`alter_schema_addSearchCommands.alter_schema_addsn4??He< ( D*J6*JKL LD##T** ( %%' 'D (s&A A*)A*delete_documentsc[UR/n[U[5(aUSLaSOSnU(aUR U5 UR "U6$)a1 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_CMDrcrurr~rj)r_rvrd delete_strs r` dropindexSearchCommands.dropindexsYt/*D116F$6N    KK ###T**rcc  ,U(dU (aSn[URX/n U(aU RS5 Ub"U RS5 U RU5 U(aAU RS5 U(aU RS5 U (aU RS5 U(aU SU/- n U RS5 U [[R "U R 565- n UbUR"U 6$UR"U 6$) zC Internal add_document used for both batch and single doc indexing TNOSAVEPAYLOADREPLACEPARTIALNOCREATELANGUAGEFIELDS)ADD_CMDrcr~rrgrhr}rj) r_doc_idconnnosaverrreplacepartiallanguage no_createrNrds r` _add_documentSearchCommands._add_documents" iG&8  KK !   KK " KK  KK " I& J'  Z* *D H Y__flln566  ''. .##T**rcc[URX/nU(aURS5 U(aUSU/- nUbUR"U6$UR"U6$)zH Internal add_document_hash used for both batch and single doc indexing rr) ADDHASH_CMDrcr~rj)r_rrrrrrds r`_add_document_hash!SearchCommands._add_document_hash$s]T__f<  KK "  Z* *D  ''. .##T**rcz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreasonrrrrrrrrc :UR"U4SUUUUUUUS.U D6$)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)rrrrrrrr)r) r_rrrrrrrrrNs r` add_documentSearchCommands.add_document8sBV!!       rcc&URUSX#US9$)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)rrrr)r)r_rrrrs r`add_document_hash SearchCommands.add_document_hashps% && Uw'  rczdeprecated since redisearch 2.0c[URU/nU(aURS5 UbUR"U6$UR"U6$)z 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 rx)DEL_CMDrcr~rj)r_rrdelete_actual_documentrds r`delete_documentSearchCommands.delete_documentsK&1 ! KK   ''. .##T**rcrc  URRU5nUR5VVs0sH%upE[U5[ U[U5U5_M' nnnUS [ SSU0UD6$s snnf![ a Nf=f) 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). rrrihgetallr}rrKeyErrorrr_rrrNrrs r` load_documentSearchCommands.load_documents$$R(  & O/<?OT T&   t (2(((    s,A/A55 BBcFUR"[UR/UQ76$)zo Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )rjMGET_CMDrc)r_idss r`rjSearchCommands.gets ##HdooDDDrccnUR[UR5nUR[U5$) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. rjr4rcrqr_rls r`rSearchCommands.infos-""8T__=""8S11rc query_paramscUc/$/n[U5S:aiURS5 UR[U5S-5 UR5H'up4URU5 URU5 M) U$)NrPARAMSr)rr~r})r_rrdrxrs r`get_params_argsSearchCommands.get_params_argssw  I | q KK ! KKL)A- .*002  C  E"3 rccUR/n[U[5(a [U5n[U[5(d[ S[ U535eX1R 5- nX0RU5- nX14$)NzBad query type )rcrurr! ValueErrorrget_argsr)r_rerrds r`_mk_query_argsSearchCommands._mk_query_argsss  eS ! !%LE%''tE{m<= =    $$\22{rcrecURXS9up1[R"5n0n[[ UR 5S5(d SU[ '[U[5(a XS'SUS'UR"[/UQ70UD6n[U[5(aU$UR[Xa[R"5U- S-S9$) n 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 `_. rrfTrerr@@rer rtime monotonicrrrir rur rjr6rqr_rerrdstoptionsrls r`searchSearchCommands.searchs ))%)K  ^^ %&:4;;&GKK$(GL ! dH % %$G "#GJ "":@@@ c8 $ $J"" DNN4Dr4IV3S#  rccombine_methodrparams_substitutiontimeoutrreturncURn0n[U/n U RUR55 U(aU RUR55 U(a#U RUR 55 X8S'U(a U RUR U55 U(aU RSU45 U(a$SUS'U RUR 55 SU[ 'XS'UR"U 0UD6n [U [5(aU $UR"[U 40UD6$) 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 `. rTIMEOUTTrre rcr8r<r build_argsrr rjrur rq r_rerrrrrindexrpiecesrls r` hybrid_searchSearchCommands.hybrid_searchs 8e$ enn&'  MM.113 4  MM/446 7)8% &  MM$../BC D  MM9g. /  $GH  MM&++- . !%  ""F6g6 c8 $ $J"":s>g>>rccRURXS9up4UR"[/UQ76$)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rrj EXPLAIN_CMD)r_rerrd query_texts r`explainSearchCommands.explain@s0 ..u.P##K7$77rcc[S5e)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r_res r` explain_cliSearchCommands.explain_cliLs!"GHHrcc[U[5(a9[UR5n[UR /UR 5-nOH[U[5(a'Sn[SUR /UR 5-nO [SU5eX@RU5- nUR"U6nUR[XQUS9$)Q 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 rurrrr:rcrr CURSOR_CMDrrrjrqr_rerrrkraws r` aggregateSearchCommands.aggregateOs" e- . .emm,J $//2U5E5E5GGC v & &Jvt7%:J:J:LLC[%0 0 ##L11""C("" 3 #  rcrrcU(a6[U[5(a USUlUnO[US5nUSnOSn[U[5(aUR(a USnUSSnOSnUSSn[ XdU5$)Nrrr)rurrr _with_schemar)r_rrerrschemars r`r$SearchCommands._get_aggregate_resultos %((F Aa&CF e- . .53E3EVFqr7DFqr7DtV44rclimitedc[R"5n[URS/nU(aUR S5 UR S5 [ U[ 5(aSUS'XQR5- nOK[ U[5(a+SUS'XQR5- nXPRU5- nO [S5eUR"U6nUR[Xa[R"5U- S-S 9$) 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. ryLIMITEDQUERY AGGREGATErrz5Must provide AggregateRequest object or Query object.rr)rrr<rcr~rurrr!rrrrjrq)r_rerrrrkrls r`rSearchCommands.profiles*^^ DOOR0  JJy ! 7 e- . . CF ##% %C u % %CF >># #C '' 5 5CTU U""C("" T^^5E5Jf4T#  rcc[URU/nU(aURSU/5 U(aURSSU/5 U(aURSSU/5 UR"U6nUR [U5$)al 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>rcr<rjrqr_redistanceincludeexcluderkrls r` spellcheckSearchCommands.spellcheckswt6  JJ H- .  JJG4 5  JJG4 5""C("">377rcnametermscR[U/nURU5 UR"U6$)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_CMDr<rjr_rrrks r`dict_addSearchCommands.dict_add+T" 5##S))rccR[U/nURU5 UR"U6$)zDeletes 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_CMDr<rjrs r`dict_delSearchCommands.dict_delrrcc0[U/nUR"U6$)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDrj)r_rrks r` dict_dumpSearchCommands.dict_dumpsd###S))rc8.0.0Ddeprecated since Redis 8.0, call config_set from core module insteadoptionrc<[SX/nUR"U6nUS:H$)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@rjr_rrrkrs r` config_setSearchCommands.config_sets*5&0""C(d{rcDdeprecated since Redis 8.0, call config_get from core module insteadc^[SU/nUR"U6nUR[U5$)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETr@rjrqr_rrkrls r` config_getSearchCommands.config_gets35&)""C("":s33rctagfieldcDUR[URU5$)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )rj TAGVALS_CMDrc)r_r$s r`tagvalsSearchCommands.tagvalss##K(KKrcaliascBUR[XR5$)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 `_. )rj ALIAS_ADD_CMDrcr_r)s r`aliasaddSearchCommands.aliasadd$s##M5//JJrccBUR[XR5$)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 `_. )rjALIAS_UPDATE_CMDrcr,s r` aliasupdateSearchCommands.aliasupdate1s##$4e__MMrcc.UR[U5$)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )rj ALIAS_DEL_CMDr,s r`aliasdelSearchCommands.aliasdel>s##M599rccxURSS9nUHn[XRUR/nUR S5(aUR S5 UR (a,UR S5 UR UR 5 UR"U6 M UR5S$)a 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 incrementINCRr pipelineSUGADD_COMMANDstringrrjr~rrjexecuter_rxrrmpipesugrds r`sugaddSearchCommands.sugaddJs}}}/C"CSYY?Dzz+&& F#{{ I& CKK(  $ '||~b!!rcrxc.UR[U5$)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rjSUGLEN_COMMAND)r_rxs r`suglenSearchCommands.suglenas ##NC88rcr@c.UR[X5$)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 `_. )rjSUGDEL_COMMAND)r_rxr@s r`sugdelSearchCommands.sugdelis##NC@@rcprefixfuzzynumr with_payloadsc8[XSU/nU(aUR[5 U(aUR[5 U(aUR[5 UR "U6n/n U(dU $[ XVU5n U V s/sHoPM sn $s sn f) 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_COMMANDr~r.r-r/rjr#) r_rxrOrPrQrrRrdrlrparserrs r`suggetSearchCommands.suggetrsPUC8  KK   KK #  KK %""D)N!+cB!"6a6"""s Bgroupid skipinitialc[URU/nU(aURS/5 URU5 UR"U6$)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_CMDrcr<rj)r_r[r\rrks r` synupdateSearchCommands.synupdatesD$doow7  JJ)* + 5##S))rccnUR[UR5nUR[U5$)z 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 `_. )rjrBrcrqrs r`syndumpSearchCommands.syndumps-"";@"";44rc)rDrXrFrOrRrZrtr4)d) FFNNFNFFF)NF?NFFNF)NreNF)FreNFFNF)reNF)NFNNNNN)FNNNNF FF)x__name__ __module__ __qualname____firstlineno____doc__ frozensetr6r:rr8r<rhrarq staticmethodrzrrPrQr5r7r9r;r=r?rArCrrrSrTrUrVrWrHrJrIr^rrrErLr rKr]r&rr[r>rGr\rMrNrLrrrrrrrmrrtr|rrrrrrrrrrrjrrrrrr!rrrr r r rrr rrrrrrrrer"rr rrrr rrr"r'r-r1r5rErIrMr#rYr_rb__static_attributes__rrcr`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 5rcr1c\rSrSrSrS#S\\\4S\\ \\\\ \ \ 444Sjjr \"5S$S\S\\S\\S \\ \\\\ \ \ 44S \\ S \\S \\\\44S jj5rS#S\\\4S\\ \\\\ \ \ 444SjjrS%Sjr\"SSS9S\S\S \4Sj5r\"SSS9S\S \4Sj5rS#S\\ \\44Sjjr Sr!S&S\S\S\S\ S\S \S \"\#4S!jjr$S"r%g)'AsyncSearchCommandsic# UR[UR5IShvN nUR[U5$N7f)rNrrs r`rAsyncSearchCommands.infos9((4??CC""8S11Ds$AAANrerc# URXS9up1[R"5n0n[[ UR 5S5(d SU[ '[U[5(a XS'SUS'UR"[/UQ70UD6IShvN n[U[5(aU$UR[Xa[R"5U- S-S 9$NI7f) rrrfTrerrNrrrrs r`rAsyncSearchCommands.searchs ))%)K  ^^ %&:4;;&GKK$(GL ! dH % %$G "#GJ ((FdFgFF c8 $ $J"" DNN4Dr4IV3S#  GsBCCA Crrrrrrc# URn0n[U/n U RUR55 U(aU RUR55 U(a#U RUR 55 X8S'U(a U RUR U55 U(aU RSU45 U(a$SUS'U RUR 55 SU[ 'XS'UR"U 0UD6IShvN n [U [5(aU $UR"[U 40UD6$N37f)rrrTrreNrrs r`r!AsyncSearchCommands.hybrid_searchs8e$ enn&'  MM.113 4  MM/446 7)8% &  MM$../BC D  MM9g. /  $GH  MM&++- . !%  ((&g>> =sDE E 4E c# [U[5(a9[UR5n[UR /UR 5-nOH[U[5(a'Sn[SUR /UR 5-nO [SU5eX@RU5- nUR"U6IShvN nUR[XQUS9$N7f)rTrrNrrrs r`rAsyncSearchCommands.aggregate8s" e- . .emm,J $//2U5E5E5GGC v & &Jvt7%:J:J:LLC[%0 0 ##L11((#.."" 3 #  /sBC?Cc.# [URU/nU(aURSU/5 U(aURSSU/5 U(aURSSU/5 UR"U6IShvN nUR [U5$N7f)av 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`rAsyncSearchCommands.spellcheckXst6  JJ H- .  JJG4 5  JJG4 5((#.."">377/sA6B8B9BrrrrrcX# [SX/nUR"U6IShvN nUS:H$N 7f)rrNrrrs r`rAsyncSearchCommands.config_setts55&0((#..d{/s *( *rc~# [SU/n0nUR"U6IShvN nUR[U5$N7f)rrNr r!s r`r"AsyncSearchCommands.config_getsC5&)((#.."":s33/s =;=rc &# URRU5IShvN nUR5VVs0sH%upE[U5[ U[U5U5_M' nnnUS [ SSU0UD6$NWs snnf![ a N!f=f7f)rNrrrrs r`r!AsyncSearchCommands.load_documents{{**2..  & O/<?OT T&   t (2(((/    sDBA9B,A;%B)B,B;B B B BBc# URSS9nUHn[XRUR/nUR S5(aUR S5 UR (a,UR S5 UR UR 5 UR"U6 M UR5IShvN S$N7f)a 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 `_. Fr8r:r;rNr<r=rBs r`rEAsyncSearchCommands.sugadds}}}/C"CSYY?Dzz+&& F#{{ I& CKK(  $ 'lln$b))$sBC?CrxrOrPrQrrRcT# [XSU/nU(aUR[5 U(aUR[5 U(aUR[5 UR "U6IShvN n/n U(dU $[ XVU5n U V s/sHoPM sn $N-s sn f7f)rTrUNrV) r_rxrOrPrQrrRrdretrrXrs r`rYAsyncSearchCommands.suggetsPUC8  KK   KK #  KK %(($//N!+cB!"6a6"" 0 #s$A1B(3B!4B( B#B(#B(rrtrfrgrh)&rjrkrlrmrrrr!rrrrrrrrr r r rrr rrrrrrrrr"rrrErr#rYrqrrcr`rsrss% 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#6#rcrs)\rgrtypingrrrrrredis._parsers.helpersr redis.clientr r "redis.commands.search.hybrid_queryr r r r#redis.commands.search.hybrid_resultrr redis.utilsrrrrrhelpersrr aggregationrrrdocumentrfieldrindex_definitionrprofile_informationr rer!rr"rr#r$rbrsr6rrrzrEXPLAINCLI_CMDrr:r<rr>rr rrr@r&r+r0r4r4r?rLrHrWr^rBr8r%r&r'r(r)r*r+r,r-r.r/r1rsrrcr`rsF 330/ QA -3(                     #          #   z5z5z3k#.k#rc