Developer Knowledge API

Xem trước

Sản phẩm này tuân theo "Điều khoản áp dụng cho các Sản phẩm ở giai đoạn trước khi phát hành rộng rãi" trong phần Điều khoản dịch vụ chung của Điều khoản dành riêng cho dịch vụ. Các sản phẩm ở giai đoạn trước khi phát hành rộng rãi được cung cấp "theo nguyên trạng" và có thể bị hạn chế về khả năng hỗ trợ. Để biết thêm thông tin, hãy xem phần mô tả giai đoạn phát hành .

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 (API Kiến thức dành cho nhà phát triển) được thiết kế để trở thành nguồn chính tắc cho quyền truy cập có thể đọ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 2 chức năng chính:

• 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.

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

Tập hợp nội dung có thể tìm kiếm được liệt kê trong phần Tài liệu tham khảo về tập hợp.

Lưu ý về bản xem trước: Bản phát hành xem trước này 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 (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 trên đám mây của Google Cloud.

Mẹo: 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 bằng cách làm theo hướng dẫn của Google Cloud hoặc Firebase.

1. Mở trang Developer Knowledge API (API Kiến thức dành cho nhà phát triển) 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ần có khoá Developer Knowledge API (API Kiến thức dành cho nhà phát triển) để sử dụng Developer Knowledge API (API Kiến thức dành cho nhà phát triển). Cách tạo khoá:

1. Trong bảng điều khiển Cloud cho dự án mà bạn đã bật API, hãy chuyển đến trang Thông tin đăng nhập.
2. Nhấp vào Tạo thông tin đăng nhập, sau đó chọn Khoá API trong trình đơn. Hộp thoại khoá API đã tạo sẽ hiển thị chuỗi cho khoá mới tạo.
3. Nhấp vào Chỉnh sửa khoá API.
4. Trong trường Tên, hãy cung cấp tên cho khoá.
5. Trong mục API restrictions (Hạn chế cho API), chọn Restrict key (Hạn chế cho khoá).
6. Trong danh sách Select APIs (Chọn API), hãy bật Developer Knowledge API (API Kiến thức dành cho nhà phát triển) rồi nhấp vào OK.
   • Lưu ý: Nếu bạn vừa bật Developer Knowledge API, thì có thể sẽ có một khoảng thời gian trễ trước khi API này xuất hiện trong danh sách Select APIs (Chọn API).
7. Nhấp vào Lưu.

Đưa khoá Developer Knowledge API (API Kiến thức dành cho nhà phát triển) 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 khoá 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 được đưa vào

Hãy tham khảo Tài liệu tham khảo về tập hợp để biết thông tin về những tài liệu mà API tìm kiếm.

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ề tập hợp 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.