Developer Knowledge API

API Kiến thức dành cho nhà phát triển 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. API này cung cấp các hàm để tìm kiếm và truy xuất tài liệu, cũng như trả lời các truy vấn:

  • SearchDocumentChunks để tìm URI trang và đoạn nội dung có liên quan dựa trên một truy vấn.
  • 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 truy vấn được lấy từ ngữ liệu 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 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 đây tuỳ thuộc vào quy trình làm việc của mình:

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

Developer Knowledge API và máy chủ MCP Kiến thức dành cho nhà phát triển đượ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 của mình.
    • Bạn muốn xử lý hoặc kết hợp kết quả trước khi chuyển kết quả đó cho 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 toàn bộ nội dung).
    • 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 máy chủ MCP Kiến thức dành cho nhà phát triển và kỹ năng tác nhân khi:
    • Bạn muốn kết nối trợ giúp lập trình hoặc tác nhân 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 tính 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 API Kiến thức dành cho nhà phát triển, trước tiên, bạn cần bật API này cho dự án Google Cloud của mình.

  1. Mở trang Developer Knowledge API trong Thư viện API của Google.
  2. Kiểm tra để đảm bảo 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 vai trò IAM cụ thể nào để bật hoặc sử dụng API.

Xác thực

Bạn có thể xác thực các yêu cầu đối với API Kiến thức dành cho nhà phát triển bằng một trong các phương thức sau:

  • Khoá API: xác thực cá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 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 làm việc sản xuất. Để tìm hiểu thêm về cách thiết lập thông tin xác thực, 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 (gcloud CLI): xác thực các yêu cầu CLI 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ề gcloud CLI để biết hướng dẫn thiết lập.

Phạm vi OAuth

Khi xác thực bằng OAuth 2.0 hoặc tài khoản dịch vụ, Developer Knowledge API và máy chủ MCP Kiến thức dành cho nhà phát triển sẽ chấp nhận các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform: phạm vi mặc định được Thông tin xác thực mặc định của ứng dụng (ADC), gcloud CLI và thư viện ứng dụng chính thức của Google Cloud sử dụng.
  • https://www.googleapis.com/auth/devprofiles.full_control: phạm vi được sử dụng cho các quy trình đồng ý của người dùng OAuth 2.0 và các hoạt động tích hợp máy chủ MCP.
  • https://www.googleapis.com/auth/developerprofiles.readonly: phạm vi chỉ đọc được hỗ trợ cho các tài khoản dịch vụ và thông tin đăng nhập không yêu cầu màn hình xin phép OAuth của người dùng cuối.

Uỷ quyền mã thông báo truy cập

Để xác thực các yêu cầu REST trực tiếp bằng tài khoản dịch vụ hoặc mã truy cập OAuth 2.0, hãy chuyển mã thông báo trong tiêu đề Authorization: Bearer và chỉ định dự án thanh toán của bạn trong X-Goog-User-Project:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Thay thế PROJECT_ID bằng mã dự án Google Cloud của bạn.

Đối với các ứng dụng Python, Node.js, Go và Java, thư viện ứng dụng chính thức sẽ tự động xử lý Thông tin xác thực mặc định của ứng dụng (ADC) và làm mới mã thông báo. Để xem ví dụ, hãy tham khảo bài viết Sử dụng thư viện ứng dụng với Developer Knowledge API.

Tài liệu đi kèm

Hãy 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.

API Kiến thức dành cho nhà phát triển nhằm mục đích cung cấp quyền truy cập vào tài liệu mới nhất dành cho nhà phát triển của Google. 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 đã 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 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ỉ các trang công khai trên Tài liệu tham khảo về ngữ liệu 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.