Struct GroupBy 

pub struct GroupBy {
    pub keys: Vec<Key>,
    pub aggregate: Option<Aggregate>,
}

Groups results by metadata keys and aggregates within each group.

Results are grouped by the specified metadata keys (like SQL GROUP BY), then aggregated within each group using MinK or MaxK ordering. The final output is flattened and sorted by score.

Fields

• keys - Metadata keys to group by (composite grouping)
• aggregate - Aggregation function to apply within each group

Behavior

• Missing metadata keys are treated as Null (forming their own group)
• Empty groups are omitted from results
• Final output is flattened (group structure not preserved)
• Results are sorted by score after aggregation

Examples

use chroma_types::operator::{GroupBy, Aggregate, Key};

// Top 3 documents per category
let group_by = GroupBy {
    keys: vec![Key::field("category")],
    aggregate: Some(Aggregate::MinK {
        keys: vec![Key::Score],
        k: 3,
    }),
};

// Top 2 per (category, author) combination
let group_by = GroupBy {
    keys: vec![Key::field("category"), Key::field("author")],
    aggregate: Some(Aggregate::MinK {
        keys: vec![Key::Score, Key::field("date")],
        k: 2,
    }),
};

Fields

keys: Vec<Key>

Metadata keys to group by

aggregate: Option<Aggregate>

Aggregation to apply within each group (required when keys is non-empty)

Trait Implementations

impl Clone for GroupBy

fn clone(&self) -> GroupBy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GroupBy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GroupBy

fn default() -> GroupBy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GroupBy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GroupBy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<GroupBy> for GroupByOperator

type Error = QueryConversionError

The type returned in the event of a conversion error.

fn try_from(value: GroupBy) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<GroupByOperator> for GroupBy

type Error = QueryConversionError

The type returned in the event of a conversion error.

fn try_from(value: GroupByOperator) -> Result<Self, Self::Error>

Performs the conversion.