Struct AnthropicCompletionRequest

pub struct AnthropicCompletionRequest {
    pub model: String,
    pub messages: Vec<CompletionRequestMessage>,
    pub max_tokens: u64,
    pub stop_sequences: Option<Vec<String>>,
    pub system: Option<String>,
    pub temperature: f32,
    pub top_p: Option<f32>,
}

Fields

model: String

ID of the model to use.

See models for additional details and options.

messages: Vec<CompletionRequestMessage>

Input messages.

Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation.

See examples for more input examples.

Note that if you want to include a system prompt, you can use the top-level system parameter — there is no “system” role for input messages in the Messages API.

max_tokens: u64

The maximum number of tokens to generate before stopping.

Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.

Different models have different maximum values for this parameter. See models for details.

stop_sequences: Option<Vec<String>>

Custom text sequences that will cause the model to stop generating.

Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of “end_turn”.

If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be “stop_sequence” and the response stop_sequence value will contain the matched stop sequence.

system: Option<String>

System prompt.

A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.

temperature: f32

Amount of randomness injected into the response.

Defaults to 0.5. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.

Note that even with temperature of 0.0, the results will not be fully deterministic.

top_p: Option<f32>

min: 0.0, max: 1.0, default: None

Implementations

impl AnthropicCompletionRequest

pub fn new(req: &CompletionRequest) -> Result<Self, CompletionError>

Trait Implementations

impl Clone for AnthropicCompletionRequest

fn clone(&self) -> AnthropicCompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnthropicCompletionRequest

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

Formats the value using the given formatter.

impl Default for AnthropicCompletionRequest

fn default() -> AnthropicCompletionRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnthropicCompletionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AnthropicCompletionRequest

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

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

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 Serialize for AnthropicCompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AnthropicCompletionRequest