phI0SSKJrJrJrJr SSKJr "SS5r"SS5r"SS\5r "S S \5r "S S 5r g ))ListOptionalTupleUnion)DEFAULT_DIALECTc X\rSrSrSrS\SS4SjrS\4SjrS3SjrS3S jr S4S \S \ \S \ \ S \ \SS4 Sjjr S\ \ \\\4S\4SjrS5S\ \S\ \S\ \S\ \SS4 SjjrS6S\ \\S\ \\SS4SjjrS\SS4SjrS\SS4SjrS\SS4SjrS3SjrS\SS4SjrS\\ \\\44S jrS\\ \\\44S!jrS"\S#\SS4S$jrS3S%jrS3S&jrS3S'jrS3S(jrS3S)jr S\SS4S*jr!S7S+jr"S8S \S,\ SS4S-jjr#S.\SS4S/jr$S0\SS4S1jr%S2r&g)9Querya) Query is used to build complex queries that have more parameters than just the query string. The query string is set in the constructor, and other options have setter functions. The setter functions return the query object so they can be chained. i.e. `Query("foo").verbatim().filter(...)` etc. query_stringreturnNc\XlSUlSUlSUlSUlSUlSUlSUlSUlSUl [5Ul SUl SUl SUlSUlSUl/Ul0Ul/Ul/UlSUlSUl[.Ulg)zq Create a new query object. The query string is set in the constructor, and other options have setter functions. r FN) _query_string_offset_num _no_content _no_stopwords_fields _verbatim_with_payloads _with_scores_scorerlist_filters_ids_slop_timeout _in_order_sortby_return_fields_return_fields_decode_as_summarize_fields_highlight_fields _language _expanderr_dialect)selfr s U/home/james-whalen/.local/lib/python3.13/site-packages/redis/commands/search/query.py__init__Query.__init__s#/  !&#(,0 $$)"'&* "f /3  )- $.2 $&.0%')')(,(,, cUR$)z+Return the query string of this query only.)rr(s r)r Query.query_string/s!!!r,cXlU$)zLLimit the results to a specific set of pre-known document ids of any length.)r)r(idss r) limit_idsQuery.limit_ids3s  r,c:UHnURU5 M U$)zAdd fields to return fields.) return_field)r(fieldsfields r) return_fieldsQuery.return_fields9sE   e $ r,r7as_field decode_fieldencodingcURRU5 U(aUOSURU'UbU=RSU4- slU$)a  Add a field to the list of fields to return. - **field**: The field to include in query results - **as_field**: The alias for the field - **decode_field**: Whether to decode the field from bytes to string - **encoding**: The encoding to use when decoding the field NAS)r!appendr")r(r7r:r;r<s r)r5Query.return_field?sM ""5);GxT%%e,     D(#3 3  r,r6cZU(d/$[U[5(aU/$[U5$N) isinstancestrrr(r6s r)_mk_field_listQuery._mk_field_listTs'I%fc22xDV Dr, context_len num_fragssepcS/nURU5nU(aUS[[U55/U-- nUbUS[U5/- nUbUS[U5/- nUbUSU/- nXPlU$)a3 Return an abridged format of the field, containing only the segments of the field that contain the matching term(s). If `fields` is specified, then only the mentioned fields are summarized; otherwise, all results are summarized. Server-side defaults are used for each option (except `fields`) if not specified - **fields** List of fields to summarize. All fields are summarized if not specified - **context_len** Amount of context to include with each fragment - **num_frags** Number of fragments per document - **sep** Separator string to separate fragments SUMMARIZEFIELDSLENFRAGS SEPARATOR)rFrDlenr#)r(r6rHrIrJargss r) summarizeQuery.summarizeYs.}$$V,  Xs3v;/069 9D  " UC ,- -D  Wc)n- -D ? [#& &D!% r,tagscS/nURU5nU(aUS[[U55/U-- nU(aUS/[U5-- nX0lU$)z Apply specified markup to matched term(s) within the returned field(s). - **fields** If specified, then only those mentioned fields are highlighted, otherwise all fields are highlighted - **tags** A list of two strings to surround the match. HIGHLIGHTrMTAGS)rFrDrQrr$)r(r6rUrRs r) highlightQuery.highlights^}$$V,  Xs3v;/069 9D  VHtDz) )D!% r,languagecXlU$)zt Analyze the query as being in the specified language. :param language: The language (e.g. `chinese` or `english`) )r%)r(r[s r)r[Query.language " r,slopcXlU$)z`Allow a maximum of N intervening non-matched terms between phrase terms (0 means exact phrase). )r)r(r_s r)r_ Query.slops  r,timeoutcXlU$)z-overrides the timeout parameter of the module)r)r(rbs r)rb Query.timeouts   r,cSUlU$)z Match only documents where the query terms appear in the same order in the document. i.e., for the query "hello world", we do not match "world hello" T)rr.s r)in_orderQuery.in_orders  r,scorercXlU$)z Use a different scoring function to evaluate document relevance. Default is `TFIDF`. Since Redis 8.0 default was changed to BM25STD. :param scorer: The scoring function to use (e.g. `TFIDF.DOCNORM` or `BM25`) )r)r(rhs r)rh Query.scorers  r,cUR/nXR5- nXRUR-- nUSURUR /- nU$)z:Format the redis arguments for this query and return them.LIMIT)r_get_args_tagsr#r$rr)r(rRs r)get_argsQuery.get_argssX.2.@.@-A ##%% &&)?)??? $,, 22 r,c/nUR(aURS5 UR(aCURS5 UR[UR55 XR- nUR(aURS5 UR (aURS5 UR (aAUR H1n[U[5(d [S5eXR- nM3 UR(aURS5 UR(aUSUR/- nUR(aURS5 UR(aCURS 5 UR[UR55 XR- nURS :aUS UR/- nUR bUS UR /- nUR"(aURS 5 UR$(aCURS5 UR[UR$55 XR$- nUR&(aS[UR&[(5(d [S5eURS5 XR&R- nUR*(aUSUR*/- nUR,(aUSUR,/- nUR.(aUSUR./- nU$)N NOCONTENTINFIELDSVERBATIM NOSTOPWORDSz Did not receive a Filter object. WITHPAYLOADSSCORER WITHSCORESINKEYSrSLOPTIMEOUTINORDERRETURNzDid not receive a SortByField.SORTBYLANGUAGEEXPANDERDIALECT)rr?rrQrrrrCFilterAttributeErrorrRrrrrrrrr!r SortbyFieldr%r&r')r(rRflts r)rmQuery._get_args_tagssH-/    KK $ << KK # KKDLL) * LL D >> KK #    KK & ==}}!#v..()KLL %    KK ' << Xt||, ,D    KK % 99 KK ! KKDII ' II D ::? VTZZ( (D == $ Y . .D >> KK "    KK ! KKD//0 1 '' 'D <<dllK88$%EFF KK ! LL%% %D >> Z0 0D >> Z0 0D == Y . .D r,offsetnumcXlX lU$)z Set the paging for the query (defaults to 0..10). - **offset**: Paging offset for the results. Defaults to 0 - **num**: How many results do we want )rr)r(rrs r)paging Query.pagings   r,cSUlU$)zHSet the query to be verbatim, i.e., use no query expansion or stemming. T)rr.s r)verbatimQuery.verbatims r,cSUlU$)z>Set the query to only return ids and not the document content.T)rr.s r) no_contentQuery.no_content s r,cSUlU$)z Prevent the query from being filtered for stopwords. Only useful in very big queries that you are certain contain no stopwords. T)rr.s r) no_stopwordsQuery.no_stopwordss " r,cSUlU$)z+Ask the engine to return document payloads.T)rr.s r) with_payloadsQuery.with_payloadss" r,cSUlU$)z0Ask the engine to return document search scores.T)rr.s r) with_scoresQuery.with_scoress  r,c&[U5UlU$)z Limit the search to specific TEXT fields only. - **fields**: Each element should be a string, case sensitive field name from the defined schema. )rrrEs r) limit_fieldsQuery.limit_fields#sF|  r,c<URRU5 U$)z Add a numeric or geo filter to the query. **Currently, only one of each filter is supported by the engine** - **flt**: A NumericFilter or GeoFilter object, used on a corresponding field )rr?)r(rs r) add_filterQuery.add_filter-s S! r,ascc&[X5UlU$)z Add a sortby field to the query. - **field** - the name of the field to sort by - **asc** - when `True`, sorting will be done in ascending order )rr r(r7rs r)sort_by Query.sort_by9s#5.  r,expandercXlU$)zP Add an expander field to the query. - **expander** - the name of the expander )r&)r(rs r)rQuery.expanderCr^r,dialectcXlU$)z_ Add a dialect field to the query. - **dialect** - dialect version to execute the query under )r')r(rs r)r Query.dialectLs   r,)r'r&rrr$rrr%rrrrrr!r"rrr r#rrrr)r r )NTutf8)NNNN)NN)rrr r T)'__name__ __module__ __qualname____firstlineno____doc__rDr*r r2r8rboolr5rrrFintrSrYr[r_floatrbrfrhrnrmrrrrrrrrrrr__static_attributes__r,r)r r sC-S-T->"c" #''+"( 3-tn  3-   *EXeDIsN.C%DEE"&%)#'! $$c]$C= $ c] $  $NOStCy)8@c8K (u  S W $uS#u_561U3U?%; <1f S s w    CG Stwswr,r c8\rSrSrS\S\S\\\4SS4SjrSrg) riVkeywordr7rRr Nc,X/[U5-UlgrB)rrR)r(rr7rRs r)r*Filter.__init__Ws$tDz1 r,rR) rrrrrDrrr*rrr,r)rrVs,22C2c5j8I2d2r,rc Z\rSrSrSrSrS S\S\\\4S\\\4S\ S\ S S 4 S jjr S r g ) NumericFilteri[z+infz-infr7minvalmaxval minExclusive maxExclusiver NcnU(dUOSU3U(dUOSU3/n[R"USU/UQ76 g)N(FILTERrr*)r(r7rrrrrRs r)r*NumericFilter.__init___s<'FaxL&FaxL  h55r,r)FF) rrrrINFNEG_INFrDrrrr*rrr,r)rr[sh CG#" 6 6c3h 6c3h 6  6  6  6 6r,rc L\rSrSrSrSrSrSr\4S\S\ S\ S \ S \S S 4 S jjr Sr g ) GeoFilteriomkmftmir7lonlatradiusunitr Nc 6[RUSXX4U5 g)N GEOFILTERr)r(r7rrrrs r)r*GeoFilter.__init__us k5sDIr,r) rrrrMETERS KILOMETERSFEETMILESrDrr*rrr,r)rros_ FJ D ENXJJ$J+0J:?JGJJ JJr,rc*\rSrSrSS\SS4SjjrSrg)ri{r7r Nc&X(aSOS/Ulg)NASCDESCrrs r)r*SortbyField.__init__|sSEf5 r,rr)rrrrrDr*rrr,r)rr{s6c666r,rN) typingrrrrredis.commands.search.dialectrr rrrrrr,r)rsI//9MM` 22 6F6( J J66r,