Struct BasicStreamedRAGChain

pub struct BasicStreamedRAGChain<T, U>
where
    T: AsyncStreamedChatClient,
    U: AsyncRetriever,
{ /* private fields */ }

BasicStreamedRAGChain

This struct allows for easily executing RAG given a single user prompt. the current implementation relies on async streamed chat clients and async retrievers. we use generics in order to preserve error types via associated types.

• T - The type of the streamed chat client to be used
• U - The type of the retriever to be used

Examples

use rag_toolchain::clients::*;
use rag_toolchain::retrievers::*;
use rag_toolchain::chains::*;
use rag_toolchain::stores::*;
use rag_toolchain::common::*;
use std::num::NonZeroU32;

async fn run_chain() {

   const SYSTEM_MESSAGE: &'static str =
        "You are to give straight forward answers using the supporting information you are provided";

   let store: PostgresVectorStore =
   PostgresVectorStore::try_new("embeddings", OpenAIEmbeddingModel::TextEmbeddingAda002)
       .await
       .unwrap();

   let embedding_client: OpenAIEmbeddingClient =
       OpenAIEmbeddingClient::try_new(OpenAIEmbeddingModel::TextEmbeddingAda002).unwrap();

   let retriever: PostgresVectorRetriever<OpenAIEmbeddingClient> =
       store.as_retriever(embedding_client, DistanceFunction::Cosine);

   let chat_client: OpenAIChatCompletionClient =
       OpenAIChatCompletionClient::try_new(OpenAIModel::Gpt3Point5Turbo).unwrap();

   let system_prompt: PromptMessage = PromptMessage::SystemMessage(SYSTEM_MESSAGE.into());

   let chain: BasicStreamedRAGChain<OpenAIChatCompletionClient, PostgresVectorRetriever<_>> =
       BasicStreamedRAGChain::builder()
           .system_prompt(system_prompt)
           .chat_client(chat_client)
           .retriever(retriever)
           .build();
   let user_message: PromptMessage =
       PromptMessage::HumanMessage("what kind of alcohol does Morwenna drink".into());

   let stream = chain
       .invoke_chain(user_message, NonZeroU32::new(2).unwrap())
       .await
       .unwrap();
}

Implementations

impl<T, U> BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient, U: AsyncRetriever,

pub fn builder() -> BasicStreamedRAGChainBuilder<T, U, ((), (), ())>

Create a builder for building BasicStreamedRAGChain. On the builder, call .system_prompt(...)(optional), .chat_client(...), .retriever(...) to set the values of the fields. Finally, call .build() to create the instance of BasicStreamedRAGChain.

impl<T, U> BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient, U: AsyncRetriever,

pub async fn invoke_chain( &self, user_message: PromptMessage, top_k: NonZeroU32, ) -> Result<T::Item, RagChainError<T::ErrorType, U::ErrorType>>

Trait Implementations

impl<T, U> Clone for BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient + Clone, U: AsyncRetriever + Clone,

fn clone(&self) -> BasicStreamedRAGChain<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient + Debug, U: AsyncRetriever + Debug,

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

Formats the value using the given formatter.

impl<T, U> PartialEq for BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient + PartialEq, U: AsyncRetriever + PartialEq,

fn eq(&self, other: &BasicStreamedRAGChain<T, U>) -> 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<T, U> Eq for BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient + Eq, U: AsyncRetriever + Eq,

impl<T, U> StructuralPartialEq for BasicStreamedRAGChain<T, U>

where T: AsyncStreamedChatClient, U: AsyncRetriever,