Struct EvaluationRequest

pub struct EvaluationRequest {
    pub model: String,
    pub prompt: Prompt,
    pub hosting: Option<Hosting>,
    pub completion_expected: String,
    pub contextual_control_threshold: Option<f64>,
    pub control_log_additive: Option<bool>,
}

Fields

model: String

prompt: Prompt

Base prompt to for the evaluation.

hosting: Option<Hosting>

Possible values: [aleph-alpha, None] Optional parameter that specifies which datacenters may process the request. You can either set the parameter to “aleph-alpha” or omit it (defaulting to null). Not setting this value, or setting it to None, gives us maximal flexibility in processing your request in our own datacenters and on servers hosted with other providers. Choose this option for maximum availability. Setting it to “aleph-alpha” allows us to only process the request in our own datacenters. Choose this option for maximal data privacy.

completion_expected: String

The completion that you would expect to be completed. Unconditional completion can be used with an empty string (default). The prompt may contain a zero shot or few shot task.

contextual_control_threshold: Option<f64>

If set to None, attention control parameters only apply to those tokens that have explicitly been set in the request. If set to a non-null value, we apply the control parameters to similar tokens as well. Controls that have been applied to one token will then be applied to all other tokens that have at least the similarity score defined by this parameter. The similarity score is the cosine similarity of token embeddings.

control_log_additive: Option<bool>

Default value: true true: apply controls on prompt items by adding the log(control_factor)`` to attention scores. false: apply controls on prompt items by (attention_scores - -attention_scores.min(-1)) * control_factor`

Implementations

impl EvaluationRequest

pub fn from_text( model: impl Into<String>, prompt: impl Into<String>, completion_expected: impl Into<String>, ) -> Self

impl EvaluationRequest

pub fn hosting(self, hosting: Hosting) -> Self

pub fn contextual_control_threshold( self, contextual_control_threshold: f64, ) -> Self

pub fn control_log_additive(self, control_log_additive: bool) -> Self

Trait Implementations

impl Debug for EvaluationRequest

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

Formats the value using the given formatter.

impl Default for EvaluationRequest

fn default() -> EvaluationRequest

Returns the “default value” for a type.

impl Serialize for EvaluationRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.