xz-provider 0.5.0

LLM 服务提供者抽象层 — 统一的 LLM 服务提供者接口
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::Citation;
use super::cache::CacheInfo;
use super::tool::ToolCall;

/// Token 用量
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TokenUsage {
    pub prompt_tokens: u32,
    pub completion_tokens: u32,
    pub total_tokens: u32,
    /// 缓存命中的 token 数(Prompt Caching)
    pub cached_tokens: Option<u32>,
    /// 推理/思考 token 数(DeepSeek reasoning、OpenAI o-series)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_tokens: Option<u32>,
    /// 缓存命中(DeepSeek prompt cache hit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prompt_cache_hit_tokens: Option<u32>,
    /// 缓存未命中(DeepSeek prompt cache miss)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prompt_cache_miss_tokens: Option<u32>,
    /// 音频输入 token 数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub audio_tokens: Option<u32>,
    /// 写入 5 分钟生命周期的缓存的 token 数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cache_write_5m_input_tokens: Option<u32>,
    /// 写入 1 小时生命周期的缓存的 token 数
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cache_write_1h_input_tokens: Option<u32>,
}

impl TokenUsage {
    pub fn new(prompt_tokens: u32, completion_tokens: u32) -> Self {
        Self {
            prompt_tokens,
            completion_tokens,
            total_tokens: prompt_tokens + completion_tokens,
            cached_tokens: None,
            reasoning_tokens: None,
            prompt_cache_hit_tokens: None,
            prompt_cache_miss_tokens: None,
            audio_tokens: None,
            cache_write_5m_input_tokens: None,
            cache_write_1h_input_tokens: None,
        }
    }
}

/// 补全响应
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CompletionResponse {
    /// 文本内容(可能为空,如 LLM 仅发起 tool call)
    pub content: Option<String>,
    /// 思考过程(Claude extended thinking / DeepSeek reasoning)
    pub thinking: Option<String>,
    /// LLM 发起的工具调用
    #[serde(default)]
    pub tool_calls: Vec<ToolCall>,
    /// Token 用量
    pub usage: TokenUsage,
    /// 实际使用的模型名(可能与请求不同,如自动回退后)
    pub model: String,
    /// 结束原因
    pub finish_reason: FinishReason,
    /// 请求延迟(毫秒)
    pub latency_ms: u64,
    /// 缓存命中信息
    pub cache_info: Option<CacheInfo>,
    /// 响应标识符(如 "chatcmpl-123")
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Unix 时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created: Option<u64>,
    /// 后端指纹
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_fingerprint: Option<String>,
    /// 内容拒绝消息
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refusal: Option<String>,
    /// 思考链签名(Anthropic extended thinking 验证用)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub signature: Option<String>,
    /// 加密思考链数据(API 返回已删节的加密内容)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redacted_thinking: Option<String>,
    /// 引用来源(Anthropic Citations 功能)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub citations: Option<Vec<Citation>>,
}

/// 结束原因
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub enum FinishReason {
    /// 正常结束
    #[default]
    #[serde(rename = "stop")]
    Stop,
    /// LLM 请求调用工具
    #[serde(rename = "tool_call")]
    ToolCall,
    /// 达到 token 上限
    #[serde(rename = "max_tokens")]
    MaxTokens,
    /// 内容过滤
    #[serde(rename = "content_filter")]
    ContentFilter,
    /// 暂停对话回合(如 Claude 的 pause_turn)
    #[serde(rename = "pause_turn")]
    PauseTurn,
    /// 拒绝回答(如内容策略拒绝)
    #[serde(rename = "refusal")]
    Refusal,
}

