Documents - Autocomplete Get
インデックス内の入力テキストと一致する用語に基づいて、不完全なクエリ用語をオートコンプリートします。
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
インデックスの名前。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
search
|
query | True |
string |
自動入力される不完全な用語。 |
|
suggester
|
query | True |
string |
インデックス定義の一部である suggesters コレクションで指定されている suggester の名前。 |
|
$filter
|
query |
string |
オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。 |
|
|
$top
|
query |
integer (int32) |
取得するオートコンプリートされた用語の数。 これは 1 から 100 までの値である必要があります。 既定値は 5 です。 |
|
|
autocomplete
|
query |
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用し、自動入力された用語を生成します。 |
||
|
fuzzy
|
query |
boolean |
オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は falseです。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語を検索します。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいなオートコンプリート クエリは速度が遅くなり、より多くのリソースを消費するため、パフォーマンスが低下します。 |
|
|
highlight
|
query |
string |
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
|
|
highlight
|
query |
string |
強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
|
|
minimum
|
query |
number (double) |
0 から 100 までの数値で、クエリが成功として報告されるためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示します。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 デフォルトは 80 です。 |
|
|
search
|
query |
string[] |
オートコンプリートされた用語を照会するときに考慮するフィールド名のリスト。 ターゲット フィールドは、指定されたサジェスタに含める必要があります。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Accept |
Acceptヘッダーです。 |
||
| x-ms-client-request-id |
string (uuid) |
要求の非透過的なグローバルに一意のクライアント生成文字列識別子。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
api-key
型:
apiKey
/:
header
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://search.azure.com/.default |
例
SearchIndexAutocompleteDocumentsGet
要求のサンプル
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2026-04-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description
応答のサンプル
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]定義
| 名前 | 説明 |
|---|---|
| Accept |
Acceptヘッダーです。 |
|
Autocomplete |
オートコンプリート要求の結果。 |
|
Autocomplete |
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用してオートコンプリート用語を生成します。 |
|
Autocomplete |
オートコンプリート クエリの結果。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。 |
Accept
Acceptヘッダーです。
| 値 | 説明 |
|---|---|
| application/json;odata.metadata=none |
AutocompleteItem
オートコンプリート要求の結果。
| 名前 | 型 | 説明 |
|---|---|---|
| queryPlusText |
string |
完了した用語と共にクエリ。 |
| text |
string |
完成した用語。 |
AutocompleteMode
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用してオートコンプリート用語を生成します。
| 値 | 説明 |
|---|---|
| oneTerm |
1つの用語のみが提案されています。 クエリに 2 つの用語がある場合は、最後の用語のみが完了します。 たとえば、入力が「ワシントン・メディック」の場合、推奨される用語には「メディケイド」、「メディケア」、「医薬品」などが含まれます。 |
| twoTerms |
インデックス内の一致する 2 つの用語のフレーズが提案されます。 たとえば、入力が「medic」の場合、提案される用語には「メディケアの補償範囲」と「医療助手」を含めることができます。 |
| oneTermWithContext |
2 つ以上の用語を含むクエリの最後の用語 (最後の 2 つの用語はインデックスに存在する語句) を補完します。 たとえば、入力が「ワシントンメディック」の場合、提案される用語には「ワシントンメディケイド」と「ワシントンメディカル」が含まれます。 |
AutocompleteResult
オートコンプリート クエリの結果。
| 名前 | 型 | 説明 |
|---|---|---|
| @search.coverage |
number (double) |
オートコンプリート要求によって考慮されたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。 |
| value |
返されたオートコンプリートされた項目の一覧。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
追加情報。 |
|
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |