La classe WebhooksServer() permet de créer une instance d'une application Gradio capable de recevoir des webhooks Huggingface. Ces webhooks peuvent être enregistrés à l'aide du décorateur add_webhook(). Les points de terminaison des webhooks sont ajoutés à l'application en tant que point de terminaison POST du routeur FastAPI. Une fois tous les webhooks enregistrés, la méthode launch doit être appelée pour démarrer l'application.

Il est recommandé d’accepter WebhookPayload comme premier argument de la fonction webhook. Il s’agit d’un modèle Pydantic qui contient toutes les informations relatives à l’événement webhook. Les données seront analysées automatiquement pour vous.

Consultez le guide des webhooks pour un tutoriel étape par étape sur la configuration de votre WebhooksServer et son déploiement sur un Space.

WebhooksServer est expérimental. Son API est susceptible d’évoluer à l’avenir.

Vous devez avoir gradio installé pour utiliser WebhooksServer (pip install --upgrade gradio).

import gradio as gr
from huggingface_hub import WebhooksServer, WebhookPayload

with gr.Blocks() as ui:
    ...

app = WebhooksServer(ui=ui, webhook_secret="my_secret_key")

@app.add_webhook("/say_hello")
async def hello(payload: WebhookPayload):
    return {"message": "hello"}

app.launch()

Décorateur pour démarrer un WebhooksServer() et enregistrer la fonction décorée en tant que point de terminaison de webhook.

Ceci est un utilitaire pour démarrer rapidement. Si vous avez besoin de plus de flexibilité (page d’accueil personnalisée ou secret de webhook), vous pouvez utiliser WebhooksServer() directement. Vous pouvez enregistrer plusieurs points de terminaison de webhook (sur le même serveur) en utilisant ce décorateur plusieurs fois.

Consultez le guide des webhooks pour un tutoriel étape par étape sur la configuration de votre serveur et son déploiement sur un Space.

webhook_endpoint est expérimental. Son API est susceptible d'évoluer à l'avenir.

Vous devez avoir gradio installé pour utiliser webhook_endpoint (pip install --upgrade gradio).

Exemples : L'utilisation par défaut consiste à enregistrer une fonction en tant que point de terminaison de webhook. Le nom de la fonction sera utilisé comme chemin. Le serveur sera démarré automatiquement à la sortie (c'est-à-dire à la fin du script).

from huggingface_hub import webhook_endpoint, WebhookPayload

@webhook_endpoint
async def trigger_training(payload: WebhookPayload):
    if payload.repo.type == "dataset" and payload.event.action == "update":
        # Trigger a training job if a dataset is updated
        ...

# Server is automatically started at the end of the script.

Utilisation avancée : enregistrez une fonction en tant que point de terminaison de webhook et démarrez le serveur manuellement. Cela est utile si vous l’exécutez dans un notebook.

from huggingface_hub import webhook_endpoint, WebhookPayload

@webhook_endpoint
async def trigger_training(payload: WebhookPayload):
    if payload.repo.type == "dataset" and payload.event.action == "update":
        # Trigger a training job if a dataset is updated
        ...

# Start the server manually
trigger_training.launch()