Documents - Suggest Post

サービス:

Search Service

API バージョン:

2026-04-01

指定された部分クエリテキストに一致するインデックス内のドキュメントを提案します。

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2026-04-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	必須	型	説明
search	True	string	ドキュメントの提案に使用する検索テキスト。 1 文字以上、100 文字以下にする必要があります。
suggesterName	True	string	インデックス定義の一部である suggesters コレクションで指定されている suggester の名前。
filter		string	提案のために考慮されるドキュメントをフィルター処理する OData 式。
fuzzy		boolean	提案クエリにあいまい一致を使用するかどうかを示す値。 既定値は falseです。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは候補を検索します。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいな候補検索は遅くなり、より多くのリソースを消費するため、パフォーマンスが低下します。
highlightPostTag		string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、候補のヒット強調表示は無効になります。
highlightPreTag		string	強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、候補のヒット強調表示は無効になります。
minimumCoverage		number (double)	0 から 100 までの数値で、クエリが成功として報告されるために、提案クエリでカバーする必要があるインデックスの割合を示します。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 デフォルトは 80 です。
orderby		string	結果を並べ替えるための OData $orderby式のコンマ区切りリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
searchFields		string	指定した検索テキストを検索するためのフィールド名のコンマ区切りリスト。 ターゲット フィールドは、指定されたサジェスタに含める必要があります。
select		string	取得するフィールドのコンマ区切りリスト。 指定しない場合、キーフィールドのみが結果に含まれます。
top		integer (int32)	取得する提案の数。 これは 1 から 100 までの値である必要があります。 既定値は 5 です。

応答

名前	型	説明
200 OK	SuggestDocumentsResult	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchIndexSuggestDocumentsPost

要求のサンプル

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.post.suggest?api-version=2026-04-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

応答のサンプル

状態コード:

200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

定義

名前	説明
Accept	Acceptヘッダーです。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
SuggestDocumentsResult	インデックスからの提案クエリ結果を含む応答。
SuggestRequest	フィルター処理、並べ替え、あいまい一致、およびその他の検索候補のクエリ動作のパラメーター。
SuggestResult	提案クエリによって検出されたドキュメントと、関連付けられているメタデータを含む結果。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

SuggestDocumentsResult

Object

インデックスからの提案クエリ結果を含む応答。

名前	型	説明
@search.coverage	number (double)	クエリに含まれたインデックスの割合を示す値、または要求で minimumCoverage が設定されていない場合は null。
value	SuggestResult[]	クエリによって返される結果のシーケンス。

SuggestRequest

Object

フィルター処理、並べ替え、あいまい一致、およびその他の検索候補のクエリ動作のパラメーター。

名前	型	説明
filter	string	提案のために考慮されるドキュメントをフィルター処理する OData 式。
fuzzy	boolean	提案クエリにあいまい一致を使用するかどうかを示す値。 既定値は falseです。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは候補を検索します。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいな候補検索は遅くなり、より多くのリソースを消費するため、パフォーマンスが低下します。
highlightPostTag	string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、候補のヒット強調表示は無効になります。
highlightPreTag	string	強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、候補のヒット強調表示は無効になります。
minimumCoverage	number (double)	0 から 100 までの数値で、クエリが成功として報告されるために、提案クエリでカバーする必要があるインデックスの割合を示します。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 デフォルトは 80 です。
orderby	string	結果を並べ替えるための OData $orderby式のコンマ区切りリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
search	string	ドキュメントの提案に使用する検索テキスト。 1 文字以上、100 文字以下にする必要があります。
searchFields	string	指定した検索テキストを検索するためのフィールド名のコンマ区切りリスト。 ターゲット フィールドは、指定されたサジェスタに含める必要があります。
select	string	取得するフィールドのコンマ区切りリスト。 指定しない場合、キーフィールドのみが結果に含まれます。
suggesterName	string	インデックス定義の一部である suggesters コレクションで指定されている suggester の名前。
top	integer (int32)	取得する提案の数。 これは 1 から 100 までの値である必要があります。 既定値は 5 です。

SuggestResult

Object

提案クエリによって検出されたドキュメントと、関連付けられているメタデータを含む結果。

名前	型	説明
@search.text	string	提案結果のテキスト。