Servidor de Webhooks

Los webhooks son la base de las funciones relacionadas con MLOps. Permiten escuchar nuevos cambios en repositorios específicos o en todos los repositorios que pertenecen a usuarios u organizaciones concretos que desees seguir. Para obtener más información sobre los webhooks en Huggingface Hub, puedes leer la guía de webhooks.

Consulta esta guía para un tutorial paso a paso sobre cómo configurar tu servidor de webhooks y desplegarlo como un Space.

Esta es una función experimental. Esto significa que seguimos trabajando en la mejora de la API. Es posible que se introduzcan cambios que rompan la compatibilidad en el futuro sin previo aviso. Asegúrate de fijar la versión de huggingface_hub en tus requisitos. Se emite una advertencia cuando usas una función experimental. Puedes desactivarla estableciendo HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1 como variable de entorno.

Servidor

El servidor es una aplicación de Gradio. Cuenta con una interfaz de usuario para mostrar instrucciones para ti o para tus usuarios y una API para escuchar webhooks. Implementar un punto de finalización de webhook es tan sencillo como decorar una función. Luego puedes depurarlo redirigiendo los Webhooks a tu máquina (usando un túnel de Gradio) antes de desplegarlo en un Space.

WebhooksServer

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()

@webhook_endpoint

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.

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()

Payload

WebhookPayload es la estructura de datos principal que contiene el payload de los Webhooks. Se trata de una clase de pydantic, lo que facilita mucho su uso con FastAPI. Si la pasas como parámetro a un endpoint de webhook, se validará y analizará automáticamente como un objeto de Python.

Para obtener más información sobre el payload de los webhooks, puede consultar la guía de Webhooks Payload.

WebhookPayload

WebhookPayloadComment

WebhookPayloadDiscussion

WebhookPayloadDiscussionChanges

WebhookPayloadEvent

WebhookPayloadMovedTo

WebhookPayloadRepo

WebhookPayloadUrl

WebhookPayloadWebhook