Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

インデックス内のドキュメントを検索します。

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前です。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信された追跡 ID。

要求本文

名前	型	説明
answers	QueryAnswerType	検索応答の一部として回答を返すかどうかを示す 値。
captions	QueryCaptionType	検索応答の一部としてキャプションを返す必要があるかどうかを示す 値。
count	boolean	結果の合計数をフェッチするかどうかを示す 値です。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは概数であることに注意してください。
debug	QueryDebugMode	再ランク付けされた結果をさらに調べるために使用できるデバッグ ツールを有効にします。
facets	string[]	検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。
filter	string	検索クエリに適用する OData $filter式。
highlight	string	ヒットハイライトに使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
highlightPostTag	string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は </em です>。
highlightPreTag	string	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は em です<>。
minimumCoverage	number	クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
orderby	string	結果の並べ替えに使用する OData $orderby式のコンマ区切りのリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大 32 個の$orderby句を指定できます。
queryLanguage	QueryLanguage	検索クエリの言語を指定する 値。
queryType	QueryType	検索クエリの構文を示す 値です。 既定値は 'simple' です。 クエリで Lucene クエリ構文が使用されている場合は、'full' を使用します。
scoringParameters	string[]	name-values 形式を使用してスコアリング関数 (referencePointParameter など) で使用されるパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation---122.2,44.8" になります (引用符は使用しません)。
scoringProfile	string	結果を並び替えるために一致ドキュメントの一致スコアを評価するスコア付けプロファイルの名前。
scoringStatistics	ScoringStatistics	スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 既定値は 'local' です。 スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。 グローバル スコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
search	string	フルテキスト検索クエリ式。すべてのドキュメントに一致するには、"*" を使用するか、このパラメーターを省略します。
searchFields	string	フルテキスト検索の範囲を指定するフィールド名のコンマ区切りリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターにリストされているフィールド名よりも優先されます。
searchMode	SearchMode	ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを示す 値。
select	string	取得するフィールドのコンマ区切りのリスト。 指定しないと、スキーマで取得可能とマークされているすべてのフィールドが含まれます。
semanticConfiguration	string	セマンティック型のクエリのドキュメントを処理するときに使用されるセマンティック構成の名前。
semanticErrorHandling	SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定値)。
semanticFields	string	セマンティック ランク付けに使用されるフィールド名のコンマ区切りリスト。
semanticMaxWaitInMilliseconds	integer	ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティック リランク、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられ、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer	スキップする検索結果の数です。 この値は 100,000 を超えることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限により skip を使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	個々の検索クエリ用語のスペルを修正するために使用するスペル チェックの種類を指定した値。
top	integer	取得する検索結果の数です。 これは、$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングによって結果が切り捨てられた場合、応答には継続トークンが含まれます。このトークンを使用して、結果の次のページに対して別の検索要求を発行できます。
vectorFilterMode	VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。 既定値は 'preFilter' です。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

応答

名前	型	説明
200 OK	SearchDocumentsResult	検索条件に一致するドキュメントを含む応答。
Other Status Codes	SearchError	エラー応答。

例

SearchIndexSearchDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Sample Response

Status code:

200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

定義

