Máy chủ Webhooks

Webhooks là nền tảng cho các tính năng liên quan đến MLOps. Chúng cho phép bạn lắng nghe các thay đổi mới trên các repo cụ thể hoặc trên tất cả các repo thuộc các người dùng/tổ chức nhất định mà bạn quan tâm. Để tìm hiểu thêm về webhooks trên Huggingface Hub, bạn có thể đọc hướng dẫn về Webhooks.

Xem hướng dẫn này để có hướng dẫn từng bước về cách thiết lập máy chủ webhooks của bạn và triển khai nó dưới dạng một Space.

Đây là một tính năng thử nghiệm. Điều này có nghĩa là chúng tôi vẫn đang tiếp tục cải thiện API. Các thay đổi gây mất tương thích có thể được đưa ra trong tương lai mà không có thông báo trước. Hãy đảm bảo cố định phiên bản của huggingface_hub trong các yêu cầu của bạn. Một cảnh báo sẽ được kích hoạt khi bạn sử dụng một tính năng thử nghiệm. Bạn có thể tắt nó bằng cách đặt HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1 như một biến môi trường.

Máy chủ

Server là một ứng dụng Gradio. Nó có giao diện người dùng để hiển thị các hướng dẫn cho bạn hoặc người dùng của bạn, cùng với một API để lắng nghe các webhook. Việc triển khai một điểm cuối webhook đơn giản như việc trang trí một hàm. Sau đó, bạn có thể gỡ lỗi bằng cách chuyển hướng các Webhooks đến máy của mình (sử dụng đường hầm Gradio) trước khi triển khai lên một 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 là cấu trúc dữ liệu chính chứa payload từ Webhooks. Đây là một class pydantic, giúp việc sử dụng với FastAPI trở nên rất dễ dàng. Nếu bạn truyền nó làm tham số cho một webhook endpoint, nó sẽ được xác thực và phân tích tự động thành một đối tượng Python.

Để biết thêm thông tin về payload của webhooks, bạn có thể tham khảo hướng dẫn về Webhooks Payload.

WebhookPayload

WebhookPayloadComment

WebhookPayloadDiscussion

WebhookPayloadDiscussionChanges

WebhookPayloadEvent

WebhookPayloadMovedTo

WebhookPayloadRepo

WebhookPayloadUrl

WebhookPayloadWebhook