Сервер вебхуков

Webhooks являются основой для функций, связанных с MLOps. Они позволяют отслеживать новые изменения в конкретных репозиториях или во всех репозиториях, принадлежащих определённым пользователям или организациям, за которыми вы хотите следить. Чтобы узнать больше о webhooks в Huggingface Hub, вы можете прочитать руководство по Webhooks.

Ознакомьтесь с этим руководством с пошаговым учебником о том, как настроить сервер вебхуков и развернуть его как Space.

Это экспериментальная функция. Это означает, что мы продолжаем дорабатывать API. В будущем могут быть внесены изменения, нарушающие обратную совместимость, без предварительного уведомления. Убедитесь, что вы зафиксировали версию huggingface_hub в своих зависимостях. Предупреждение выводится при использовании экспериментальной функции. Вы можете отключить его, задав переменную окружения HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1.

Сервер

Сервер представляет собой приложение Gradio. В нём есть интерфейс для отображения инструкций для вас или ваших пользователей, а также API для приёма вебхуков. Реализация конечной точки вебхука сводится к декорированию функции. Затем вы можете отладить её, перенаправив вебхуки на ваш компьютер (используя туннель Gradio), прежде чем развернуть приложение в 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()

Параметры

WebhookPayload — это основная структура данных, содержащая полезную нагрузку от Webhooks. Это класс pydantic, что делает его очень удобным для использования с FastAPI. Если передать его в качестве параметра в endpoint вебхука, он будет автоматически валидирован и распарсен как объект Python.

Для получения дополнительной информации о содержимом вебхуков обратитесь к руководству по содержимому вебхуков.

WebhookPayload

WebhookPayloadComment

WebhookPayloadDiscussion

WebhookPayloadDiscussionChanges

WebhookPayloadEvent

WebhookPayloadMovedTo

WebhookPayloadRepo

WebhookPayloadUrl

WebhookPayloadWebhook