Web 検索 API — Web でアプリを検索ドキュメント

1。認証

API-key と Content-Type: application/json ヘッダーを使用してサーバーから呼び出します。キーを秘密にしておきます。

2。リクエストパラメータ

リクエストはクエリ、カウント、および search_lang のみをサポートします。クエリは自然言語の質問またはキーワードを受け入れます。

フィールド	種類	必須	説明
query	string	はい	検索の質問またはキーワード。空であってはなりません。
count	integer	いいえ	必要な結果の数。サービスのデフォルトを使用するには、0 を省略するか渡します。
search_lang	string	いいえ	検索言語 (zh-hans など)。このサービスは、zh を zh-hans に正規化します。サポートされているリストについては、この行をクリックしてください。

3。検索に電話してください API

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

YOUR_API_KEY を置き換えて、クエリを検索テキストに設定します。 count と search_lang はオプションです。

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"
}'

本文ラッパーや追加の /v1 を使用せずに、JSON オブジェクトを直接送信します。

4。結果を読む

まず成功を確認してください。成功すると、data.references と data.data を読み取ります。障害が発生した場合は、errorCode および errorMsg を検査します。以下の Web コンテンツは一例です。

成功の応答

json

{
  "success": true,
  "data": {
    "references": [
      {
        "website": "example.com",
        "logo": "https://example.com/favicon.ico",
        "title": "スマートホームニュースの例",
        "url": "https://example.com/article",
        "summary": "検索結果の概要がここに表示されます。",
        "published": "",
        "extra": {}
      }
    ],
    "data": [
      "検索結果の概要がここに表示されます。"
    ]
  },
  "errorCode": null,
  "errorMsg": null
}

`data.references`	タイトル、リンク、概要を含む Web 参照。
`data.data`	外部データオブジェクト内にネストされた結果テキストリスト。
`references[].website / logo`	Web サイト名またはドメインとロゴ URL。
`references[].title / url / summary`	結果のタイトル、元のページ URL、および概要。
`references[].published / extra`	出版日と追加情報。空いているかもしれません。

success=true で参照とデータ配列が空の場合は、有効な結果が見つからなかったことを意味します。別のキーワードまたは別の検索言語を試してください。 API の障害として扱わないでください。

エラー応答

json

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

よくあるエラーと次のステップ

`PARAM_INVALID`	JSONを確認して問い合わせてください。再試行する前にパラメータを修正してください。
`SEARCH_FAILED`	検索は失敗しました。試行回数を制限して後で再試行します。永続的な障害の場合は、呼び出し時間を保存し、サポート用の ID を要求します。