Struct ChatRequest

pub struct ChatRequest { /* private fields */ }

https://platform.openai.com/docs/api-reference/chat/create

Implementations

impl ChatRequest

pub fn new(model: impl Into<String>, messages: Vec<ChatMessage>) -> Self

pub fn from_system(message: impl Into<Content>) -> Self

pub fn from_model(model: impl Into<String>) -> Self

pub fn iter_messages(&self) -> impl Iterator<Item = &ChatMessage>

pub async fn send(self) -> Result<ChatResponse, Error>

pub async fn send_stream( self, ) -> Result<Pin<Box<dyn Stream<Item = Result<ChatResponseStream, Error>> + Send>>, Error>

impl ChatRequest

Chainable setters

pub fn system(self, message: impl Into<Content>) -> Self

pub fn user(self, message: impl Into<String>) -> Self

pub fn developer(self, message: impl Into<Content>) -> Self

pub fn assistant(self, message: impl Into<AssistantContent>) -> Self

pub fn tool( self, message: impl Into<Content>, tool_call_id: impl Into<String>, ) -> Self

pub fn tool_choice(self, tool_choice: ChatToolChoice) -> Self

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

pub fn stream(self) -> Self

pub fn tools(self, tools: Vec<impl Into<ChatTool>>) -> Self

pub fn response_format( self, response_format: impl Into<ChatResponseFormat>, ) -> Self

impl ChatRequest

pub fn to_string_pretty(&self) -> Result<String, Error>

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 Default for ChatRequest

fn default() -> ChatRequest

Returns the “default value” for a type.

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 PartialEq for ChatRequest

fn eq(&self, other: &ChatRequest) -> 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 Printable for ChatRequest

fn to_string_pretty(&self) -> Result<String, Error>

impl Requestable for ChatRequest

fn stream(&self) -> bool

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.

impl StructuralPartialEq for ChatRequest