Documents - Autocomplete Post

リファレンス

サービス:: Search Service

API バージョン:: 2024-07-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-07-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	ErrorResponse	エラー応答。

例

SearchIndexAutocompleteDocumentsPost

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-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	オートコンプリートクエリの結果。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

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 つの用語の語句が推奨されます。たとえば、入力が "メディック" の場合、提案される用語には "メディケアカバレッジ" と "医療アシスタント" が含まれる場合があります。

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[]	返されたオートコンプリートされた項目の一覧。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

次の方法で共有