Struct ChatRequest

pub struct ChatRequest { /* private fields */ }

request providing chat completion. Detailed parameter description can be found at https://platform.openai.com/docs/api-reference/chat

Usage example

use openai_req::chat::{ChatRequest, Message, Role};
use openai_req::JsonRequest;

let messages  = vec!(Message{
     role: Role::User,
     content: "hello!".to_string(),
   });
   let chat_request = ChatRequest::new(messages);
   let response = chat_request.run(&client).await?;

Implementations

impl ChatRequest

pub fn new(messages: Vec<Message>) -> Self

pub fn with_model_and_messages(model: &str, messages: Vec<Message>) -> Self

pub fn add_message(self, message: Message) -> Self

pub fn model(self, model: String) -> Self

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

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

pub fn n(self, n: u16) -> Self

pub fn stream(self, stream: bool) -> Self

pub fn stop(self, stop: StopSeq) -> Self

pub fn max_tokens(self, max_tokens: u64) -> Self

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

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

pub fn logit_bias(self, logit_bias: HashMap<String, f32>) -> Self

pub fn user(self, user: String) -> Self

Trait Implementations

impl Clone for ChatRequest

fn clone(&self) -> ChatRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonRequest<ChatSuccess> for ChatRequest

const ENDPOINT: &'static str = "/chat/completions"

fn run<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient, ) -> Pin<Box<dyn Future<Output = Result<TRes>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Serialize for ChatRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.