Struct EmbeddingParametersBuilder 

pub struct EmbeddingParametersBuilder { /* private fields */ }

Builder for EmbeddingParameters.

Implementations

impl EmbeddingParametersBuilder

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.

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

ID of the model to use.

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

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

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 user<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn build( &self, ) -> Result<EmbeddingParameters, EmbeddingParametersBuilderError>

Builds a new EmbeddingParameters.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for EmbeddingParametersBuilder

fn clone(&self) -> EmbeddingParametersBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for EmbeddingParametersBuilder

fn default() -> Self

Returns the “default value” for a type.