Struct ModelHint

pub struct ModelHint {
    pub name: Option<String>,
}

Hints to use for model selection.

Keys not declared here are currently left unspecified by the spec and are up to the client to interpret.

JSON schema

{
 "description": "Hints to use for model selection.\n\nKeys not declared here are currently left unspecified by the spec and are up\nto the client to interpret.",
 "type": "object",
 "properties": {
   "name": {
     "description": "A hint for a model name.\n\nThe client SHOULD treat this as a substring of a model name; for example:\n - `claude-3-5-sonnet` should match `claude-3-5-sonnet-20241022`\n - `sonnet` should match `claude-3-5-sonnet-20241022`, `claude-3-sonnet-20240229`, etc.\n - `claude` should match any Claude model\n\nThe client MAY also map the string to a different provider's model name or a different model family, as long as it fills a similar niche; for example:\n - `gemini-1.5-flash` could match `claude-3-haiku-20240307`",
     "type": "string"
   }
 }
}

Fields

name: Option<String>

A hint for a model name.

The client SHOULD treat this as a substring of a model name; for example:

• claude-3-5-sonnet should match claude-3-5-sonnet-20241022
• sonnet should match claude-3-5-sonnet-20241022, claude-3-sonnet-20240229, etc.
• claude should match any Claude model

The client MAY also map the string to a different provider’s model name or a different model family, as long as it fills a similar niche; for example:

• gemini-1.5-flash could match claude-3-haiku-20240307

Trait Implementations

impl Clone for ModelHint

fn clone(&self) -> ModelHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModelHint

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

Formats the value using the given formatter.

impl Default for ModelHint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelHint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ModelHint> for ModelHint

fn from(value: &ModelHint) -> Self

Converts to this type from the input type.

impl PartialEq for ModelHint

fn eq(&self, other: &ModelHint) -> 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 ModelHint

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 ModelHint