Struct Pipeline

pub struct Pipeline<'stream, STRATEGY: SearchStrategy = SimilaritySingleEmbedding, STATE: QueryState = Pending> { /* private fields */ }

The starting point of a query pipeline

Implementations

impl<'a, STRATEGY: SearchStrategy> Pipeline<'a, STRATEGY>

pub fn from_search_strategy(strategy: STRATEGY) -> Pipeline<'a, STRATEGY>

Create a query pipeline from a SearchStrategy

Panics

Panics if the inner stream fails to build

impl<'stream: 'static, STRATEGY> Pipeline<'stream, STRATEGY, Pending>

where STRATEGY: SearchStrategy,

pub fn evaluate_with<T: EvaluateQuery + 'stream>(self, evaluator: T) -> Self

Evaluate queries with an evaluator

pub fn then_transform_query<T: TransformQuery + 'stream>( self, transformer: T, ) -> Pipeline<'stream, STRATEGY, Pending>

Transform a query into something else, see crate::query_transformers

impl<'stream: 'static, STRATEGY: SearchStrategy + 'stream> Pipeline<'stream, STRATEGY, Pending>

pub fn then_retrieve<T: ToOwned<Owned = impl Retrieve<STRATEGY> + 'stream>>( self, retriever: T, ) -> Pipeline<'stream, STRATEGY, Retrieved>

Executes the query based on a search query with a retriever

impl<'stream: 'static, STRATEGY: SearchStrategy> Pipeline<'stream, STRATEGY, Retrieved>

pub fn then_transform_response<T: TransformResponse + 'stream>( self, transformer: T, ) -> Pipeline<'stream, STRATEGY, Retrieved>

Transforms a retrieved query into something else

impl<'stream: 'static, STRATEGY: SearchStrategy> Pipeline<'stream, STRATEGY, Retrieved>

pub fn then_answer<T: Answer + 'stream>( self, answerer: T, ) -> Pipeline<'stream, STRATEGY, Answered>

Generates an answer based on previous transformations

impl<STRATEGY: SearchStrategy> Pipeline<'_, STRATEGY, Answered>

pub async fn query( self, query: impl Into<Query<Pending>>, ) -> Result<Query<Answered>>

Runs the pipeline with a user query, accepts &str as well.

Errors

Errors if any of the transformations failed or no response was found

pub async fn query_mut( &mut self, query: impl Into<Query<Pending>>, ) -> Result<Query<Answered>>

Runs the pipeline with a user query, accepts &str as well.

Does not consume the pipeline and requires a mutable reference. This allows the pipeline to be reused.

Errors

Errors if any of the transformations failed or no response was found

pub async fn query_all( self, queries: Vec<impl Into<Query<Pending>> + Clone>, ) -> Result<Vec<Query<Answered>>>

Runs the pipeline with multiple queries

Errors

Errors if any of the transformations failed, no response was found, or the stream was closed.

Trait Implementations

impl Default for Pipeline<'_, SimilaritySingleEmbedding>

By default the SearchStrategy is SimilaritySingleEmbedding, which embed the current query and returns a collection of documents.

fn default() -> Self

Returns the “default value” for a type.