opengatellm 0.1.0

Client Rust pour OpenGateLLM, l'API gateway open-source pour LLM self-hosted (DINUM / Etalab).
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
//! Endpoint `POST /v1/chat/completions` (non-streaming).
//!
//! Le streaming SSE est géré séparément par [`crate::stream`].

use crate::client::Client;
use crate::common::Usage;
use crate::error::Error;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Rôle d'un message dans la conversation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Role {
    /// Instructions système (souvent injectées en tête de conversation).
    System,
    /// Message utilisateur.
    User,
    /// Réponse du modèle.
    Assistant,
    /// Résultat d'un appel d'outil.
    Tool,
    /// Rôle développeur (`OpenAI` Responses API).
    Developer,
}

/// Contenu d'un message : texte simple ou parties multimodales.
///
/// Côté input, OGL accepte les deux formes (compat `OpenAI`). Côté output,
/// les modèles texte-only ne renvoient qu'une `String`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ChatContent {
    /// Texte simple.
    Text(String),
    /// Parties multimodales (texte + images).
    Parts(Vec<ContentPart>),
}

impl From<String> for ChatContent {
    fn from(s: String) -> Self {
        Self::Text(s)
    }
}

impl From<&str> for ChatContent {
    fn from(s: &str) -> Self {
        Self::Text(s.to_owned())
    }
}

/// Une partie d'un contenu multimodal.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum ContentPart {
    /// Bloc de texte.
    Text {
        /// Texte de la partie.
        text: String,
    },
    /// Référence à une image (URL ou data URI base64).
    ImageUrl {
        /// Détails de l'image référencée.
        image_url: ImageUrl,
    },
}

/// URL d'une image (référence ou data-URI base64).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImageUrl {
    /// URL ou data-URI (`data:image/png;base64,...`).
    pub url: String,
    /// Hint de détail (`auto`, `low`, `high`) accepté par certains modèles vision.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detail: Option<String>,
}

/// Message d'une conversation (input ou output).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ChatMessage {
    /// Rôle du locuteur.
    pub role: Role,
    /// Contenu du message (peut être `null` si le message est un appel d'outil pur).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub content: Option<ChatContent>,
    /// Nom optionnel (pour distinguer plusieurs utilisateurs / outils).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Refus du modèle (renvoyé par certains modèles modérés).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub refusal: Option<String>,
    /// Annotations attachées (citations URL, etc.).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub annotations: Option<Vec<Annotation>>,
    /// Identifiant de l'appel d'outil auquel ce message répond (rôle `tool`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tool_call_id: Option<String>,
    /// Appels d'outils émis par le modèle (rôle `assistant`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tool_calls: Option<Vec<ToolCall>>,
}

impl ChatMessage {
    /// Raccourci : message texte simple avec rôle `user`.
    pub fn user(content: impl Into<String>) -> Self {
        Self {
            role: Role::User,
            content: Some(ChatContent::Text(content.into())),
            name: None,
            refusal: None,
            annotations: None,
            tool_call_id: None,
            tool_calls: None,
        }
    }

    /// Raccourci : message texte simple avec rôle `system`.
    pub fn system(content: impl Into<String>) -> Self {
        Self {
            role: Role::System,
            content: Some(ChatContent::Text(content.into())),
            name: None,
            refusal: None,
            annotations: None,
            tool_call_id: None,
            tool_calls: None,
        }
    }

    /// Raccourci : message texte simple avec rôle `assistant`.
    pub fn assistant(content: impl Into<String>) -> Self {
        Self {
            role: Role::Assistant,
            content: Some(ChatContent::Text(content.into())),
            name: None,
            refusal: None,
            annotations: None,
            tool_call_id: None,
            tool_calls: None,
        }
    }
}

/// Citation source attachée à un message (URL annotée).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum Annotation {
    /// Citation d'une URL avec plage de caractères concernée.
    UrlCitation {
        /// Détails de la citation.
        url_citation: AnnotationUrlCitation,
    },
}