名前	説明
AnswerResult	回答は、クエリに一致した最も関連性の高いドキュメントの内容から抽出されたテキストの一節です。 回答は上位の検索結果から抽出されます。 回答候補がスコア付けされ、上位の回答が選択されます。
CaptionResult	キャプションは、ドキュメントから検索クエリまでの最も代表的な一節です。 多くの場合、ドキュメントの概要として使用されます。 キャプションは、型 'semantic' のクエリに対してのみ返されます。
DocumentDebugInfo	検索結果をさらに探索するために使用できるデバッグ情報が含まれています。
QueryAnswerType	検索応答の一部として回答を返す必要があるかどうかを示す 値。
QueryCaptionType	検索応答の一部としてキャプションを返す必要があるかどうかを示す 値。
QueryDebugMode	検索結果をさらに探索するために使用できるデバッグ ツールを有効にします。
QueryLanguage	クエリの言語。
QueryResultDocumentRerankerInput	セマンティック エンリッチメント プロセスに送信された未加工の連結文字列。
QueryResultDocumentSemanticField	セマンティック エンリッチメント プロセスに送信されたフィールドの説明と、その使用方法
QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペル チェックの種類を指定した 値。
QueryType	検索クエリの構文を指定します。 既定値は 'simple' です。 クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。
RawVectorQuery	生ベクター値が指定されたときにベクター検索に使用するクエリ パラメーター。
ScoringStatistics	スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 既定値は 'local' です。 スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。 グローバル スコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
SearchDocumentsResult	インデックスからの検索結果を含む応答。
SearchError	API のエラー条件について説明します。
SearchMode	一致ドキュメントをカウントする上で、検索用語の一部が一致すればよいか、それともすべて一致する必要があるかを指定します。
SearchRequest	フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。
SearchResult	検索クエリによって検出されたドキュメントと、関連するメタデータが含まれます。
SemanticDebugInfo
SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定値)。
SemanticErrorReason	セマンティック ランク付け要求に対して部分的な応答が返された理由。
SemanticFieldState	フィールドがセマンティック エンリッチメント プロセスに使用された方法 (完全に使用される、部分的に使用される、または未使用)
SemanticSearchResultsType	セマンティック ランク付け要求に対して返された部分応答の型。
VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを決定します。
VectorizableTextQuery	ベクター化する必要があるテキスト値が指定されている場合にベクター検索に使用するクエリ パラメーター。
VectorQueryKind	実行されるベクター クエリの種類。

AnswerResult

回答は、クエリに一致した最も関連性の高いドキュメントの内容から抽出されたテキストの一節です。 回答は上位の検索結果から抽出されます。 回答候補がスコア付けされ、上位の回答が選択されます。

名前	型	説明
highlights	string	クエリに最も関連するテキスト フレーズが強調表示された Text プロパティと同じテキストの一節。
key	string	回答が抽出されたドキュメントのキー。
score	number	スコア値は、クエリに対して返される他の回答に対する回答の関連性を表します。
text	string	文書の内容から回答として抽出されたテキストの一節。

CaptionResult

キャプションは、ドキュメントから検索クエリまでの最も代表的な一節です。 多くの場合、ドキュメントの概要として使用されます。 キャプションは、型 'semantic' のクエリに対してのみ返されます。

名前	型	説明
highlights	string	クエリに最も関連する強調表示された語句を含む Text プロパティと同じテキストの一節。
text	string	検索クエリに最も関連するドキュメントから抽出された代表的なテキストの一節。

DocumentDebugInfo

検索結果をさらに探索するために使用できるデバッグ情報が含まれています。

名前	型	説明
semantic	SemanticDebugInfo	セマンティック ランク付け要求に固有のデバッグ情報が含まれています。

QueryAnswerType

検索応答の一部として回答を返す必要があるかどうかを示す 値。

名前	型	説明
extractive	string	自然言語で質問として表現されたクエリに応答して返されるドキュメントの内容から回答候補を抽出します。
none	string	クエリの回答を返さないでください。

QueryCaptionType

検索応答の一部としてキャプションを返す必要があるかどうかを示す 値。

名前	型	説明
extractive	string	検索クエリに関連する文章を含む一致するドキュメントからキャプションを抽出します。
none	string	クエリのキャプションを返さないでください。

QueryDebugMode

検索結果をさらに探索するために使用できるデバッグ ツールを有効にします。

名前	型	説明
disabled	string	クエリ デバッグ情報は返されません。
semantic	string	ユーザーが再ランク付けされた結果をさらに探索できるようにします。

QueryLanguage

クエリの言語。