/// 流式响应事件类型
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum StreamEvent {
    /// 文本内容增量
    #[serde(rename = "content_delta")]
    ContentDelta { delta: String },

    /// 工具调用增量 —— 函数名和参数片段逐步拼接
    #[serde(rename = "tool_call_delta")]
    ToolCallDelta {
        index: usize,
        #[serde(skip_serializing_if = "Option::is_none")]
        id: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        function_name: Option<String>,
        arguments_delta: String,
    },

    /// 思考过程增量(Claude extended thinking、DeepSeek reasoning)
    #[serde(rename = "thinking_delta")]
    ThinkingDelta { delta: String },

    /// 图像增量(Gemini 图像生成等多模态输出场景)
    #[serde(rename = "image_delta")]
    ImageDelta { media_type: String, delta: String },

    /// Token 用量更新
    #[serde(rename = "usage")]
    Usage { usage: TokenUsage },

    /// 流结束信号
    #[serde(rename = "done")]
    Done {
        finish_reason: FinishReason,
        #[serde(skip_serializing_if = "Option::is_none")]
        usage: Option<TokenUsage>,
    },

    /// 签名增量(模型输出签名,用于验证)
    #[serde(rename = "signature_delta")]
    SignatureDelta { signature: String },

    /// 引用来源增量
    #[serde(rename = "citations_delta")]
    CitationsDelta { citations: Value },

    /// 隐式思考过程增量(redacted thinking,API 返回已删节版本)
    #[serde(rename = "redacted_thinking_delta")]
    RedactedThinkingDelta { data: String },

    /// Provider 特有的事件(可扩展)
    #[serde(rename = "custom")]
    Custom { event: String, data: Value },
}

// ── Old types compat ──

/// (Deprecated) 流式补全块 —— 使用 StreamEvent 代替
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StreamChunk {
    pub delta: String,
    pub finish_reason: Option<String>,
    pub usage: Option<TokenUsage>,
}

