Struct CreateEmbeddingRequest 

pub struct CreateEmbeddingRequest {
    pub model: String,
    pub input: EmbeddingInput,
    pub encoding_format: Option<EncodingFormat>,
    pub dimensions: Option<i32>,
    pub user: Option<String>,
}

Request to create embeddings.

Example

use portkey_sdk::model::{CreateEmbeddingRequest, EmbeddingInput, EncodingFormat};

let request = CreateEmbeddingRequest {
    model: "text-embedding-ada-002".to_string(),
    input: EmbeddingInput::String("The quick brown fox jumped over the lazy dog".to_string()),
    encoding_format: Some(EncodingFormat::Float),
    dimensions: None,
    user: None,
};

Fields

model: String

ID of the model to use.

Common models:

• text-embedding-ada-002
• text-embedding-3-small
• text-embedding-3-large

input: EmbeddingInput

Input text to embed.

Can be a string, array of strings, array of tokens, or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less.

encoding_format: Option<EncodingFormat>

The format to return the embeddings in.

Can be either float or base64. Defaults to float.

dimensions: Option<i32>

The number of dimensions the resulting output embeddings should have.

Only supported in text-embedding-3 and later models.

user: Option<String>

A unique identifier representing your end-user.

This can help providers monitor and detect abuse.

Implementations

impl CreateEmbeddingRequest

pub fn new(model: impl Into<String>, input: impl Into<EmbeddingInput>) -> Self

Creates a new embedding request with the minimum required fields.

Arguments

• model - The model ID to use (e.g., “text-embedding-ada-002”, “text-embedding-3-small”)
• input - The input text or texts to embed

Example

use portkey_sdk::model::{CreateEmbeddingRequest, EmbeddingInput};

let request = CreateEmbeddingRequest::new(
    "text-embedding-ada-002",
    "Hello, world!",
);

Trait Implementations

impl Clone for CreateEmbeddingRequest

fn clone(&self) -> CreateEmbeddingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEmbeddingRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateEmbeddingRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateEmbeddingRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.