Documents - Autocomplete Post

リファレンス

サービス:: Search Service

API バージョン:: 2023-11-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前です。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信される追跡 ID。

要求本文

名前	必須	型	説明
search	True	string	オートコンプリートの結果の基となる検索テキスト。
suggesterName	True	string	インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
autocompleteMode		AutocompleteMode	オートコンプリートのモードを指定します。既定値は 'oneTerm' です。 'twoTerms' を使用してシングルを取得し、'oneTermWithContext' を使用して、オートコンプリートの用語を生成するときに現在のコンテキストを使用します。
filter		string	オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。
fuzzy		boolean	オートコンプリートクエリにあいまい一致を使用するかどうかを示す値。既定値は false です。 true に設定すると、検索テキストに置換または欠落した文字がある場合でも、クエリは用語をオートコンプリートします。これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいオートコンプリートクエリの速度が低下し、リソースが多く消費されるため、パフォーマンスコストがかかります。
highlightPostTag		string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。省略すると、ヒット強調表示は無効になります。
highlightPreTag		string	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。省略すると、ヒット強調表示は無効になります。
minimumCoverage		number	クエリを成功として報告するためにオートコンプリートクエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。既定値は 80 です。
searchFields		string	オートコンプリート用語のクエリを実行するときに考慮するフィールド名のコンマ区切りのリスト。ターゲットフィールドは、指定した suggester に含まれている必要があります。
top		integer	取得する自動完了の用語の数。これは 1 ~ 100 の値である必要があります。既定値は 5 です。

応答

名前	型	説明
200 OK	AutocompleteResult	部分入力を完了するクエリ用語の候補を含む応答。
Other Status Codes	SearchError	エラー応答。

例

SearchIndexAutocompleteDocumentsPost

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-11-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

応答のサンプル

状態コード:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

定義

名前	説明
AutocompleteItem	オートコンプリート要求の結果。
AutocompleteMode	オートコンプリートのモードを指定します。既定値は 'oneTerm' です。 "twoTerms" を使用してシングルを取得し、'oneTermWithContext' を使用してオートコンプリート用語を生成する現在のコンテキストを使用します。
AutocompleteRequest	あいまい一致のパラメーター、およびその他のオートコンプリートクエリの動作。
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 medicalaid" と "washington medical" が含まれる可能性があります。
twoTerms	string	インデックス内の 2 つの用語の語句の一致が推奨されます。たとえば、入力が "メディック" の場合、提案される用語には "medicare coverage" と "medical アシスタント" が含まれる場合があります。

AutocompleteRequest

あいまい一致のパラメーター、およびその他のオートコンプリートクエリの動作。

名前	型	説明
autocompleteMode	AutocompleteMode	オートコンプリートのモードを指定します。既定値は 'oneTerm' です。 'twoTerms' を使用してシングルを取得し、'oneTermWithContext' を使用して、オートコンプリートの用語を生成するときに現在のコンテキストを使用します。
filter	string	オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。
fuzzy	boolean	オートコンプリートクエリにあいまい一致を使用するかどうかを示す値。既定値は false です。 true に設定すると、検索テキストに置換または欠落した文字がある場合でも、クエリは用語をオートコンプリートします。これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいオートコンプリートクエリの速度が低下し、リソースが多く消費されるため、パフォーマンスコストがかかります。
highlightPostTag	string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。省略すると、ヒット強調表示は無効になります。
highlightPreTag	string	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。省略すると、ヒット強調表示は無効になります。
minimumCoverage	number	クエリを成功として報告するためにオートコンプリートクエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。既定値は 80 です。
search	string	オートコンプリートの結果の基となる検索テキスト。
searchFields	string	オートコンプリート用語のクエリを実行するときに考慮するフィールド名のコンマ区切りのリスト。ターゲットフィールドは、指定した suggester に含まれている必要があります。
suggesterName	string	インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
top	integer	取得する自動完了の用語の数。これは 1 ~ 100 の値である必要があります。既定値は 5 です。

AutocompleteResult

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

名前	型	説明
@search.coverage	number	オートコンプリート要求によって考慮されたインデックスの割合を示す値。要求で minimumCoverage が指定されていない場合は null。
value	AutocompleteItem[]	返されたオートコンプリートされた項目の一覧。

SearchError

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

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
details	SearchError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message	string	エラーの人間が判読できる表現。

次の方法で共有