Tính năng AI

Chuẩn bị tài liệu API của bạn để sẵn sàng cho AI bằng các tính năng AI cho phép tích hợp liền mạch với các trợ lý AI và công cụ phát triển. Các tính năng này giúp nhà phát triển tận dụng các công cụ AI như Cursor, Cline và các IDE được hỗ trợ bởi AI khác để tăng tốc quá trình tích hợp API và tạo mã.

Yêu cầu phiên bản

Phiên bản Apidog phải ≥ 2.7.2 để truy cập các tính năng này.

Để bật các tính năng này: Điều hướng đến Publish Docs → Publish Docs Sites → AI Features.

Hỏi AI

Tính năng này cho phép chức năng tìm kiếm dạng hội thoại trên trang tài liệu của bạn. Bạn có thể kết nối Trợ lý AI của mình từ Algolia để sử dụng tính năng này. Bạn có thể tìm hiểu thêm về tính năng này trong phần Ask AI của trang Tìm kiếm tài liệu.

Bật MCP (Model Context Protocol)

Khi được bật, nút "MCP" sẽ xuất hiện trong tài liệu của bạn, hướng dẫn người dùng cách kết nối tài liệu API của bạn với các IDE hỗ trợ MCP như Cursor và Cline. Điều này cho phép Agentic AI hỗ trợ tạo mã trực tiếp từ tài liệu API của bạn.

Tìm hiểu thêm

Để xem hướng dẫn thiết lập chi tiết, hãy đọc: Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Bật Sao chép trang

Khi được bật, nút "Sao chép trang" sẽ xuất hiện trong tài liệu của bạn, cho phép người dùng sao chép trang hiện tại ở định dạng Markdown—rất phù hợp để dán vào các cuộc hội thoại với AI.

Bật llms.txt

Khi được bật, một tệp Markdown llms.txt sẽ được tự động tạo trong thư mục gốc của trang tài liệu của bạn. Tệp này chứa các liên kết đến mọi trang Markdown kèm mô tả ngắn gọn, giúp các trợ lý AI dễ dàng khám phá và điều hướng tài liệu của bạn.

Ví dụ:

Cách trợ lý AI sử dụng llms.txt

Có hai phương pháp phổ biến để sử dụng llms.txt và các tệp Markdown liên quan:

1. Chia sẻ liên kết Markdown với các trợ lý AI có thể truy cập URL

Mỗi trang tài liệu trực tuyến được xuất bản thông qua Apidog đều có một phiên bản Markdown. Bạn có thể:

Thêm ".md" vào bất kỳ URL tài liệu nào (ví dụ: https://example.apidog.io/page.md)

Hoặc nhấp vào "Xem dưới dạng Markdown" trong tài liệu trực tuyến

Các trợ lý AI có khả năng Duyệt web có thể sử dụng các URL ".md" này để truy xuất tài liệu ngắn gọn.

Ví dụ, trong Cursor, bạn có thể yêu cầu "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client".

Định dạng prompt

Định dạng prompt phải tuân theo các quy tắc cụ thể của công cụ AI đang được sử dụng. Ví dụ, trong Cursor, URL phải bắt đầu bằng @ để được nhận dạng là ngữ cảnh.

2. Sao chép nội dung Markdown cho các trợ lý AI không thể truy cập URL

Nếu trợ lý AI không thể truy cập nội dung thông qua URL, bạn cần sao chép và dán nội dung Markdown theo cách thủ công.

Nhấp vào nút "Sao chép trang" trong tài liệu trực tuyến để lấy nội dung trang hiện tại ở định dạng Markdown, sau đó dán nội dung đó vào cuộc hội thoại của bạn với trợ lý AI.

Prompt ví dụ:

"Dựa trên định nghĩa endpoint này, vui lòng tạo một TypeScript client: (dán nội dung đã sao chép vào đây)."

Câu hỏi thường gặp

Việc bật llms.txt có ảnh hưởng đến bảo mật tài liệu không?

Không. llms.txt chỉ bao gồm nội dung đã được xuất bản công khai. Nó chỉ đơn giản chuyển đổi HTML sang Markdown và không tiết lộ tài liệu riêng tư hoặc chưa được xuất bản. Nếu kiểm soát truy cập (mật khẩu, danh sách cho phép IP, danh sách cho phép email, v.v.) được cấu hình, người dùng vẫn phải xác thực để truy cập llms.txt và các tệp Markdown.

Tôi có thể sử dụng llms.txt nếu tài liệu của tôi được bảo vệ bằng mật khẩu, IP hoặc danh sách cho phép email không?？

Tại sao tôi không thấy nút `Copy Page` trong Apidog App?

Tôi đã bật tính năng 'Web Search' cho trợ lý AI của mình. Tại sao nó không thể đọc nội dung trang web thông qua URL?

Tôi nên làm gì nếu trợ lý AI không truy cập được tệp Markdown thông qua URL?

Tôi có cần làm thêm gì sau khi bật llms.txt không?

Làm thế nào để tôi xác minh rằng llms.txt đang hoạt động đúng cách?

Hỏi AI#

Bật MCP (Model Context Protocol)#

Bật Sao chép trang#

Bật llms.txt#

Cách trợ lý AI sử dụng llms.txt#

Câu hỏi thường gặp#

Hỏi AI

Bật MCP (Model Context Protocol)

Bật Sao chép trang

Bật llms.txt

Cách trợ lý AI sử dụng llms.txt

Câu hỏi thường gặp