Struct Item 

pub struct Item {
    pub id: Option<String>,
    pub text: Option<String>,
    pub images: Vec<ImageInput>,
    pub audio: Option<AudioInput>,
    pub video: Option<BinaryInput>,
    pub document: Option<BinaryInput>,
    pub metadata: Option<Value>,
}

One unit of input: text, images, audio, video or a document, in any combination the model accepts.

Fields

id: Option<String>

Caller-chosen identifier, echoed back on the matching result.

text: Option<String>

images: Vec<ImageInput>

audio: Option<AudioInput>

video: Option<BinaryInput>

document: Option<BinaryInput>

metadata: Option<Value>

Opaque metadata passed through to the model adapter.

Implementations

impl Item

pub fn new() -> Self

An empty item.

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

A text-only item.

pub fn image(image: ImageInput) -> Self

An item holding a single image.

pub fn with_id(self, id: impl Into<String>) -> Self

Set the identifier echoed back on the result.

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

Set or replace the text.

pub fn with_image(self, image: ImageInput) -> Self

Append an image.

pub fn with_audio(self, audio: AudioInput) -> Self

Attach audio.

pub fn with_video(self, video: BinaryInput) -> Self

Attach a video.

pub fn with_document(self, document: BinaryInput) -> Self

Attach a document.

pub fn with_metadata(self, metadata: Value) -> Self

Attach adapter metadata.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl PartialEq for Item

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Item