Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Documentation: examples of validators and config for create validator config endpoint

Đang mở
#69 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét các guardrail khi chạy và các API endpoint để tạo cấu hình validator, sau đó so sánh các yêu cầu cấu hình của chúng với README của repository. Công việc được hoàn tất khi tài liệu API bao gồm các request body mẫu và cấu hình tương ứng cho tất cả validator.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation

Describe the current behaviour
Currently when we use the run guardrails endpoint or create validator config we don't have any documentation with api endpoints that we can refer to which tells us what configuration we have to set for each validator. users will have to read through repo's readme to get to know about validator specific configuration.

Describe the enhancement you'd like
Add documentation in the api itself about sample request body when saving or sending config of all the validators, with their respective config.

Ngôn ngữ chính
Python
Star
5
Fork
3
Merge trung bình
9 ngày 13 giờ
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ProjectTech4DevAI/kaapi-guardrails

Tất cả issue của ProjectTech4DevAI/kaapi-guardrails

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.