o Lj9@sddlZddlZddlmZmZmZmZmZmZddl m Z ddl m Z m Z ddlmZmZmZmZddlmZmZddlmZddlmZmZmZmZmZd d lmZm Z d d l!m"Z"m#Z#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/m0Z0d dl1m2Z2dZ3dZ4dZ5dZ6dZ7dZ8dZ9dZ:dZ;dZd Z?d!Z@d"ZAd#ZBd$ZCd%ZDd&ZEd'ZFd(ZGd)ZHd*ZId+ZJd,ZKd-ZLd.ZMd/ZNd0ZOd1ZPd2ZQd3ZRd4ZSd5ZTd6ZUd7ZVd8ZWd9ZXd:ZYd;ZZdZ]Gd?d@d@Z^GdAdBdBe^Z_dS)CN)AnyDictListOptionalSetUnion) pairs_to_dict) NEVER_DECODEPipeline)CombineResultsMethodHybridCursorQueryHybridPostProcessingConfig HybridQuery)HybridCursorResult HybridResult)KeyT)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.ALIASDELz FT.ALIASLISTzFT.INFOz FT.SUGADDz FT.SUGDELz FT.SUGLENz FT.SUGGETz FT.SYNUPDATEz FT.SYNDUMPz FT.HYBRID NOOFFSETSNOFIELDSNOHLNOFREQS MAXTEXTFIELDS TEMPORARY STOPWORDSSKIPINITIALSCAN WITHSCORESFUZZY WITHPAYLOADSc@s>eZdZdZeeeeee hZ ddZ ddZ e dddZe d d Zd d Zd dZddZddZddZddZddZddZddZddZdd Zehd!Ze d"d#Zd$d%Zd&d'Zd(d)Zd*d+Z d,d-Z!d.d/Z"d0d1Z#d2d3Z$d4d5Z%d6d7Z&e d8d9Z'e d:d;Z(dd?Z*d@dAZ+dBdCZ,dDdEZ-e ddGdHZ.e dIdJZ/dKdLZ0e dMdNZ1dOdPZ2dQdRZ3dSdTZ4dUdVZ5ddXdYZ6 F F   F  F F FddZe7e8d[e9d\e9d]e:e7e;d^e:e<d_e9d`e9dae9fdbdcZ=dZe>e8e7e8ffdddeZ?ddfe9fdgdhZ@  F i  F F  FddjdkZA FddldmZBeCdndodp F i  F F  Fddqe;dre9dseDdte:e9due9dve9dwe:e;dxe9dZe7e;fdydzZEeCdndodpdd{d|ZFeCdnd}dpdd~dZGdde:eHe;eIffddZJeCdnd}dpddZKddZLde:eHe;e>e;eMeDeNfffddZOde:eHe;e>e;eMeDeNfffddZP dde>e;eQfde>eHe;e>e;eMeDeNffdffddZReS     ddeTde:eUde:eVde:eHe;e>e;eMeDeNffde:eMde:eWde>eXeYeZffddZ[ dde>e;eQfde:eHe;e>e;eMeDeNfffddZ\de>e;eQffddZ] dde>e^e_fde:eHe;e>e;eMeDeNfffddZ`de7de>e^e_fde9fddZa F dde>eQe^fde9de:eHe;e>e;eMeDeNffde>ebe>ecedfeefeeffddZfdddZgde;de7e;fddZhde;de7e;fddZide;fddZjeCdddpde;de;de9fddZkeCdddpde;de;fddZlde;fddZmdenfddZodenfddZpdenfddZqdere;eNBfdd„ZsddĄZtde;deMfddDŽZude;de;deMfddʄZv F F Fdde;de;de9deMde9de9de7ewfdd҄Zxdde;de9de7e;fddքZydd؄ZzdS)SearchCommandszSearch commands.cCs0t|jt|jt|jt|jt|j t |j t |j t|jt|ji |_t|jt|jt|ji|_t|jt|jt|jt|jt|jt |jt |jt|jt|ji |_t|jt|j t|ji|_!t|ji|_"t|j#t|jt|j$t|jt|j%t |j t |j&t|j't|ji |_(t)|j|_*|j+|j*t<|j,|j*t <|j-|j*t<|j.|j*t<dS)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_syndumpALIAS_LIST_CMD_parse_aliaslist_RESP2_MODULE_CALLBACKS_parse_search_resp3_native!_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 _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_unifiedselfrc\/home/djax/ivt_ai_plugin/venv/lib/python3.10/site-packages/redis/commands/search/commands.py_init_module_callbacks`sb      z%SearchCommands._init_module_callbackscKs||jvr d|vr |St|j}t|j}|r=|dvr*|tkr#t|S|j|}n%t|dr6|j |}n|j |}nt|drI|j |}n|j |}|durU|S||fi|S)Nquery)3rg) _QUERY_REQUIRED_CMDSrclientrr:r!rGgetrrPrDr\rZ)rbcmdreskwargsprotocollegacycbrcrcrd_parse_resultss$     zSearchCommands._parse_resultsNcCs&t|ts|S|||||SN) isinstancer[rkencode)mappingkeydefaultrcrcrd _resp3_gets zSearchCommands._resp3_getcCs@t|ts|Sg}|D]\}}|t|||q |Srs)rtr[itemsappendr)rvflatrwvaluercrcrd_flatten_resp3_mappings  z%SearchCommands._flatten_resp3_mappingc Ks|d}|dust|ts|S||ddg}||dgD]3}|||d|jr6|||d|jrB|||d|jsR||||d iq|S) zDConvert RESP3 FT.SEARCH pipeline output to raw RESP2 pipeline shape.rfN total_resultsrresultsidscorepayloadextra_attributes) rkrtr[ryr{ _with_scores_with_payloads _no_contentr~)rbrmrnrfoutputitemrcrcrdrQs$  z5SearchCommands._pipeline_parse_search_resp3_to_legacyc st|ts|Sdd|D}d|vr d|dd|dgSfdd|dgD}d |d d d|d |d gd |d d gS) zDConvert RESP3 FT.HYBRID pipeline output to raw RESP2 pipeline shape.cSi|] \}}t||qSrcr.0rwr}rcrcrd zPSearchCommands._pipeline_parse_hybrid_search_resp3_to_legacy..cursorSEARCHVSIMc$g|]}t|tr|n|qSrc)rtr[r~rrrarcrd zPSearchCommands._pipeline_parse_hybrid_search_resp3_to_legacy..rrrwarningsexecution_time)rtr[rzrk)rbrmrnrrcrardrRs"      z.r)rtrlen)rbrmrn corrections _correctionrcrcrdr=Rs   z SearchCommands._parse_spellcheckcKs|r dd|DSiS)NcSsi|] }|d|dqSrrrcrkvsrcrcrdrxrz4SearchCommands._parse_config_get..rcrrcrcrdr?wrz SearchCommands._parse_config_getc sfddtdtdDS)Ncsi|] }||dqS)rrcrirmrcrdr{z1SearchCommands._parse_syndump..rrrangerrrcrrdrAzszSearchCommands._parse_syndump>typeWEIGHTPHONETIC SEPARATOR attribute identifiercCsi}g}tj}d}|t|kr?t||}||vr0|dt|kr0t||d||<|d7}n |||d7}|t|ks||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_KEYSrrr{) attr_listrr pair_keysrrwrcrcrd_normalize_info_attributes      z(SearchCommands._normalize_info_attributec sLtt|}tt||}d|vr$t|dtr$fdd|dD|d<|S)zParse FT.INFO into the unified shape with ``attributes`` as a list of dicts so RESP2 output matches RESP3 output. attributescrrc)rtlistrrattrrarcrdrrz6SearchCommands._parse_info_unified..)rrr[rrtr)rbrmrnrinforcrardrUs   z"SearchCommands._parse_info_unifiedc st|dd}d|vrtt|dt|ddSjdi|g}|dD]}t|dd}|fdd |Dq&tt|d ||d t|d d S)NTrrrrrrc i|] \}}|||qSrc_decode_hybrid_field_valuerrrbrcrdrsz?SearchCommands._parse_hybrid_search_unified..rrrrrc)rrr_hybrid_field_encodingsr{rzrrrrcrrdrVs*        z+SearchCommands._parse_hybrid_search_unifiedcKs|d}t|tr||d||j}nt|d|j |d|j|jd}|d}t|tr?|r?t|dt t fr?t |dd}|t |fS)zParse FT.PROFILE into ``(result, ProfileInformation)`` with the profile_data normalised to a dict on >= 7.9.0 servers. rfrrrrTr) rtrrrr#rrrrstrbytesrr!)rbrmrnrfr profile_datarcrcrdrWs&   z%SearchCommands._parse_profile_unifiedcKs|siSdd|DS)NcSs"i|] }t|dt|dqSrrrrcrcrdrs"z.rcrrcrcrdrXsz(SearchCommands._parse_config_get_unifiedc s&siSfddtdtdDS)NcsNi|]#}t|t|dtrdd|dDnt|dqS)rcSg|]}t|qSrcrrsrcrcrdrzDSearchCommands._parse_syndump_unified...)rrtrrrrcrdrs z9SearchCommands._parse_syndump_unified..rrrrrcrrdrYs  z%SearchCommands._parse_syndump_unifiedcKs4|d}tj||ddt|ddt|dddS) z4Parse RESP3 FT.SEARCH response into a Result object.rfrrrFrN)rrr)rkr# from_resp3getattr)rbrmrnrfrcrcrdrIs    z"SearchCommands._parse_search_resp3c Kst|ts|S|d}t|dd}dd|D}d|vrvg}|dD]L}t|ts2||q%dd|D}d|vrGt|d|d<|d }t|trli}|D]\} } t| } t| | ||| <qW||d <||q%||d<d |vrd d |d D|d <|S) aNormalise the RESP3 FT.SEARCH map while preserving its native shape. ``protocol=3`` + ``legacy_responses=True`` keeps the RESP3 dict surface. FT.SEARCH uses ``NEVER_DECODE`` (its results may contain binary field values such as vector embeddings), so the wire hands back raw bytes. Decode the structural keys and the field values here instead of at the wire: text values are decoded leniently while binary fields flagged via ``return_field(..., decode_field=False)`` are preserved as raw bytes. This keeps the previously decoded native surface intact and no longer crashes on non-UTF-8 field data. rfrNcSrrcrrkvrcrcrdrrz=SearchCommands._parse_search_resp3_native..rcSrrcrrrcrcrdrrrrwarningcSrrcrrwrcrcrdr"rz=SearchCommands._parse_search_resp3_native..)rtr[rkrrzr{rr) rbrmrnrfrrrextradecodedrrrcrcrdrEs4         z)SearchCommands._parse_search_resp3_nativecKs.|d}|dd}d}|r%t|tr%|d}t|dkr"|dnd}n|}|dur-i}dd|D}d d |d gD}|d d}g} |d gD]+} dd| D} | di} g} | D]\} }| | | |qf| | qOd}|rt|tr||_|}nt|}t| |d||dS)zAParse RESP3 FT.AGGREGATE response into an AggregateResult object.rfrFrrNcSrrcrrrcrcrdr7rz9SearchCommands._parse_aggregate_resp3..cSrrcrrrcrcrdr9rz9SearchCommands._parse_aggregate_resp3..rrrcSrrcrrrcrcrdr>rr)totalr) rkrtrrrzr{rcidr)rbrmrnrfr cursor_iddatarrrows result_item extra_attrsr|rrrrcrcrdrK%s8        z%SearchCommands._parse_aggregate_resp3c Ksdd|D}d|vrtt|dt|ddSg}|dgD]}t|tr7|dd|Dq#|t|d d q#tt|d d ||d gt |dd dS)a4Parse RESP3 FT.HYBRID response into HybridResult/HybridCursorResult. Top-level keys are normalised to strings. Values are preserved as delivered by the wire (bytes when ``NEVER_DECODE`` is set, strings otherwise) so byte/str semantics match the RESP2 legacy parser. cSrrcrrrcrcrdr\rz=SearchCommands._parse_hybrid_search_resp3..rrrrrcSrrcrrrcrcrdrfrTrrrrrr) rzrrrkrtr[r{rrr)rbrmrnrrrcrcrdrJTs"    z)SearchCommands._parse_hybrid_search_resp3c sdd|D}d|vrtt|dt|ddSjdi|g}|dgD],}t|trB|fdd|Dq+t|d d }|fd d|Dq+t t|d d ||dgt |dd dS)z=Parse RESP3 FT.HYBRID into the approved unified HybridResult.cSrrcrrrcrcrdrsrzESearchCommands._parse_hybrid_search_resp3_unified..rrrrrcs(i|]\}}t||t|qSrc)rrrrrcrdrs  Trcrrcrrrrcrdrs rrrrrNrc) rzrrrrkrtr[r{rrr)rbrmrnrrrrcrrdr`qs6        z1SearchCommands._parse_hybrid_search_resp3_unifiedcKs:i}dD]}||}t|dd}|r||q|pdS)N)rfpost_processingr)rkrupdate)rn encodings source_namesourcesource_encodingsrcrcrdrs   z&SearchCommands._hybrid_field_encodingscCs|r||vr|St|||Srs)r)r}rwrrcrcrdrs  z)SearchCommands._decode_hybrid_field_valuecKs^dd|D}d|vr|Sd|vrdd|dD|d<d|vr-dd|dD|d<|S) 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. cSrrcrrrcrcrdrrzDSearchCommands._parse_hybrid_search_resp3_native..rrcSs4g|]}t|trdd|Dnt|ddqS)cSrrcrrrcrcrdrrzOSearchCommands._parse_hybrid_search_resp3_native...Tr)rtr[rzrrrcrcrdrs  zDSearchCommands._parse_hybrid_search_resp3_native..rcSrrcrrrcrcrdrrrzrrcrcrdrFs z0SearchCommands._parse_hybrid_search_resp3_nativec Kst|ts|j|fi|Sdd|D}i}|di}|D]4\}}|s*q#g}|D]"}|D]\} } t| } | drG| dd} || | dq4q.|rW|||<q#|S)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}, ...], ...} cSrrcrrrcrcrdrrz:SearchCommands._parse_spellcheck_resp3..rz.0Nr)rtr[r=rzrkrendswithr{) rbrmrnrrterm suggestionsterm_correctionssuggestion_dictrr score_strrcrcrdrMs,     z&SearchCommands._parse_spellcheck_resp3cKs|d}|d}|dur|d}|dur|d}|dur$|d}|dur-|d}|d}|dur;|d }|durD|d }|durM|d }|durV|d }t|trbt||d }t|trs|j||t|jd}ntj ||ddt |ddd}| |}||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. rfResultsNsResultsrsresultsrProfilesProfileprofilesprofiler)rrrfrrrF)rr) rkrtrrrrKboolrr#rr_to_string_recursive)rbrmrnrf results_datarrrcrcrd_extract_resp3_profile_partssD                z+SearchCommands._extract_resp3_profile_partscKsft|tr|j|fi|S|j|fi|\}}t|tr-d|vp%d|v}|j||d}|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)rtrr;rr[_resp3_profile_dict_to_listr!)rbrmrnrrr rcrcrdrLs   z#SearchCommands._parse_profile_resp3cKsbt|tr|j|fi|S|j|fi|\}}t|tr+d|vs+d|vs+||}|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)rtrrWrr[r r!)rbrmrnrrrcrcrdr_7s    z+SearchCommands._parse_profile_resp3_unifiedFcs&ddd fdd |ddS) 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. cSst|to |o t|dtS)Nr)rtrr[objrcrcrd_is_list_of_dicts]szESearchCommands._resp3_profile_dict_to_list.._is_list_of_dictsFcst|tr`|r6s6g}|D]$\}}|g}|r'|D] }||qn||||q|Sg}|D]!\}}|||rV|D] }||qKq<||q<|St|trnfdd|DS|S)Ncsg|]}|qSrcrcr)_convertrcrdrxrzPSearchCommands._resp3_profile_dict_to_list.._convert..)rtr[rzr{r)r  top_levelrrrentryrrr r rcrdr`s0    z._convertT)rNFrc)rr rcrrdr Ks z*SearchCommands._resp3_profile_dict_to_listcCsJt|tr t|St|trdd|DSt|tr#dd|DS|S)zRecursively convert bytes keys/values to strings in nested structures. Non-bytes scalars (int, float, None, bool) pass through unchanged. cSs.i|]\}}t|trt|n|t|qSrc)rtrrr1rrrcrcrdrs z7SearchCommands._to_string_recursive..cSsg|]}t|qSrc)r1rrrcrcrdrsz7SearchCommands._to_string_recursive..)rtrrr[rzrr rcrcrdrs   z#SearchCommands._to_string_recursivecKs ||S)z;Parse RESP3 FT.INFO response, normalising bytes to strings.rrrcrcrdr]s z SearchCommands._parse_info_resp3cCsPg}|dpg}|D]\}}|dkrq ||||q |||S)zConvert a RESP3-style attribute dict back into the RESP2 flat list (key-value pairs followed by bare flag tokens). r)rkrzr{extend) attr_dictr|rrrrcrcrd_flatten_info_attributes   z&SearchCommands._flatten_info_attributec s8|}|d}t|trfdd|D|d<|S)zParse RESP3 FT.INFO into the legacy RESP2 flat shape so ``legacy_responses=True`` on a RESP3 wire matches RESP2 output. rcrrc)rtr[rrrarcrdrrz>SearchCommands._parse_info_resp3_to_legacy..)rrkrtr)rbrmrnrattrsrcrardrHs     z*SearchCommands._parse_info_resp3_to_legacycKs|siSdd|DS)zAParse RESP3 FT.CONFIG GET response, normalising bytes to strings.cSsi|] \}}t|t|qSrcrrrcrcrdrrz:SearchCommands._parse_config_get_resp3..rrrcrcrdr^sz&SearchCommands._parse_config_get_resp3cKs|rt|SiS)z>Parse RESP3 FT.CONFIG GET back to the RESP2 legacy dict shape.)r[rrcrcrdrNsz0SearchCommands._parse_config_get_resp3_to_legacycKs|siS||S)z>Parse RESP3 FT.SYNDUMP response, normalising bytes to strings.rrrcrcrdrOs z#SearchCommands._parse_syndump_resp3dcCs|j||dS)zT Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)rbrrcrcrd batch_indexerszSearchCommands.batch_indexerfieldsno_term_offsetsno_field_flags stopwords definition no_highlightno_term_frequenciesskip_initial_scanc Cs*t|jg} |dur| |j7} |r| t|dur(t|tr(| t| ||r/| t|r6| t |r=| t | rD| t | rK| t |durkt|t ttfrk| tt|g7} t|dkrk| t |7} | dz| t tjdd|D7} Wnty| |7} Ynw|j| S)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. NrSCHEMAcs|]}|VqdSrs redis_argsrfrcrcrd z.SearchCommands.create_index..) CREATE_CMD index_nameargsr{r*rtrr+r&r(r'r)r-rtuplerr,r itertoolschain TypeErrorr'execute_command) rbrrrrr max_text_fields temporaryr!r"r#r.rcrcrd create_indexs: '               zSearchCommands.create_indexcCsXt|jddg}z|ttjdd|D7}Wnty&||7}Ynw|j|S)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$ADDcsr%rsr&r(rcrcrdr*r+z2SearchCommands.alter_schema_add..) ALTER_CMDr-rr0r1r2r'r3)rbrr.rcrcrdalter_schema_adds    zSearchCommands.alter_schema_adddelete_documentscCs<t|jg}t|tr|durdnd}|r|||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_CMDr-rtrr{r3)rbr:r. delete_strrcrcrd dropindex"s   zSearchCommands.dropindex?c Ks|s| rd}t|j||g} |r| d|dur"| d| ||r7| d|r0| d| r7| d|r?| d|g7} | d | ttj| 7} |durX|j| S|j| S) zS Internal add_document used for both batch and single doc indexing TNOSAVENPAYLOADREPLACEPARTIALNOCREATELANGUAGEFIELDS)ADD_CMDr-r{rr0r1rzr3) rbdoc_idconnnosaverrreplacepartiallanguage no_createrr.rcrcrd _add_document;s*          zSearchCommands._add_documentcCsHt|j||g}|r|d|r|d|g7}|dur|j|S|j|S)zX Internal add_document_hash used for both batch and single doc indexing rCrFN) ADDHASH_CMDr-r{r3)rbrIrJrrNrLr.rcrcrd_add_document_hashes    z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreasonrIrKrrrLrMrNrOc Ks$|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)rJrKrrrLrMrNrO)rP) rbrIrKrrrLrMrNrOrrcrcrd add_documentys+ zSearchCommands.add_documentcCs|j|d|||dS)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)rJrrNrL)rR)rbrIrrNrLrcrcrdadd_document_hashs z SearchCommands.add_document_hashzdeprecated since redisearch 2.0cCs6t|j|g}|r |d|dur|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 r;N)DEL_CMDr-r{r3)rbrIrJdelete_actual_documentr.rcrcrddelete_documents    zSearchCommands.delete_documentrcsR|j|}fdd|D}z|d=Wn tyYnwtdd|i|S) 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). c&i|]\}}t|t|t|qSrcrrrrrcrdrz0SearchCommands.load_document..rNrcrjhgetallrzKeyErrorrrbrrrrcr^rd load_documents    zSearchCommands.load_documentcGs|jt|jg|RS)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )r3MGET_CMDr-)rbidsrcrcrdrks zSearchCommands.getcC|t|j}|t|S) Get info an stats about the the current index, including the number of documents, memory consumption, etc For more information see `FT.INFO `_. r3r2r-rrrbrmrcrcrdrs zSearchCommands.info query_paramscCsb|durgSg}t|dkr/|d|t|d|D]\}}||||q |S)NrPARAMSr)rr{rz)rbrkr.rwr}rcrcrdget_params_argss    zSearchCommands.get_params_argscCsX|jg}t|tr t|}t|tstdt|||7}|||7}||fS)NzBad query type )r-rtrr" ValueErrorrget_argsrm)rbrfrkr.rcrcrd_mk_query_argss   zSearchCommands._mk_query_argsrfcCs|j||d\}}t}tdi}t|tr||d<d|d<|jtg|Ri|}t|tr1|S|jt||t|ddS) 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 `_. rkTrfrr@@rfr rptime monotonicr rtr r3r4rrrbrfrkr.stoptionsrmrcrcrdsearch$s  zSearchCommands.searchcombine_methodrparams_substitutiontimeoutrreturnc Cs|j}i}t|g} | ||r| ||r&| |||d<|r0| |||r9| d|f|rFd|d<| |d|t<||d<|j| i|} t| t r]| S|j t| 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 `. rTIMEOUTTrrf r-r6rro build_argsrmr r3rtr rr rbrfr|rr}r~rindexrzpiecesrmrcrcrd hybrid_searchHs, zSearchCommands.hybrid_searchcCs$|j||d\}}|jtg|RS)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. rr)rpr3 EXPLAIN_CMD)rbrfrkr. query_textrcrcrdexplains zSearchCommands.explaincCstd)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)rbrfrcrcrd explain_cliszSearchCommands.explain_clicCst|trt|j}t|jg|}nt|tr&d}td|jg|}nt d||| |7}|j |}|j t|||dS) 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 rtrrrr8r-rr CURSOR_CMDrnrmr3rrrbrfrkrrlrawrcrcrd aggregates     zSearchCommands.aggregaterrcCsz|rt|tr|d|_|}nt|d}|d}nd}t|tr/|jr/|d}|dd}nd}|dd}t|||S)Nrrr)rtrrr _with_schemar)rbrrfrrschemarrcrcrdrs      z$SearchCommands._get_aggregate_resultlimitedcCst}t|jdg}|r|d|dt|tr&d|d<||7}nt|tr=d|d<|| 7}|| |7}nt d|j |}|j t||t|dd 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. r<LIMITEDQUERY AGGREGATErrz5Must provide AggregateRequest object or Query object.rsrt)rvrwr:r-r{rtrrr"rormrnr3rr)rbrfrrkryrlrmrcrcrdrs"       zSearchCommands.profilecCs\t|j|g}|r|d|g|r|dd|g|r#|dd|g|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<r-rr3rrrbrfdistanceincludeexcluderlrmrcrcrd spellchecks   zSearchCommands.spellchecknametermscGt|g}|||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_CMDrr3rbrrrlrcrcrddict_add  zSearchCommands.dict_addcGr)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_CMDrr3rrcrcrddict_delrzSearchCommands.dict_delcCst|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDr3)rbrrlrcrcrd dict_dump*s zSearchCommands.dict_dump8.0.0Ddeprecated since Redis 8.0, call config_set from core module insteadoptionr}cCstd||g}|j|}|dkS)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>r3rbrr}rlrrcrcrd config_set6s  zSearchCommands.config_setDdeprecated since Redis 8.0, call config_get from core module insteadcCs td|g}|j|}|t|S)Get runtime configuration option value. ### Parameters - **option**: the name of the configuration option. For more information see `FT.CONFIG GET `_. GETr>r3rrrbrrlrmrcrcrd config_getHs  zSearchCommands.config_gettagfieldcCs|t|j|S)z Return a list of all possible tag values ### Parameters - **tagfield**: Tag field name For more information see `FT.TAGVALS `_. )r3 TAGVALS_CMDr-)rbrrcrcrdtagvalsY zSearchCommands.tagvalsaliascC|t||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 `_. )r3 ALIAS_ADD_CMDr-rbrrcrcrdaliasaddfrzSearchCommands.aliasaddcCr)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 `_. )r3ALIAS_UPDATE_CMDr-rrcrcrd aliasupdatesrzSearchCommands.aliasupdatecC |t|S)z Removes an alias to a search index ### Parameters - **alias**: Name of the alias to delete For more information see `FT.ALIASDEL `_. )r3 ALIAS_DEL_CMDrrcrcrdaliasdels zSearchCommands.aliasdelcCs(|t|j}t|tr|S|t|S) List all aliases associated with the current index as an unordered set. The index must be the name of an index created with ``FT.CREATE``; an alias name is not accepted as a substitute. Returns an empty set when the index exists but has no aliases. Alias names honor ``decode_responses`` (``str`` when decoding is enabled, ``bytes`` otherwise). For more information see `FT.ALIASLIST `_. r3rBr-rtr rrrjrcrcrd aliaslists  zSearchCommands.aliaslistcOsl|jdd}|D]'}t||j|jg}|dr|d|jr*|d||j|j|q|dS)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 incrementINCRrB pipelineSUGADD_COMMANDstringrrkr{rr3executerbrwrrnpipesugr.rcrcrdsugadds       zSearchCommands.sugaddrwcCr)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )r3SUGLEN_COMMAND)rbrwrcrcrdsuglens zSearchCommands.suglenrcCs|t||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 `_. )r3SUGDEL_COMMAND)rbrwrrcrcrdsugdelszSearchCommands.sugdel prefixfuzzynumr with_payloadsc Csht||d|g}|r|t|r|t|r|t|j|}g} |s'| St|||} dd| DS)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 `_. MAXcSg|]}|qSrcrcrrcrcrdrz)SearchCommands.sugget..SUGGET_COMMANDr{r/r.r0r3r$) rbrwrrrrrr.rmrparserrcrcrdsuggets(     zSearchCommands.suggetgroupid skipinitialcGs0t|j|g}|r|dg|||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_CMDr-rr3)rbrrrrlrcrcrd synupdates    zSearchCommands.synupdatecCrg)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 `_. )r3r@r-rrrjrcrcrdsyndumps zSearchCommands.syndumprsr)r) FFNNFNFFF)NFr@NFFNF)Nr@NF)Fr@NFFNF)r@NF)NFNNNNN)FNNNNFrFF){__name__ __module__ __qualname____doc__ frozensetr4r8rr6r:rirerr staticmethodryr~rQrRr3rCr5r7r9r;r=r?rArrrUrVrWrXrYrIrErKrJr`rrrFrMrrLr_r rr]rrHr^rNrOrrrrrrr r6rr9r?rPrRrrrVrWrZrrrdrkrrrrmrpr"r{rrr r r rrr rrrrrrrr/r#rr!rrrrrrrrrrrrrrrrrr$rrrrcrcrcrdr1Ts ]     %    '/(  (1 3         F +   5           $  <          +        8 r1c@seZdZddZdeeeBfddZ d/deee fde e eeee e efffd d Ze     d0ded e ed e ed e e eeee e effde e de edeeeeffddZ d/deeefde e eeee e efffddZd1ddZeddddededefddZeddddedefddZd/d e e ee ffd!d"Z!d#d$Z" % & % %d2d'ed(ed)ed*e d+ed,ede#e$fd-d.Z%dS)3AsyncSearchCommandscs"|t|jIdH}|t|S)rhNrirjrcrcrdr#s zAsyncSearchCommands.inforcs0|t|jIdH}t|tr|S|t|S)rNrrjrcrcrdr.s   zAsyncSearchCommands.aliaslistNrfrkcs|j||d\}}t}tdi}t|tr||d<d|d<|jtg|Ri|IdH}t|tr5|S|jt||t|ddS) rqrrTrfrrNrsrtrurxrcrcrdr{?s  zAsyncSearchCommands.searchr|rr}r~rc s|j}i}t|g} | ||r| ||r'| |||d<|r1| |||r:| d|f|rGd|d<| |d|t<||d<|j| i|IdH} t| t ra| S|j t| fi|S)rrrTrrfNrrrcrcrdrcs. z!AsyncSearchCommands.hybrid_searchcst|trt|j}t|jg|}nt|tr'd}td|jg|}nt d||| |7}|j |IdH}|j t|||dS)rTrrNrrrrcrcrdrs    zAsyncSearchCommands.aggregatecsdt|j|g}|r|d|g|r|dd|g|r$|dd|g|j|IdH}|t|S)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 `_. rrrrNrrrcrcrdrs  zAsyncSearchCommands.spellcheckrrrSrr}cs&td||g}|j|IdH}|dkS)rrNrrrrcrcrdrs zAsyncSearchCommands.config_setrcs,td|g}i}|j|IdH}|t|S)rrNrrrcrcrdrs   zAsyncSearchCommands.config_getrcsZ|j|IdH}fdd|D}z|d=Wn ty#Ynwtdd|i|S)r[Ncr\rcr]rr^rcrdrr_z5AsyncSearchCommands.load_document..rrcr`rcrcr^rdrds   z!AsyncSearchCommands.load_documentcst|jdd}|D]'}t||j|jg}|dr|d|jr+|d||j|j|q |IdHdS)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 `_. FrrrrBNrrrrcrcrdrs      zAsyncSearchCommands.sugaddFrrwrrrrrc spt||d|g}|r|t|r|t|r|t|j|IdH}g} |s+| St|||} dd| DS)rrNcSrrcrcrrcrcrdr_rz.AsyncSearchCommands.sugget..r) rbrwrrrrrr.retrrrcrcrdr)s(    zAsyncSearchCommands.suggetrsrrr)&rrrrrrrrrr"rrrrr{rrr r r rrr rrrrrrrrrrrdrrr$rrcrcrcrdr"s   $  <  r)`r0rvtypingrrrrrrredis._parsers.helpersr redis.clientr r "redis.commands.search.hybrid_queryr r r r#redis.commands.search.hybrid_resultrr redis.typingr redis.utilsrrrrrhelpersrr aggregationrrrdocumentrfieldrindex_definitionr profile_informationr!rfr"rr#rr$r%r,r8r4rHrQr=rEXPLAINCLI_CMDrXr8r:rr<rrrrer>rrrrrBr2rrrrrr@r6r&r'r(r)r*r+r,r-r.r/r0r1rrcrcrcrds          [