Enum EmbeddingModel 

pub enum EmbeddingModel {
    TextEmbedding3Small,
    TextEmbedding3Large,
    TextEmbeddingAda002,
}

Models available for the Embeddings API.

This enum covers all models that can be used with the Embeddings API (/v1/embeddings) for converting text into vector representations.

Available Models

• [TextEmbedding3Small]: Improved, performant model (default)
• [TextEmbedding3Large]: Most capable model for English and non-English
• [TextEmbeddingAda002]: Legacy model (not recommended for new projects)

Example

use openai_tools::common::models::EmbeddingModel;

let model = EmbeddingModel::TextEmbedding3Small;
assert_eq!(model.as_str(), "text-embedding-3-small");
assert_eq!(model.dimensions(), 1536);

Reference

See OpenAI Embeddings Guide

Variants

TextEmbedding3Small

text-embedding-3-small - Improved, more performant embedding model

• Dimensions: 1536
• Max input: 8191 tokens
• Recommended for most use cases

TextEmbedding3Large

text-embedding-3-large - Most capable embedding model

• Dimensions: 3072
• Max input: 8191 tokens
• Best for high-accuracy tasks

TextEmbeddingAda002

text-embedding-ada-002 - Legacy embedding model

• Dimensions: 1536
• Max input: 8191 tokens
• Not recommended for new projects

Implementations

impl EmbeddingModel

pub fn as_str(&self) -> &str

Returns the model identifier string for API requests.

pub fn dimensions(&self) -> usize

Returns the default output dimensions for this model.

Note: For text-embedding-3-* models, you can request fewer dimensions via the API’s dimensions parameter. This returns the default/maximum.

Trait Implementations

impl Clone for EmbeddingModel

fn clone(&self) -> EmbeddingModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingModel

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

Formats the value using the given formatter.

impl Default for EmbeddingModel

fn default() -> EmbeddingModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmbeddingModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EmbeddingModel

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

Formats the value using the given formatter.

impl From<&str> for EmbeddingModel

fn from(s: &str) -> Self

Converts to this type from the input type.

impl Hash for EmbeddingModel

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmbeddingModel

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for EmbeddingModel

impl Eq for EmbeddingModel

impl StructuralPartialEq for EmbeddingModel