Skip to content

FieldStats

Source code in docs_src/capo_cloudsearch_domain/types/field_stats.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class FieldStats(TypedDict, closed=True):
    min: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The minimum value found in the specified field in the result set.</p> <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>min</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>min</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>"""
    max: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The maximum value found in the specified field in the result set.</p> <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>max</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>max</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>"""
    count: "capo_cloudsearch_domain.types.long.Long"
    """<p>The number of documents that contain a value in the specified field in the result set.</p>"""
    missing: "capo_cloudsearch_domain.types.long.Long"
    """<p>The number of documents that do not contain a value in the specified field in the result set.</p>"""
    sum: "capo_cloudsearch_domain.types.double.Double"
    """<p>The sum of the field values across the documents in the result set. <code>null</code> for date fields.</p>"""
    sum_of_squares: "capo_cloudsearch_domain.types.double.Double"
    """<p>The sum of all field values in the result set squared.</p>"""
    mean: NotRequired["capo_cloudsearch_domain.types.string.String"]
    """<p>The average of the values found in the specified field in the result set.</p> <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>mean</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>mean</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>"""
    stddev: "capo_cloudsearch_domain.types.double.Double"
    """<p>The standard deviation of the values in the specified field in the result set.</p>"""

count instance-attribute 

count: Long

The number of documents that contain a value in the specified field in the result set.

max instance-attribute 

max: NotRequired[String]

The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

mean instance-attribute 

mean: NotRequired[String]

The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

min instance-attribute 

min: NotRequired[String]

The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

missing instance-attribute 

missing: Long

The number of documents that do not contain a value in the specified field in the result set.

stddev instance-attribute 

stddev: Double

The standard deviation of the values in the specified field in the result set.

sum instance-attribute 

sum: Double

The sum of the field values across the documents in the result set. null for date fields.

sum_of_squares instance-attribute 

sum_of_squares: Double

The sum of all field values in the result set squared.