自動 REST API リファレンス (ベータ)

Note

自動は、アプリケーション プロファイルが Auto に対して有効になっている外部パートナーに対してベータ版で使用できます。API サーフェスとコントラクトが変更される可能性があります。

エンドポイント：POST https://api.microsoft.ai/v3/auto

すべての要求には、API キーまたはMicrosoft Entra IDアクセス トークンが必要です。 セットアップ手順については、「 認証」 を参照してください。

サンプル依頼

curl -X POST "https://api.microsoft.ai/v3/auto" \
  -H "x-apikey: <Your API key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "Microsoft AI announcements",
    "language": "en",
    "region": "US",
    "location": "lat:47.6062;long:-122.3321",
    "mode": "fast",
    "maxResponseLength": 30000,
    "responseFilter": ["web", "news"]
  }'

Parameters

パラメーター Required タイプ Default Description
query はい 文字列 - 1 ~ 1,000 文字の検索クエリ。 site:演算子と-site:演算子をサポートします。
language いいえ 文字列 en 2 文字の ISO 639-1 インターフェイス言語。
region いいえ 文字列 US 2 文字の市場または国/地域コード。
mode いいえ 文字列 fast fast 速度に優先順位を付けます。 advanced は、包括的性に優先順位を付けます。
maxResponseLength いいえ 整数 30000 応答の最大長。 1500未満の値は1500にクランプされます。500000 を超える値は 500000 にクランプされます。
location いいえ 文字列 - lat:47.6062;long:-122.3321など、lat:<latitude>;long:<longitude>形式の地理的コンテキスト。
responseFilter いいえ 文字列の配列 - 対象となる回答の種類: web、 news、 timezone、 weather、 images、 videos。

応答

成功した証拠応答は、 200 OKを返します。 各結果には、1 つの型指定された証拠オブジェクトと、それをサポートする引用文献が含まれます。 サポートされていない証拠または形式が正しくない証拠は、引用文献と共に省略されます。 指定されたすべての証拠の結果を省略すると、 results は空になります。

AutoEvidenceResponse

Field タイプ Description
results AutoEvidenceResult の配列 その結果を範囲とする引用文献と組み合わせられた証拠項目。
traceId 文字列 デバッグとサポートの関連付け ID。

AutoEvidenceResult

Field タイプ Description
evidence AutoEvidence 生成された型指定された証拠。
citations AutoEvidenceCitation の配列 この証拠の結果のみをサポートする引用。

AutoEvidence

証拠オブジェクトの独自の type 識別子は、 contentのスキーマを選択します。

type content
text Web および News の結果に対して返される文字列証拠。
media/image 画像の結果オブジェクト。
media/video ビデオの結果オブジェクト。
structured/weather Weather オブジェクト。
structured/timeZone タイム ゾーン オブジェクト。

ニュース テキストの証拠には、url、width、heightを含むthumbnailを含めることもできます。 構造化コンテンツは、対応する検索回答と同じパブリック フィールド表示ルールに従います。

AutoEvidenceCitation

Field タイプ Description
contentSource 文字列 引用文献。
title 文字列 引用文献のタイトル。
url 文字列 引用 URL。
lastUpdatedAt 文字列 最終更新日時のタイムスタンプ。
crawledAt 文字列 クロール タイムスタンプ。
language 文字列 コンテンツ言語。
isAdult boolean 引用文献に成人コンテンツが含まれているかどうか。

応答の例

{
  "results": [
    {
      "evidence": {
        "type": "text",
        "content": "Microsoft announced a new set of AI capabilities."
      },
      "citations": [
        {
          "contentSource": "web",
          "url": "https://www.microsoft.com/en-us/ai",
          "title": "Microsoft AI",
          "language": "en",
          "isAdult": false
        }
      ]
    }
  ],
  "traceId": "00000000000000000000000000000000"
}

エラー コード

ステータスコード Description
200 結果のない有効な検索を含め、要求は成功しました。
400 無効なパラメーターまたは形式が正しくない JSON。
401 認証資格情報が見つからないか無効です。
403 認証されたプロファイルが Auto に対して有効になっていません。
429 レートまたはクォータの制限を超えました。
500 内部サービスエラー。
503 必要なサービスは使用できません。
504 要求がタイムアウトしました。

共有エラー スキーマと再試行のガイダンスについては、「 エラー処理」を参照してください。

関連するコンテンツ

  • 最終更新: