Struct EmbeddingRequest 

pub struct EmbeddingRequest {
    pub input: EmbeddingInput,
    pub model: String,
    pub dimensions: Option<u32>,
    pub encoding_format: Option<EncodingFormat>,
    pub user: Option<String>,
    pub extra_body: Option<Map<String, Value>>,
}

Creates an embedding vector representing the input text.

Fields

input: EmbeddingInput

Input text to embed, encoded as a string, an array of strings, an array of tokens, or an array of token arrays.

The input must not exceed the max input tokens for the model (8192 tokens for all embedding models) and cannot be an empty string.

model: String

ID of the model to use, e.g. text-embedding-v4.

dimensions: Option<u32>

The number of dimensions the resulting output embeddings should have.

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

encoding_format: Option<EncodingFormat>

The format to return the embeddings in. Can be either float or base64.

Note that some OpenAI-compatible providers (e.g. Qwen) only support float.

user: Option<String>

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

extra_body: Option<Map<String, Value>>

Add additional JSON properties to the request.

Implementations

impl EmbeddingRequest

pub fn is_streaming(&self) -> bool

Trait Implementations

impl Clone for EmbeddingRequest

fn clone(&self) -> EmbeddingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingRequest

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

Formats the value using the given formatter.

impl Default for EmbeddingRequest

fn default() -> EmbeddingRequest

Returns the “default value” for a type.

impl Post for EmbeddingRequest

fn build_url(&self, base_url: &str) -> Result<String, OapiError>

Builds the URL for the request.

base_url should be like https://api.openai.com/v1

fn is_streaming(&self) -> bool

impl PostNoStream for EmbeddingRequest

type Response = CreateEmbeddingResponse

fn get_response_string( &self, client: &Client, base_url: &str, key: &str, ) -> impl Future<Output = Result<String, OapiError>> + Send + Sync

Sends a POST request and returns the raw response body.

fn get_response( &self, client: &Client, url: &str, key: &str, ) -> impl Future<Output = Result<Self::Response, OapiError>> + Send + Sync

Sends a POST request and deserializes the response.

impl Serialize for EmbeddingRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.