Documents - Suggest Post

  • リファレンス
サービス:
Search Service
API バージョン:
2023-11-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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

ドキュメントの提案に使用する検索テキスト。 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

SearchError

エラー応答。

例

SearchIndexSuggestDocumentsPost

要求のサンプル

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-11-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"
    }
  ]
}

定義

名前 説明
SearchError

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

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

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

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

SearchError

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

名前 型 説明
code

string

サーバー定義のエラー コードのセットの 1 つ。
details

SearchError[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message

string

エラーの人間が判読できる表現。

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

候補の結果のテキスト。