Interface IWeightedAverageValue

The configuration for a field or script that provides a value or weight for WeightedAverageAggregation

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IWeightedAverageValue

Properties

| Edit this page View Source

Field

The field that values should be extracted from

Declaration
[DataMember(Name = "field")]
Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

Missing

defines how documents that are missing a value should be treated. The default behavior is different for value and weight: By default, if the value field is missing the document is ignored and the aggregation moves on to the next document. If the weight field is missing, it is assumed to have a weight of 1 (like a normal average).

Declaration
[DataMember(Name = "missing")]
double? Missing { get; set; }
Property Value
Type Description
double?
| Edit this page View Source

Script

A script to derive the value and the weight from

Declaration
[DataMember(Name = "script")]
IScript Script { get; set; }
Property Value
Type Description
IScript

Extension Methods