Documents - Search Get

サービス:: Search Service

API バージョン:: 2024-03-01-Preview

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-03-01-Preview

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

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2024-03-01-Preview

URI パラメーター

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

要求ヘッダー

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

応答

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

例

SearchIndexSearchDocumentsGet

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-03-01-Preview

応答のサンプル

状態コード:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

定義

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

AnswerResult

Object

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

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

CaptionResult

Object

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

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

DocumentDebugInfo

Object

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

QueryAnswerType

列挙

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

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

QueryCaptionType

列挙

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

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

QueryDebugMode

列挙

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

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

QueryLanguage

列挙

クエリの言語。

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

QueryResultDocumentRerankerInput

Object

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

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

QueryResultDocumentSemanticField

Object

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

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

QuerySpellerType

列挙

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

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

QueryType

列挙

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

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

RawVectorQuery

Object

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

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して、完全な k ニアレストネイバー検索がトリガーされます。地上の真偽値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	ベクター検索に含めるフィールド名のコンマ区切りのリスト。各フィールドは、Collection(Edm.Single) などの有効なベクター型である必要があります。複数のフィールドが指定されている場合、ベクターを使用して、すべてのフィールドで最も近い一致が検索されます。
k	integer (int32)	トップヒットとして返される最も近いネイバーの数。
kind	string: vector	実行されるベクタークエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。インデックス定義で構成されている 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
vector	number[] (float)	検索クエリのベクター表現。

ScoringStatistics

列挙

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

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

SearchDocumentsResult

Object

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

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

SearchMode

列挙

ドキュメントを一致としてカウントするために、検索語句の一部または全部を照合する必要があるかどうかを指定します。

値	説明
any	ドキュメントを一致としてカウントするには、検索語句のいずれかを照合する必要があります。
all	ドキュメントを一致としてカウントするには、すべての検索語句が一致する必要があります。

SearchRequest

Object

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

名前	型	説明
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 (double)	クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 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[]	形式名と値を使用してスコアリング関数 (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 (int32) minimum: 700	ユーザーが、セマンティックエンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティックの再ランク付け、セマンティックキャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。基本取得フェーズとランク付けフェーズと L2 セマンティックフェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	スティッキーセッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。同じ sessionId が使用されている限り、同じレプリカセットをターゲットにするためのベストエフォート試行が行われます。同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer (int32)	スキップする検索結果の数。この値を 100,000 より大きくすることはできません。ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペルチェックの種類を指定した値。
top	integer (int32)	取得する検索結果の数。これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode	VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。既定値は 'preFilter' です。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリパラメーター。

SearchResult

Object

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

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

SemanticDebugInfo

Object

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

SemanticErrorMode

列挙

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

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

SemanticErrorReason

列挙

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

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

SemanticFieldState

列挙

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

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

SemanticSearchResultsType

列挙

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

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

Speller

列挙

個々の検索クエリ用語をスペル修正することで、検索の再現率を向上させます。

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

VectorFilterMode

列挙

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

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

VectorizableTextQuery

Object

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

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して、完全な k ニアレストネイバー検索がトリガーされます。地上の真偽値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	ベクター検索に含めるフィールド名のコンマ区切りのリスト。各フィールドは、Collection(Edm.Single) などの有効なベクター型である必要があります。複数のフィールドが指定されている場合、ベクターを使用して、すべてのフィールドで最も近い一致が検索されます。
k	integer (int32)	トップヒットとして返される最も近いネイバーの数。
kind	string: text	実行されるベクタークエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。インデックス定義で構成されている 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
text	string	ベクター検索クエリを実行するためにベクター化されるテキスト。

VectorQueryKind

列挙

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

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