Documents - Autocomplete Get

  • リファレンス
サービス:
Search Service
API バージョン:
2023-11-01

入力テキストとインデックス内の一致する用語に基づいて、不完全なクエリ用語をオートコンプリートします。

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}
省略可能なパラメーターを含む: 
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-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。
indexName
 path True

string

インデックスの名前です。
api-version
 query True

string

クライアント API のバージョン。
search
 query True

string

オートコンプリートする必要がある不完全な用語。
suggesterName
 query True

string

インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
$filter
 query

string

オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。
$top
 query

integer

int32

取得する自動完了語の数。 これは、1 ~ 100 の値である必要があります。 既定値は 5 です。
autocompleteMode
 query

AutocompleteMode

オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 "twoTerms" を使用して、シングルグルを取得し、'oneTermWithContext' を使用して現在のコンテキストを使用し、自動完了の用語を生成します。
fuzzy
 query

boolean

オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語を検索します。 一部のシナリオではエクスペリエンスが向上しますが、あいまいオートコンプリート クエリの速度が遅くなり、リソースが多く消費されるため、パフォーマンス コストがかかります。
highlightPostTag
 query

string

ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。
highlightPreTag
 query

string

ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。
minimumCoverage
 query

number

double

クエリを成功として報告するためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。
searchFields
 query

string[]

オートコンプリート用語のクエリを実行するときに考慮するフィールド名の一覧。 ターゲット フィールドは、指定した suggester に含まれている必要があります。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string

uuid

デバッグに役立つ要求と共に送信された追跡 ID。

応答

名前 型 説明
200 OK

AutocompleteResult

部分的な入力を完了するクエリ用語の候補を含む応答。
Other Status Codes

SearchError

エラー応答。

例

SearchIndexAutocompleteDocumentsGet

要求のサンプル

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

応答のサンプル

状態コード:
200 
[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

定義

名前 説明
AutocompleteItem

オートコンプリート要求の結果。
AutocompleteMode

オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 "twoTerms" を使用して、シングルグルを取得し、'oneTermWithContext' を使用してオートコンプリート用語を生成する現在のコンテキストを使用します。
AutocompleteResult

オートコンプリート クエリの結果。
SearchError

API のエラー条件について説明します。

AutocompleteItem

オートコンプリート要求の結果。

名前 型 説明
queryPlusText

string

クエリと完了した用語。
text

string

完了した用語。

AutocompleteMode

オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 "twoTerms" を使用して、シングルグルを取得し、'oneTermWithContext' を使用してオートコンプリート用語を生成する現在のコンテキストを使用します。

名前 型 説明
oneTerm

string

推奨される用語は 1 つだけです。 クエリに 2 つの用語がある場合は、最後の用語のみが完了します。 たとえば、入力が "washington medic" の場合、提案される用語には"メディケイド"、"メディケア"、"メディケア" が含まれる可能性があります。
oneTermWithContext

string

2 つ以上の用語を含むクエリの最後の用語を完了します。最後の 2 つの用語はインデックスに存在する語句です。 たとえば、入力が "washington medic" の場合、提案される用語には "washington medicaid" と "washington medical" が含まれる可能性があります。
twoTerms

string

インデックス内の 2 つの用語の語句を照合することをお勧めします。 たとえば、入力が "medic" の場合、提案される用語には "メディケア カバレッジ" と "医療アシスタント" が含まれる可能性があります。

AutocompleteResult

オートコンプリート クエリの結果。

名前 型 説明
@search.coverage

number

オートコンプリート要求によって考慮されたインデックスの割合を示す値。要求で minimumCoverage が指定されていない場合は null。
value

AutocompleteItem[]

返されるオートコンプリートされたアイテムの一覧。

SearchError

API のエラー条件について説明します。

名前 型 説明
code

string

サーバー定義のエラー コードのセットの 1 つ。
details

SearchError[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message

string

エラーの人間が判読できる表現。