名前	型	説明
ar-eg	string	アラビア語 (エジプト) のクエリ言語値。
ar-jo	string	アラビア語 (ヨルダン) のクエリ言語値。
ar-kw	string	アラビア語 (クウェート) のクエリ言語値。
ar-ma	string	アラビア語 (モロッコ) のクエリ言語値。
ar-sa	string	アラビア語 (サウジアラビア) のクエリ言語値。
bg-bg	string	ブルガリア語 (ブルガリア) のクエリ言語の値。
bn-in	string	ベンガル語 (インド) のクエリ言語値。
ca-es	string	カタロニア語のクエリ言語の値。
cs-cz	string	チェコ語 (チェコ共和国) のクエリ言語値。
da-dk	string	デンマーク語 (デンマーク) のクエリ言語値。
de-de	string	ドイツ語 (ドイツ) のクエリ言語の値。
el-gr	string	ギリシャ語 (ギリシャ) のクエリ言語値。
en-au	string	英語 (オーストラリア) のクエリ言語の値。
en-ca	string	英語 (カナダ) のクエリ言語の値。
en-gb	string	英語 (英国) のクエリ言語の値。
en-in	string	英語 (インド) のクエリ言語の値。
en-us	string	英語 (米国) のクエリ言語値。
es-es	string	スペイン語 (スペイン) のクエリ言語の値。
es-mx	string	スペイン語 (メキシコ) のクエリ言語の値。
et-ee	string	エストニア語 (エストニア) のクエリ言語値。
eu-es	string	バスク語のクエリ言語値。
fa-ae	string	ペルシャ語 (U.A.E.) のクエリ言語値。
fi-fi	string	フィンランド語 (フィンランド) のクエリ言語値。
fr-ca	string	フランス語 (カナダ) のクエリ言語の値。
fr-fr	string	フランス語 (フランス) のクエリ言語値。
ga-ie	string	アイルランド語 (アイルランド) のクエリ言語の値。
gl-es	string	ガリシア語のクエリ言語値。
gu-in	string	Gujarati (インド) の言語値を照会します。
he-il	string	ヘブライ語 (イスラエル) の言語値を照会します。
hi-in	string	ヒンディー語 (インド) のクエリ言語値。
hr-ba	string	クロアチア語 (ボスニア・ヘルツェゴビナ) のクエリ言語値。
hr-hr	string	クロアチア語 (クロアチア) のクエリ言語値。
hu-hu	string	ハンガリー語 (ハンガリー) のクエリ言語値。
hy-am	string	アルメニア語 (アルメニア) のクエリ言語値。
id-id	string	インドネシア語 (インドネシア) のクエリ言語値。
is-is	string	アイスランド語 (アイスランド) のクエリ言語の値。
it-it	string	イタリア語 (イタリア) のクエリ言語値。
ja-jp	string	日本語 (日本) のクエリ言語値。
kn-in	string	カンナダ (インド) のクエリ言語の値。
ko-kr	string	韓国語 (韓国) のクエリ言語値。
lt-lt	string	リトアニア語 (リトアニア) のクエリ言語値。
lv-lv	string	ラトビア語 (ラトビア) のクエリ言語値。
ml-in	string	Malayalam (インド) のクエリ言語値。
mr-in	string	Marathi (インド) のクエリ言語値。
ms-bn	string	マレー語 (ブルネイ ダルサラーム) のクエリ言語値。
ms-my	string	マレー語 (マレーシア) のクエリ言語値。
nb-no	string	ノルウェー語 (ノルウェー) のクエリ言語値。
nl-be	string	オランダ語 (ベルギー) のクエリ言語値。
nl-nl	string	オランダ語 (オランダ) のクエリ言語の値。
no-no	string	ノルウェー語 (ノルウェー) のクエリ言語値。
none	string	クエリ言語が指定されていません。
pa-in	string	Punjabi (インド) の言語値を照会します。
pl-pl	string	ポーランド語 (ポーランド) のクエリ言語値。
pt-br	string	ポルトガル語 (ブラジル) のクエリ言語値。
pt-pt	string	ポルトガル語 (ポルトガル) のクエリ言語値。
ro-ro	string	ルーマニア語 (ルーマニア) のクエリ言語の値。
ru-ru	string	ロシア語 (ロシア) のクエリ言語の値。
sk-sk	string	スロバキア語 (スロバキア) の言語値を照会します。
sl-sl	string	スロベニア語 (スロベニア) のクエリ言語値。
sr-ba	string	セルビア語 (ボスニア・ヘルツェゴビナ) の言語値を照会します。
sr-me	string	セルビア語 (モンテネグロ) の言語値を照会します。
sr-rs	string	セルビア語 (セルビア) のクエリ言語値。
sv-se	string	スウェーデン語 (スウェーデン) のクエリ言語値。
ta-in	string	Tamil (インド) のクエリ言語値。
te-in	string	テルグ語 (インド) のクエリ言語の値。
th-th	string	タイ語 (タイ) の言語値を照会します。
tr-tr	string	トルコ語 (トルコ) のクエリ言語値。
uk-ua	string	ウクライナ語 (ウクライナ) のクエリ言語値。
ur-pk	string	Urdu (パキスタン) の言語値を照会します。
vi-vn	string	ベトナム語 (ベトナム) のクエリ言語の値。
zh-cn	string	中国語 (中国) のクエリ言語値。
zh-tw	string	中国語 (台湾) のクエリ言語値。

