次の方法で共有


Documents - Suggest Get

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2024-07-01
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-07-01

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

要求のサンプル

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-07-01

応答のサンプル

{
  "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

エラー オブジェクト。

SuggestDocumentsResult

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

名前 説明
@search.coverage

number

クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求に設定されていない場合は null。

value

SuggestResult[]

クエリによって返される結果のシーケンス。

SuggestResult

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

名前 説明
@search.text

string

提案結果のテキスト。