Run.start()

La méthode .start() démarre une exécution de Workflow avec des données d’entrée, ce qui permet d’exécuter le Workflow depuis le début.

Exemple d’utilisation

const run = await workflow.createRun()

const result = await run.start({
  inputData: {
    value: 'initial data',
  },
})

Paramètres

inputData?:

z.infer<TInput>

Données d’entrée correspondant au schéma d’entrée du Workflow

requestContext?:

RequestContext

Données de Request Context à utiliser pendant l’exécution du Workflow

outputWriter?:

(chunk: TOutput) => Promise<void>

Fonction asynchrone facultative permettant de traiter les fragments de sortie à mesure qu’ils sont produits

tracingContext?:

TracingContext

Contexte de traçage pour créer des spans enfants et ajouter des métadonnées. Injecté automatiquement lors de l’utilisation du système de traçage de Mastra.

currentSpan?:

Span

Span actuel pour créer des spans enfants et ajouter des métadonnées. Utilisez-le pour créer des spans enfants personnalisés ou mettre à jour les attributs du span pendant l’exécution.

tracingOptions?:

TracingOptions

Options de configuration de Tracing.

metadata?:

Record<string, any>

Métadonnées à ajouter au span racine de la trace. Utile pour ajouter des attributs personnalisés, tels que des ID utilisateur, des ID de session ou des feature flags.

requestContextKeys?:

string[]

Clés RequestContext supplémentaires à extraire comme métadonnées pour cette trace. Prend en charge la notation par points pour les valeurs imbriquées (par exemple, 'user.id').

traceId?:

string

ID de trace à utiliser pour cette exécution (1 à 32 caractères hexadécimaux). S’il est fourni, cette trace fera partie de la trace spécifiée.

parentSpanId?:

string

ID du span parent à utiliser pour cette exécution (1 à 16 caractères hexadécimaux). S’il est fourni, le span racine sera créé comme enfant de ce span.

tags?:

string[]

Tags à appliquer à cette trace. Étiquettes de chaîne pour catégoriser et filtrer les traces.

outputOptions?:

OutputOptions

Options de configuration de la sortie.

includeState?:

boolean

Indique si l’état de l’exécution du Workflow doit être inclus dans le résultat.

Valeurs renvoyées

result:

Promise<WorkflowResult<TState, TOutput, TSteps>>

Promise qui se résout avec le résultat de l’exécution du Workflow, contenant les sorties des étapes et l’état

traceId?:

string

ID de trace associé à cette exécution lorsque Tracing est activé. Utilisez-le pour corréler les journaux et déboguer le flux d’exécution.

spanId?:

string

ID du span racine associé à cette exécution lorsque Tracing est activé. Utilisez-le pour la recherche et la corrélation au niveau du span.

Exemple d’utilisation avancé

import { RequestContext } from '@mastra/core/request-context'

const run = await workflow.createRun()

const requestContext = new RequestContext()
requestContext.set('variable', false)

const result = await run.start({
  inputData: {
    value: 'initial data',
  },
  requestContext,
})

Voir aussi

• Présentation des Workflows
• Workflow.createRun()