Struct Request 

pub struct Request<T> { /* private fields */ }

Used to send a request for chat.

Implementations

impl Request<MessageVision>

pub fn add_message( self, role: Roles, prompt: String, image_uri: String, ) -> Request<MessageVision>

Adds a message to the request when making a chat vision call.

Arguments

• role - The role of the user sending the message.
• prompt - The text prompt to be sent along with the image.
• image_uri - data URI for base64 encoded image e.g. data:image/jpeg;base64,data

impl Request<Message>

pub fn add_message(self, role: Roles, prompt: String) -> Request<Message>

Adds a message to the request when making a chat completion call or chat events call.

Arguments

• role - The role of the user sending the message.
• prompt - The text prompt to be added to the message.

impl<T> Request<T>

pub fn new(model: String) -> Self

Creates a new request for chat.

Arguments

• model - The model to be used for the request.

pub fn with_message(self, msg: T) -> Request<T>

Returns a request with the added message.

Arguments

• msg - The message to be added to the request.

pub fn with_messages(self, messages: Vec<T>) -> Request<T>

Returns a request with the list of messages.

Arguments

• messages - The messages to be added to the request.

pub fn max_tokens(self, max: i64) -> Request<T>

Sets the max tokens for the request.

Arguments

• max - The maximum number of tokens to be returned in the response.

pub fn temperature(self, temp: f64) -> Request<T>

Sets the temperature for the request.

Arguments

• temp - The temperature setting for the request. Used to control randomness.

pub fn top_p(self, top: f64) -> Request<T>

Sets the Top p for the request.

Arguments

• top - The Top p setting for the request. Used to control randomness.

pub fn top_k(self, top_k: i64) -> Request<T>

Sets the Top k for the request.

Arguments

• top_k - The Top k setting for the request. Used to control randomness.

pub fn input( self, block_prompt_injection: bool, pii: Option<(InputMethod, ReplaceMethod)>, ) -> Request<T>

Sets the input parameters for the request, to check for prompt injection and PII.

Arguments

• block_prompt_injection - Determines whether to check for prompt injection in the request.
• pii - Sets the pii::InputMethod and the pii::ReplacementMethod.

pub fn output(self, check_factuality: bool, check_toxicity: bool) -> Request<T>

Sets the output parameters for the request, to check for factuality and toxicity.

Arguments

• check_factuality - Determines whether to check for factuality in the response.
• check_toxicity - Determines whether to check for toxicity in the response.

Trait Implementations

impl<T: Debug> Debug for Request<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Request<T>

fn default() -> Request<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Request<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for Request<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.