Struct RouteLayerBuilder

pub struct RouteLayerBuilder { /* private fields */ }

A builder for creating a RouteLayer.

 let captial_route = Router::new(
     "captial",
     &[
         "Capital of France is Paris.",
         "What is the captial of France?",
     ],
 );
 let weather_route = Router::new(
     "temperature",
     &[
         "What is the temperature?",
         "Is it raining?",
         "Is it cloudy?",
     ],
 );
 let router_layer = RouteLayerBuilder::default()
     .embedder(OpenAiEmbedder::default())
     .add_route(captial_route)
     .add_route(weather_route)
     .aggregation_method(AggregationMethod::Sum)
     .threshold(0.82)
     .build()
     .await
     .unwrap();

Implementations

impl RouteLayerBuilder

pub fn new() -> Self

pub fn top_k(self, top_k: usize) -> Self

pub fn llm<L: LLM + 'static>(self, llm: L) -> Self

pub fn index<I: Index + 'static>(self, index: I) -> Self

pub fn embedder<E: Embedder + 'static>(self, embedder: E) -> Self

pub fn threshold(self, threshold: f64) -> Self

The threshold is the minimum similarity score that a route must have to be considered. This depends on the similarity metric used by the embedder. For open ai text-embedding-ada-002, the best threshold is 0.82

pub fn add_route(self, route: Router) -> Self

pub fn aggregation_method(self, aggregation_method: AggregationMethod) -> Self

pub async fn build(self) -> Result<RouteLayer, RouteLayerBuilderError>

Trait Implementations

impl Default for RouteLayerBuilder

fn default() -> Self

Returns the “default value” for a type.