Struct EmbeddingsArguments

pub struct EmbeddingsArguments {
    pub model: String,
    pub input: String,
    pub user: Option<String>,
}

Request arguments for embeddings.

See https://platform.openai.com/docs/api-reference/embeddings/create.

openai_rust::embeddings::EmbeddingsArguments::new(
    "text-embedding-ada-002",
    "The food was delicious and the waiter...".to_owned(),
);

Fields

model: String

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.

input: String

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. Each input must not exceed the max input tokens for the model (8191 tokens for text-embedding-ada-002). Example Python code for counting tokens.

user: Option<String>

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

Implementations

impl EmbeddingsArguments

pub fn new(model: impl AsRef<str>, input: String) -> EmbeddingsArguments

Trait Implementations

impl Clone for EmbeddingsArguments

fn clone(&self) -> EmbeddingsArguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingsArguments

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

Formats the value using the given formatter.

impl Serialize for EmbeddingsArguments

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.