Struct ChatGPT

pub struct ChatGPT {
    pub config: ModelConfiguration,
    /* private fields */
}

The client that operates the ChatGPT API

Fields

config: ModelConfiguration

The configuration for this ChatGPT client

Implementations

impl ChatGPT

pub fn new<S: Into<String>>(api_key: S) -> Result<Self>

Constructs a new ChatGPT API client with provided API key and default configuration

pub fn new_with_proxy<S: Into<String>>(api_key: S, proxy: Proxy) -> Result<Self>

Constructs a new ChatGPT API client with provided API key, default configuration and a reqwest proxy

pub fn new_with_config<S: Into<String>>( api_key: S, config: ModelConfiguration, ) -> Result<Self>

Constructs a new ChatGPT API client with provided API Key and Configuration

pub fn new_with_config_proxy<S: Into<String>>( api_key: S, config: ModelConfiguration, proxy: Proxy, ) -> Result<Self>

Constructs a new ChatGPT API client with provided API Key, Configuration and Reqwest proxy

pub async fn restore_conversation_json<P: AsRef<Path>>( &self, file: P, ) -> Result<Conversation>

Restores a conversation from local conversation JSON file. The conversation file can originally be saved using the Conversation::save_history_json().

pub async fn restore_conversation_postcard<P: AsRef<Path>>( &self, file: P, ) -> Result<Conversation>

Restores a conversation from local conversation postcard file. The conversation file can originally be saved using the Conversation::save_history_postcard().

pub fn new_conversation(&self) -> Conversation

Starts a new conversation with a default starting message.

Conversations record message history.

pub fn new_conversation_directed<S: Into<String>>( &self, direction_message: S, ) -> Conversation

Starts a new conversation with a specified starting message.

Conversations record message history.

pub async fn send_history( &self, history: &Vec<ChatMessage>, ) -> Result<CompletionResponse>

Explicitly sends whole message history to the API.

In most cases, if you would like to store message history, you should be looking at the Conversation struct, and Self::new_conversation() and Self::new_conversation_directed()

pub async fn send_history_streaming( &self, history: &Vec<ChatMessage>, ) -> Result<impl Stream<Item = ResponseChunk>>

Explicitly sends whole message history to the API and returns the response as stream. Stream will be empty if any errors are returned from the server.

In most cases, if you would like to store message history, you should be looking at the Conversation struct, and Self::new_conversation() and Self::new_conversation_directed()

Requires the streams crate feature

pub async fn send_message<S: Into<String>>( &self, message: S, ) -> Result<CompletionResponse>

Sends a single message to the API without preserving message history.

pub async fn send_message_streaming<S: Into<String>>( &self, message: S, ) -> Result<impl Stream<Item = ResponseChunk>>

Sends a single message to the API, and returns the response as stream, without preserving message history. Stream will be empty if any errors are returned from the server.

Requires the streams crate feature

pub async fn send_message_functions<S: Into<String>, A: FunctionArgument>( &self, message: S, functions: Vec<FunctionDescriptor<A>>, ) -> Result<CompletionResponse>

Sends a message with specified function descriptors. ChatGPT is then able to call these functions.

NOTE: Functions are processed as tokens on the backend, so you might want to limit the amount of functions or their description.

pub async fn send_message_functions_baked<S: Into<String>>( &self, message: S, baked_functions: Vec<Value>, ) -> Result<CompletionResponse>

Sends a message with specified pre-baked function descriptors. ChatGPT is then able to call these functions.

NOTE: Functions are processed as tokens on the backend, so you might want to limit the amount of functions or their description.

pub async fn send_history_functions( &self, history: &Vec<ChatMessage>, functions: &Vec<Value>, ) -> Result<CompletionResponse>

Sends whole message history alongside with defined baked functions.

Trait Implementations

impl Clone for ChatGPT

fn clone(&self) -> ChatGPT

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatGPT

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

Formats the value using the given formatter.