Struct EmbeddingRequestBuilder

pub struct EmbeddingRequestBuilder { /* private fields */ }

Builder for EmbeddingRequest.

Implementations

impl EmbeddingRequestBuilder

pub fn input(&mut self, value: EmbeddingInput) -> &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.

pub fn model(&mut self, value: EmbeddingModel) -> &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 encoding_format(&mut self, value: EmbeddingEncodingFormat) -> &mut Self

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

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. Learn more.

pub fn build(&self) -> Result<EmbeddingRequest, EmbeddingRequestBuilderError>

Builds a new EmbeddingRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for EmbeddingRequestBuilder

fn clone(&self) -> EmbeddingRequestBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for EmbeddingRequestBuilder

fn default() -> Self

Returns the “default value” for a type.