Struct OpenRouterOptions 

#[non_exhaustive]
pub struct OpenRouterOptions {
    pub shared: OpenRouterShared,
}

OpenRouter’s request options, all sent on every route.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

shared: OpenRouterShared

The fields every route takes.

Implementations

impl OpenRouterOptions

pub fn new() -> Self

No option set.

pub fn provider(self, preferences: ProviderPreferences) -> Self

Route by preferences.

pub fn models(self, models: ModelFallbacks) -> Self

Fall back to models, in order, after the request’s own model.

pub fn plugin(self, plugin: Value) -> Self

Add plugin, such as {"id": "web"}.

pub fn session_id(self, id: impl Into<String>) -> Self

Group the request under session id.

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Attach the metadata pair key, value.

pub fn reasoning_exclude(self, exclude: bool) -> Self

Reason but leave the reasoning out of the reply when exclude.

pub fn reasoning_summary(self, summary: ReasoningSummary) -> Self

Summarize the reasoning at summary.

pub fn top_k(self, k: u32) -> Self

Sample from the k most likely tokens.

pub fn min_p(self, p: f64) -> Self

Set the minimum relative token probability.

pub fn top_a(self, a: f64) -> Self

Set top-a sampling.

pub fn repetition_penalty(self, penalty: f64) -> Self

Set the repetition penalty.

pub fn user(self, user: impl Into<String>) -> Self

Name the end user.

Trait Implementations

impl Clone for OpenRouterOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenRouterOptions

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

Formats the value using the given formatter.

impl Default for OpenRouterOptions

fn default() -> Self

Returns the “default value” for a type.

impl ExtensionOptions for OpenRouterOptions

type Ext = OpenRouterExt

The provider these options are for: the entry ProviderOptions::set stores them under. A type that serves as the Options of several providers names one of them here, and is stored for the others with ProviderOptions::with.

fn unsupported( &self, target: &dyn ReplayTarget, request: &CompletionRequest, ) -> Vec<(&'static str, String)>

The fields target cannot send for request, each a top-level body key with the reason. Each one set is reported through the request’s OnUnsupported policy under the name "<provider>.<section>.<field>". It must not call options::param, which reads it. By default every field is sent.

impl PartialEq for OpenRouterOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenRouterOptions

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 OpenRouterOptions