Struct Query

pub struct Query<STATE: QueryState> {
    pub embedding: Option<Embedding>,
    pub sparse_embedding: Option<SparseEmbedding>,
    pub documents: Vec<Document>,
    /* private fields */
}

A query is the main object going through a query pipeline

It acts as a statemachine, with the following transitions:

states::Pending: No documents have been retrieved states::Retrieved: Documents have been retrieved states::Answered: The query has been answered

Fields

embedding: Option<Embedding>

sparse_embedding: Option<SparseEmbedding>

documents: Vec<Document>

Documents the query will operate on

A query can retrieve multiple times, accumulating documents

Implementations

impl<STATE: Clone + QueryState> Query<STATE>

pub fn builder() -> QueryBuilder<STATE>

pub fn original(&self) -> &str

Return the query it started with

pub fn current(&self) -> &str

Return the current query (or after retrieval!)

pub fn history(&self) -> &Vec<TransformationEvent>

pub fn documents(&self) -> &[Document]

Returns the current documents that will be used as context for answer generation

pub fn documents_mut(&mut self) -> &mut Vec<Document>

Returns the current documents as mutable

impl<STATE: Clone + CanRetrieve> Query<STATE>

pub fn retrieved_documents(self, documents: Vec<Document>) -> Query<Retrieved>

Add retrieved documents and transition to states::Retrieved

impl Query<Pending>

pub fn new(query: impl Into<String>) -> Self

pub fn transformed_query(&mut self, new_query: impl Into<String>)

Transforms the current query

impl Query<Retrieved>

pub fn new() -> Self

pub fn transformed_response(&mut self, new_response: impl Into<String>)

Transforms the current response

pub fn answered(self, answer: impl Into<String>) -> Query<Answered>

Transition the query to states::Answered

impl Query<Answered>

pub fn new() -> Self

pub fn answer(&self) -> &str

Returns the answer of the query

Trait Implementations

impl<STATE: Clone + QueryState> Clone for Query<STATE>

fn clone(&self) -> Query<STATE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<STATE: Debug + QueryState> Debug for Query<STATE>

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

Formats the value using the given formatter.

impl<STATE: Default + QueryState> Default for Query<STATE>

fn default() -> Query<STATE>

Returns the “default value” for a type.

impl From<Query<Answered>> for QueryEvaluation

fn from(val: Query<Answered>) -> Self

Converts to this type from the input type.

impl From<Query<Retrieved>> for QueryEvaluation

fn from(val: Query<Retrieved>) -> Self

Converts to this type from the input type.

impl<T: AsRef<str>> From<T> for Query<Pending>

fn from(original: T) -> Self

Converts to this type from the input type.

impl<STATE: PartialEq + QueryState> PartialEq for Query<STATE>

fn eq(&self, other: &Query<STATE>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<STATE: QueryState> StructuralPartialEq for Query<STATE>