Hướng dẫn nhanh: Bắt đầu sử dụng Developer Knowledge API

Hướng dẫn này sẽ cho bạn biết cách bắt đầu sử dụng Developer Knowledge API. Bạn sẽ tìm hiểu cách bật Developer Knowledge API, lấy khoá API và thực hiện các lệnh gọi API đầu tiên để tìm kiếm và truy xuất tài liệu dành cho nhà phát triển.

Trước khi bắt đầu

Bật API

  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.

Tạo và bảo mật khoá API

  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 xác thực, rồi chọn Khoá API trong trình đơn.
  3. Trong trường Name (Tên), hãy cung cấp tên cho khoá.
  4. Nhấp vào trình đơn thả xuống Select API restrictions, rồi nhập Developer Knowledge API. Nhấp vào kết quả, rồi nhấp vào OK.
    • Lưu ý: Nếu bạn vừa bật API Thông tin về nhà phát triển, 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. Hãy đợi vài phút rồi thử lại.
  5. Nhấp vào Tạo.

Tìm kiếm các đoạn tài liệu

Sau khi có khoá API Developer Knowledge, bạn có thể bắt đầu sử dụng API này. Ví dụ sau đây cho biết cách tìm kiếm các đoạn tài liệu liên quan đến "BigQuery":

  1. Lưu khoá API Developer Knowledge vào một biến môi trường:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Thay thế YOUR_API_KEY bằng khoá API mà bạn đã tạo.

  2. Sử dụng curl để gọi điểm cuối searchDocumentChunks:

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Lệnh này trả về danh sách các đoạn tài liệu khớp với truy vấn, bao gồm cả các đoạn trích từ nội dung và parent cho từng tài liệu.

Truy xuất tài liệu

Phản hồi từ searchDocumentChunks chứa danh sách các đoạn tài liệu. Mỗi đoạn tài liệu có một trường parent. Bạn có thể sử dụng trường này để truy xuất toàn bộ nội dung của tài liệu bằng GetDocument.

Sao chép parent của một trong các đoạn tài liệu do lệnh gọi searchDocumentChunks trả về (ví dụ: documents/developers.google.com/...), lưu vào một biến môi trường và sử dụng curl để gọi điểm cuối GetDocument:

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Lệnh này trả về toàn bộ nội dung Markdown của tài liệu được chỉ định.

Bước tiếp theo

  • Khám phá tài liệu tham khảo về Corpus để xem danh sách đầy đủ các tài liệu được đưa vào.
  • Xem tài liệu tham khảo API để biết thêm thông tin chi tiết về các phương thức và tham số của API.