Skip to content

Tài liệu tham khảo

Phần này chứa các tài liệu tham khảo kỹ thuật chi tiết.

API Reference

Tài liệu API được tạo tự động và có sẵn tại endpoint /docs khi ứng dụng đang chạy.

Nó cung cấp thông tin chi tiết về tất cả các endpoints, bao gồm:

  • Paths (e.g., /chat, /history)
  • Methods (POST, GET, etc.)
  • Tham số đầu vào (request bodies, query parameters)
  • Dữ liệu trả về (response models)
  • Mã lỗi

Để xem tài liệu API:

  1. Chạy ứng dụng (xem Hướng dẫn bắt đầu nhanh).
  2. Mở trình duyệt và truy cập http://localhost:8686/docs.

Cấu hình

Các biến môi trường và tệp cấu hình được quản lý bởi app.config.Settings.

Biến môi trường

Các biến môi trường chính cần được định nghĩa trong tệp .env:

  • DATABASE_URL: Chuỗi kết nối đến cơ sở dữ liệu PostgreSQL.
  • OPENAI_API_KEY: API key cho dịch vụ của OpenAI.
  • SECRET_KEY: Khóa bí mật để tạo JWT.
  • ... (thêm các biến quan trọng khác)

user.json

Tệp này chứa thông tin về người dùng mẫu hoặc các cấu hình liên quan đến người dùng.

tracing_env.json

Cấu hình cho việc theo dõi (tracing) và giám sát hiệu năng, ví dụ như LangSmith.