Struct EmbeddingsBuilder 

pub struct EmbeddingsBuilder { /* private fields */ }

Builder for creating embedding requests.

Examples

use openai_ergonomic::{Builder, EmbeddingsBuilder};

let request = EmbeddingsBuilder::new("text-embedding-3-small")
    .input_text("hello world")
    .dimensions(256)
    .build()
    .unwrap();

assert_eq!(request.model, "text-embedding-3-small");
assert_eq!(request.dimensions, Some(256));

Implementations

impl EmbeddingsBuilder

pub fn new(model: impl Into<String>) -> Self

Create a new embeddings builder for the specified model.

pub fn input(self, input: EmbeddingInput) -> Self

Provide the request input explicitly.

pub fn input_text(self, text: impl Into<String>) -> Self

Embed a single string input.

pub fn input_texts<I, S>(self, texts: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Embed multiple string inputs in one request.

pub fn input_tokens<I>(self, tokens: I) -> Self

where I: IntoIterator<Item = i32>,

Embed a single tokenized input.

pub fn input_token_batches<I, J>(self, batches: I) -> Self

where I: IntoIterator<Item = J>, J: IntoIterator<Item = i32>,

Embed multiple tokenized inputs.

pub fn encoding_format(self, format: EncodingFormat) -> Self

Set the encoding format for the embeddings response.

pub fn dimensions(self, dimensions: i32) -> Self

Set the output dimensions for supported models.

pub fn user(self, user: impl Into<String>) -> Self

Associate a user identifier with the request.

pub fn model(&self) -> &str

Access the configured model name.

pub fn input_ref(&self) -> Option<&EmbeddingInput>

Access the configured input, if set.

pub fn encoding_format_ref(&self) -> Option<EncodingFormat>

Access the configured encoding format, if set.

pub fn dimensions_ref(&self) -> Option<i32>

Access the configured dimensions, if set.

pub fn user_ref(&self) -> Option<&str>

Access the configured user identifier, if set.

Trait Implementations

impl Builder<CreateEmbeddingRequest> for EmbeddingsBuilder

fn build(self) -> Result<CreateEmbeddingRequest>

Build the final request type.

impl Clone for EmbeddingsBuilder

fn clone(&self) -> EmbeddingsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingsBuilder

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

Formats the value using the given formatter.