Struct CreateEmbeddingRequest

pub struct CreateEmbeddingRequest {
    pub input: CreateEmbeddingRequestInput,
    pub model: String,
    pub encoding_format: Option<CreateEmbeddingRequestEncodingFormat>,
    pub dimensions: Option<u64>,
    pub user: Option<String>,
}

Fields

input: CreateEmbeddingRequestInput

Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings 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. Example Python code for counting tokens. Some models may also impose a limit on total number of tokens summed across inputs.

model: String

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

encoding_format: Option<CreateEmbeddingRequestEncodingFormat>

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

dimensions: Option<u64>

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, which can help OpenAI to monitor and detect abuse. Learn more.

Implementations

impl CreateEmbeddingRequest

pub fn builder() -> CreateEmbeddingRequestBuilder<((), (), (), (), ())>

Create a builder for building CreateEmbeddingRequest. On the builder, call .input(...), .model(...), .encoding_format(...)(optional), .dimensions(...)(optional), .user(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateEmbeddingRequest.

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 PartialEq for CreateEmbeddingRequest

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateEmbeddingRequest