Struct Request 

pub struct Request {

    pub messages: Vec<Message>,
    pub model: Model,
    pub temperature: Option<f64>,
    pub frequency_penalty: Option<f64>,
    pub max_tokens: Option<usize>,
    pub timeout: Option<u64>,
    pub max_retry: usize,
    pub sleep_between_retries: u64,
    pub dump_api_usage_at: Option<AuditRecordAt>,
    pub dump_pdl_at: Option<String>,
    pub dump_json_at: Option<String>,
    pub schema: Option<Schema>,
    pub schema_max_try: usize,
}

Fields

messages: Vec<Message>

model: Model

temperature: Option<f64>

frequency_penalty: Option<f64>

max_tokens: Option<usize>

timeout: Option<u64>

milliseconds

max_retry: usize

It tries 1 + max_retry times.

sleep_between_retries: u64

milliseconds

dump_api_usage_at: Option<AuditRecordAt>

dump_pdl_at: Option<String>

It dumps the AI conversation in pdl format. See https://crates.io/crates/ragit-pdl to read about pdl.

dump_json_at: Option<String>

It’s a directory, not a file. If given, it dumps dir/request-<timestamp>.json and dir/response-<timestamp>.json.

schema: Option<Schema>

It can force LLMs to create a json output with a given schema. You have to call send_and_validate instead of send if you want to force the schema.

schema_max_try: usize

If LLMs fail to generate a valid schema schema_max_try times, it returns a default value. If it’s 0, it wouldn’t call LLM at all!

Implementations

impl Request

pub fn is_valid(&self) -> bool

pub fn build_json_body(&self) -> Value

It panics if its fields are not complete. If you’re not sure, run self.is_valid() before sending a request.

pub async fn send_and_validate<T: DeserializeOwned>( &self, default: T, ) -> Result<T, Error>

It panics if schema field is missing. It doesn’t tell you whether the default value is used or not.

pub fn blocking_send(&self) -> Result<Response, Error>

NOTE: this function dies ocassionally, for no reason.

It panics if its fields are not complete. If you’re not sure, run self.is_valid() before sending a request.

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

It panics if its fields are not complete. If you’re not sure, run self.is_valid() before sending a request.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Self

Returns the “default value” for a type.