o d%Z?d&Z@d'ZAd(ZBd)ZCd*ZDd+ZEd,ZFd-ZGd.ZHd/ZId0ZJd1ZKd2ZLd3ZMd4ZNd5ZOd6ZPd7ZQd8ZRd9ZSd:ZTd;ZUdd?d?ZXGd@dAdAeXZYdS)BN)AnyDictListOptionalUnion) pairs_to_dict) NEVER_DECODEPipeline)CombineResultsMethodHybridCursorQueryHybridPostProcessingConfig HybridQuery)HybridCursorResult HybridResult)deprecated_functionexperimental_method)get_protocol_version to_string)AggregateRequestAggregateResultCursor)Document)Field)IndexDefinition)ProfileInformation)Query)Result)SuggestionParserNUMERICz FT.CREATEzFT.ALTERz FT.SEARCHzFT.ADDz FT.ADDHASHz FT.DROPINDEXz FT.EXPLAINz FT.EXPLAINCLIzFT.DELz FT.AGGREGATE 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@seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ dddZ         ddeedededeeedeededed efd!d"Zdeeeeffd#d$Zdd%efd&d'Z   (     dd)d*Z dd+d,Zed-d.d/  (     dd0ed1ed2ed3eed4ed5ed6eed7edeefd8d9Zed-d.d/dd:d;Zed-dZd?d@Zed-dduefdvdwZ?dxefdydzZ@dxefd{d|ZAdxefd}d~ZBddZCdedRe#fddZDdededRe#fddZE   ddededede#dededReeFfddZGddededeeefddZHddZIdS)SearchCommandszSearch commands.cKs8t|jdvr|dkrt|S|S|j||fi|S)N3r")rclientr_RESP2_MODULE_CALLBACKS)selfcmdreskwargsr8]/root/parts/websockify/install/lib/python3.10/site-packages/redis/commands/search/commands.py_parse_resultsPszSearchCommands._parse_resultscKstt|}tt||SN)maprdictzip)r4r6r7itr8r8r9 _parse_infoVs zSearchCommands._parse_infocKs2t||dj |d|dj|dj|djdS)Nqueryduration)rB has_payload with_scoresfield_encodings)r _no_content_with_payloads _with_scores_return_fields_decode_asr4r6r7r8r8r9 _parse_searchZs zSearchCommands._parse_searchcKs|t|dd}d|vrtt|dt|ddSg}|dD] }t|dd}||qtt|d||d t|d d S) NT) decode_keyscursorSEARCHVSIM)search_cursor_idvsim_cursor_idresults total_resultswarningsexecution_time)rSrRrTrU)rrintappendrfloat)r4r6r7res_dictrRres_item item_dictr8r8r9_parse_hybrid_searchds        z#SearchCommands._parse_hybrid_searchcKs|||d|dS)NrA has_cursor)_get_aggregate_resultrJr8r8r9_parse_aggregatezzSearchCommands._parse_aggregatecKsZ|d}t|tr||d||j}nt|d|j |d|j|jd}|t|dfS)NrArrB)rBrCrDr) isinstancerr^_cursorrrFrGrHr)r4r6r7rAresultr8r8r9_parse_profile}s zSearchCommands._parse_profilecKsri}|dkr|S|D],}t|tr|dkrq t|dkrq |ds"q |dds)q dd|dD||d<q |S)Nrr1rcSsg|] }|d|ddqS)rr)score suggestionr8).0_itemr8r8r9 sz4SearchCommands._parse_spellcheck..r)rarVlen)r4r6r7 corrections _correctionr8r8r9_parse_spellchecks   z SearchCommands._parse_spellcheckcKs|r dd|DSiS)NcSsi|] }|d|dqS)rrr8)rgkvsr8r8r9 sz4SearchCommands._parse_config_get..r8rJr8r8r9_parse_config_getr`z SearchCommands._parse_config_getc sfddtdtdDS)Ncsi|] }||dqS)rr8)rgir6r8r9roz1SearchCommands._parse_syndump..rr)rangerjrJr8rrr9_parse_syndumpszSearchCommands._parse_syndumpdcCs|j||dS)zT Create a new batch indexer from the client with a given chunk size ) chunk_size) BatchIndexer)r4rwr8r8r9 batch_indexerszSearchCommands.batch_indexerFNfieldsno_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|]}|VqdSr; redis_argsrgfr8r8r9 z.SearchCommands.create_index..) CREATE_CMD index_nameargsrWr'rarVr(r#r%r$r&r*listtuplesetr)rj itertoolschain TypeErrorrexecute_command) r4rzr{r|r}r~max_text_fields temporaryrrrrr8r8r9 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 `_. rADDcsrr;rrr8r8r9rrz2SearchCommands.alter_schema_add..) ALTER_CMDrrrrrrr)r4rzrr8r8r9alter_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_CMDrraboolrWr)r4rr delete_strr8r8r9 dropindexs   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_CMDrrWrrritemsr) r4doc_idconnnosaverepayloadreplacepartiallanguage no_createrzrr8r8r9 _add_document0s*          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 rrN) ADDHASH_CMDrrWr)r4rrrerrrr8r8r9_add_document_hashZs    z!SearchCommands._add_document_hashz2.0.0z2deprecated since redisearch 2.0, call hset insteadversionreasonrrrerrrrrc 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 shoule be encoded as strings of "lon,lat" N)rrrerrrrr)r) r4rrrerrrrrrzr8r8r9 add_documentns+ 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)rrerr)r)r4rrerrr8r8r9add_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 rN)DEL_CMDrrWr)r4rrdelete_actual_documentrr8r8r9delete_documents    zSearchCommands.delete_documentcCsR|j|}dd|D}|}z|d=Wn tyYnwtdd|i|S). Load a single document by id cSi|] \}}t|t|qSr8rrgkvr8r8r9rorsz0SearchCommands.load_document..idNr8r2hgetallrKeyErrorrr4rrzf2r8r8r9 load_documents   zSearchCommands.load_documentcGs|jt|jg|RS)z Returns the full contents of multiple documents. ### Parameters - **ids**: the ids of the saved documents. )rMGET_CMDr)r4idsr8r8r9gets 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 `_. rINFO_CMDrr:r4r6r8r8r9infos zSearchCommands.info query_paramscCsb|durgSg}t|dkr/|d|t|d|D]\}}||||q |S)NrPARAMSr)rjrWr)r4rrkeyvaluer8r8r9get_params_argss    zSearchCommands.get_params_argscCsX|jg}t|tr t|}t|tstdt|||7}|||7}||fS)NzBad query type )rrastrr ValueErrortypeget_argsr)r4rArrr8r8r9_mk_query_argss   zSearchCommands._mk_query_argsrAcCsx|j||d\}}t}i}t|jdvrd|t<|jtg|Ri|}t|t r-|S|j t||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 `_. rr/T@@rArB rtime monotonicrr2rr SEARCH_CMDrar r:r4rArrstoptionsr6r8r8r9searchs zSearchCommands.searchcombine_methodpost_processingparams_substitutiontimeoutrMreturnc Cs|j}i}t|g} | ||r| ||r"| ||r,| |||r5| d|f|rBd|d<| |t|jdvrMd|t<|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 `. TIMEOUTTrMr/ r HYBRID_CMDextendr build_argsrrr2rrrar r: r4rArrrrrMindexrpiecesr6r8r8r9 hybrid_search3s* zSearchCommands.hybrid_searchcCs$|j||d\}}|jtg|RS)zReturns the execution plan for a complex query. For more information see `FT.EXPLAIN `_. r)rr EXPLAIN_CMD)r4rArr query_textr8r8r9explainis zSearchCommands.explaincCstd)Nz#EXPLAINCLI will not be implemented.)NotImplementedError)r4rAr8r8r9 explain_cliuszSearchCommands.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 queryrAr] rarrrb AGGREGATE_CMDrrr CURSOR_CMDrrrr:r4rArr]r5rawr8r8r9 aggregatexs     zSearchCommands.aggregaterr]cCsz|rt|tr|d|_|}nt|d}|d}nd}t|tr/|jr/|d}|dd}nd}|dd}t|||S)Nrrr)rarcidr _with_schemar)r4rrAr]rMschemarowsr8r8r9r^s      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. rLIMITEDQUERY AGGREGATErrNz5Must provide AggregateRequest object or Query object.rr)rr PROFILE_CMDrrWrarrrrrrrr:)r4rAr rrr5r6r8r8r9profiles"       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 `_. DISTANCETERMSINCLUDEEXCLUDESPELLCHECK_CMDrrrr:r4rAdistanceincludeexcluder5r6r8r8r9 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_CMDrrr4rrr5r8r8r9dict_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_CMDrrr r8r8r9dict_delr"zSearchCommands.dict_delcCst|g}|j|S)zDumps all terms in the given dictionary. ### Parameters - **name**: Dictionary name. For more information see `FT.DICTDUMP `_. ) DICT_DUMP_CMDr)r4rr5r8r8r9 dict_dumps zSearchCommands.dict_dump8.0.0Ddeprecated since Redis 8.0, call config_set from core module insteadoptionrcCstd||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 `_. SETOK CONFIG_CMDrr4r)rr5rr8r8r9 config_sets  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.rr:r4r)r5r6r8r8r9 config_get,s  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 `_. )r TAGVALS_CMDr)r4r7r8r8r9tagvals= 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 `_. )r ALIAS_ADD_CMDrr4r;r8r8r9aliasaddJr:zSearchCommands.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 `_. )rALIAS_UPDATE_CMDrr>r8r8r9 aliasupdateWr:zSearchCommands.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 `_. )r ALIAS_DEL_CMDr>r8r8r9aliasdelds zSearchCommands.aliasdelcOsl|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 incrementINCRr pipelineSUGADD_COMMANDstringrerrWrrexecuter4r suggestionsr7pipesugrr8r8r9sugaddps       zSearchCommands.sugaddrcCrB)z Return the number of entries in the AutoCompleter index. For more information see `FT.SUGLEN `_. )rSUGLEN_COMMAND)r4rr8r8r9suglens zSearchCommands.suglenrMcCs|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 `_. )rSUGDEL_COMMAND)r4rrMr8r8r9sugdelszSearchCommands.sugdel prefixfuzzynumrD 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|]}|qSr8r8rgsr8r8r9riz)SearchCommands.sugget..SUGGET_COMMANDrWr,r+r-rr ) r4rrYrZr[rDr\rr6rRparserr8r8r9suggets(     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_CMDrrr)r4rgrhrr5r8r8r9 synupdates    zSearchCommands.synupdatecCr)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 SYNDUMP_CMDrr:rr8r8r9syndumps zSearchCommands.syndump)rv) FFNNFNFFF)F)NFrNFFNF)NrNF)FrNFFNF)rNF)NFr;NNNNN)FNNNNFrXFF)J__name__ __module__ __qualname____doc__r:r@rKr\r_rdrmrpruryrrrrrrrrrrrrrrXrrrrrrrrVbytesrrrrrr r r r rrr rrrrrrr^rrr!r$r&r0r6r9r?rArDrSrUrWr rfrjrlr8r8r8r9r.Ms %      F +   5              8          (        8 r.c@sxeZdZddZ d,deeefdeeeeee e e fffddZ e     d-dedeed eed eeeeee e e ffd ee d eed eeeeffddZ d,deeefdeeeeee e e fffddZd.ddZeddddeded efddZedddded efddZddZd d!Z " # " "d/d$ed%ed&ed'e d(ed)ed e e!fd*d+Z"dS)0AsyncSearchCommandscs"|t|jIdH}|t|S)rNrrr8r8r9rs zAsyncSearchCommands.infoNrArcs|j||d\}}t}i}t|jdvrd|t<|jtg|Ri|IdH}t|t r1|S|j t||t|ddS)rrr/TNrrrrr8r8r9rs zAsyncSearchCommands.searchrrrrrMrc s|j}i}t|g} | ||r| ||r#| ||r-| |||r6| d|f|rCd|d<| |t|jdvrNd|t<|j | i|IdH} t | t r`| S|j t| fi|S)rrTrMr/Nrrr8r8r9r!s, z!AsyncSearchCommands.hybrid_searchcst|trt|j}t|jg|}nt|tr'd}td|jg|}nt d||| |7}|j |IdH}|j t|||dS)rTrrNrrrr8r8r9rWs    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 `_. rrrrNrrr8r8r9rws  zAsyncSearchCommands.spellcheckr'r(rr)rcs&td||g}|j|IdH}|dkS)r*r+Nr,r-r/r8r8r9r0s zAsyncSearchCommands.config_setr1cs,td|g}i}|j|IdH}|t|S)r2r3Nr4r5r8r8r9r6s   zAsyncSearchCommands.config_getcsZ|j|IdH}dd|D}|}z|d=Wn ty#Ynwtdd|i|S)rNcSrr8rrr8r8r9rorsz5AsyncSearchCommands.load_document..rr8rrr8r8r9rs  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 `_. FrErGrHrNrIrJrOr8r8r9rSs      zAsyncSearchCommands.sugaddFrXrrYrZr[rDr\c spt||d|g}|r|t|r|t|r|t|j|IdH}g} |s+| St|||} dd| DS)r]r^NcSr_r8r8r`r8r8r9rirbz.AsyncSearchCommands.sugget..rc) r4rrYrZr[rDr\rretrRrer8r8r9rfs(    zAsyncSearchCommands.suggetr;rmrnro)#rprqrrrrrrrrrVrXrtrrr r r r rrr rrrrrrrr0r6rrSrr rfr8r8r8r9rus     8  ru)Zrrtypingrrrrrredis._parsers.helpersr redis.clientrr "redis.commands.search.hybrid_queryr r r r #redis.commands.search.hybrid_resultrr redis.utilsrrhelpersr_utilr aggregationrrrdocumentrfieldrindex_definitionrprofile_informationrrArrcrrfr r!rrrrrrrEXPLAINCLI_CMDrrrrrrr#r%rr.r8r=r@rCrrLrVrTrdrirkrr#r$r%r&r'r(r)r*r+r,r-r.rur8r8r8r9s          /