Aller au contenu
Référence API
Référence API

Objet Batch

Un lot de modération à portée de compte dont le cycle de vie d'exécution est rapporté par l'API Batch compatible.

Un lot de modération à portée de compte dont le cycle de vie d’exécution est rapporté par l’API Batch compatible.

01

Champs de l'objet

Corps JSON

Champs stables partagés par l'objet réutilisable de la ressource.

Lots23 champs
cancelled_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch a été annulé.

cancelling_atinteger | null
Optionnel

Horodatage Unix lorsque l'annulation a commencé.

completed_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch s'est terminé.

completion_windowstring
Requis

Fenêtre de complétion du Batch.

created_atinteger
Requis

Horodatage Unix lorsque le Batch a été créé.

endpointstring
Requis

Point de terminaison de modération traité par le lot.

error_file_idstring | null
Optionnel

ID de fichier d'erreur RunAPI

errorsobject | null
Optionnel

Erreurs de validation ou d'exécution du Batch

expired_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch a expiré.

expires_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch expire.

failed_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch a échoué.

finalizing_atinteger | null
Optionnel

Horodatage Unix lorsque le Batch est entré en phase de finalisation.

idstring
Requis

ID de Batch RunAPI.

in_progress_atinteger | null
Optionnel

Horodatage Unix lorsque le traitement du Batch a commencé.

input_file_idstring
Requis

ID de fichier d'entrée RunAPI.

metadataobject
Requis

Métadonnées de l'appelant retournées avec le Batch.

objectstring
Requis

Type d'objet.

output_file_idstring | null
Optionnel

ID de fichier de sortie RunAPI

request_countsobject
Requis
request_counts.completedinteger
Requis
request_counts.failedinteger
Requis
request_counts.totalinteger
Requis
statusstring
Requis

Statut du cycle de vie du Batch.

Valeurs autorisées: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled