Documents - Search Get

リファレンス

サービス:: Search Service

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

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-05-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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-05-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

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>` に answers パラメーター値の後にオプション (など `extractive\|count-3`) を追加することで構成できます。既定のカウントは 1 です。信頼度しきい値を構成するには、パイプ文字 `\|` の後 `threshold-<confidence threshold>` に answers パラメーター値の後にオプション (など `extractive\|threshold-0.9`) を追加します。既定のしきい値は 0.7 です。
captions	query		QueryCaptionType	このパラメーターは、クエリの種類がの場合にのみ有効です `semantic`。設定した場合、クエリは、ランクが最も高いドキュメントの主要な部分から抽出されたキャプションを返します。 Captions がに `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[]	name-values 形式を使用してスコアリング関数 (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	ユーザーが、セマンティックエンリッチメントが要求に失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-05-01-preview&speller={speller}

応答のサンプル

状態コード:: 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	エラー応答
HybridCountAndFacetMode	カウントとファセットに、検索クエリに一致したすべてのドキュメント、または 'maxTextRecallSize' ウィンドウ内で取得されたドキュメントのみを含める必要があるかどうかを決定します。既定値は 'countAllResults' です。
HybridSearch	Tハイブリッド検索動作を構成するためのクエリパラメーター。
QueryAnswerType	検索応答の一部として回答を返す必要があるかどうかを示す値。
QueryCaptionType	検索応答の一部としてキャプションを返す必要があるかどうかを示す値。
QueryDebugMode	検索結果をさらに探索するために使用できるデバッグツールを有効にします。
QueryLanguage	クエリの言語。
QueryResultDocumentRerankerInput	セマンティックエンリッチメントプロセスに送信された未加工の連結文字列。
QueryResultDocumentSemanticField	セマンティックエンリッチメントプロセスに送信されたフィールドの説明と、その使用方法
QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペルチェックの種類を指定した値。
QueryType	検索クエリの構文を指定します。既定値は 'simple' です。クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。
RawVectorQuery	生ベクター値が指定されたときにベクター検索に使用するクエリパラメーター。
ScoringStatistics	スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。既定値は 'local' です。スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。グローバルスコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
SearchDocumentsResult	インデックスからの検索結果を含む応答。
SearchMode	一致ドキュメントをカウントする上で、検索用語の一部が一致すればよいか、それともすべて一致する必要があるかを指定します。
SearchRequest	フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。
SearchResult	検索クエリによって検出されたドキュメントと、関連付けられているメタデータが含まれます。
SearchScoreThreshold	ベクタークエリの結果は、'@search.score' 値に基づいてフィルター処理されます。これは、検索応答の @search.score 一部として返されるであることに注意してください。しきい値の方向は、より高い @search.scoreに対して選択されます。
SemanticDebugInfo
SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定)。
SemanticErrorReason	セマンティックランク付け要求に対して部分的な応答が返された理由。
SemanticFieldState	フィールドがセマンティックエンリッチメントプロセスに使用された方法 (完全に使用される、部分的に使用される、または未使用)
SemanticSearchResultsType	セマンティックランク付け要求に対して返された部分応答の型。
Speller	個々の検索クエリ用語をスペル修正することで、検索の呼び戻しを改善します。
VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを決定します。
VectorizableImageBinaryQuery	ベクター化する必要があるイメージの base 64 でエンコードされたバイナリが提供されている場合に、ベクター検索に使用するクエリパラメーター。
VectorizableImageUrlQuery	ベクター化する必要がある画像値を表す URL が指定されている場合に、ベクター検索に使用するクエリパラメーター。
VectorizableTextQuery	ベクター化する必要があるテキスト値が指定されている場合にベクター検索に使用するクエリパラメーター。
VectorQueryKind	実行されるベクタークエリの種類。
VectorSimilarityThreshold	ベクタークエリの結果は、ベクターの類似性メトリックに基づいてフィルター処理されます。これは類似性メトリックの正規の定義であり、'distance' バージョンではないことに注意してください。しきい値の方向 (大きいか小さいか) は、フィールドで使用されるメトリックに従って自動的に選択されます。
VectorThresholdKind	実行されるベクタークエリの種類。