/// Détails d'une citation URL.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AnnotationUrlCitation {
    /// Index de fin (exclusif) dans le contenu textuel.
    pub end_index: u32,
    /// Index de début (inclusif) dans le contenu textuel.
    pub start_index: u32,
    /// Titre de la page citée.
    pub title: String,
    /// URL citée.
    pub url: String,
}

/// Appel d'outil émis par le modèle.
///
/// OGL supporte deux variants : `function` (legacy / structured) et `custom`
/// (outil utilisateur libre).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum ToolCall {
    /// Appel de fonction structurée.
    Function {
        /// Identifiant unique de l'appel.
        id: String,
        /// Détails de la fonction appelée.
        function: FunctionDetails,
    },
    /// Appel d'outil custom.
    Custom {
        /// Identifiant unique de l'appel.
        id: String,
        /// Détails de l'outil custom.
        custom: CustomDetails,
    },
}

/// Détails d'un appel de fonction.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FunctionDetails {
    /// Nom de la fonction.
    pub name: String,
    /// Arguments JSON-stringifiés (à parser côté appelant).
    pub arguments: String,
}

/// Détails d'un appel d'outil custom.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomDetails {
    /// Nom de l'outil.
    pub name: String,
    /// Entrée brute fournie par le modèle.
    pub input: String,
}

/// Raison de terminaison d'une génération.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum FinishReason {
    /// Stop naturel (EOS).
    Stop,
    /// Limite de tokens atteinte.
    Length,
    /// Appels d'outils retournés.
    ToolCalls,
    /// Bloqué par le filtre de contenu.
    ContentFilter,
    /// Appel de fonction (legacy).
    FunctionCall,
}

/// Conditions de stop : un mot ou une liste.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Stop {
    /// Un seul motif de stop.
    Single(String),
    /// Plusieurs motifs (le générateur s'arrête au premier rencontré).
    Many(Vec<String>),
}

/// Niveau de service côté `OpenAI` (rarement utilisé côté self-hosted).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ServiceTier {
    /// Auto.
    Auto,
    /// Défaut.
    Default,
    /// Flex (best-effort, latence variable).
    Flex,
    /// Scale.
    Scale,
    /// Priorité.
    Priority,
}

/// Logprob d'un token candidat.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TopLogprob {
    /// Texte du token.
    pub token: String,
    /// Bytes UTF-8 du token (utile si le token n'est pas du texte valide).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bytes: Option<Vec<i32>>,
    /// Log-probabilité.
    pub logprob: f64,
}

/// Logprob d'un token avec ses alternatives.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TokenLogprob {
    /// Texte du token.
    pub token: String,
    /// Bytes UTF-8 du token.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bytes: Option<Vec<i32>>,
    /// Log-probabilité.
    pub logprob: f64,
    /// Tokens alternatifs et leurs logprobs.
    pub top_logprobs: Vec<TopLogprob>,
}

/// Logprobs d'un `Choice`.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ChoiceLogprobs {
    /// Logprobs du contenu généré.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub content: Option<Vec<TokenLogprob>>,
    /// Logprobs du refus (si applicable).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub refusal: Option<Vec<TokenLogprob>>,
}

/// Un choix retourné par le modèle (généralement un seul, sauf `n > 1`).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Choice {
    /// Index du choix dans la liste (0-based).
    pub index: u32,
    /// Message complet du choix.
    pub message: ChatMessage,
    /// Raison de terminaison.
    pub finish_reason: FinishReason,
    /// Logprobs détaillés si demandés via `logprobs: true`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logprobs: Option<ChoiceLogprobs>,
}

/// Réponse non-streamée de `POST /v1/chat/completions`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ChatCompletion {
    /// Identifiant de la complétion.
    #[serde(default)]
    pub id: String,
    /// Liste des choix.
    pub choices: Vec<Choice>,
    /// Timestamp Unix de création.
    pub created: i64,
    /// Modèle utilisé.
    pub model: String,
    /// Type de l'objet (`chat.completion`).
    #[serde(default)]
    pub object: String,
    /// Niveau de service.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub service_tier: Option<ServiceTier>,
    /// Empreinte système (config backend).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub system_fingerprint: Option<String>,
    /// Compteurs d'usage / coût / empreinte.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub usage: Option<Usage>,
    /// Résultats de recherche RAG (extension OGL).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub search_results: Option<Vec<serde_json::Value>>,
}

