Trait ImageGenerationClient 

pub trait ImageGenerationClient {
    type ImageGenerationModel: ImageGenerationModel<Client = Self>;

    // Required method
    fn image_generation_model(
        &self,
        model: impl Into<String>,
    ) -> Self::ImageGenerationModel;

    // Provided method
    fn custom_image_generation_model(
        &self,
        model: impl Into<String>,
    ) -> Self::ImageGenerationModel { ... }
}

Available on crate feature image only.

A provider client with image generation capabilities. Clone is required for conversions between client types.

Required Associated Types

type ImageGenerationModel: ImageGenerationModel<Client = Self>

The ImageGenerationModel used by the Client

Required Methods

fn image_generation_model( &self, model: impl Into<String>, ) -> Self::ImageGenerationModel

Create an image generation model with the given name.

Example with OpenAI

use rig::prelude::*;
use rig::providers::openai::{Client, self};

// Initialize the OpenAI client
let openai = Client::new("your-open-ai-api-key");

let gpt4 = openai.image_generation_model(openai::DALL_E_3);

Provided Methods

fn custom_image_generation_model( &self, model: impl Into<String>, ) -> Self::ImageGenerationModel

Create an image generation model with the given name.

Example with OpenAI

use rig::prelude::*;
use rig::providers::openai::{Client, self};

// Initialize the OpenAI client
let openai = Client::new("your-open-ai-api-key");

let gpt4 = openai.image_generation_model(openai::DALL_E_3);

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<M, Ext, H> ImageGenerationClient for Client<Ext, H>

where Ext: Capabilities<H, ImageGeneration = Capable<M>>, M: ImageGenerationModel<Client = Self>,

type ImageGenerationModel = M