Skip to main content

EmbeddingInput

Struct EmbeddingInput 

Source
pub struct EmbeddingInput {
    pub contents: Vec<Content>,
}
Expand description

One value to embed.

Upstream is generic over the input type (EmbeddingInputT): text-only clients take str, while Foundry takes Content | str and Gemini takes str or a multimodal Content. This port uses one input type for every client so the trait stays object-safe. An input is a list of Content items embedded together as one vector: usually a single text, or a single image as Content::Data or Content::Uri, and several items where a provider can combine them (Gemini embeds text and media parts together; Foundry pairs an image with a caption).

Strings convert directly, so text callers write vec!["hello".into()]:

let text: EmbeddingInput = "a cat on a mat".into();
assert_eq!(text.as_text(), Some("a cat on a mat"));

let png = [0x89, 0x50, 0x4e, 0x47];
let image = EmbeddingInput::from(Content::Data(DataContent::from_bytes(&png, "image/png")));
assert_eq!(image.as_text(), None);

A client that cannot embed some input returns an error naming its index rather than skipping it, so results always line up with inputs.

Fields§

§contents: Vec<Content>

The items embedded together into one vector.

Implementations§

Source§

impl EmbeddingInput

Source

pub fn new(contents: Vec<Content>) -> EmbeddingInput

An input from content items embedded together.

Source

pub fn text(text: impl Into<String>) -> EmbeddingInput

A text input.

Source

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

The text, when this input is exactly one text item.

Source

pub fn into_texts( values: Vec<EmbeddingInput>, provider: &str, ) -> Result<Vec<String>, Error>

Converts a batch to plain strings for a client that embeds text only.

Fails on the first input that is not exactly one text item, naming provider and the input’s index.

Trait Implementations§

Source§

impl Clone for EmbeddingInput

Source§

fn clone(&self) -> EmbeddingInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmbeddingInput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EmbeddingInput

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<EmbeddingInput, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&String> for EmbeddingInput

Source§

fn from(text: &String) -> EmbeddingInput

Converts to this type from the input type.
Source§

impl From<&str> for EmbeddingInput

Source§

fn from(text: &str) -> EmbeddingInput

Converts to this type from the input type.
Source§

impl From<Content> for EmbeddingInput

Source§

fn from(content: Content) -> EmbeddingInput

Converts to this type from the input type.
Source§

impl From<String> for EmbeddingInput

Source§

fn from(text: String) -> EmbeddingInput

Converts to this type from the input type.
Source§

impl From<Vec<Content>> for EmbeddingInput

Source§

fn from(contents: Vec<Content>) -> EmbeddingInput

Converts to this type from the input type.
Source§

impl PartialEq for EmbeddingInput

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EmbeddingInput

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EmbeddingInput

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more