openrouter-client 0.2.0

Idiomatic async Rust SDK for the OpenRouter API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! Types for the rerank endpoint (`POST /rerank`).
//!
//! Shapes mirror the Go SDK (`rerank_models.go`).

use serde::{Deserialize, Serialize};

use super::common::Provider;

/// Request body for [`crate::Client::rerank`].
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct RerankRequest {
    /// Rerank model identifier (e.g. `cohere/rerank-v3.5`).
    pub model: String,
    /// Search query used to rank `documents`.
    pub query: String,
    /// Candidate documents to rerank.
    pub documents: Vec<String>,
    /// Return only the top `top_n` documents.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub top_n: Option<u32>,
    /// Provider routing parameters (shared with chat/completions).
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub provider: Option<Provider>,
}

/// Response body from `/rerank`.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct RerankResponse {
    /// Unique identifier for the response (ORID format).
    #[serde(default)]
    pub id: String,
    /// Model that served the request.
    #[serde(default)]
    pub model: String,
    /// Provider that served the request.
    #[serde(default)]
    pub provider: String,
    /// Ranked results, ordered by descending relevance.
    #[serde(default)]
    pub results: Vec<RerankResult>,
    /// Usage statistics (when reported by the provider).
    #[serde(default)]
    pub usage: Option<RerankUsage>,
}

/// A single ranked result.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct RerankResult {
    /// Index of the document in the original `documents` array.
    #[serde(default)]
    pub index: u32,
    /// Relevance score (provider-defined scale).
    #[serde(default)]
    pub relevance_score: f64,
    /// Echoed document text.
    #[serde(default)]
    pub document: RerankDocument,
}

/// The echoed document text inside a [`RerankResult`].
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct RerankDocument {
    /// Echoed document text.
    #[serde(default)]
    pub text: String,
}

/// Usage statistics for a rerank request.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct RerankUsage {
    /// Total tokens consumed across query + documents.
    #[serde(default)]
    pub total_tokens: u64,
    /// Cohere-style billing unit (per-document cost).
    #[serde(default)]
    pub search_units: u64,
    /// Cost in credits.
    #[serde(default)]
    pub cost: Option<f64>,
}