AnswerResult

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

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

CaptionResult

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

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

DocumentDebugInfo

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

HybridCountAndFacetMode

カウントとファセットに、検索クエリに一致したすべてのドキュメント、または 'maxTextRecallSize' ウィンドウ内で取得されたドキュメントのみを含める必要があるかどうかを決定します。既定値は 'countAllResults' です。

名前	型	説明
countAllResults	string	'maxTextRecallSize' 取得ウィンドウ内にあるかどうかに関係なく、'count' と 'facets' を計算するときに検索クエリで一致したすべてのドキュメントを含めます。
countRetrievableResults	string	'count' と 'facets' を計算するときに、'maxTextRecallSize' 取得ウィンドウ内で一致したドキュメントのみを含めます。

HybridSearch

Tハイブリッド検索動作を構成するためのクエリパラメーター。

名前	型	説明
countAndFacetMode	HybridCountAndFacetMode	カウントとファセットに、検索クエリに一致したすべてのドキュメント、または 'maxTextRecallSize' ウィンドウ内で取得されたドキュメントのみを含める必要があるかどうかを決定します。
maxTextRecallSize	integer	ハイブリッド検索要求のテキストクエリ部分によって取得されるドキュメントの最大数を決定します。これらのドキュメントは、ベクタークエリに一致するドキュメントと組み合わせて、結果の 1 つの最終的なリストを生成します。より大きな maxTextRecallSize 値を選択すると、リソース使用率が高く、待機時間が長くなるというコストで、より多くのドキュメントを取得してページングできます (上位パラメーターとスキップパラメーターを使用)。値は 1 から 10,000 の間である必要があります。既定値は 1000 です。

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	タミル語 (インド) のクエリ言語値。
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	実行されるベクタークエリの種類。
oversampling	number	オーバーサンプリング係数。最大値は 1 です。インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクタークエリに使用されるしきい値。これは、すべての 'フィールド' で同じ類似性メトリックが使用されている場合にのみ設定できることに注意してください。
vector	number[]	検索クエリのベクター表現。
weight	number	同じ検索要求内の他のベクタークエリやテキストクエリと比較した場合のベクタークエリの相対的な重み。この値は、異なるベクタークエリによって生成された複数のランク付けリストの結果や、テキストクエリを介して取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終的なランク付けになります。既定値は 1.0 で、値は 0 より大きい正の数値である必要があります。

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[]	クエリによって返される結果のシーケンス。

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 です<>。
hybridSearch	HybridSearch[]	ハイブリッド検索動作を構成するためのクエリパラメーター。
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[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリパラメーター。

SearchResult

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

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

SearchScoreThreshold

ベクタークエリの結果は、'@search.score' 値に基づいてフィルター処理されます。これは、検索応答の @search.score 一部として返されるであることに注意してください。しきい値の方向は、より高い @search.scoreに対して選択されます。

名前	型	説明
kind	string: searchScore	ベクタークエリのフィルター処理に使用されるしきい値の種類
value	number	しきい値は、'@search.score' 値に基づいてフィルター処理されます。これは、検索応答の @search.score 一部として返されるであることに注意してください。しきい値の方向は、より高い @search.scoreに対して選択されます。

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	結果は再ランカーモデルで再ランク付けされ、セマンティックキャプションが含まれます。回答、回答の強調表示、またはキャプションの強調表示は含まれません。

Speller

個々の検索クエリ用語をスペル修正することで、検索の呼び戻しを改善します。

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

VectorFilterMode

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

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

VectorizableImageBinaryQuery

ベクター化する必要があるイメージの base 64 でエンコードされたバイナリが提供されている場合に、ベクター検索に使用するクエリパラメーター。

名前	型	説明
base64Image	string	ベクター検索クエリを実行するためにベクター化される画像の base 64 でエンコードされたバイナリ。
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクターに含める Collection(Edm.Single) 型のベクターフィールド。
k	integer	トップヒットとして返される最も近い近隣の数。
kind	string: imageBinary	実行されるベクタークエリの種類。
oversampling	number	オーバーサンプリング係数。最大値は 1 です。インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクタークエリに使用されるしきい値。これは、すべての 'フィールド' で同じ類似性メトリックが使用されている場合にのみ設定できることに注意してください。
weight	number	同じ検索要求内の他のベクタークエリやテキストクエリと比較した場合のベクタークエリの相対的な重み。この値は、異なるベクタークエリによって生成された複数のランク付けリストの結果や、テキストクエリを介して取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終的なランク付けになります。既定値は 1.0 で、値は 0 より大きい正の数値である必要があります。

VectorizableImageUrlQuery

ベクター化する必要がある画像値を表す URL が指定されている場合に、ベクター検索に使用するクエリパラメーター。

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクターに含める Collection(Edm.Single) 型のベクターフィールド。
k	integer	トップヒットとして返される最も近い近隣の数。
kind	string: imageUrl	実行されるベクタークエリの種類。
oversampling	number	オーバーサンプリング係数。最大値は 1 です。インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクタークエリに使用されるしきい値。これは、すべての 'フィールド' で同じ類似性メトリックが使用されている場合にのみ設定できることに注意してください。
url	string	ベクター検索クエリを実行するためにベクター化される画像の URL。
weight	number	同じ検索要求内の他のベクタークエリやテキストクエリと比較した場合のベクタークエリの相対的な重み。この値は、異なるベクタークエリによって生成された複数のランク付けリストの結果や、テキストクエリを介して取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終的なランク付けになります。既定値は 1.0 で、値は 0 より大きい正の数値である必要があります。

VectorizableTextQuery

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

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクターに含める Collection(Edm.Single) 型のベクターフィールド。
k	integer	トップヒットとして返される最も近い近隣の数。
kind	string: text	実行されるベクタークエリの種類。
oversampling	number	オーバーサンプリング係数。最大値は 1 です。インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。このパラメーターは、基になるベクターフィールドで圧縮メソッドを使用する場合にのみ使用できます。
text	string	ベクター検索クエリを実行するためにベクター化されるテキスト。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクタークエリに使用されるしきい値。これは、すべての 'フィールド' で同じ類似性メトリックが使用されている場合にのみ設定できることに注意してください。
weight	number	同じ検索要求内の他のベクタークエリやテキストクエリと比較した場合のベクタークエリの相対的な重み。この値は、異なるベクタークエリによって生成された複数のランク付けリストの結果や、テキストクエリを介して取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終的なランク付けになります。既定値は 1.0 で、値は 0 より大きい正の数値である必要があります。

VectorQueryKind

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

名前	型	説明
imageBinary	string	ベクター化する必要があるイメージの base 64 でエンコードされたバイナリが提供されるベクタークエリ。
imageUrl	string	ベクター化する必要がある画像値を表す URL が提供されるベクタークエリ。
text	string	ベクター化する必要があるテキスト値が提供されるベクタークエリ。
vector	string	生ベクター値が提供されるベクタークエリ。

VectorSimilarityThreshold

ベクタークエリの結果は、ベクターの類似性メトリックに基づいてフィルター処理されます。これは類似性メトリックの正規の定義であり、'distance' バージョンではないことに注意してください。しきい値の方向 (大きいか小さいか) は、フィールドで使用されるメトリックに従って自動的に選択されます。

名前	型	説明
kind	string: vectorSimilarity	ベクタークエリのフィルター処理に使用されるしきい値の種類
value	number	しきい値は、類似性メトリック値に基づいてフィルター処理されます。これは類似性メトリックの正規の定義であり、'distance' バージョンではないことに注意してください。しきい値の方向 (大きいか小さいか) は、フィールドで使用されるメトリックに従って自動的に選択されます。

VectorThresholdKind