Struct EmbedOptions 

pub struct EmbedOptions {
    pub headers: Option<Headers>,
    pub capture_raw_body: Option<bool>,
    pub capture_usage: Option<bool>,
    pub dimensions: Option<usize>,
    pub encoding_format: Option<String>,
    pub user: Option<String>,
    pub embedding_type: Option<String>,
    pub truncate: Option<String>,
}

Options for customizing embedding requests.

Fields

headers: Option<Headers>

Custom headers to include in the request.

capture_raw_body: Option<bool>

Whether to capture the raw response body for provider-specific features.

capture_usage: Option<bool>

Whether to capture usage information (token counts, etc.).

dimensions: Option<usize>

The desired dimensionality of the embedding vectors (if supported by the provider). Note: Not all providers support custom dimensions.

encoding_format: Option<String>

The encoding format for the embeddings (if supported by the provider). Common values: “float”, “base64”, “binary”, etc.

user: Option<String>

A unique identifier representing your end-user (for OpenAI and similar providers).

embedding_type: Option<String>

The type/purpose of the embedding request.

• Cohere: “search_document”, “search_query”, “classification”, “clustering”
• Gemini: “SEMANTIC_SIMILARITY”, “RETRIEVAL_QUERY”, “RETRIEVAL_DOCUMENT”, “CLASSIFICATION”

Default: “search_document” (Cohere), “SEMANTIC_SIMILARITY” (Gemini)

truncate: Option<String>

How to handle inputs longer than the maximum token length (supported by Cohere). Common values: “NONE”, “START”, “END” Default: “END”

Implementations

impl EmbedOptions

Constructors

pub fn new() -> Self

Create a new EmbedOptions with default values.

impl EmbedOptions

Chainable Setters

pub fn with_headers(self, headers: Headers) -> Self

Set custom headers for the request.

pub fn with_capture_raw_body(self, capture: bool) -> Self

Enable or disable capturing the raw response body.

pub fn with_capture_usage(self, capture: bool) -> Self

Enable or disable capturing usage information.

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

Set the desired dimensionality of the embedding vectors.

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

Set the encoding format for the embeddings.

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

Set the user identifier.

pub fn with_embedding_type(self, embedding_type: impl Into<String>) -> Self

Set the type/purpose of the embedding request.

pub fn with_truncate(self, truncate: impl Into<String>) -> Self

Set the truncation method for inputs longer than the maximum token length.

impl EmbedOptions

Getters

pub fn headers(&self) -> Option<&Headers>

Get the headers.

pub fn capture_raw_body(&self) -> bool

Get whether to capture raw body.

pub fn capture_usage(&self) -> bool

Get whether to capture usage.

pub fn dimensions(&self) -> Option<usize>

Get the desired dimensions.

pub fn encoding_format(&self) -> Option<&str>

Get the encoding format.

pub fn user(&self) -> Option<&str>

Get the user identifier.

pub fn embedding_type(&self) -> Option<&str>

Get the type/purpose of the embedding request.

pub fn truncate(&self) -> Option<&str>

Get the truncation method.

Trait Implementations

impl Clone for EmbedOptions

fn clone(&self) -> EmbedOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedOptions

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

Formats the value using the given formatter.

impl Default for EmbedOptions

fn default() -> EmbedOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmbedOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EmbedOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.