Bỏ qua đến nội dung chính

JSON Schema for tools

📖 Nội dung bài học

Tóm tắt

Sau khi tạo hàm tool, bước tiếp theo là viết JSON schema để mô tả nó. Schema này cho Claude biết hàm của bạn mong đợi các đối số nào và cách sử dụng nó đúng cách. Mặc dù cấu hình có vẻ đáng sợ lúc đầu, nhưng thực ra nó rất đơn giản khi bạn hiểu quy trình.

Tìm hiểu về JSON Schema

JSON Schema không phải là thứ chỉ được phát minh cho các tool AI - nó đã tồn tại nhiều năm như một tiêu chuẩn để xác thực dữ liệu. Schema có hai phần chính: tên và mô tả ở trên cùng (giúp Claude hiểu khi nào nên dùng tool) và schema thực tế mô tả các đối số của hàm.

Phần trên cùng chứa tên và mô tả của tool, giúp Claude hiểu khi nào nên dùng nó. Phần dưới cùng là schema thực tế mô tả chi tiết các đối số của hàm của bạn.

Tạo JSON Schema: Từng bước

Đây là cách đơn giản nhất để tạo JSON schema cho bất kỳ hàm nào:

Bước 1: Viết một Dictionary với Dữ liệu Mẫu

Lấy hàm của bạn và tạo một dictionary của tất cả các đối số từ khóa với dữ liệu mẫu. Ví dụ, nếu bạn có một hàm như sau:

def process_data(ids, profile, primary_id, value):
    pass

Tạo một dictionary với các giá trị mẫu:

Bước 2: Chuyển đổi sang JSON

Chuyển đổi dictionary Python của bạn sang định dạng JSON thích hợp. Điểm khác biệt chính là thay đổi True của Python thành true của JSON.

Bước 3: Dùng một Công cụ Chuyển đổi Trực tuyến

Tìm kiếm "JSON to JSON Schema converter" và dùng một trong nhiều công cụ trực tuyến miễn phí. Dán dữ liệu JSON của bạn và để nó tự động tạo schema.

Công cụ sẽ phân tích dữ liệu mẫu của bạn và tạo cấu trúc schema thích hợp. Xóa mọi khai báo $schema khỏi đầu ra - bạn không cần chúng.

Bước 4: Thêm Mô tả

Bước quan trọng nhất là thêm mô tả chi tiết cho từng thuộc tính. Những mô tả này giúp Claude hiểu chính xác từng đối số làm gì và cách dùng nó.

Viết Mô tả Tốt

Khi viết mô tả cho tool và thuộc tính của bạn, hãy tuân theo các phương pháp hay nhất sau:

  • Giải thích tool làm gì, khi nào nên dùng và nó trả về gì
  • Đặt mục tiêu 3-4 câu trong mô tả tool của bạn
  • Cung cấp mô tả siêu chi tiết cho từng thuộc tính
  • Nếu bạn gặp khó khăn, hãy dán hàm của bạn vào Claude và yêu cầu nó viết mô tả cho bạn

Đây là một ví dụ về schema tool được mô tả tốt:

Lưu ý cách mô tả giải thích rõ ràng tool thời tiết làm gì, khi nào nên dùng, dữ liệu nào nó trả về và cung cấp các ví dụ cụ thể về các định dạng vị trí hợp lệ.

Kết hợp Tất cả lại với nhau

JSON schema cuối cùng của bạn sẽ có dạng cấu trúc như sau, với toolSpec chứa tên, mô tả và inputSchema với các thông số kỹ thuật đối số chi tiết:

Schema hoạt động như một hợp đồng giữa code của bạn và Claude, đảm bảo rằng khi Claude quyết định dùng tool của bạn, nó biết chính xác thông tin nào cần cung cấp và ở định dạng nào. Sự giao tiếp rõ ràng này là điều khiến việc dùng tool trở nên đáng tin cậy và hiệu quả.

🔁 Bài học liên quan

📚 Nguồn & ghi nhận

Bài học có hữu ích không?

Góp ý / Báo lỗiPhát hiện sai sót hoặc có ý tưởng cải thiện?