Documents - Suggest Post

リファレンス

サービス:: Search Service

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

指定された部分的なクエリテキストと一致するインデックス内のドキュメントを提案します。

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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	ドキュメントの提案に使用する検索テキスト。 1 文字以上、100 文字以下にする必要があります。
suggesterName	True	string	インデックス定義の一部である suggesters コレクションで指定されている suggester の名前。
filter		string	提案の対象と見なされるドキュメントをフィルター処理する OData 式。
fuzzy		boolean	検索候補クエリにあいまい一致を使用するかどうかを示す値。既定値は false です。 true に設定すると、検索テキストに置換文字または不足文字がある場合でも、クエリで候補が検索されます。一部のシナリオではエクスペリエンスが向上しますが、あいまい検索の速度が遅くなり、リソースが多く消費されるため、パフォーマンスコストがかかります。
highlightPostTag		string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。省略すると、検索候補の強調表示が無効になります。
highlightPreTag		string	強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。省略すると、検索候補の強調表示が無効になります。
minimumCoverage		number	クエリが成功として報告されるように、提案クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。既定値は 80 です。
orderby		string	結果を並べ替える OData $orderby式のコンマ区切りのリスト。各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。既定値は昇順です。同点は、ドキュメントのマッチスコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。最大で 32 個の$orderby句があります。
searchFields		string	指定した検索テキストを検索するフィールド名のコンマ区切りのリスト。ターゲットフィールドは、指定した suggester に含まれている必要があります。
select		string	取得するフィールドのコンマ区切りのリスト。指定しない場合は、キーフィールドのみが結果に含まれます。
top		integer	取得する候補の数。 1 ~ 100 の値を指定する必要があります。既定値は 5 です。

応答

名前	型	説明
200 OK	SuggestDocumentsResult	部分的な入力に一致する提案されたドキュメントを含む応答。
Other Status Codes	ErrorResponse	エラー応答。

例

SearchIndexSuggestDocumentsPost

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SuggestDocumentsResult	インデックスからの提案クエリ結果を含む応答。
SuggestRequest	フィルター処理、並べ替え、あいまい一致、およびその他の検索候補のクエリ動作のパラメーター。
SuggestResult	提案クエリによって検出されたドキュメントと、関連付けられているメタデータを含む結果。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

SuggestDocumentsResult

インデックスからの提案クエリ結果を含む応答。

名前	型	説明
@search.coverage	number	クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求に設定されていない場合は null。
value	SuggestResult[]	クエリによって返される結果のシーケンス。

SuggestRequest

フィルター処理、並べ替え、あいまい一致、およびその他の検索候補のクエリ動作のパラメーター。

名前	型	説明
filter	string	提案の対象と見なされるドキュメントをフィルター処理する OData 式。
fuzzy	boolean	検索候補クエリにあいまい一致を使用するかどうかを示す値。既定値は false です。 true に設定すると、検索テキストに置換文字または不足文字がある場合でも、クエリで候補が検索されます。一部のシナリオではエクスペリエンスが向上しますが、あいまい検索の速度が遅くなり、リソースが多く消費されるため、パフォーマンスコストがかかります。
highlightPostTag	string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。省略すると、検索候補の強調表示が無効になります。
highlightPreTag	string	強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。省略すると、検索候補の強調表示が無効になります。
minimumCoverage	number	クエリが成功として報告されるように、提案クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。既定値は 80 です。
orderby	string	結果を並べ替える OData $orderby式のコンマ区切りのリスト。各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。既定値は昇順です。同点は、ドキュメントのマッチスコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。最大で 32 個の$orderby句があります。
search	string	ドキュメントの提案に使用する検索テキスト。 1 文字以上、100 文字以下にする必要があります。
searchFields	string	指定した検索テキストを検索するフィールド名のコンマ区切りのリスト。ターゲットフィールドは、指定した suggester に含まれている必要があります。
select	string	取得するフィールドのコンマ区切りのリスト。指定しない場合は、キーフィールドのみが結果に含まれます。
suggesterName	string	インデックス定義の一部である suggesters コレクションで指定されている suggester の名前。
top	integer	取得する候補の数。 1 ~ 100 の値を指定する必要があります。既定値は 5 です。

SuggestResult

提案クエリによって検出されたドキュメントと、関連付けられているメタデータを含む結果。

名前	型	説明
@search.text	string	提案結果のテキスト。

次の方法で共有

Documents - Suggest Post

URI パラメーター

要求ヘッダー

要求本文

応答

例

SearchIndexSuggestDocumentsPost

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestRequest

SuggestResult

その他のリソース