Documents - Suggest Get

リファレンス

サービス:: Search Service

API バージョン:: 2024-05-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2024-05-01-preview

省略可能なパラメーターを含む:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2024-05-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前です。
api-version	query	True	string	クライアント API のバージョン。
search	query	True	string	ドキュメントの提案に使用する検索テキスト。 1 文字以上 100 文字以下で指定する必要があります。
suggesterName	query	True	string	インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
$filter	query		string	候補と見なされるドキュメントをフィルター処理する OData 式。
$orderby	query		string[]	結果の並べ替えに使用する OData $orderby式の一覧。各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。既定値は昇順です。結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。最大 32 個の$orderby句を指定できます。
$select	query		string[]	取得するフィールドの一覧。指定しない場合は、キーフィールドのみが結果に含まれます。
$top	query		integer int32	取得する候補の数。値は 1 ～ 100 の数値である必要があります。既定値は 5 です。
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	SuggestDocumentsResult	部分入力に一致する提案されたドキュメントを含む応答。
Other Status Codes	ErrorResponse	エラー応答。

例

SearchIndexSuggestDocumentsGet

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2024-05-01-preview

応答のサンプル

状態コード:: 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	インデックスからの提案クエリ結果を含む応答。
SuggestResult	提案クエリによって検出されたドキュメントと、関連付けられているメタデータを含む結果。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

SuggestDocumentsResult

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

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

SuggestResult

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

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

次の方法で共有

Documents - Suggest Get

URI パラメーター

要求ヘッダー

応答

例

SearchIndexSuggestDocumentsGet

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestResult

その他のリソース