Struct EmbeddingGenerationOptions 

pub struct EmbeddingGenerationOptions {
    pub model: Option<String>,
    pub dimensions: Option<u32>,
    pub additional_properties: HashMap<String, Value>,
}

Common request settings for embedding generation.

All fields are optional. Provider-specific settings (e.g. OpenAI’s encoding_format or user) ride in additional_properties, exactly like ChatOptions::additional_properties — upstream expresses the same extension point as per-provider TypedDict subclasses.

Fields

model: Option<String>

The embedding model to use; falls back to the client’s default.

dimensions: Option<u32>

Requested output dimensionality, for models that support shortening (e.g. text-embedding-3-*).

additional_properties: HashMap<String, Value>

Provider-specific extras, forwarded by the provider converters that understand them.

Implementations

impl EmbeddingGenerationOptions

pub fn new() -> EmbeddingGenerationOptions

pub fn with_model(self, model: impl Into<String>) -> EmbeddingGenerationOptions

Builder: set the model.

pub fn with_dimensions(self, dimensions: u32) -> EmbeddingGenerationOptions

Builder: set the requested output dimensionality.

Trait Implementations

impl Clone for EmbeddingGenerationOptions

fn clone(&self) -> EmbeddingGenerationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingGenerationOptions

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

Formats the value using the given formatter.

impl Default for EmbeddingGenerationOptions

fn default() -> EmbeddingGenerationOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmbeddingGenerationOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EmbeddingGenerationOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EmbeddingGenerationOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EmbeddingGenerationOptions