Documents - Suggest Get

サービス:: Search Service

API バージョン:: 2026-04-01

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

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

省略可能なパラメーターを含む:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}

URI パラメーター

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

要求ヘッダー

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

応答

名前	型	説明
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

例

SearchIndexSuggestDocumentsGet

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

定義

名前	説明
Accept	Acceptヘッダーです。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
SuggestDocumentsResult	インデックスからの提案クエリ結果を含む応答。
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[]	クエリによって返される結果のシーケンス。

SuggestResult

Object

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

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