/// (Deprecated) 结构化输出响应 —— 直接使用 CompletionResponse
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StructuredResponse<T> {
    pub parsed: T,
    pub raw: String,
    pub usage: TokenUsage,
    pub model: String,
    pub latency_ms: u64,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_token_usage_new() {
        let usage = TokenUsage::new(100, 50);
        assert_eq!(usage.prompt_tokens, 100);
        assert_eq!(usage.completion_tokens, 50);
        assert_eq!(usage.total_tokens, 150);
        assert!(usage.cached_tokens.is_none());
    }

    #[test]
    fn test_token_usage_new_zero() {
        let usage = TokenUsage::new(0, 0);
        assert_eq!(usage.total_tokens, 0);
        assert_eq!(usage.prompt_tokens, 0);
        assert_eq!(usage.completion_tokens, 0);
    }

    #[test]
    fn test_finish_reason_serde() {
        let cases = vec![
            (FinishReason::Stop, "\"stop\""),
            (FinishReason::ToolCall, "\"tool_call\""),
            (FinishReason::MaxTokens, "\"max_tokens\""),
            (FinishReason::ContentFilter, "\"content_filter\""),
        ];
        for (reason, expected) in cases {
            let json = serde_json::to_string(&reason).unwrap();
            assert_eq!(json, expected);
            let deserialized: FinishReason = serde_json::from_str(&json).unwrap();
            assert!(
                matches!(&deserialized, r if std::mem::discriminant(&reason) == std::mem::discriminant(r))
            );
        }
    }

    #[test]
    fn test_stream_event_content_delta() {
        let evt = StreamEvent::ContentDelta { delta: "Hello".into() };
        match evt {
            StreamEvent::ContentDelta { delta } => assert_eq!(delta, "Hello"),
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_tool_call_delta() {
        let evt = StreamEvent::ToolCallDelta {
            index: 0,
            id: Some("call_1".into()),
            function_name: Some("search".into()),
            arguments_delta: "{}".into(),
        };
        match evt {
            StreamEvent::ToolCallDelta { index, id, function_name, arguments_delta } => {
                assert_eq!(index, 0);
                assert_eq!(id.unwrap(), "call_1");
                assert_eq!(function_name.unwrap(), "search");
                assert_eq!(arguments_delta, "{}");
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_thinking_delta() {
        let evt = StreamEvent::ThinkingDelta { delta: "thinking...".into() };
        match evt {
            StreamEvent::ThinkingDelta { delta } => assert_eq!(delta, "thinking..."),
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_usage() {
        let usage = TokenUsage::new(10, 20);
        let evt = StreamEvent::Usage { usage: usage.clone() };
        match evt {
            StreamEvent::Usage { usage: u } => {
                assert_eq!(u.prompt_tokens, 10);
                assert_eq!(u.completion_tokens, 20);
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_done() {
        let evt = StreamEvent::Done { finish_reason: FinishReason::Stop, usage: None };
        match evt {
            StreamEvent::Done { finish_reason, usage } => {
                assert!(matches!(finish_reason, FinishReason::Stop));
                assert!(usage.is_none());
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_done_with_usage() {
        let usage = TokenUsage::new(5, 10);
        let evt = StreamEvent::Done { finish_reason: FinishReason::MaxTokens, usage: Some(usage) };
        match evt {
            StreamEvent::Done { finish_reason, usage } => {
                assert!(matches!(finish_reason, FinishReason::MaxTokens));
                assert_eq!(usage.unwrap().total_tokens, 15);
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_custom() {
        let evt =
            StreamEvent::Custom { event: "ping".into(), data: serde_json::json!({"key": "value"}) };
        match evt {
            StreamEvent::Custom { event, data } => {
                assert_eq!(event, "ping");
                assert_eq!(data["key"], "value");
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_token_usage_serde() {
        let usage = TokenUsage::new(100, 50);
        let json = serde_json::to_string(&usage).unwrap();
        let deserialized: TokenUsage = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.prompt_tokens, 100);
        assert_eq!(deserialized.completion_tokens, 50);
        assert_eq!(deserialized.total_tokens, 150);
    }

    #[test]
    fn test_completion_response_fields() {
        let usage = TokenUsage::new(10, 20);
        let resp = CompletionResponse {
            content: Some("Hello".into()),
            thinking: None,
            tool_calls: vec![],
            usage,
            model: "gpt-4".into(),
            finish_reason: FinishReason::Stop,
            latency_ms: 100,
            cache_info: None,
            id: Some("chatcmpl-123".into()),
            created: Some(1700000000),
            system_fingerprint: Some("fp_abc".into()),
            refusal: None,
            ..Default::default()
        };
        assert_eq!(resp.content.unwrap(), "Hello");
        assert_eq!(resp.model, "gpt-4");
        assert_eq!(resp.latency_ms, 100);
        assert_eq!(resp.id.unwrap(), "chatcmpl-123");
        assert_eq!(resp.created.unwrap(), 1700000000);
        assert_eq!(resp.system_fingerprint.unwrap(), "fp_abc");
        assert!(resp.refusal.is_none());
    }

    #[test]
    fn test_completion_response_new_fields_serde() {
        let usage = TokenUsage::new(10, 20);
        let resp = CompletionResponse {
            content: Some("Hi".into()),
            thinking: None,
            tool_calls: vec![],
            usage,
            model: "gpt-4o".into(),
            finish_reason: FinishReason::Stop,
            latency_ms: 200,
            cache_info: None,
            id: Some("chatcmpl-456".into()),
            created: Some(1700000001),
            system_fingerprint: Some("fp_xyz".into()),
            refusal: Some("I cannot answer that.".into()),
            ..Default::default()
        };
        let json = serde_json::to_string(&resp).unwrap();
        let deserialized: CompletionResponse = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.id.unwrap(), "chatcmpl-456");
        assert_eq!(deserialized.created.unwrap(), 1700000001);
        assert_eq!(deserialized.system_fingerprint.unwrap(), "fp_xyz");
        assert_eq!(deserialized.refusal.unwrap(), "I cannot answer that.");
    }

    #[test]
    fn test_completion_response_new_fields_defaults() {
        let usage = TokenUsage::new(10, 20);
        let resp = CompletionResponse {
            content: Some("Hi".into()),
            thinking: None,
            tool_calls: vec![],
            usage,
            model: "gpt-4o".into(),
            finish_reason: FinishReason::Stop,
            latency_ms: 200,
            cache_info: None,
            id: None,
            created: None,
            system_fingerprint: None,
            refusal: None,
            ..Default::default()
        };
        let json = serde_json::to_string(&resp).unwrap();
        assert!(!json.contains("id"));
        assert!(!json.contains("created"));
        assert!(!json.contains("system_fingerprint"));
        assert!(!json.contains("refusal"));
        let deserialized: CompletionResponse = serde_json::from_str(&json).unwrap();
        assert!(deserialized.id.is_none());
        assert!(deserialized.created.is_none());
        assert!(deserialized.system_fingerprint.is_none());
        assert!(deserialized.refusal.is_none());
    }

    #[test]
    fn test_token_usage_new_fields_serde() {
        let mut usage = TokenUsage::new(100, 50);
        usage.reasoning_tokens = Some(30);
        usage.prompt_cache_hit_tokens = Some(20);
        usage.prompt_cache_miss_tokens = Some(80);
        usage.audio_tokens = Some(10);
        let json = serde_json::to_string(&usage).unwrap();
        let deserialized: TokenUsage = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.reasoning_tokens.unwrap(), 30);
        assert_eq!(deserialized.prompt_cache_hit_tokens.unwrap(), 20);
        assert_eq!(deserialized.prompt_cache_miss_tokens.unwrap(), 80);
        assert_eq!(deserialized.audio_tokens.unwrap(), 10);
        assert_eq!(deserialized.total_tokens, 150);
    }

    #[test]
    fn test_token_usage_new_fields_defaults() {
        let usage = TokenUsage::new(50, 25);
        let json = serde_json::to_string(&usage).unwrap();
        assert!(!json.contains("reasoning_tokens"));
        assert!(!json.contains("prompt_cache_hit_tokens"));
        assert!(!json.contains("prompt_cache_miss_tokens"));
        assert!(!json.contains("audio_tokens"));
        let deserialized: TokenUsage = serde_json::from_str(&json).unwrap();
        assert!(deserialized.reasoning_tokens.is_none());
        assert!(deserialized.prompt_cache_hit_tokens.is_none());
        assert!(deserialized.prompt_cache_miss_tokens.is_none());
        assert!(deserialized.audio_tokens.is_none());
    }

    #[test]
    fn test_finish_reason_new_variants_serde() {
        let cases = vec![
            (FinishReason::PauseTurn, "\"pause_turn\""),
            (FinishReason::Refusal, "\"refusal\""),
        ];
        for (reason, expected) in cases {
            let json = serde_json::to_string(&reason).unwrap();
            assert_eq!(json, expected);
            let deserialized: FinishReason = serde_json::from_str(&json).unwrap();
            assert!(
                matches!(&deserialized, r if std::mem::discriminant(&reason) == std::mem::discriminant(r))
            );
        }
    }

    #[test]
    fn test_stream_event_signature_delta() {
        let evt = StreamEvent::SignatureDelta { signature: "sig_abc123".into() };
        let json = serde_json::to_string(&evt).unwrap();
        let deserialized: StreamEvent = serde_json::from_str(&json).unwrap();
        match deserialized {
            StreamEvent::SignatureDelta { signature } => {
                assert_eq!(signature, "sig_abc123");
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_citations_delta() {
        let citations = serde_json::json!([{"url": "https://example.com", "title": "Example"}]);
        let evt = StreamEvent::CitationsDelta { citations: citations.clone() };
        let json = serde_json::to_string(&evt).unwrap();
        let deserialized: StreamEvent = serde_json::from_str(&json).unwrap();
        match deserialized {
            StreamEvent::CitationsDelta { citations: c } => {
                assert_eq!(c[0]["url"], "https://example.com");
                assert_eq!(c[0]["title"], "Example");
            }
            _ => panic!("Wrong variant"),
        }
    }

    #[test]
    fn test_stream_event_redacted_thinking_delta() {
        let evt = StreamEvent::RedactedThinkingDelta { data: "redacted_thought".into() };
        let json = serde_json::to_string(&evt).unwrap();
        let deserialized: StreamEvent = serde_json::from_str(&json).unwrap();
        match deserialized {
            StreamEvent::RedactedThinkingDelta { data } => {
                assert_eq!(data, "redacted_thought");
            }
            _ => panic!("Wrong variant"),
        }
    }
}