PromptCompletionRequest

Struct PromptCompletionRequest 

Source
pub struct PromptCompletionRequest {
Show 14 fields pub variables: HashMap<String, Value>, pub stream: Option<bool>, pub max_tokens: Option<i32>, pub temperature: Option<f32>, pub presence_penalty: Option<f32>, pub frequency_penalty: Option<f32>, pub top_p: Option<f32>, pub stop: Option<Vec<String>>, pub n: Option<i32>, pub logprobs: Option<bool>, pub echo: Option<bool>, pub best_of: Option<i32>, pub logit_bias: Option<HashMap<String, i32>>, pub user: Option<String>,
}
Expand description

Request to execute a prompt template with completions.

This allows you to execute saved prompt templates on Portkey, substituting variables and optionally overriding hyperparameters.

§Example

use portkey_sdk::model::PromptCompletionRequest;
use std::collections::HashMap;

let mut variables = HashMap::new();
variables.insert("user_input".to_string(), serde_json::json!("Hello world"));

let request = PromptCompletionRequest {
    variables,
    stream: Some(false),
    max_tokens: Some(250),
    temperature: Some(0.7),
    presence_penalty: Some(0.2),
    frequency_penalty: None,
    top_p: None,
    stop: None,
    n: None,
    logprobs: None,
    echo: None,
    best_of: None,
    logit_bias: None,
    user: None,
};

Fields§

§variables: HashMap<String, Value>

Variables to substitute in the prompt template

§stream: Option<bool>

Whether to stream the response (default: false)

§max_tokens: Option<i32>

Maximum number of tokens to generate

§temperature: Option<f32>

Sampling temperature (0-2)

§presence_penalty: Option<f32>

Presence penalty (-2 to 2)

§frequency_penalty: Option<f32>

Frequency penalty (-2 to 2)

§top_p: Option<f32>

Nucleus sampling parameter (0-1)

§stop: Option<Vec<String>>

Stop sequences

§n: Option<i32>

Number of completions to generate

§logprobs: Option<bool>

Include log probabilities

§echo: Option<bool>

Echo back the prompt

§best_of: Option<i32>

Generate best_of completions server-side

§logit_bias: Option<HashMap<String, i32>>

Logit bias map

§user: Option<String>

User identifier

Trait Implementations§

Source§

impl Clone for PromptCompletionRequest

Source§

fn clone(&self) -> PromptCompletionRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptCompletionRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PromptCompletionRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PromptCompletionRequest

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,