Struct InferenceConfiguration

#[non_exhaustive]
pub struct InferenceConfiguration {
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
    pub maximum_length: Option<i32>,
    pub stop_sequences: Option<Vec<String>>,
}

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

temperature: Option<f32>

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

top_p: Option<f32>

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.

top_k: Option<i32>

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

maximum_length: Option<i32>

The maximum number of tokens allowed in the generated response.

stop_sequences: Option<Vec<String>>

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

Implementations

impl InferenceConfiguration

pub fn temperature(&self) -> Option<f32>

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

pub fn top_p(&self) -> Option<f32>

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.

pub fn top_k(&self) -> Option<i32>

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

pub fn maximum_length(&self) -> Option<i32>

The maximum number of tokens allowed in the generated response.

pub fn stop_sequences(&self) -> &[String]

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .stop_sequences.is_none().

impl InferenceConfiguration

pub fn builder() -> InferenceConfigurationBuilder

Creates a new builder-style object to manufacture InferenceConfiguration.

Trait Implementations

impl Clone for InferenceConfiguration

fn clone(&self) -> InferenceConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InferenceConfiguration

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

Formats the value using the given formatter.

impl PartialEq for InferenceConfiguration

fn eq(&self, other: &InferenceConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InferenceConfiguration