Struct OpenAICompatibleChatModel

pub struct OpenAICompatibleChatModel { /* private fields */ }

An chat model that uses OpenAI’s API for the a remote chat model.

Implementations

impl OpenAICompatibleChatModel

pub fn builder() -> OpenAICompatibleChatModelBuilder<false>

Create a new builder for the OpenAI compatible chat model.

Trait Implementations

impl ChatModel for OpenAICompatibleChatModel

fn add_messages_with_callback<'a>( &'a self, session: &'a mut Self::ChatSession, messages: &[ChatMessage], sampler: GenerationParameters, on_token: impl FnMut(String) -> Result<(), Self::Error> + Send + Sync + 'static, ) -> impl Future<Output = Result<(), Self::Error>> + Send + 'a

Add messages to the chat session with a callback that is called for each token.

impl Clone for OpenAICompatibleChatModel

fn clone(&self) -> OpenAICompatibleChatModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CreateChatSession for OpenAICompatibleChatModel

type ChatSession = OpenAICompatibleChatSession

The type of chat session.

type Error = OpenAICompatibleChatModelError

The type of error the chat session may return during operations.

fn new_chat_session(&self) -> Result<Self::ChatSession, Self::Error>

Create a new chat session for this model.

impl<T: Schema + DeserializeOwned> CreateDefaultChatConstraintsForType<T> for OpenAICompatibleChatModel

type DefaultConstraints = SchemaParser<T>

The default constraints for this type that work with this chat model.

fn create_default_constraints() -> Self::DefaultConstraints

Create Self::DefaultConstraints which parse the type T for this chat model.

impl Debug for OpenAICompatibleChatModel

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

Formats the value using the given formatter.

impl<P> StructuredChatModel<SchemaParser<P>> for OpenAICompatibleChatModel

where P: Schema + DeserializeOwned,

fn add_message_with_callback_and_constraints<'a>( &'a self, session: &'a mut Self::ChatSession, messages: &[ChatMessage], sampler: GenerationParameters, _: SchemaParser<P>, on_token: impl FnMut(String) -> Result<(), Self::Error> + Send + Sync + 'static, ) -> impl Future<Output = Result<P, Self::Error>> + Send + 'a

Add messages to the chat session with a callback that is called for each token and a constraints the response must follow.