Documentation

Classe : TypeSafeClient

Client pour l’API TypeSafe AI.

Constructeurs

Constructeur

new TypeSafeClient(config?): TypeSafeClient;

Crée un client pour l’API TypeSafe AI.

Les options explicites ont priorité sur les variables d’environnement, puis sur les valeurs par défaut du SDK. Les valeurs d’environnement vides ou composées uniquement d’espaces sont ignorées.

Paramètres

config?

TypeSafeClientConfig = {}

Valeur de retour

TypeSafeClient

Lève

La clé d’API est manquante, la configuration est invalide, ou le runtime n’est pas pris en charge.

Propriétés

baseURL

readonly baseURL: string;

Racine de l’API sans les barres obliques finales.


defaultHeaders

readonly defaultHeaders: Readonly<Record<string, string>>;

En-têtes supplémentaires envoyés avec chaque requête.


defaultModel

readonly defaultModel: string;

Modèle utilisé quand une requête omet model.


fetch

readonly fetch: Fetch;

Implémentation du fetch HTTP.


logger

readonly logger: Logger;

Le logger configuré, filtré sur logLevel.


logLevel

readonly logLevel: LogLevel;

Niveau de verbosité de journalisation configuré.


models

readonly models: Models;

Les modèles disponibles pour le compte.


retry

readonly retry: RetryPolicy;

Réglages de réessai avec les surcharges du constructeur appliquées.


timeout

readonly timeout: number;

Délai d’attente par tentative en millisecondes.

Méthodes

systemOne()

systemOne<Q>(request, options?): APIPromise<SystemOneResult<Q>>;

Répond à des questions nommées sur du texte ou un état structuré.

Paramètres de type

Q

Q extends Questions

Paramètres

request

SystemOneRequest<Q>

État, questions et une surcharge de modèle facultative.

options?

RequestOptions = {}

Réglages de délai d’attente, de réessai, d’en-têtes et d’annulation par appel.

Valeur de retour

APIPromise<SystemOneResult<Q>>

Réponses typées par nom de question et critères, avec le modèle et la consommation de jetons.

Lève

Les questions sont vides, ou les criteria de score ne forment pas une liste d’au moins deux entrées.

Lève

Le serveur renvoie une réponse non 2xx après les réessais.

Lève

La requête ne peut pas se connecter ou expire après les réessais.

Lève

L’appelant interrompt la requête.

Exemple

const { answers } = await client.systemOne({
  state: "I was charged twice. Please help.",
  questions: { billing: noul("Is this about billing?") },
});
console.log(answers.billing.noul);