Struct CompletionRequest 

pub struct CompletionRequest {
    pub system: String,
    pub user: String,
    pub tools: Vec<ToolSpec>,
    pub media: Vec<Media>,
}

A request for one model completion.

Construct with ..Default::default() for forward compatibility — fields are added in minor releases (media in 0.15.0). An exhaustive struct literal will not survive the next one.

use io_harness::{CompletionRequest, OpenRouter, Provider, ToolSpec};

let request = CompletionRequest {
    system: "You answer with one sentence.".into(),
    user: "Which crate builds the workspace?".into(),
    // Offering a tool here is what allows the model to reply with a
    // `ToolCall` instead of text; an empty `tools` guarantees prose.
    tools: vec![ToolSpec {
        name: "grep".into(),
        description: "Search the workspace for a pattern.".into(),
        parameters: serde_json::json!({
            "type": "object",
            "properties": { "pattern": { "type": "string" } },
            "required": ["pattern"]
        }),
    }],
    // Never an exhaustive literal: `media` appeared in 0.15.0 and the next
    // field will appear the same way, in a minor.
    ..Default::default()
};

let response = OpenRouter::from_env()?.complete(request).await?;

Fields

system: String

System instructions.

user: String

The user turn.

tools: Vec<ToolSpec>

Tools the model may call.

media: Vec<Media>

Available on crate feature media only.

Images the model should see alongside user.

A provider that does not accept images refuses a request carrying any, before the body is built and before anything is spent — see ensure_media_accepted. Media is never silently dropped: a run that paid for an answer about an image the model never received is the failure this field exists to make impossible.

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRequest

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

Formats the value using the given formatter.

impl Default for CompletionRequest

fn default() -> CompletionRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompletionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CompletionRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CompletionRequest