Struct EmbeddingOptions 

pub struct EmbeddingOptions {
    pub user: Option<String>,
    pub encoding_format: Option<String>,
    pub dimensions: Option<u32>,
    pub api_key: Option<String>,
    pub api_base: Option<String>,
    pub timeout: Option<u64>,
    pub headers: Option<HashMap<String, String>>,
    pub task_type: Option<String>,
    pub extra_params: HashMap<String, Value>,
}

Embedding options - Python LiteLLM compatible

These options control how embeddings are generated and allow customization of API behavior, authentication, and encoding format.

Example

use litellm_rs::core::embedding::EmbeddingOptions;

let options = EmbeddingOptions::new()
    .with_api_key("sk-...")
    .with_dimensions(1536)
    .with_encoding_format("float");

Fields

user: Option<String>

User identifier for tracking

encoding_format: Option<String>

Encoding format for the embeddings (e.g., “float”, “base64”)

dimensions: Option<u32>

Number of dimensions for the embedding output Only supported by models that allow dimension reduction

api_key: Option<String>

API key to use for this request Overrides environment variable configuration

api_base: Option<String>

Custom API base URL Allows using custom endpoints or proxies

timeout: Option<u64>

Request timeout in seconds

headers: Option<HashMap<String, String>>

Custom headers to include in the request

task_type: Option<String>

Task type for specialized embeddings (e.g., for Vertex AI) Values: “RETRIEVAL_QUERY”, “RETRIEVAL_DOCUMENT”, “SEMANTIC_SIMILARITY”, etc.

extra_params: HashMap<String, Value>

Extra provider-specific parameters

Implementations

impl EmbeddingOptions

pub fn new() -> Self

Create new empty options

pub fn with_user(self, user: impl Into<String>) -> Self

Set user identifier

pub fn with_encoding_format(self, format: impl Into<String>) -> Self

Set encoding format

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

Set output dimensions

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Set API key

pub fn with_api_base(self, api_base: impl Into<String>) -> Self

Set API base URL

pub fn with_timeout(self, timeout: u64) -> Self

Set request timeout in seconds

pub fn with_headers(self, headers: HashMap<String, String>) -> Self

Set custom headers

pub fn with_header( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a single custom header

pub fn with_task_type(self, task_type: impl Into<String>) -> Self

Set task type for specialized embeddings

pub fn with_extra_param( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Add an extra parameter

pub fn with_extra_params(self, params: HashMap<String, Value>) -> Self

Set multiple extra parameters

Trait Implementations

impl Clone for EmbeddingOptions

fn clone(&self) -> EmbeddingOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingOptions

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

Formats the value using the given formatter.

impl Default for EmbeddingOptions

fn default() -> EmbeddingOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmbeddingOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EmbeddingOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.