Struct OpenRouterRequestOptions 

pub struct OpenRouterRequestOptions {

    pub api_mode: Option<OpenRouterApiMode>,
    pub models: Option<Vec<String>>,
    pub route: Option<String>,
    pub plugins: Option<Vec<OpenRouterPlugin>>,
    pub response_tools: Option<Vec<OpenRouterResponseTool>>,
    pub provider: Option<OpenRouterProviderPreferences>,
    pub reasoning: Option<OpenRouterReasoningConfig>,
    pub reasoning_content: Option<String>,
    pub reasoning_details: Option<Value>,
    pub previous_response_id: Option<String>,
    pub prompt_cache_key: Option<String>,
    pub modalities: Option<Vec<String>>,
    pub include: Option<Vec<String>>,
    pub image_config: Option<OpenRouterImageConfig>,
    pub metadata: Option<Value>,
    pub instructions: Option<String>,
    pub session_id: Option<String>,
    pub trace: Option<Value>,
    pub user: Option<String>,
    pub tool_choice: Option<OpenRouterToolChoice>,
    pub parallel_tool_calls: Option<bool>,
    pub response_text: Option<OpenRouterResponseTextConfig>,
    pub response_format: Option<OpenRouterResponseFormat>,
    pub extra: BTreeMap<String, Value>,
}

Available on crate features models and openrouter only.

Agent-facing OpenRouter options serialized into GenerateContentConfig::extensions["openrouter"].

These options let callers select the native OpenRouter API mode and pass OpenRouter-specific request parameters through the generic ADK request layer without losing them during serialization.

Example

use adk_core::GenerateContentConfig;
use adk_model::openrouter::{OpenRouterApiMode, OpenRouterRequestOptions};

let mut config = GenerateContentConfig::default();
OpenRouterRequestOptions::default()
    .with_api_mode(OpenRouterApiMode::Responses)
    .with_route("fallback")
    .insert_into_config(&mut config)
    .expect("options should serialize");

assert!(config.extensions.contains_key("openrouter"));

Fields

api_mode: Option<OpenRouterApiMode>

models: Option<Vec<String>>

route: Option<String>

plugins: Option<Vec<OpenRouterPlugin>>

response_tools: Option<Vec<OpenRouterResponseTool>>

provider: Option<OpenRouterProviderPreferences>

reasoning: Option<OpenRouterReasoningConfig>

reasoning_content: Option<String>

reasoning_details: Option<Value>

previous_response_id: Option<String>

prompt_cache_key: Option<String>

modalities: Option<Vec<String>>

include: Option<Vec<String>>

image_config: Option<OpenRouterImageConfig>

metadata: Option<Value>

instructions: Option<String>

session_id: Option<String>

trace: Option<Value>

user: Option<String>

tool_choice: Option<OpenRouterToolChoice>

parallel_tool_calls: Option<bool>

response_text: Option<OpenRouterResponseTextConfig>

response_format: Option<OpenRouterResponseFormat>

extra: BTreeMap<String, Value>

Implementations

impl OpenRouterRequestOptions

pub fn with_api_mode( self, api_mode: OpenRouterApiMode, ) -> OpenRouterRequestOptions

Set the native OpenRouter API mode used by the adapter.

pub fn with_models(self, models: Vec<String>) -> OpenRouterRequestOptions

Set fallback models for OpenRouter routing.

pub fn with_route(self, route: impl Into<String>) -> OpenRouterRequestOptions

Set OpenRouter route selection.

pub fn with_plugin(self, plugin: OpenRouterPlugin) -> OpenRouterRequestOptions

Append one chat plugin.

pub fn with_response_tool( self, tool: OpenRouterResponseTool, ) -> OpenRouterRequestOptions

Append one Responses API server tool.

pub fn with_provider_preferences( self, provider: OpenRouterProviderPreferences, ) -> OpenRouterRequestOptions

Set OpenRouter provider preferences.

pub fn with_reasoning( self, reasoning: OpenRouterReasoningConfig, ) -> OpenRouterRequestOptions

Set OpenRouter reasoning configuration.

pub fn with_previous_response_id( self, previous_response_id: impl Into<String>, ) -> OpenRouterRequestOptions

Set a previous response ID for Responses API chaining.

pub fn with_prompt_cache_key( self, prompt_cache_key: impl Into<String>, ) -> OpenRouterRequestOptions

Set a prompt cache key for the Responses API.

pub fn with_modalities( self, modalities: Vec<String>, ) -> OpenRouterRequestOptions

Set requested response modalities.

pub fn with_include(self, include: Vec<String>) -> OpenRouterRequestOptions

Set Responses API include fields.

pub fn to_extension_value(&self) -> Result<Value, AdkError>

Serialize the options into a JSON extension value.

pub fn from_extension_value( value: &Value, ) -> Result<OpenRouterRequestOptions, AdkError>

Deserialize the options from a JSON extension value.

pub fn from_generate_config( config: Option<&GenerateContentConfig>, ) -> Result<Option<OpenRouterRequestOptions>, AdkError>

Extract OpenRouter request options from GenerateContentConfig.

pub fn insert_into_config( &self, config: &mut GenerateContentConfig, ) -> Result<(), AdkError>

Insert the serialized options into GenerateContentConfig::extensions.

Trait Implementations

impl Clone for OpenRouterRequestOptions

fn clone(&self) -> OpenRouterRequestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenRouterRequestOptions

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

Formats the value using the given formatter.

impl Default for OpenRouterRequestOptions

fn default() -> OpenRouterRequestOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenRouterRequestOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpenRouterRequestOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenRouterRequestOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenRouterRequestOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenRouterRequestOptions