Struct SearchPayload 

pub struct SearchPayload {
    pub filter: Filter,
    pub rank: Rank,
    pub limit: Limit,
    pub select: Select,
}

A search payload for the hybrid search API.

Combines filtering, ranking, pagination, and field selection into a single query. Use the builder methods to construct complex searches with a fluent interface.

Examples

Basic vector search

use chroma_types::plan::SearchPayload;
use chroma_types::operator::{RankExpr, QueryVector, Key};

let search = SearchPayload::default()
    .rank(RankExpr::Knn {
        query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
        key: Key::Embedding,
        limit: 100,
        default: None,
        return_rank: false,
    })
    .limit(Some(10), 0)
    .select([Key::Document, Key::Score]);

Filtered search

use chroma_types::plan::SearchPayload;
use chroma_types::operator::{RankExpr, QueryVector, Key};

let search = SearchPayload::default()
    .r#where(
        Key::field("status").eq("published")
            & Key::field("year").gte(2020)
    )
    .rank(RankExpr::Knn {
        query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
        key: Key::Embedding,
        limit: 200,
        default: None,
        return_rank: false,
    })
    .limit(Some(5), 0)
    .select([Key::Document, Key::Score, Key::field("title")]);

Hybrid search with custom ranking

use chroma_types::plan::SearchPayload;
use chroma_types::operator::{RankExpr, QueryVector, Key};

let dense = RankExpr::Knn {
    query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
    key: Key::Embedding,
    limit: 200,
    default: None,
    return_rank: false,
};

let sparse = RankExpr::Knn {
    query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
    key: Key::field("sparse_embedding"),
    limit: 200,
    default: None,
    return_rank: false,
};

let search = SearchPayload::default()
    .rank(dense * 0.7 + sparse * 0.3)
    .limit(Some(10), 0)
    .select([Key::Document, Key::Score]);

Fields

filter: Filter

rank: Rank

limit: Limit

select: Select

Implementations

impl SearchPayload

pub fn limit(self, limit: Option<u32>, offset: u32) -> Self

Sets pagination parameters.

Arguments

• limit - Maximum number of results to return (None = no limit)
• offset - Number of results to skip

Examples

use chroma_types::plan::SearchPayload;

// First page: results 0-9
let search = SearchPayload::default().limit(Some(10), 0);

// Second page: results 10-19
let search = SearchPayload::default().limit(Some(10), 10);

pub fn rank(self, expr: RankExpr) -> Self

Sets the ranking expression for scoring and ordering results.

Arguments

• expr - A ranking expression (typically Knn or a combination of expressions)

Examples

Simple KNN ranking

use chroma_types::plan::SearchPayload;
use chroma_types::operator::{RankExpr, QueryVector, Key};

let search = SearchPayload::default()
    .rank(RankExpr::Knn {
        query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
        key: Key::Embedding,
        limit: 100,
        default: None,
        return_rank: false,
    });

Weighted combination

use chroma_types::plan::SearchPayload;
use chroma_types::operator::{RankExpr, QueryVector, Key};

let knn1 = RankExpr::Knn {
    query: QueryVector::Dense(vec![0.1, 0.2, 0.3]),
    key: Key::Embedding,
    limit: 100,
    default: None,
    return_rank: false,
};

let knn2 = RankExpr::Knn {
    query: QueryVector::Dense(vec![0.2, 0.3, 0.4]),
    key: Key::field("other_embedding"),
    limit: 100,
    default: None,
    return_rank: false,
};

let search = SearchPayload::default()
    .rank(knn1 * 0.8 + knn2 * 0.2);

pub fn select<I, T>(self, keys: I) -> Self

where I: IntoIterator<Item = T>, T: Into<Key>,

Selects which fields to include in the results.

Arguments

• keys - Fields to include (e.g., Document, Score, Metadata, or custom fields)

Examples

use chroma_types::plan::SearchPayload;
use chroma_types::operator::Key;

// Select predefined fields
let search = SearchPayload::default()
    .select([Key::Document, Key::Score]);

// Select metadata fields
let search = SearchPayload::default()
    .select([Key::field("title"), Key::field("author")]);

// Mix predefined and custom fields
let search = SearchPayload::default()
    .select([Key::Document, Key::Score, Key::field("title")]);

pub fn where(self, where: Where) -> Self

Sets the filter expression for narrowing results.

Arguments

• where - A Where expression for filtering

Examples

Simple equality filter

use chroma_types::plan::SearchPayload;
use chroma_types::operator::Key;

let search = SearchPayload::default()
    .r#where(Key::field("status").eq("published"));

Numeric comparisons

use chroma_types::plan::SearchPayload;
use chroma_types::operator::Key;

let search = SearchPayload::default()
    .r#where(Key::field("year").gte(2020));

Combining filters

use chroma_types::plan::SearchPayload;
use chroma_types::operator::Key;

let search = SearchPayload::default()
    .r#where(
        Key::field("status").eq("published")
            & Key::field("year").gte(2020)
            & Key::field("category").is_in(vec!["tech", "science"])
    );

Document content filtering

use chroma_types::plan::SearchPayload;
use chroma_types::operator::Key;

let search = SearchPayload::default()
    .r#where(Key::Document.contains("machine learning"));

Trait Implementations

impl Clone for SearchPayload

fn clone(&self) -> SearchPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchPayload

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

Formats the value using the given formatter.

impl Default for SearchPayload

fn default() -> SearchPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchPayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SearchPayload> for SearchPayload

type Error = QueryConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SearchPayload> for SearchPayload

type Error = QueryConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Validate for SearchPayload

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for SearchPayload

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>