context.ts
Source : sdks/typescript/packages/sdk/src/context.ts. Retour à l'index de la référence du SDK TypeScript.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Interface ContextBudgetInit
Tailles transmises au constructeur de ContextBudget.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
window | number | oui | W : fenêtre de contexte du modèle en jetons. |
output | number | oui | Sortie de l'opération (transcription, références d'images...). |
reasoning | number | non | B_reasoning : jetons réservés au raisonnement interne. |
safety | number | non | B_safety : marge de sécurité en jetons (2 pour cent de la fenêtre par défaut). |
locale | Locale | non | Langue des messages d'erreur, en (par défaut) ou fr. |
Interface BudgetSegment
Un morceau de contexte transmis à ContextBudget.plan : identifiant, nombre de jetons, priorité et indicateur obligatoire.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
id | string | oui | Identifiant du segment, renvoyé dans included ou dropped. |
tokens | number | oui | Taille du segment en jetons. |
priority | number | non | Les segments de priorité plus haute sont gardés en premier (0 par défaut). |
required | boolean | non | Si vrai (par défaut), un rendu sans valeur ni valeur par défaut échoue. |
Interface BudgetPlan
Résultat de ContextBudget.plan : les jetons réservés, le budget de contexte, les jetons utilisés et les identifiants des segments gardés et écartés.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
window | number | oui | Fenêtre de contexte du modèle en jetons. |
output_reserved | number | oui | Jetons réservés à la réponse. |
reasoning_reserved | number | oui | Jetons réservés au raisonnement interne. |
safety_margin | number | oui | Marge de sécurité en jetons. |
context_budget | number | oui | Jetons disponibles pour le contexte du prompt. |
used | number | oui | Jetons des segments gardés. |
remaining | number | oui | Budget de contexte restant après les segments gardés. |
included | string[] | oui | Identifiants des segments gardés, dans l'ordre d'entrée. |
dropped | string[] | oui | Identifiants des segments écartés, dans l'ordre d'entrée. |
Classe ContextBudget
Utilitaire local du Context Manager : B_context = W - B_out - B_reasoning - B_safety.
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
output | number | oui | Jetons réservés à la réponse (B_out). |
reasoning | number | oui | Jetons réservés au raisonnement interne (B_reasoning). |
safety | number | oui | Marge de sécurité en jetons (B_safety), 2 pour cent de la fenêtre par défaut. |
window | number | oui | Fenêtre de contexte du modèle en jetons (W). |
Constructeur ContextBudget
new ContextBudget(init: ContextBudgetInit)
Arrondit les tailles à l'entier inférieur et les vérifie ; lève RangeError sur une taille négative et ContextOverflowError quand les réserves dépassent la fenêtre.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
init | ContextBudgetInit | oui | Tailles de la fenêtre, de la sortie, du raisonnement et de la marge en jetons, et langue des messages. |
ContextBudget.assertFits
assertFits(tokens: number): void
Lève ContextOverflowError quand le nombre de jetons donné ne tient pas.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
tokens | number | oui | Nombre de jetons à comparer au budget de contexte. |
Retour : void.
Erreurs levées : ContextOverflowError.
ContextBudget.contextBudget
contextBudget(): number
Jetons disponibles pour le contexte du prompt : fenêtre moins sortie, raisonnement et marge.
Cet élément ne prend aucun paramètre.
Retour : number. Budget de contexte en jetons.
ContextBudget.fits
fits(tokens: number): boolean
Indique si un nombre de jetons tient dans le budget de contexte.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
tokens | number | oui | Nombre de jetons à vérifier. |
Retour : boolean. Vrai quand tokens est au plus égal au budget de contexte.
ContextBudget.plan
plan(segments: BudgetSegment[]): BudgetPlan
Sélection gloutonne : les segments obligatoires d'abord, puis par priorité décroissante, en gardant l'ordre d'entrée à égalité.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
segments | BudgetSegment[] | oui | Segments à faire tenir ; les obligatoires doivent tenir, sinon ContextOverflowError est levée. |
Retour : BudgetPlan. Chiffres du budget et identifiants des segments gardés et écartés.
Fonctions
isEffort
isEffort(value: unknown): value is Effort
Indique si une valeur est l'un des niveaux d'effort none, low, medium, high ou max.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
value | unknown | oui | Valeur à vérifier. |
Retour : value is Effort. Vrai quand la valeur est une chaîne d'effort connue.
compareEffort
compareEffort(a: Effort, b: Effort): number
Compare deux niveaux d'effort sur l'échelle ordonnée none < low < medium < high < max.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
a | Effort | oui | Premier niveau d'effort. | |
b | Effort | oui | Second niveau d'effort. |
Retour : number. Négatif quand a est inférieur à b, 0 en cas d'égalité, positif quand il est supérieur.
estimateTokens
estimateTokens(text: string): number
Estimation approximative des jetons (environ 4 caractères par jeton), utilisée quand aucun tokenizer n'est disponible.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
text | string | oui | Texte à mesurer. |
Retour : number. Longueur du texte divisée par 4, arrondie au supérieur ; 0 pour un texte vide.