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.GetDocumenthoặcBatchGetDocumentsđể tìm nạp toàn bộ nội dung của(các) kết quả tìm kiếm.AnswerQueryđể nhận câu trả lời cho các truy vấn dựa trên tập hợp tài liệu.
Để bắt đầu nhanh chóng, 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 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.
- Mở trang Developer Knowledge API trong thư viện API của Google.
- Kiểm tra để đảm bảo rằng bạn đã chọn đúng dự án mà bạn dự định sử dụng API.
- 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 phải có khoá Developer Knowledge API để sử dụng Developer Knowledge API. Cách tạo một bộ sưu tập:
- Trong Google Cloud Console cho dự án mà bạn đã bật API, hãy chuyển đến trang Thông tin đăng nhập.
- Nhấp vào Tạo thông tin xác thực, rồi chọn Khoá API trong trình đơn.
- Trong trường Name (Tên), hãy nhập tên cho khoá.
-
Nhấp vào trình đơn thả xuống Select API restrictions (Chọn hạn chế cho API), rồi nhập Developer Knowledge API (API Kiến thức dành cho nhà phát triển). Nhấp vào kết quả, rồi nhấp vào OK.
Lưu ý:
- Nếu bạn vừa bật Developer Knowledge API, có thể sẽ có một độ trễ trước khi API này xuất hiện trong danh sách. Vui lòng đợi vài phút rồi thử lại.
-
Nếu dự định dùng cùng một khoá này cho các lệnh gọi mô hình chung của ứng dụng AI (ví dụ:
GEMINI_API_KEY), bạn cũng phải chọn Generative Language API. Nếu không, những cuộc gọi đó sẽ bị chặn.
- Nhấp vào Tạo.
Đưa khoá Developer Knowledge API này vào các yêu cầu của bạn. Ví dụ: các lệnh gọi REST phải bao gồm thông số này bằng cách sử dụng tham số truy vấn key. Hãy tham khảo Hướng dẫn bắt đầu nhanh để xem ví dụ.
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.