QueryResultDocumentRerankerInput

セマンティック エンリッチメント プロセスに送信された未加工の連結文字列。

名前	型	説明
content	string	セマンティック エンリッチメントに使用されたコンテンツ フィールドの未加工の連結文字列。
keywords	string	セマンティック エンリッチメントに使用されたキーワード (keyword) フィールドの未加工の連結文字列。
title	string	セマンティック エンリッチメントに使用されたタイトル フィールドの生文字列。

QueryResultDocumentSemanticField

セマンティック エンリッチメント プロセスに送信されたフィールドの説明と、その使用方法

名前	型	説明
name	string	セマンティック エンリッチメント プロセスに送信されたフィールドの名前
state	SemanticFieldState	フィールドがセマンティック エンリッチメント プロセスに使用された方法 (完全に使用される、部分的に使用される、または未使用)

QuerySpellerType

個々の検索クエリ用語のスペル修正に使用するスペル チェックの種類を指定した 値。

名前	型	説明
lexicon	string	スペル チェックは、queryLanguage パラメーターで指定された言語の静的辞書を使用して、個々のクエリ用語を修正します。
none	string	スペル チェックが有効になっていません。

QueryType

検索クエリの構文を指定します。 既定値は 'simple' です。 クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。

名前	型	説明
full	string	検索に完全な Lucene クエリ構文を使用します。 検索テキストは、Lucene クエリ言語を使用して解釈されます。この言語では、フィールド固有の検索や重み付けされた検索、およびその他の高度な機能を使用できます。
semantic	string	キーワードではなく自然言語で表現されるクエリに最適です。 Web コーパスでトレーニングされたランク付けモデルを使用して上位の検索結果を再ランク付けすることで、検索結果の精度を向上させます。
simple	string	検索に単純なクエリ構文を使用します。 検索テキストは、+、*、"" などのシンボルを使用できる単純なクエリ言語を使用して解釈されます。 searchFields パラメーターが指定されていない限り、クエリは既定ですべての検索可能なフィールドで評価されます。

RawVectorQuery

生ベクター値が指定されたときにベクター検索に使用するクエリ パラメーター。

名前	型	説明
exhaustive	boolean	true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。 グラウンド トゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクターに含める Collection(Edm.Single) 型のベクター フィールド。
k	integer	トップ ヒットとして返される最も近い近隣の数。
kind	string: vector	実行されるベクター クエリの種類。
vector	number[]	検索クエリのベクター表現。

ScoringStatistics

スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 既定値は 'local' です。 スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。 グローバル スコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。

名前	型	説明
global	string	スコアリング統計は、より一貫性のあるスコアリングのためにグローバルに計算されます。
local	string	スコアリング統計は、待機時間を短くするためにローカルで計算されます。

SearchDocumentsResult

インデックスからの検索結果を含む応答。

名前	型	説明
@odata.count	integer	検索操作によって検出された結果の合計数。カウントが要求されなかった場合は null。 存在する場合、この応答の結果の数よりもカウントが大きくなる可能性があります。 これは、$topまたは$skipパラメーターを使用する場合、またはクエリが要求されたすべてのドキュメントを 1 つの応答で返さない場合に発生する可能性があります。
@odata.nextLink	string	クエリが要求されたすべての結果を 1 つの応答で返すことができる場合に返される継続 URL。 この URL を使用して、別の GET または POST 検索要求を作成して、検索応答の次の部分を取得できます。 この応答を生成した要求と同じ動詞 (GET または POST) を使用してください。
@search.answers	AnswerResult[]	検索操作のクエリ結果に応答します。answers クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。
@search.coverage	number	クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。
@search.facets	object	各ファセット フィールドのバケットのコレクションとして編成された、検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。
@search.nextPageParameters	SearchRequest	クエリが要求されたすべての結果を 1 つの応答で返すことができる場合に返される継続 JSON ペイロード。 この JSON を と @odata.nextLink 共に使用して、別の POST 検索要求を作成して、検索応答の次の部分を取得できます。
@search.semanticPartialResponseReason	SemanticErrorReason	セマンティック ランク付け要求に対して部分的な応答が返された理由。
@search.semanticPartialResponseType	SemanticSearchResultsType	セマンティック ランク付け要求に対して返された部分応答の型。
value	SearchResult[]	クエリによって返される結果のシーケンス。

