Developer Knowledge API

Developer Knowledge API cung cấp quyền truy cập có lập trình vào tài liệu công khai dành cho nhà phát triển của Google, cho phép bạn tích hợp cơ sở kiến thức này vào các ứng dụng và quy trình làm việc của riêng mình.

Tổng quan

Developer Knowledge API được thiết kế để trở thành nguồn chính tắc cho quyền truy cập có thể đọc được bằng máy vào tài liệu dành cho nhà phát triển của Google. Nó cung cấp các chức năng tìm kiếm và truy xuất tài liệu, đồng thời trả lời các câu hỏi:

• SearchDocumentChunks để tìm URI trang và đoạn nội dung có liên quan dựa trên một cụm từ tìm kiếm.
• GetDocument hoặc BatchGetDocuments để tìm nạp toàn bộ nội dung của(các) kết quả tìm kiếm.
• AnswerQuery để tạo câu trả lời cho các câu hỏi được lấy từ kho tài liệu.

Developer Knowledge API hỗ trợ tìm kiếm và truy xuất các trang tài liệu dưới dạng nội dung Markdown không có cấu trúc. Ngữ liệu của nội dung có thể tìm kiếm được liệt kê trong Tài liệu tham khảo về ngữ liệu.

Cách sử dụng Kiến thức dành cho nhà phát triển

Bạn có thể truy cập vào Kiến thức dành cho nhà phát triển thông qua các nền tảng sau, tuỳ thuộc vào quy trình làm việc của bạn:

• API REST và API RPC: gọi trực tiếp các điểm cuối HTTP hoặc gRPC. Hãy tham khảo thông tin tham khảo về REST và thông tin tham khảo về RPC để biết các quy cách về phương thức.
• Thư viện ứng dụng: tích hợp Developer Knowledge API vào các ứng dụng của bạn bằng cách sử dụng thư viện ứng dụng chính thức cho Python, Node.js và TypeScript, Go, Java, PHP và Ruby.
• Google Cloud CLI (gcloud): chạy các lệnh gcloud developer-knowledge từ thiết bị đầu cuối để tìm kiếm các đoạn tài liệu, tìm nạp nội dung Markdown và tạo câu trả lời.
• Máy chủ MCP Kiến thức dành cho nhà phát triển: kết nối trợ lý hoặc tác nhân lập trình AI của bạn với tài liệu của Google bằng các công cụ Giao thức ngữ cảnh mô hình (MCP) (search_documents, get_documents và answer_query). Hãy tham khảo tài liệu tham khảo về MCP.

Lưu ý: Nếu bạn đang dùng một trợ lý lập trình AI, hãy cài đặt kỹ năng tác nhân retrieving-developer-knowledge bằng cách chạy npx skills add google/skills --skill retrieving-developer-knowledge. Kỹ năng này cung cấp cho trợ lý của bạn các hướng dẫn tích hợp về công cụ máy chủ MCP Developer Knowledge cần chọn, cách xử lý lỗi và cách gọi API REST bằng curl nếu máy chủ MCP không hoạt động. Để tìm hiểu thêm, hãy xem bài viết Sử dụng kỹ năng của tác nhân Kiến thức dành cho nhà phát triển.

Chọn giữa API và máy chủ MCP

Developer Knowledge API và máy chủ Developer Knowledge MCP được thiết kế cho các nhu cầu tích hợp khác nhau:

• Sử dụng Developer Knowledge API, thư viện ứng dụng hoặc gcloud CLI khi:
  • Dự án của bạn không sử dụng tác nhân AI.
  • Bạn muốn xác định các công cụ hoặc bộ công cụ tuỳ chỉnh cho tác nhân.
  • Bạn muốn xử lý hoặc kết hợp kết quả trước khi truyền chúng đến một mô hình (ví dụ: kiểm tra độ dài byte của tài liệu trước khi tìm nạp nội dung đầy đủ).
  • Bạn cần lọc kết quả tìm kiếm (chẳng hạn như theo data_source hoặc update_time) hoặc áp dụng mặt nạ trường.
• Sử dụng kỹ năng về tác nhân và máy chủ MCP của Kiến thức dành cho nhà phát triển khi:
  • Bạn muốn kết nối một trợ lý hoặc tác nhân lập trình AI mà không cần viết nội dung mô tả và định nghĩa công cụ tuỳ chỉnh.
  • Bạn muốn cập nhật tự động khi máy chủ MCP Kiến thức dành cho nhà phát triển thêm các chức năng mới.
  • Bạn không cần lọc siêu dữ liệu tuỳ chỉnh trên kết quả tìm kiếm.

Bật API

Để sử dụng Developer Knowledge API, trước tiên bạn cần bật API này cho dự án trên đám mây của Google Cloud.

Lưu ý: Nếu bạn không có dự án trên đám mây của Google, hãy tạo một dự án theo hướng dẫn của Google Cloud hoặc Firebase.

1. Mở trang Developer Knowledge API trong thư viện Google API.
2. Kiểm tra để đảm bảo rằng bạn đã chọn đúng dự án mà bạn dự định sử dụng API.
3. Nhấp vào Bật. Bạn không cần có vai trò IAM cụ thể để bật hoặc sử dụng API này.

Xác thực

Bạn có thể xác thực các yêu cầu đến Developer Knowledge API bằng một trong những phương thức sau:

• Khoá API: xác thực yêu cầu REST trực tiếp hoặc máy chủ MCP Kiến thức dành cho nhà phát triển bằng cách sử dụng tham số truy vấn key hoặc tiêu đề X-Goog-Api-Key.
• Thông tin xác thực mặc định của ứng dụng (ADC), OAuth 2.0 hoặc tài khoản dịch vụ: xác thực các yêu cầu khi sử dụng thư viện ứng dụng chính thức hoặc quy trình sản xuất. Để tìm hiểu thêm về cách thiết lập thông tin đăng nhập, hãy tham khảo tài liệu về Thông tin xác thực mặc định của ứng dụng.
• Thông tin đăng nhập của người dùng (giao diện dòng lệnh gcloud): xác thực các yêu cầu của giao diện dòng lệnh bằng cách đăng nhập vào tài khoản Google Cloud của bạn bằng gcloud auth login. Hãy tham khảo phần bắt đầu nhanh với gcloud CLI để biết hướng dẫn thiết lập.

Tài liệu đi kèm

Tham khảo Tài liệu tham khảo về ngữ liệu để biết thông tin về những tài liệu mà API tìm kiếm.

Developer Knowledge API hướng đến việc cung cấp quyền truy cập vào tài liệu mới nhất của Google dành cho nhà phát triển. Mục tiêu của chúng tôi là lập chỉ mục lại nội dung trong vòng 48 giờ kể từ khi xuất bản để tài liệu mới hoặc tài liệu đã cập nhật có sẵn trong vòng 2 ngày làm việc.

Các hạn chế đã biết

• Chất lượng của Markdown: Markdown được tạo từ HTML nguồn. Có thể có một số điểm khác biệt hoặc vấn đề về định dạng.
• Phạm vi nội dung: Chỉ những trang công khai trên Corpus reference mới được đưa vào. Nội dung từ các nguồn khác như GitHub, các trang web OSS, blog hoặc YouTube không được đưa vào.