エンドポイント：POST https://api.microsoft.ai/v3/search/news
サンプル要求:
curl -X POST "https://api.microsoft.ai/v3/search/news" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H "content-type: application/json" \
-d '{
"query": "latest VC funding in tech",
"maxResults": 10,
"language": "en",
"region": "US",
"maxLength": 3000,
"contentFormat": "passage"
}'
Parameters
| パラメーター | Required | タイプ | Default | Description |
|---|---|---|---|---|
| クエリ | はい | 文字列 | - | ニュース結果の検索クエリ。 最大長は 1000 文字です。 |
| maxResults | いいえ | 整数 | 10 | 返される結果の最大数。 既定値は 10 です。 最大値は 20 です。 |
| 言語 | いいえ | 文字列 | "en" | 検索結果のインターフェイス言語の 2 文字の ISO 639-1 言語コード。 完全な一覧については、「 サポートされている言語 」を参照してください。 |
| リージョン | いいえ | 文字列 | "US" | 結果の取得先の 2 文字の国/地域コード (例: "US"、"JP"、"GB")。 完全な一覧については、「 サポートされているリージョン 」を参照してください。 |
| 位置 | いいえ | 文字列 | - | 場所情報の形式は "lat:<float>;long:<float>", 例: "lat:40.753250;long:-74.003807" |
| コンテンツフォーマット | いいえ | 文字列 | "passage" ("text" with full document access) |
passage は、クエリに最も関連する各結果の部分を返します (接地に推奨)。
textを html し、 markdown 完全なドキュメントを返し、完全なドキュメント アクセス権を持つアプリケーションにのみ適用されます。 「パッサージュとコンテンツ形式」を参照してください。 すべての要求に対して設定します。 |
| マックスレングス | いいえ | 整数 | 3000 (完全なドキュメント アクセス権を持つ 10000) | 結果あたりの content の最大文字数は 1 ~ 5,0000 文字です。 完全なドキュメント アクセスがない場合、 content は最大 3,000 文字です。
「既定値と制限」を参照してください。 すべての要求に対して設定します。 |
コンテンツ形式
contentFormat
=
passageを設定して、クエリに最も関連する各結果の部分を取得します。最大maxLength文字 (3000 が適切な開始点です)。 これは接地に推奨される形式です。FAQ の 「 passageとは何か、なぜ使用するのか 」を参照してください。 完全なドキュメント アクセス権を持つアプリケーションは、 text、 html 、または markdownとしてドキュメント全体を要求することもできます。他のアプリケーションの場合、これらの形式では HTTP 403 が返されます。 「 節とコンテンツの形式」を参照してください。
要求ヘッダー
| Field | タイプ | Description |
|---|---|---|
| ホスティング | 文字列 | Microsoft AI API のホスト: api.microsoft.ai。 |
| x-apikey または Authorization | 文字列 | 認証用の API キーまたはEntra IDアクセス トークン。 |
| コンテンツタイプ | 文字列 | 要求本文の MIME の種類。
application/json を使用してください。 |
応答
ニュースの応答
| Field | タイプ | Description |
|---|---|---|
| newsResults | newsResult の配列 | ニュース記事の結果の一覧。 |
| instrumentationClickBase | 文字列 | クリック ping 要求のベース URL。 結果項目から instrumentationSuffix 値を追加して、完全な ping URL を形成します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。 注: ユーザーのクリックは、URL リダイレクトを使用してログに記録することもできます。 リダイレクトが有効になっている場合、ユーザーのクリックをログに記録するためのアクションは必要なく、 instrumentationClickBase は応答に含まれません。 セットアップ手順については、 インストルメンテーション ガイド を参照してください。 |
| instrumentationCitationBase | 文字列 | LLM ログ ping 要求のベース URL。 完全な ping URL を形成する DATA ペイロードを追加します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。 |
| traceId | 文字列 | デバッグ用のトレース ID。 |
newsResult
| Field | タイプ | Description |
|---|---|---|
| title | 文字列 | ニュースのタイトル。 |
| url | 文字列 | ニュース記事のソース URL。 URL リダイレクトが有効になっている中国のユーザーの場合、このフィールドには clickUrlと同じリダイレクト URL が代わりに含まれます。 |
| ドメイン | 文字列 | 結果の宛先ホスト。 URL リダイレクトが有効になっている中国のユーザーに対してのみ返されます。 |
| コンテンツ | 文字列 | ニュース結果の詳細な Web ページ コンテンツ (別名グラウンド)。 |
| サムネイル | thumbnail オブジェクト | ニュース記事のサムネイル。 |
| lastUpdatedAt | 文字列 | ニュースの最終更新日 (UTC ISO8601形式)。 |
| crawledAt | 文字列 | ニュースの最後のクロール日は、ISO8601形式に従います。 |
| 言語 | 文字列 | ニュース記事の言語は、ISO 639-1 言語コードを使用します。 |
| ソース | 文字列 | Publisher名 ("USA TODAY |MSN"、"CNN"など |
| isAdult | boolean | コンテンツが成人用かどうかを示します。 |
| clickUrl | 文字列 | クリックをプロキシするリダイレクト URL Bing。 クリック リダイレクトが有効な場合にのみ存在します。 |
| instrumentationSuffix | 文字列 | この結果項目のインストルメンテーション ping URL ベースに追加するサフィックス。 インストルメンテーション ping URL と clickUrl リダイレクトの両方の K 値として使用されます。 インストルメンテーション ping が有効な場合に表示されます。 |
Note
lastUpdatedAt フィールドは省略可能です。つまり、このフィールドに空の値が表示される場合があります。
サムネイル
| Field | タイプ | Description |
|---|---|---|
| url | 文字列 | サムネイルのURLです。 |
| 幅 | 整数 | サムネイルの幅 (ピクセル単位)。 |
| height | 整数 | サムネイルの高さ (ピクセル単位)。 |
Note
thumbnail はオプションの応答オブジェクトでもあります。特定のニュース結果では使用できない場合があります。
エラー コード
| 状態コード | エラー カテゴリ | Description | 一般的な原因 |
|---|---|---|---|
| 200 | 成功 | 要求は成功しました。 | - |
| 400 | 正しくない要求 | 要求パラメーターが無効です。 | 必須フィールドが見つからない、無効なパラメーター値、形式が正しくない JSON |
| 401 | Unauthorized | 認証に失敗したか、見つかりません。 | 無効な API キー、x-apikey ヘッダーがありません |
| 403 | 許可されていません | 有効な資格情報ですが、アクセス許可が不十分です。 | API キーに必要なアクセス許可がない |
| 410 | 使用されていないリソース (Gone) | HTTPS が必要です。 | HTTPS ではなく HTTP 経由で行われた要求 |
| 415 | サポートされていないメディアの種類 | コンテンツ タイプはサポートされていません。 | コンテンツ タイプ ヘッダーが見つからないか、正しくない |
| 429 | 要求が多すぎます | レート制限を超えました。 | 時間枠内の要求が多すぎます |
| 500 | サーバー内部エラー | 予期しないサーバー エラー。 | 一時的なサーバーの問題 |
| 503 | サービス利用不可 | サービスは一時的に使用できません。 | メンテナンスまたは一時的な停止 |
| 504 | ゲートウェイのタイムアウト | リクエストがタイムアウトしました。 | アップストリーム サービスのタイムアウト |
エラー処理のガイダンスの詳細については、「 エラー処理」を参照してください。
Web Search | Videos Search | Browse | Images Search | MCPも参照してください。