API tìm kiếm trên web — Tìm kiếm trên web cho ứng dụng của bạn Tài liệu

1. Xác thực

Gọi từ máy chủ của bạn với tiêu đề api-key và Content-Type: application/json. Giữ chìa khóa của bạn ở chế độ riêng tư.

2. Thông số yêu cầu

Yêu cầu chỉ hỗ trợ truy vấn, đếm và search_lang. truy vấn chấp nhận câu hỏi hoặc từ khóa bằng ngôn ngữ tự nhiên.

Trường	Loại	Bắt buộc	Mô tả
query	string	Có	Một câu hỏi tìm kiếm hoặc từ khóa. Không được để trống.
count	integer	Không	Số kết quả mong muốn. Bỏ qua hoặc chuyển số 0 để sử dụng dịch vụ mặc định.
search_lang	string	Không	Ngôn ngữ tìm kiếm, ví dụ zh-hans. Dịch vụ bình thường hóa zh thành zh-hans. Nhấp vào hàng này để xem danh sách được hỗ trợ.

3. Gọi API tìm kiếm

POSThttps://api.starsg.ai/api/product/websearch/search

Thay thế YOUR_API_KEY và đặt truy vấn cho văn bản tìm kiếm của bạn. số lượng và search_lang là tùy chọn.

bash

curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
  -H 'api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "北京今天的天气",
  "count": 5,
  "search_lang": "zh-hans"
}'

Gửi trực tiếp một đối tượng JSON mà không cần có phần bao bọc nội dung hoặc phần bổ sung /v1.

4. Đọc kết quả

Kiểm tra thành công trước. Khi thành công, hãy đọc data.references và data.data; khi thất bại, hãy kiểm tra errorCode và errorMsg. Nội dung web dưới đây mang tính minh họa.

Phản hồi thành công

json

{
  "success": true,
  "data": {
    "references": [
      {
        "website": "example.com",
        "logo": "https://example.com/favicon.ico",
        "title": "Ví dụ về tin tức nhà thông minh",
        "url": "https://example.com/article",
        "summary": "Tóm tắt kết quả tìm kiếm ở đây.",
        "published": "",
        "extra": {}
      }
    ],
    "data": [
      "Tóm tắt kết quả tìm kiếm ở đây."
    ]
  },
  "errorCode": null,
  "errorMsg": null
}

`data.references`	Tài liệu tham khảo trên web có tiêu đề, liên kết và tóm tắt.
`data.data`	Danh sách văn bản kết quả, được lồng bên trong đối tượng dữ liệu bên ngoài.
`references[].website / logo`	Tên trang web hoặc tên miền và URL logo.
`references[].title / url / summary`	Tiêu đề kết quả, URL trang gốc và tóm tắt.
`references[].published / extra`	Ngày xuất bản và thông tin bổ sung. Có thể trống rỗng.

success=true với các tham chiếu và mảng dữ liệu trống có nghĩa là không tìm thấy kết quả hợp lệ. Hãy thử các từ khóa khác hoặc ngôn ngữ tìm kiếm khác; đừng coi đó là lỗi API.

Phản hồi lỗi

json

{
  "success": false,
  "data": null,
  "errorCode": "PARAM_INVALID",
  "errorMsg": "query is required"
}

Các lỗi thường gặp và các bước tiếp theo

`PARAM_INVALID`	Kiểm tra JSON và truy vấn. Sửa các thông số trước khi thử lại.
`SEARCH_FAILED`	Việc tìm kiếm không thành công. Thử lại sau với giới hạn số lần thử. Đối với những lỗi liên tục, hãy lưu thời gian gọi và yêu cầu mã định danh để được hỗ trợ.