Documents - Autocomplete Get
入力テキストとインデックス内の一致する用語に基づいて、不完全なクエリ用語をオートコンプリートします。
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2024-07-01&search={search}&suggesterName={suggesterName}GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2024-07-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 |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
インデックスの名前。 |
|
api-version
|
query | True |
string |
クライアント 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[] |
オートコンプリート用語のクエリを実行するときに考慮するフィールド名の一覧。 ターゲット フィールドは、指定した suggester に含まれている必要があります。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string uuid |
デバッグに役立つ要求と共に送信される追跡 ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
部分的な入力を完了するクエリ用語の候補を含む応答。 |
|
| Other Status Codes |
エラー応答。 |
例
SearchIndexAutocompleteDocumentsGet
要求のサンプル
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2024-07-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"
}
]定義
| 名前 | 説明 |
|---|---|
|
Autocomplete |
オートコンプリート要求の結果。 |
|
Autocomplete |
オートコンプリートのモードを指定します。 既定値は "oneTerm" です。 "twoTerms" を使用して、新しい単語を取得し、オートコンプリート用語を生成する場合に現在のコンテキストを使用する場合は "oneTermWithContext" を使用します。 |
|
Autocomplete |
オートコンプリート クエリの結果。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
AutocompleteItem
オートコンプリート要求の結果。
| 名前 | 型 | 説明 |
|---|---|---|
| queryPlusText |
string |
完了した用語と共にクエリ。 |
| text |
string |
完成した用語。 |
AutocompleteMode
オートコンプリートのモードを指定します。 既定値は "oneTerm" です。 "twoTerms" を使用して、新しい単語を取得し、オートコンプリート用語を生成する場合に現在のコンテキストを使用する場合は "oneTermWithContext" を使用します。
| 名前 | 型 | 説明 |
|---|---|---|
| oneTerm |
string |
推奨される用語は 1 つだけです。 クエリに 2 つの用語がある場合、最後の用語のみが完了します。 たとえば、入力が "washington medic" の場合、提案される用語には "メディケイド"、"メディケア"、"medicine" が含まれる場合があります。 |
| oneTermWithContext |
string |
クエリの最後の用語を 2 つ以上の用語で完了します。最後の 2 つの用語はインデックスに存在する語句です。 たとえば、入力が "washington medic" の場合、提案される用語には "washington medicaid" と "washington medical" が含まれる可能性があります。 |
| twoTerms |
string |
インデックス内の一致する 2 つの用語の語句が推奨されます。 たとえば、入力が "メディック" の場合、提案される用語には "メディケア カバレッジ" と "医療アシスタント" が含まれる場合があります。 |
AutocompleteResult
オートコンプリート クエリの結果。
| 名前 | 型 | 説明 |
|---|---|---|
| @search.coverage |
number |
オートコンプリート要求によって考慮されたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。 |
| value |
返されたオートコンプリートされた項目の一覧。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |