ph:-SSKJrJrJrJr SSKJr \"5r"SS5r "SS5r "SS5r "S S \ 5r "S S \ 5r "S S5r"SS5r"SS5rg))ListOptionalTupleUnion)DEFAULT_DIALECTc4\rSrSrS S\S\SS4SjjrSrSrg) LimitoffsetcountreturnNcXlX lgN)r r )selfr r s [/home/james-whalen/.local/lib/python3.13/site-packages/redis/commands/search/aggregation.py__init__Limit.__init__ s   c~UR(a+S[UR5[UR5/$/$)NLIMIT)r strr rs r build_argsLimit.build_args s, ::S-s4::? ?Ir)r r )rr__name__ __module__ __qualname____firstlineno__intrr__static_attributes__rrr r s!ss4rr cb\rSrSrSrSrS\SS4SjrS\SS4Sjr\ S\ \S 44S j5r S r g) Reducerzf Base reducer object for all reducers. See the `redisearch.reducers` module for the actual reducers. Nargsr c,XlSUlSUlgr)_args_field_aliasrr&s rrReducer.__init__s&* %) %) raliasczU[La+UR(d [S5eURSSnXlU$)a Set the alias for this reducer. ### Parameters - **alias**: The value of the alias for this reducer. If this is the special value `aggregation.FIELDNAME` then this reducer will be aliased using the same name as the field upon which it operates. Note that using `FIELDNAME` is only possible on reducers which operate on a single field value. This method returns the `Reducer` object making it suitable for chaining. z(Cannot use FIELDNAME alias with no fieldN) FIELDNAMEr) ValueErrorr*)rr-s rr- Reducer.alias"s: I ;; !KLL AB  r.cUR$r)r(rs rr& Reducer.args:s zzr)r*r(r)) rrrr__doc__NAMErrr-propertyrr&r!r"rrr$r$sW D*c*d* 390eCHorr$c@\rSrSr%SrSr\\\S'S\SS4Sjr Sr g) SortDirection?z8 This special class is used to indicate sort direction. N DIRSTRINGfieldr cXlgrr<)rr<s rrSortDirection.__init__Fs rr>) rrrrr5r;rr__annotations__rr!r"rrr9r9?s* $Ix}#cdrr9c\rSrSrSrSrSrg)AscJzC Indicate that the given field should be sorted in ascending order ASCr"Nrrrrr5r;r!r"rrrBrBJsIrrBc\rSrSrSrSrSrg)DescRzD Indicate that the given field should be sorted in descending order DESCr"NrEr"rrrGrGRsIrrGc*\rSrSrSrSS\SS4SjjrS\SS4SjrS\\\ \4S \ SS4S jr SS jr S \ S \ SS4SjrS\SS4SjrS\\\ \4SS4SjrSSjrSSjrS\SS4SjrSSjrS S\ S\SS4SjjrS\ \4SjrS\ SS4SjrSrg)!AggregateRequestZz@ Aggregation request which can be passed to `Client.aggregate`. queryr NcXl/Ul/UlSUlSUlSUlSUl/Ul[Ul SUl SUl g)a= Create an aggregation request. This request may then be passed to `client.aggregate()`. In order for the request to be usable, it must contain at least one group. - **query** Query string for filtering records. All member methods (except `build_args()`) return the object itself, making them useful for chaining. FrTFIDFN) _query_aggregateplan _loadfields_loadall_max _with_schema _verbatim_cursorr_dialect _add_scores_scorer)rrMs rrAggregateRequest.__init___sS! )+&(#  "'$"$ , !&# rfieldsc\U(aURRU5 U$SUlU$)a Indicate the fields to be returned in the response. These fields are returned in addition to any others implicitly specified. ### Parameters - **fields**: If fields not specified, all the fields will be loaded. Otherwise, fields should be given in the format of `@field`. T)rRextendrS)rr\s rloadAggregateRequest.loadxs0     # #F + !DM rreducersc [U[5(aU/OUnS[[U55/UQnUHlnUSUR[[UR55/- nUR UR5 UR cM[USUR /- nMn URR U5 U$)a< Specify by which fields to group the aggregation. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. both cases, the field should be specified as `@field`. - **reducers**: One or more reducers. Reducers may be found in the `aggregation` module. GROUPBYREDUCEAS) isinstancerlenr6r&r^r*rQ)rr\raretreducers rgroup_byAggregateRequest.group_bys(44&&#c&k*4V4G HgllCGLL0A,BC CC JJw|| $~~)gnn--  ""3' rc UR5H.up#SU/nUbUSU/- nURRU5 M0 U$)a! Specify one or more projection expressions to add to each result ### Parameters - **kwexpr**: One or more key-value pairs for a projection. The key is the alias for the projection, and the value is the projection expression itself, for example `apply(square_root="sqrt(@foo)")` APPLYre)itemsrQr^)rkwexprr-exprrhs rapplyAggregateRequest.applysN"<<>KED/C e}$    & &s + *  rr numcn[X5nURRUR55 U$)aX Sets the limit for the most recent group or query. If no group has been defined yet (via `group_by()`) then this sets the limit for the initial pool of results from the query. Otherwise, this limits the number of items operated on from the previous group. Setting a limit on the initial search results may be useful when attempting to execute an aggregation on a sample of a large data set. ### Parameters - **offset**: Result offset from which to begin paging - **num**: Number of results to return Example of sorting the initial results: ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 10) .group_by("@state", r.count()) ``` Will only group by the states found in the first 10 results of the query `@sale_amount:[10000, inf]`. On the other hand, ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 1000) .group_by("@state", r.count() .limit(0, 10) ``` Will group all the results matching the query, but only return the first 10 groups. If you only wish to return a *top-N* style query, consider using `sort_by()` instead. )r rQr^r)rr rs_limits rlimitAggregateRequest.limits1Tv# ""6#4#4#67 rch/nUH?n[U[[45(aX4RUR/- nM:X4/- nMA S[ [ U55/nURU5 URSS5nUS:aUS[ U5/- nURRU5 U$)a Indicate how the results should be sorted. This can also be used for *top-N* style queries ### Parameters - **fields**: The fields by which to sort. This can be either a single field or a list of fields. If you wish to specify order, you can use the `Asc` or `Desc` wrapper classes. - **max**: Maximum number of results to return. This can be used instead of `LIMIT` and is also faster. Example of sorting by `foo` ascending and `bar` descending: ``` sort_by(Asc("@foo"), Desc("@bar")) ``` Return the top 10 customers: ``` AggregateRequest() .group_by("@customer", r.sum("@paid").alias(FIELDNAME)) .sort_by(Desc("@paid"), max=10) ``` SORTBYmaxrMAX) rfrBrGr<r;rrgr^getrQ)rr\kwargs fields_argsfrhrzs rsort_byAggregateRequest.sort_bys: A!c4[))55 s"  S-./ ;jj" 7 E3s8$ $C ""3' r expressionsc[U[5(aU/nUH nURRSU/5 M" U$)z Specify filter for post-query results using predicates relating to values in the result set. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. FILTER)rfrrQr^)rr expressions rfilterAggregateRequest.filtersB k3 ' '&-K%J    & &*'= >& rcSUlU$)zd If set, the `schema` property will contain a list of `[field, type]` entries in the result object. T)rUrs r with_schemaAggregateRequest.with_schema!s ! rcSUlU$)z= If set, includes the score as an ordinary field of the row. T)rYrs r add_scoresAggregateRequest.add_scores)s  rscorercXlU$)z Use a different scoring function to evaluate document relevance. Default is `TFIDF`. :param scorer: The scoring function to use (e.g. `TFIDF.DOCNORM` or `BM25`) )rZ)rrs rrAggregateRequest.scorer0s  rcSUlU$)NT)rVrs rverbatimAggregateRequest.verbatim;s rr max_idleczS/nU(aUS[U5/- nU(aUS[US-5/- nX0lU$)N WITHCURSORCOUNTMAXIDLEi)rrW)rr rr&s rcursorAggregateRequest.cursor?sD~  Wc%j) )D  YHtO 45 5D  rcfUR/nUR(aURS5 UR(aURS5 UR(aUR SUR/5 UR (aURS5 UR(aXR- nUR(a#URS5 URS5 OjUR(aYURS5 UR[[UR555 UR UR5 UR(a&UR S[UR5/5 UR UR5 U$)N WITHSCHEMAVERBATIMSCORER ADDSCORESLOAD*DIALECT)rPrUappendrVrZr^rYrWrSrRrrgrXrQ)rrhs rrAggregateRequest.build_argsHs{{m    JJ| $ >> JJz " << JJ$,,/ 0    JJ{ # << << C == JJv  JJsO    JJv  JJs3t//01 2 JJt'' ( == JJ 3t}}#56 7 4&&' rdialectcXlU$)zk Add a dialect field to the aggregate command. - **dialect** - dialect version to execute the query under )rX)rrs rrAggregateRequest.dialectks   r) rYrQrWrXrSrRrTrPrZrVrU)r)r rK)rg)rrrrr5rrr_rrr$rjrqr rvrrrrrrfloatrrrr!r"rrrKrKZs$c$D$2C$6 CcN+8? 4$,C,c,.@,\+s+1C+Z%T#Y"7)rr __class__ridrgrrs r__repr__AggregateResult.__repr__sZ!%dkkoo"''(r$xl; N#9SE 4 r)rrr) rrrrrrrrr!r"rrrrs!V  # rrN)typingrrrrredis.commands.search.dialectrobjectr0r r$r9rBrGrKrrr"rrrsm//9 H   ((V-=XXv     r