Skip to main content

ContentBuilder

Struct ContentBuilder 

Source
pub struct ContentBuilder { /* private fields */ }
Expand description

Fluent builder for composing a multimodal Message from interleaved text, image, file, and audio parts.

use openrouter::{ContentBuilder, ImageDetail, Role};

let msg = ContentBuilder::new()
    .add_text("Compare these:")
    .add_image("https://example.com/a.png")
    .add_image_with_detail("https://example.com/b.png", ImageDetail::High)
    .build_message(Role::User);
assert_eq!(msg.role, Role::User);

Implementations§

Source§

impl ContentBuilder

Source

pub fn new() -> Self

New empty builder.

Source

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

Append a plain-text part.

Source

pub fn add_image(self, url: impl Into<String>) -> Self

Append an image-URL part.

Source

pub fn add_image_with_detail( self, url: impl Into<String>, detail: ImageDetail, ) -> Self

Append an image-URL part with an explicit detail level.

Source

pub fn add_base64_image(self, path: impl AsRef<Path>) -> Result<Self>

Read an image from disk, base64-encode it, and append it.

Source

pub fn add_pdf( self, url: impl Into<String>, filename: impl Into<String>, ) -> Self

Append a PDF reference by URL.

Source

pub fn add_base64_pdf( self, path: impl AsRef<Path>, filename: impl Into<String>, ) -> Result<Self>

Read a PDF from disk, base64-encode it, and append it.

Source

pub fn add_audio(self, path: impl AsRef<Path>) -> Result<Self>

Read an audio file from disk and append it.

Source

pub fn add_text_file(self, path: impl AsRef<Path>) -> Result<Self>

Read a UTF-8 text file and append its contents as a text part.

Source

pub fn add_part(self, part: ContentPart) -> Self

Append an arbitrary pre-built part (escape hatch).

Source

pub fn build_message(self, role: Role) -> Message

Finalize as a Message with the given role.

Source

pub fn build_parts(self) -> Vec<ContentPart>

Finalize as a raw Vec<ContentPart>.

Trait Implementations§

Source§

impl Clone for ContentBuilder

Source§

fn clone(&self) -> ContentBuilder

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 ContentBuilder

Source§

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

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

impl Default for ContentBuilder

Source§

fn default() -> ContentBuilder

Returns the “default value” for a type. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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