/// Corps de requête de `POST /v1/chat/completions`.
///
/// Construire via [`CreateChatCompletion::new`] + builder, ou littéralement
/// via `CreateChatCompletion { ... }` si plus pratique.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreateChatCompletion {
    /// Liste des messages constituant la conversation.
    pub messages: Vec<ChatMessage>,
    /// Identifiant du modèle (cf. `client.models()`).
    pub model: String,
    /// `[-2.0, 2.0]` — pénalise la fréquence de tokens déjà émis.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub frequency_penalty: Option<f64>,
    /// Biais de logit par token id.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logit_bias: Option<HashMap<String, f64>>,
    /// Renvoie les logprobs.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logprobs: Option<bool>,
    /// Nombre d'alternatives top logprobs à inclure.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub top_logprobs: Option<u8>,
    /// `[-2.0, 2.0]` — pénalise la présence de tokens déjà émis.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub presence_penalty: Option<f64>,
    /// Nombre max de tokens en sortie.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_completion_tokens: Option<u32>,
    /// Nombre de complétions à générer (souvent 1).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub n: Option<u32>,
    /// Format de réponse (JSON Mode, Structured Outputs, etc.).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub response_format: Option<serde_json::Value>,
    /// Seed pour la génération déterministe.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
    /// Motif(s) de stop.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stop: Option<Stop>,
    /// Active le streaming SSE. Voir aussi
    /// [`Client::chat_completion_stream`](crate::client::Client) à l'étape 4.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stream: Option<bool>,
    /// Options du streaming (`include_usage`, etc.).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stream_options: Option<serde_json::Value>,
    /// `[0.0, 2.0]` — randomness.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub temperature: Option<f64>,
    /// `(0.0, 1.0]` — nucleus sampling.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub top_p: Option<f64>,
    /// Outils que le modèle peut appeler (functions + `SearchTool` OGL).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tools: Option<Vec<serde_json::Value>>,
    /// Politique de choix d'outil.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tool_choice: Option<serde_json::Value>,
    /// Autorise les appels d'outils en parallèle.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parallel_tool_calls: Option<bool>,
    /// Identifiant utilisateur (pour le logging côté OGL).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
    /// Active la recherche RAG OGL (extension propre à `OpenGateLLM`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub search: Option<bool>,
    /// Paramètres de recherche RAG (extension OGL).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub search_args: Option<serde_json::Value>,
}

impl CreateChatCompletion {
    /// Construit une requête minimale `(messages, model)`.
    pub fn new(messages: Vec<ChatMessage>, model: impl Into<String>) -> Self {
        Self {
            messages,
            model: model.into(),
            ..Self::default()
        }
    }

    /// Définit la temperature.
    #[must_use]
    pub fn temperature(mut self, t: f64) -> Self {
        self.temperature = Some(t);
        self
    }

    /// Définit le `top_p`.
    #[must_use]
    pub fn top_p(mut self, p: f64) -> Self {
        self.top_p = Some(p);
        self
    }

    /// Définit le nombre max de tokens en sortie.
    #[must_use]
    pub fn max_completion_tokens(mut self, n: u32) -> Self {
        self.max_completion_tokens = Some(n);
        self
    }

    /// Définit le seed déterministe.
    #[must_use]
    pub fn seed(mut self, seed: i64) -> Self {
        self.seed = Some(seed);
        self
    }
}

impl Client {
    /// `POST /v1/chat/completions` (non-streaming).
    ///
    /// Force `stream = false` quel que soit le champ de la requête fournie.
    /// Pour du streaming SSE, utiliser `Client::chat_completion_stream`
    /// (étape 4 — module `stream`).
    pub async fn chat_completion(
        &self,
        req: &CreateChatCompletion,
    ) -> Result<ChatCompletion, Error> {
        let mut owned = req.clone();
        owned.stream = Some(false);
        let url = self.endpoint("/v1/chat/completions")?;
        self.post_json(url, &owned).await
    }
}