Struct ImageGenerateTool 

pub struct ImageGenerateTool { /* private fields */ }

Builtin tool that generates images from a text prompt via the OpenRouter image API.

Sends a request to the configured model (default: google/gemini-3.1-flash-image-preview) and returns the result as a base64-encoded inline image block marked with the [IMAGE:base64:...] prefix so downstream handlers can decode it. Requires an OPENROUTER_API_KEY environment variable; construction fails gracefully via try_new if the HTTP client cannot be initialised.

Implementations

impl ImageGenerateTool

pub fn new() -> Self

Create an ImageGenerateTool.

Panics if the HTTP client cannot be built. Use ImageGenerateTool::try_new if you need to handle the error.

pub fn try_new() -> Result<Self, Error>

Create an ImageGenerateTool, returning Err on failure.

Returns Err if the underlying HTTP client cannot be constructed (e.g., TLS initialisation failure).

Trait Implementations

impl Default for ImageGenerateTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for ImageGenerateTool

fn definition(&self) -> ToolDefinition

Return the tool’s definition (name, description, input schema) for the LLM.

fn redact_for_history(&self, output: &str) -> String

Optional override: produce a compact version of the tool output suitable for inclusion in conversation history sent to subsequent LLM turns. The default implementation returns the input verbatim.

fn execute( &self, _ctx: &ExecutionContext, input: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, Error>> + Send + '_>>

Execute the tool with the LLM-supplied input JSON.