Référence du schéma de l’objet Appel

Référence de la structure et des propriétés de l’objet Appel

Cette référence décrit le schéma de l’objet Appel dans W&B Weave. Pour plus d’informations sur les requêtes portant sur les appels, voir Interroger et exporter des appels.

​

Propriétés de l’Appel

Le tableau ci-dessous présente les principales propriétés d’un Appel dans Weave. Pour l’implémentation complète, voir ce qui suit :

• classe : CallSchema dans le SDK Python.
• Interface : CallSchema dans le SDK TypeScript.

Propriété	Type	Description
id	string (uuid)	Identifiant unique de l’Appel
project_id	string (facultatif)	Identifiant du projet associé
op_name	string	Nom de l’opération (peut être une référence)
display_name	string (facultatif)	Nom lisible de l’Appel
trace_id	string (uuid)	Identifiant de la trace à laquelle cet Appel appartient
parent_id	string (uuid)	Identifiant de l’Appel parent
started_at	datetime	Horodatage auquel l’Appel a commencé
attributes	Dict[str, Any]	Métadonnées définies par l’utilisateur pour l’Appel (en lecture seule pendant l’exécution)
inputs	Dict[str, Any]	Paramètres d’entrée de l’Appel
ended_at	datetime (facultatif)	Horodatage de fin de l’Appel
exception	string (facultatif)	Message d’erreur si l’Appel a échoué
output	Any (facultatif)	Résultat de l’Appel
summary	Optional[SummaryMap]	Informations de synthèse après l’exécution. Vous pouvez les modifier pendant l’exécution pour enregistrer des métriques personnalisées.
wb_user_id	Optional[str]	ID utilisateur W&B associé
wb_run_id	Optional[str]	ID de run W&B associé
deleted_at	datetime (facultatif)	Horodatage de suppression de l’Appel, le cas échéant

​

Détails des propriétés

Les propriétés de CallSchema vous aident à suivre et à gérer les appels :

• Les propriétés id, trace_id et parent_id aident à organiser les appels et à les relier entre eux dans le système.
• Les informations temporelles (started_at, ended_at) permettent d’analyser les performances.
• Les propriétés attributes et inputs fournissent du contexte pour l’appel. Les attributs sont figés une fois l’appel démarré ; définissez-les donc avant l’invocation à l’aide du gestionnaire de contexte weave.attributes(). output et summary capturent les résultats.
• Utilisez wb_user_id et wb_run_id pour associer l’appel à un utilisateur W&B et à un run.

Ensemble, ces propriétés permettent un suivi et une analyse détaillés des appels tout au long de votre projet.

​

Utiliser la synthèse d’un Appel

La propriété summary est un dictionnaire dans lequel vous pouvez écrire pendant l’exécution d’un Appel. Lorsque l’Appel se termine, Weave fusionne en profondeur vos valeurs avec ses propres données calculées et stocke le résultat.

Le dictionnaire comporte deux zones :

• Vos clés personnalisées : tout ce que vous écrivez directement dans call.summary, par exemple call.summary["accuracy"] = 0.95. Elles se trouvent au niveau supérieur du dictionnaire de synthèse.
• summary["weave"] : un espace de noms réservé que Weave renseigne automatiquement à la fin de l’Appel. N’écrivez pas directement dans cette clé.

Weave capture également le nombre brut de jetons LLM à partir de la réponse du modèle dans summary["usage"] (indexé par nom de modèle). Il s’agit de données sources transmises par le fournisseur, et non d’un calcul de Weave. Le champ costs dans summary["weave"] correspond à ce que Weave déduit de ces données d’utilisation à l’aide de la tarification des jetons.

Champs calculés par Weave dans summary["weave"] :

Champ	Description
status	Statut d’exécution : SUCCESS, ERROR, RUNNING ou DESCENDANT_ERROR (l’Appel a réussi, mais un Appel enfant a échoué).
latency_ms	Durée en millisecondes entre started_at et ended_at. null si status vaut RUNNING.
costs	Répartition des coûts par modèle, déduite de summary["usage"] et des données de tarification des jetons. Voir Track costs.
trace_name	Nom d’Op lisible, extrait de l’URI de référence interne de l’Op. Utilisé pour l’affichage et le filtrage.

​

Ajouter des données pendant un Appel

Vous pouvez ajouter des données personnalisées pendant votre Appel à l’aide du dictionnaire summary.

Python

En Python, attribuez des valeurs à call.summary à tout moment de l’exécution à l’aide de weave.get_current_call().

import weave

@weave.op()
def my_op(x):
    result = do_work(x)
    call = weave.get_current_call()
    # Ajoutez des données personnalisées à la synthèse.
    call.summary["accuracy"] = 0.95
    call.summary["num_retries"] = 2
    return result

TypeScript

En TypeScript, fournissez une fonction summarize en option à op(). Elle reçoit le résultat final et renvoie les données de synthèse une fois l’Appel terminé.

const myOp = weave.op(
  async (x: any) => {
    const result = await doWork(x);
    return result;
  },
  {
    name: 'my_op',
    summarize: (result) => ({
      accuracy: result.accuracy,
      numRetries: result.numRetries,
    }),
  }
);

​

Lire les données de synthèse

Utilisez getCall pour récupérer un appel unique par son ID, ou getCalls pour récupérer plusieurs appels. Dans les deux cas, summary correspond au même dictionnaire fusionné.

Python

import weave
client = weave.init("my-team/my-project")

# Récupérer un appel unique par son ID.
call = client.get_call("<call-id>")
weave_summary = (call.summary or {}).get("weave", {})

print(weave_summary.get("status"))       # Énumération TraceStatus : SUCCESS, ERROR, RUNNING ou DESCENDANT_ERROR.
print(weave_summary.get("latency_ms"))   # Vaut `null` si l'appel est toujours en cours d'exécution.
print(weave_summary.get("costs"))        # Répartition des coûts par modèle.
print(call.summary.get("usage"))         # Nombre brut de jetons provenant du fournisseur LLM.
print(call.summary.get("accuracy"))      # Votre champ personnalisé.

# Parcourir plusieurs appels avec un filtrage côté serveur.
for call in client.get_calls(filter={"op_names": ["weave:///my-team/my-project/op/my_op:*"]}):
    s = call.summary or {}
    weave_s = s.get("weave", {})
    print(call.id, weave_s.get("status"), weave_s.get("latency_ms"), s.get("accuracy"))

TypeScript

import * as weave from 'weave';
const client = await weave.init('my-team/my-project');

// Récupérer un appel unique par son ID.
const call = await client.getCall('<call-id>');
const weaveSummary = call.summary?.weave;

console.log(weaveSummary?.status);       // "success", "error", "running" ou "descendant_error".
console.log(weaveSummary?.latency_ms);   // Vaut `undefined` si l'appel est toujours en cours d'exécution.
console.log(weaveSummary?.costs);        // Répartition des coûts par modèle.
console.log(call.summary?.usage);        // Nombre brut de jetons provenant du fournisseur LLM.
console.log(call.summary?.accuracy);     // Votre champ personnalisé.

// Récupérer plusieurs appels avec un filtrage côté serveur.
const calls = await client.getCalls({ filter: { op_names: ['weave:///my-team/my-project/op/my_op:*'] } });
for (const call of calls) {
  const weaveS = call.summary?.weave;
  console.log(call.id, weaveS?.status, weaveS?.latency_ms, call.summary?.accuracy);
}