Struct CompletionRequest

pub struct CompletionRequest { /* private fields */ }

text completion request detailed description of params at https://platform.openai.com/docs/api-reference/completions

Usage example

    use openai_req::completion::CompletionRequest;
    use openai_req::JsonRequest;

    let completion_request =
         CompletionRequest::new("long long time ago".into());
     let response = completion_request.run(&client).await?;

Implementations

impl CompletionRequest

pub fn new(prompt: Input) -> CompletionRequest

pub fn with_model(model: &str, prompt: Input) -> CompletionRequest

pub fn set_suffix(&mut self, suffix: &str) -> &mut Self

pub fn set_max_tokens(&mut self, max_tokens: u32) -> &mut Self

pub fn set_temperature(&mut self, temperature: f32) -> &mut Self

pub fn set_top_p(&mut self, top_p: f32) -> &mut Self

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

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

pub fn set_logprobs(&mut self, logprobs: u32) -> &mut Self

pub fn set_echo(&mut self, echo: bool) -> &mut Self

pub fn set_stop(self, stop: impl Into<Vec<String>>) -> Self

pub fn set_presence_penalty(self, presence_penalty: f32) -> Self

pub fn set_frequency_penalty(self, frequency_penalty: f32) -> Self

pub fn set_best_of(self, best_of: u16) -> Self

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

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

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonRequest<CompletionSuccess> for CompletionRequest

const ENDPOINT: &'static str = "/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 CompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.