Servidor de Webhooks

Webhooks são a base para recursos relacionados a MLOps. Eles permitem que você acompanhe novas alterações em repositórios específicos ou em todos os repositórios pertencentes a usuários/organizações específicos que você deseja acompanhar. Para saber mais sobre webhooks no Huggingface Hub, você pode ler o guia de Webhooks.

Confira este guia para um tutorial passo a passo sobre como configurar seu servidor de webhooks e implantá-lo como um Space.

Este é um recurso experimental. Isso significa que ainda estamos trabalhando para melhorar a API. Alterações que quebram a compatibilidade podem ser introduzidas no futuro sem aviso prévio. Certifique-se de fixar a versão de huggingface_hub nos seus requisitos. Um aviso é acionado quando você usa um recurso experimental. Você pode desativá-lo definindo HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1 como uma variável de ambiente.

Servidor

O servidor é um aplicativo Gradio. Ele possui uma interface para exibir instruções para você ou seus usuários e uma API para receber webhooks. Implementar um endpoint de webhook é tão simples quanto decorar uma função. Em seguida, você pode depurá-lo redirecionando os Webhooks para sua máquina (usando um túnel do Gradio) antes de implantá-lo em um 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 é a principal estrutura de dados que contém o payload dos Webhooks. Trata-se de uma classe pydantic, o que facilita muito seu uso com FastAPI. Se você a passar como parâmetro para um endpoint de webhook, ela será validada e analisada automaticamente como um objeto Python.

Para mais informações sobre o payload de webhooks, você pode consultar o guia de Payload de Webhooks.

WebhookPayload

WebhookPayloadComment

WebhookPayloadDiscussion

WebhookPayloadDiscussionChanges

WebhookPayloadEvent

WebhookPayloadMovedTo

WebhookPayloadRepo

WebhookPayloadUrl

WebhookPayloadWebhook