SearchError

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

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
details	SearchError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message	string	エラーの人間が判読できる表現。

SearchMode

一致ドキュメントをカウントする上で、検索用語の一部が一致すればよいか、それともすべて一致する必要があるかを指定します。

名前	型	説明
all	string	ドキュメントを一致としてカウントするには、すべての検索語句が一致している必要があります。
any	string	ドキュメントを一致としてカウントするには、検索語句の一致が必要です。

SearchRequest

フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。

名前	型	説明
answers	QueryAnswerType	検索応答の一部として回答を返す必要があるかどうかを示す 値。
captions	QueryCaptionType	検索応答の一部としてキャプションを返す必要があるかどうかを示す 値。
count	boolean	結果の合計数をフェッチするかどうかを示す 値です。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは概数であることに注意してください。
debug	QueryDebugMode	再ランク結果をさらに調べるために使用できるデバッグ ツールを有効にします。
facets	string[]	検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。
filter	string	検索クエリに適用する OData $filter式。
highlight	string	ヒットハイライトに使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
highlightPostTag	string	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は </em です>。
highlightPreTag	string	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は em です<>。
minimumCoverage	number	クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
orderby	string	結果の並べ替えに使用する OData $orderby式のコンマ区切りのリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大 32 個の$orderby句を指定できます。
queryLanguage	QueryLanguage	検索クエリの言語を示す 値です。
queryType	QueryType	検索クエリの構文を示す 値です。 既定値は 'simple' です。 クエリで Lucene クエリ構文が使用されている場合は、'full' を使用します。
scoringParameters	string[]	name-values 形式を使用してスコアリング関数 (referencePointParameter など) で使用されるパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation---122.2,44.8" になります (引用符は使用しません)。
scoringProfile	string	結果を並び替えるために一致ドキュメントの一致スコアを評価するスコア付けプロファイルの名前。
scoringStatistics	ScoringStatistics	スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 既定値は 'local' です。 スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。 グローバル スコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
search	string	フルテキスト検索クエリ式。すべてのドキュメントに一致するには、"*" を使用するか、このパラメーターを省略します。
searchFields	string	フルテキスト検索の範囲を指定するフィールド名のコンマ区切りのリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターにリストされているフィールド名よりも優先されます。
searchMode	SearchMode	ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを示す 値。
select	string	取得するフィールドのコンマ区切りのリスト。 指定しないと、スキーマで取得可能とマークされているすべてのフィールドが含まれます。
semanticConfiguration	string	セマンティック型のクエリのドキュメントを処理するときに使用されるセマンティック構成の名前。
semanticErrorHandling	SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定)。
semanticFields	string	セマンティック ランク付けに使用されるフィールド名のコンマ区切りのリスト。
semanticMaxWaitInMilliseconds	integer	ユーザーが、セマンティック エンリッチメントが要求に失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティック リランク、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得とランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられ、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer	スキップする検索結果の数です。 この値は 100,000 を超えることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限により skip を使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペル チェックの種類を指定した 値。
top	integer	取得する検索結果の数です。 これは、$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングによって結果が切り捨てられた場合、応答には継続トークンが含まれます。このトークンを使用して、結果の次のページに対して別の検索要求を発行できます。
vectorFilterMode	VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを決定します。 既定値は 'preFilter' です。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

SearchResult

検索クエリによって検出されたドキュメントと、関連するメタデータが含まれます。

