Struct CreateEmbeddingRequest 

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

Request for creating embeddings

Fields

input: EmbeddingInput

Input text to embed, encoded as a string or array of strings

model: String

ID of the model to use

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<String>

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

user: Option<String>

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

Implementations

impl CreateEmbeddingRequest

pub fn former() -> CreateEmbeddingRequestFormer<CreateEmbeddingRequestFormerDefinition<(), CreateEmbeddingRequest, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

impl CreateEmbeddingRequest

pub fn new_single(input: String, model: String) -> Self

Create a new embedding request with single text input

pub fn new_multiple(input: Vec<String>, model: String) -> Self

Create a new embedding request with multiple text inputs

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

fn default() -> Self

Returns the “default value” for a type.

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<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for CreateEmbeddingRequest

where __End: FormingEnd<CreateEmbeddingRequestFormerDefinitionTypes<__Context, __Formed>>,

type Definition = CreateEmbeddingRequestFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = CreateEmbeddingRequestFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for CreateEmbeddingRequest

type Types = CreateEmbeddingRequestFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for CreateEmbeddingRequest

where Definition: FormerDefinition<Storage = CreateEmbeddingRequestFormerStorage>,

type Former = CreateEmbeddingRequestFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for CreateEmbeddingRequest

type Storage = CreateEmbeddingRequestFormerStorage

The storage type used for forming the entity.

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

Implement Validate for CreateEmbeddingRequest

fn validate(&self) -> Result<(), Vec<ValidationError>>

Validate the request parameters

impl StructuralPartialEq for CreateEmbeddingRequest