Skip to main content

OpenRouterImageProvider

Struct OpenRouterImageProvider 

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

Provider for the OpenRouter image API.

// From `OPENROUTER_API_KEY` and, if set, `OPENROUTER_BASE_URL`
let provider = OpenRouterImageProvider::from_env("bytedance-seed/seedream-4.5")?;
// Or everything in code
let provider =
    OpenRouterImageProvider::new("bytedance-seed/seedream-4.5", "sk-or-...", DEFAULT_BASE_URL);

Implementations§

Source§

impl OpenRouterImageProvider

Source

pub fn new( model: impl Into<String>, api_key: impl Into<String>, base_url: impl Into<String>, ) -> Self

Creates a provider for model with the API key and base URL given in code, for example DEFAULT_BASE_URL.

Source

pub fn from_env(model: impl Into<String>) -> Result<Self, ImageError>

Creates a provider for model with the API key from OPENROUTER_API_KEY and the base URL from OPENROUTER_BASE_URL, or DEFAULT_BASE_URL when it is not set.

Source

pub fn model(&self) -> &str

Model name sent to the API.

Trait Implementations§

Source§

impl Clone for OpenRouterImageProvider

Source§

fn clone(&self) -> Self

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 OpenRouterImageProvider

Source§

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

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

impl ImageProvider for OpenRouterImageProvider

Source§

fn edit<'life0, 'async_trait>( &'life0 self, request: ImageEditRequest, ) -> Pin<Box<dyn Future<Output = Result<ImageResponse, ImageError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Sends the images as input_references; models that do not take input images answer with an API error.

Source§

fn list_models<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ImageModel>, ImageError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Lists the models that output images, following every page of the list.

Source§

fn model(&self) -> Option<&str>

Name of the model, if the provider has one.
Source§

fn generate<'life0, 'async_trait>( &'life0 self, request: ImageRequest, ) -> Pin<Box<dyn Future<Output = Result<ImageResponse, ImageError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates an image.
Source§

fn supports_edit(&self) -> bool

Returns true when the provider implements edit.

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> 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