名前	型	説明
@search.captions	CaptionResult[]	キャプションは、ドキュメントから検索クエリまでの最も代表的な一節です。 多くの場合、ドキュメントの概要として使用されます。 キャプションは、型 'semantic' のクエリに対してのみ返されます。
@search.documentDebugInfo	DocumentDebugInfo[]	検索結果をさらに探索するために使用できるデバッグ情報が含まれています。
@search.highlights	object	該当する各フィールドで編成された、一致する検索用語を示すドキュメントのテキスト フラグメント。クエリでヒット強調表示が有効になっていない場合は null。
@search.rerankerScore	number	上位の検索結果のセマンティック ランカーによって計算された関連性スコア。 検索結果は、最初に RerankerScore で並べ替え、次に Score で並べ替えられます。 RerankerScore は、型 'semantic' のクエリに対してのみ返されます。
@search.score	number	クエリによって返される他のドキュメントと比較したドキュメントの関連性スコア。

SemanticDebugInfo

名前	型	説明
contentFields	QueryResultDocumentSemanticField[]	セマンティック エンリッチメント プロセスに送信されたコンテンツ フィールドと、その使用方法
keywordFields	QueryResultDocumentSemanticField[]	セマンティック エンリッチメント プロセスに送信されたキーワード (keyword) フィールドと、その使用方法
rerankerInput	QueryResultDocumentRerankerInput	セマンティック エンリッチメント プロセスに送信された未加工の連結文字列。
titleField	QueryResultDocumentSemanticField	セマンティック エンリッチメント プロセスに送信されたタイトル フィールドと、その使用方法

SemanticErrorMode

セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定値)。

名前	型	説明
fail	string	セマンティック処理ステップ中に例外がある場合、クエリは失敗し、エラーに応じて適切な HTTP コードを返します。
partial	string	セマンティック処理が失敗した場合でも、部分的な結果が返されます。 部分的な結果の定義は、失敗したセマンティック ステップと失敗の理由によって異なります。

SemanticErrorReason

セマンティック ランク付け要求に対して部分的な応答が返された理由。

名前	型	説明
capacityOverloaded	string	要求が調整されました。 基本結果のみが返されました。
maxWaitExceeded	string	'semanticMaxWaitInMilliseconds' が設定され、セマンティック処理期間がその値を超えた場合。 基本結果のみが返されました。
transient	string	セマンティック プロセスの少なくとも 1 つのステップが失敗しました。

SemanticFieldState

フィールドがセマンティック エンリッチメント プロセスに使用された方法 (完全に使用される、部分的に使用される、または未使用)

名前	型	説明
partial	string	フィールドは、セマンティック エンリッチメントに部分的に使用されました。
unused	string	フィールドはセマンティック エンリッチメントに使用されませんでした。
used	string	フィールドは、セマンティック エンリッチメントに完全に使用されました。

SemanticSearchResultsType

セマンティック ランク付け要求に対して返された部分応答の型。

名前	型	説明
baseResults	string	セマンティック エンリッチメントや再ランク付けのない結果。
rerankedResults	string	結果は再ランカー モデルで再ランク付けされ、セマンティック キャプションが含まれます。 回答、回答のハイライト、キャプションハイライトは含まれません。

VectorFilterMode

ベクター検索の実行前または実行後にフィルターを適用するかどうかを決定します。

名前	型	説明
postFilter	string	フィルターは、ベクター結果の候補セットが返された後に適用されます。 フィルター選択性によっては、パラメーター 'k' によって要求された結果よりも結果が少なくなる可能性があります。
preFilter	string	フィルターは、検索クエリの前に適用されます。

VectorizableTextQuery

ベクター化する必要があるテキスト値が指定されている場合にベクター検索に使用するクエリ パラメーター。

名前	型	説明
exhaustive	boolean	true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。 グラウンド トゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクターに含める Collection(Edm.Single) 型のベクター フィールド。
k	integer	トップ ヒットとして返される最も近い近隣の数。
kind	string: text	実行されるベクター クエリの種類。
text	string	ベクター検索クエリを実行するためにベクター化されるテキスト。

VectorQueryKind

実行されるベクター クエリの種類。

名前	型	説明
text	string	ベクター化する必要があるテキスト値が提供されるベクター クエリ。
vector	string	生ベクター値が提供されるベクター クエリ。