Documents - Autocomplete Post
インデックス内の入力テキストと一致する用語に基づいて、不完全なクエリ用語をオートコンプリートします。
POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2025-09-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
インデックスの名前です。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
デバッグを支援するためにリクエストとともに送信されたトラッキング ID。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| search | True |
string |
オートコンプリート結果のベースとなる検索テキスト。 |
| suggesterName | True |
string |
インデックス定義の一部である suggesters コレクションで指定されているサジェスターの名前。 |
| autocompleteMode |
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用し、自動入力された用語を生成します。 |
||
| filter |
string |
オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。 |
|
| fuzzy |
boolean |
オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字や欠落文字がある場合でも、クエリは用語をオートコンプリートします。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいなオートコンプリート クエリは速度が遅くなり、より多くのリソースを消費するため、パフォーマンスが低下します。 |
|
| highlightPostTag |
string |
ヒットハイライトに追加される文字列タグ。 highlightPreTag で設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
|
| highlightPreTag |
string |
ヒットハイライトの先頭に追加される文字列タグ。 highlightPostTag で設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
|
| minimumCoverage |
number (double) |
0 から 100 までの数値で、クエリが成功として報告されるためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示します。 このパラメーターは、レプリカが 1 つしかないサービスでも検索の可用性を確保するのに役立ちます。 デフォルトは 80 です。 |
|
| searchFields |
string |
オートコンプリートされた用語を照会するときに考慮するフィールド名のコンマ区切りリスト。 ターゲット フィールドは、指定されたサジェスタに含める必要があります。 |
|
| top |
integer (int32) |
取得するオートコンプリートされた用語の数。 これは 1 から 100 までの値である必要があります。 既定値は 5 です。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
部分的な入力を完了する提案されたクエリ用語を含む応答。 |
|
| Other Status Codes |
エラー応答。 |
例
SearchIndexAutocompleteDocumentsPost
要求のサンプル
POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01
{
"search": "p",
"autocompleteMode": "oneTerm",
"filter": "ownerId ne '1'",
"fuzzy": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"searchFields": "category, ownerId",
"suggesterName": "sg",
"top": 10
}
応答のサンプル
{
"@search.coverage": 100,
"value": [
{
"text": "purple",
"queryPlusText": "<em>purple</em>"
},
{
"text": "pink",
"queryPlusText": "<em>pink</em>"
}
]
}定義
| 名前 | 説明 |
|---|---|
|
Autocomplete |
オートコンプリート要求の結果。 |
|
Autocomplete |
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用してオートコンプリート用語を生成します。 |
|
Autocomplete |
あいまい一致のパラメーター、およびその他のオートコンプリートクエリ動作。 |
|
Autocomplete |
オートコンプリートクエリの結果。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
AutocompleteItem
オートコンプリート要求の結果。
| 名前 | 型 | 説明 |
|---|---|---|
| queryPlusText |
string |
クエリと完了した用語。 |
| text |
string |
完了した期間。 |
AutocompleteMode
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用してオートコンプリート用語を生成します。
| 値 | 説明 |
|---|---|
| oneTerm |
1つの用語のみが提案されています。 クエリに 2 つの用語がある場合は、最後の用語のみが完了します。 たとえば、入力が「ワシントン・メディック」の場合、推奨される用語には「メディケイド」、「メディケア」、「医薬品」などが含まれます。 |
| twoTerms |
インデックス内の一致する 2 つの用語のフレーズが提案されます。 たとえば、入力が「medic」の場合、提案される用語には「メディケアの補償範囲」と「医療助手」を含めることができます。 |
| oneTermWithContext |
2 つ以上の用語を含むクエリの最後の用語 (最後の 2 つの用語はインデックスに存在する語句) を補完します。 たとえば、入力が「ワシントンメディック」の場合、提案される用語には「ワシントンメディケイド」と「ワシントンメディカル」が含まれます。 |
AutocompleteRequest
あいまい一致のパラメーター、およびその他のオートコンプリートクエリ動作。
| 名前 | 型 | 説明 |
|---|---|---|
| autocompleteMode |
オートコンプリートのモードを指定します。 デフォルトは「oneTerm」です。 'twoTerms' を使用して帯状疱疹を取得し、'oneTermWithContext' を使用して現在のコンテキストを使用し、自動入力された用語を生成します。 |
|
| filter |
string |
オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。 |
| fuzzy |
boolean |
オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字や欠落文字がある場合でも、クエリは用語をオートコンプリートします。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいなオートコンプリート クエリは速度が遅くなり、より多くのリソースを消費するため、パフォーマンスが低下します。 |
| highlightPostTag |
string |
ヒットハイライトに追加される文字列タグ。 highlightPreTag で設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
| highlightPreTag |
string |
ヒットハイライトの先頭に追加される文字列タグ。 highlightPostTag で設定する必要があります。 省略すると、ヒットの強調表示は無効になります。 |
| minimumCoverage |
number (double) |
0 から 100 までの数値で、クエリが成功として報告されるためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示します。 このパラメーターは、レプリカが 1 つしかないサービスでも検索の可用性を確保するのに役立ちます。 デフォルトは 80 です。 |
| search |
string |
オートコンプリート結果のベースとなる検索テキスト。 |
| searchFields |
string |
オートコンプリートされた用語を照会するときに考慮するフィールド名のコンマ区切りリスト。 ターゲット フィールドは、指定されたサジェスタに含める必要があります。 |
| suggesterName |
string |
インデックス定義の一部である suggesters コレクションで指定されているサジェスターの名前。 |
| top |
integer (int32) |
取得するオートコンプリートされた用語の数。 これは 1 から 100 までの値である必要があります。 既定値は 5 です。 |
AutocompleteResult
オートコンプリートクエリの結果。
| 名前 | 型 | 説明 |
|---|---|---|
| @search.coverage |
number (double) |
オートコンプリート要求によって考慮されたインデックスの割合を示す値、または要求で minimumCoverage が指定されていない場合は null。 |
| value |
返される自動完了項目のリスト。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |