Enum EmbeddingPart 

#[non_exhaustive]
pub enum EmbeddingPart {
    Text(Text),
    Image(Image),
}

A part of an EmbeddingInput.

Unlike ContentPart, which keeps content it does not recognize as Other, an embedding part is strict: an unknown type fails to deserialize, because dropping a part would silently change the vector.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text(Text)

Text.

Text::citations describe model output (ADR 0007) and are ignored on embedding input. EmbeddingPart::text, EmbeddingInput::text, and the From conversions clear them; a part built directly with EmbeddingPart::Text(text) keeps them, and they then count for equality, hashing, and serialization. Build parts through the constructors when inputs are used as cache keys.

Image(Image)

An image, for models that report EmbeddingCapability::ImageInput.

Image::detail is a hint no embedding API honors: adapters warn, or fail under UnsupportedPolicy::Error.

Implementations

impl EmbeddingPart

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

A text part.

pub fn image_url(url: impl Into<String>) -> Self

An image part from a URL.

pub fn image_base64( media_type: impl Into<String>, data: impl Into<Base64Data>, ) -> Self

An image part from inline base64 data.

pub fn image_bytes( media_type: impl Into<String>, data: impl AsRef<[u8]>, ) -> Self

An image part from raw bytes, sent inline (base64-encoded).

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

The text of a text part.

pub fn as_image(&self) -> Option<&Image>

The image of an image part.

pub fn kind(&self) -> &'static str

Stable snake_case name of the part kind, for messages.

pub fn provider_data(&self) -> &ProviderData

The part’s provider data.

Trait Implementations

impl Clone for EmbeddingPart

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 EmbeddingPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbeddingPart

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EmbeddingPart

impl From<EmbeddingPart> for EmbeddingInput

fn from(part: EmbeddingPart) -> Self

Converts to this type from the input type.

impl From<Image> for EmbeddingPart

fn from(image: Image) -> Self

Converts to this type from the input type.

impl From<Text> for EmbeddingPart

fn from(text: Text) -> Self

Clears citations, which describe model output.

impl Hash for EmbeddingPart

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmbeddingPart

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EmbeddingPart

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 EmbeddingPart