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.

Để bắt đầu nhanh, hãy làm theo Hướng dẫn bắt đầu nhanh.

Ngữ liệu của nội dung có thể tìm kiếm được liệt kê trong phần Tài liệu tham khảo về ngữ 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.

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.

  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:

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.