Struct Embeddings 

pub struct Embeddings {
    pub provider: OpenAIConfig,
    pub model: String,
    pub ndims: Option<usize>,
    pub encoding_format: Option<EncodingFormat>,
    pub user: Option<String>,
}

The embeddings wire.

Fields

provider: OpenAIConfig

Which provider, and how to reach it.

model: String

The embedding model.

ndims: Option<usize>

The width the caller asked for, when they named one rather than taking the model’s default.

encoding_format: Option<EncodingFormat>

The encoding the caller asked the provider to answer in.

user: Option<String>

The end-user identifier the provider attributes the call to.

Implementations

impl Embeddings

pub fn new( provider: OpenAIConfig, model: impl Into<String>, ndims: Option<usize>, ) -> Self

The embeddings wire for model.

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

Ask the provider to answer in encoding_format.

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

Attribute the call to an end user.

Trait Implementations

impl Clone for Embeddings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Embeddings

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Embeddings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Embeddings

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Embeddings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Embeddings

impl Wire for Embeddings

fn describe(&self) -> Descriptor<'_>

Only an explicit nonzero declaration permits reply-width mismatch checks.

type Op = Embedding

The operation this wire performs.

type Payload = Encoded

What Self::encode produces for the transport to send.

type Frame = WireFrame

One unit of a reply, as the transport delivers it.

type Event = CompatibleEmbeddingResponse

The decoder’s classified event, which the reassembler reads too.

type Decoder<'id> = EmbeddingsDecoder

The decoder for one of its replies, branded with that reply.

type Reassembler = Unreassembled

What rebuilds a reply’s provider document from its events when the transport reports no whole document, as for a stream. The driver hands it every known event before the decoder decodes it, and records what it finishes with as raw. A wire whose operation’s decoders record raw themselves names document::Unreassembled; a completion wire cannot, because it does not Serve completions.

fn encode( &self, request: Vec<String>, _mode: Mode, ) -> Result<Encoded, EncodeError>

The request to send. Pure: it may read self, request and mode, and nothing else. A request that cannot be built is an EncodeError, which always reports as a request failure.

fn decoder<'id>(&self) -> Self::Decoder<'id>

A fresh decoder for one reply.

fn reassembler(&self) -> Self::Reassembler

A fresh reassembler for one reply. A wire that picks its API per reply builds the matching one.