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
/*
* OpenAI API
*
* The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
*
* The version of the OpenAPI document: 2.3.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// RetentionRatioTruncation : Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct RetentionRatioTruncation {
/// Use retention ratio truncation.
#[serde(rename = "type")]
pub r#type: Type,
/// Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.
#[serde(rename = "retention_ratio")]
pub retention_ratio: f64,
#[serde(rename = "token_limits", skip_serializing_if = "Option::is_none")]
pub token_limits: Option<Box<models::RetentionRatioTruncationTokenLimits>>,
}
impl RetentionRatioTruncation {
/// Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.
pub fn new(r#type: Type, retention_ratio: f64) -> RetentionRatioTruncation {
RetentionRatioTruncation {
r#type,
retention_ratio,
token_limits: None,
}
}
}
/// Use retention ratio truncation.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
#[serde(rename = "retention_ratio")]
RetentionRatio,
}
impl Default for Type {
fn default() -> Type {
Self::RetentionRatio
}
}
impl std::fmt::Display for RetentionRatioTruncation {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match serde_json::to_string(self) {
Ok(s) => write!(f, "{}", s),
Err(_) => Err(std::fmt::Error),
}
}
}