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

Hướng dẫn này sẽ giúp bạn 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

Trước khi bắt đầu sử dụng Developer Knowledge API, hãy nhớ hoàn tất các bước sau.

Bật API

  1. Mở trang Developer Knowledge API trong thư viện API của Google.
  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.

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 nhập tên cho khoá.
  4. 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ẽ mất một khoảng thời gian 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.
  5. Nhấp vào Tạo.

Trả lời một câu hỏi bằng tính năng tạo thông tin có căn cứ

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 thấy cách đặt câu hỏi và nhận câu trả lời dựa trên tài liệu:

  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 AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Lệnh này sẽ trả về câu trả lời cho câu hỏi của bạn dựa trên tài liệu.

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

Nếu muốn tìm các đoạn tài liệu cụ thể thay vì câu trả lời được tạo, bạn có thể tìm trực tiếp các đoạn tài liệu.

Sử dụng curl để gọi điểm cuối SearchDocumentChunks:

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

Phản hồi bao gồm các khối nội dung phù hợp trong tài liệu và các tham chiếu đến tài liệu mẹ.

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 khối tài liệu đều có một trường parent chứa tên tài nguyên của tài liệu. Bạn có thể dùng trường này với GetDocument để truy xuất toàn bộ nội dung của tài liệu.

Để truy xuất một tài liệu, hãy sao chép trường parent từ một trong các đoạn được trả về bởi searchDocumentChunks và lưu vào một biến môi trường, sau đó sử dụng curl để gọi điểm cuối GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

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

Thao tác 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