Struct CreateEmbeddingRequestArgs

pub struct CreateEmbeddingRequestArgs { /* private fields */ }

Builder for CreateEmbeddingRequest.

Implementations

impl CreateEmbeddingRequestArgs

pub fn model<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn input<VALUE: Into<EmbeddingInput>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn encoding_format<VALUE: Into<EncodingFormat>>( &mut self, value: VALUE, ) -> &mut Self

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

pub fn user<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn dimensions<VALUE: Into<u32>>(&mut self, value: VALUE) -> &mut Self

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

pub fn build(&self) -> Result<CreateEmbeddingRequest, OpenAIError>

Builds a new CreateEmbeddingRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateEmbeddingRequestArgs

fn clone(&self) -> CreateEmbeddingRequestArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEmbeddingRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateEmbeddingRequestArgs

fn default() -> Self

Returns the “default value” for a type.