Struct Embedding

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

Given a prompt and an instruction, the model will return an edited version of the prompt.

Fields

model: Model

input: String

user: Option<String>

Implementations

impl Embedding

pub fn model(self, model: Model) -> 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(self, content: &str) -> Self

Input text to get embeddings for, encoded as a string or array of tokens. To get embeddings for multiple inputs in a single request, pass an array of strings or array of token arrays. Each input must not exceed 8192 tokens in length.

pub fn user(self, user: &str) -> Self

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

pub async fn embedding(self) -> Result<EmbeddingResponse, Box<dyn Error>>

Send embedding request to OpenAI.

Trait Implementations

impl Debug for Embedding

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

Formats the value using the given formatter.

impl Default for Embedding

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Embedding

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Embedding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.