Documents - Search Get

サービス:: Search Service

API バージョン:: 2025-08-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-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=2025-08-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&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`の場合にのみ有効です。設定すると、クエリは、最高ランクのドキュメントの主要なパッセージから抽出された回答を返します。返される回答の数は、パイプ文字 `\|` の後に answers パラメーター値の後に `count-<number of answers>` オプション ( `extractive\|count-3` など) を追加することで構成できます。デフォルトのカウントは 1 です。信頼度のしきい値は、パイプ文字 `\|` を付けて、answers パラメーター値の後に `threshold-<confidence threshold>` オプション ( `extractive\|threshold-0.9` など) を追加することで構成できます。デフォルトのしきい値は 0.7 です。回答の最大文字数は、パイプ文字 '\|' の後に 'count-<number of maximum character length>' (例: 'extractive\|maxcharlength-600') を追加することで構成できます。
captions	query		QueryCaptionType	このパラメータは、クエリタイプが `semantic`の場合にのみ有効です。設定すると、クエリは、最高ランクのドキュメントの主要なパッセージから抽出されたキャプションを返します。キャプションが `extractive` に設定されている場合、強調表示はデフォルトで有効になり、パイプ文字`\|`の後に `extractive\|highlight-true` などの`highlight-<true/false>` オプションを追加することで構成できます。既定値は `None` です。キャプションの最大文字長は、パイプ文字 '\|' の後に 'count-<number of maximum character length>' (例: 'extractive\|maxcharlength-600') を追加することで構成できます。
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	クエリの言語。
queryRewrites	query		QueryRewritesType	QueryRewrites が `generative` に設定されている場合、クエリ用語は生成モデルに送信され、要求の再現率を高めるために 10 回 (既定) の書き換えが生成されます。要求されたカウントは、パイプ文字 `\|` の後に `count-<number of rewrites>` オプション ( `generative\|count-3` など) を追加することで構成できます。既定値は `None` です。このパラメータは、クエリタイプが `semantic`の場合にのみ有効です。
queryType	query		QueryType	検索クエリの構文を指定する値。デフォルトは「シンプル」です。クエリで 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) minimum: 700	ユーザーは、要求が失敗する前にセマンティックエンリッチメントが処理を完了するまでにかかる時間の上限を設定できます。
semanticQuery	query		string	セマンティックリランク付け、セマンティックキャプション、およびセマンティック回答にのみ使用される別の検索クエリを設定できます。基本取得フェーズとランク付けフェーズ、および L2 セマンティックフェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	query		string	より一貫性のある結果を得るのに役立つスティッキーセッションを作成するために使用される値。同じ sessionId が使用されている限り、同じレプリカセットをターゲットにするためにベストエフォートアトライが行われます。同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられ、検索サービスのパフォーマンスに悪影響を及ぼす可能性があることに注意してください。 sessionId として使用される値は、'_' 文字で始まることはできません。
speller	query		QuerySpellerType	個々の検索クエリ用語のスペル修正により、検索再現率を向上させます。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	デバッグを支援するためにリクエストとともに送信されたトラッキング ID。
x-ms-query-source-authorization		string	クエリが実行されているユーザーを識別するトークン。このトークンは、ドキュメントにセキュリティ制限を適用するために使用されます。

応答

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

例

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

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=2025-08-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"
    }
  ]
}

状態コード:: 206

{
  "@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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-08-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

応答のサンプル

状態コード:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

状態コード:: 206

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

定義

名前	説明
AnswerResult	回答は、クエリに一致する最も関連性の高いドキュメントの内容から抽出されたテキストパッセージです。回答は上位の検索結果から抽出されます。回答候補が採点され、上位の回答が選択されます。
CaptionResult	キャプションは、検索クエリに対してドキュメントから最も代表的なパッセージです。これらは、ドキュメントの概要としてよく使用されます。キャプションは、タイプ `semantic` のクエリに対してのみ返されます。
DebugInfo	検索結果をさらに調べるために使用できるデバッグ情報が含まれています。
DocumentDebugInfo	検索結果をさらに調べるために使用できるデバッグ情報が含まれています。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HybridCountAndFacetMode	カウントとファセットに、検索クエリに一致したすべてのドキュメントを含めるか、'maxTextRecallSize' ウィンドウ内で取得されたドキュメントのみを含めるかを決定します。デフォルト値は 'countAllResults' です。
HybridSearch	ハイブリッド検索動作を構成するためのクエリパラメーター。
QueryAnswerType	検索応答の一部として回答を返すかどうかを指定する値。
QueryCaptionType	検索応答の一部としてキャプションを返すかどうかを指定する値。
QueryDebugMode	検索結果をさらに調べるために使用できるデバッグツールを有効にします。複数のデバッグモードを \|文字 (例: semantic\|queryRewrites) です。
QueryLanguage	クエリの言語。
QueryResultDocumentRerankerInput	セマンティック・エンリッチメント・プロセスに送信された生の連結ストリング。
QueryResultDocumentSemanticField	セマンティックエンリッチメントプロセスに送信されたフィールドの説明、およびそれらの使用方法
QueryResultDocumentSubscores	このドキュメントの検索クエリのテキストクエリコンポーネントとベクトルクエリコンポーネント間のサブスコアの内訳。各ベクトルクエリは、受信したのと同じ順序で個別のオブジェクトとして表示されます。
QueryRewritesDebugInfo	クエリの書き換えに固有のデバッグ情報が含まれています。
QueryRewritesType	検索クエリを拡張するためにクエリの書き換えを生成するかどうかを指定する値。
QueryRewritesValuesDebugInfo	クエリの書き換えに固有のデバッグ情報が含まれています。
QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペルチェックのタイプを指定する値。
QueryType	検索クエリの構文を指定します。デフォルトは「シンプル」です。クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。
RawVectorQuery	未加工のベクトル値が指定されている場合にベクトル検索に使用するクエリパラメーター。
ScoringStatistics	スコアリング統計 (ドキュメントの頻度など) をグローバルに計算してスコアリングをより一貫性のあるスコアリングにするか、ローカルで計算して待機時間を短縮するかを指定する値。デフォルトは「local」です。スコアリングの前にスコアリング統計をグローバルに集計するには、「global」を使用します。グローバルスコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
SearchDocumentsResult	インデックスからの検索結果を含む応答。
SearchMode	ドキュメントを一致としてカウントするために、検索語のいずれかまたはすべてを一致させる必要があるかどうかを指定します。
SearchRequest	フィルター処理、並べ替え、ファセット処理、ページング、およびその他の検索クエリ動作のパラメーター。
SearchResult	検索クエリで見つかったドキュメントと、関連するメタデータが含まれます。
SearchScoreThreshold	ベクトルクエリの結果は、'@search.score' 値に基づいてフィルター処理されます。これは、検索応答の一部として返される @search.score であることに注意してください。しきい値の方向は、より高い @search.scoreに対して選択されます。
SemanticDebugInfo
SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか (既定/現在の動作)、部分的な結果を返すかを選択できます。
SemanticErrorReason	セマンティックランク付け要求に対して部分的な応答が返された理由。
SemanticFieldState	セマンティックエンリッチメントプロセスでのフィールドの使用方法(完全使用、部分的使用、または未使用)
SemanticQueryRewritesResultType	この要求に使用されたクエリの書き換えの種類。
SemanticSearchResultsType	セマンティックランク付け要求に対して返された部分応答の種類。
SingleVectorFieldResult	単一ベクトル場の結果。 @search.score類似度値とベクトル類似度値の両方が返されます。ベクトル類似性は、方程式によって @search.score に関連付けられます。
TextResult	クエリのテキスト部分の BM25 またはクラシックスコア。
VectorFilterMode	ベクトル検索の実行前または実行後にフィルターを適用するかどうかを決定します。
VectorizableImageBinaryQuery	ベクトル化する必要がある画像の基底 64 でエンコードされたバイナリが提供されている場合に、ベクトル検索に使用するクエリパラメーター。
VectorizableImageUrlQuery	ベクトル化が必要な画像値を表す URL が指定されている場合に、ベクトル検索に使用するクエリパラメーター。
VectorizableTextQuery	ベクトル化が必要なテキスト値が指定されている場合にベクトル検索に使用するクエリパラメータ。
VectorQueryKind	実行されているベクトルクエリの種類。
VectorsDebugInfo
VectorSimilarityThreshold	ベクトルクエリの結果は、ベクトル類似性メトリックに基づいてフィルタリングされます。これは類似性メトリックの標準的な定義であり、「距離」バージョンではないことに注意してください。しきい値の方向 (大きいまたは小さい) は、フィールドで使用されるメトリックに従って自動的に選択されます。
VectorThresholdKind	実行されているベクトルクエリの種類。

AnswerResult

Object

回答は、クエリに一致する最も関連性の高いドキュメントの内容から抽出されたテキストパッセージです。回答は上位の検索結果から抽出されます。回答候補が採点され、上位の回答が選択されます。

名前	型	説明
highlights	string	Text プロパティと同じテキストパッセージで、クエリに最も関連性の高いテキストフレーズが強調表示されます。
key	string	回答が抽出された文書のキー。
score	number (double)	スコア値は、クエリに対して返される他の回答と比較して、回答がクエリにどの程度関連しているかを表します。
text	string	文書内容から抽出したテキストパッセージを答えとして。

CaptionResult

Object

キャプションは、検索クエリに対してドキュメントから最も代表的なパッセージです。これらは、ドキュメントの概要としてよく使用されます。キャプションは、タイプ semantic のクエリに対してのみ返されます。

名前	型	説明
highlights	string	Text プロパティと同じテキストパッセージで、クエリに最も関連性の高い強調表示されたフレーズ。
text	string	検索クエリに最も関連性の高いドキュメントから抽出された代表的なテキストパッセージ。

DebugInfo

Object

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

名前	型	説明
queryRewrites	QueryRewritesDebugInfo	クエリの書き換えに固有のデバッグ情報が含まれています。

DocumentDebugInfo

Object

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

名前	型	説明
innerHits	object	複合型のコレクション内で一致するベクトルに固有のデバッグ情報が含まれます。
semantic	SemanticDebugInfo	セマンティックランク付け要求に固有のデバッグ情報が含まれています。
vectors	VectorsDebugInfo	ベクトル検索とハイブリッド検索に固有のデバッグ情報が含まれています。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

HybridCountAndFacetMode

列挙

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

値	説明
countRetrievableResults	'count' と 'facets' を計算するときには、'maxTextRecallSize' 取得ウィンドウ内で一致したドキュメントのみを含めます。
countAllResults	「count」と「ファセット」の計算時に検索クエリに一致したすべてのドキュメントを含めます (それらのドキュメントが 'maxTextRecallSize' 取得ウィンドウ内にあるかどうかに関係なく)。

HybridSearch

Object

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

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

QueryAnswerType

列挙

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

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

QueryCaptionType

列挙

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

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

QueryDebugMode

列挙

検索結果をさらに調べるために使用できるデバッグツールを有効にします。複数のデバッグモードを |文字 (例: semantic|queryRewrites) です。

値	説明
disabled	クエリのデバッグ情報は返されません。
semantic	ユーザーが再ランク付けされた結果をさらに調べることができます。
vector	ユーザーは、ハイブリッドおよびベクトルのクエリ結果をさらに探索できます。
queryRewrites	ユーザーは、検索要求に対して生成されたクエリの書き換えのリストを探索できます。
innerHits	ユーザーは、複合型のコレクション内で一致するベクトルに関するスコアリング情報を取得できます。
all	すべてのデバッグオプションをオンにします。

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	タミル語 (インド) のクエリ言語値。
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	グジャラート語 (インド) のクエリ言語値。
he-il	ヘブライ語 (イスラエル) のクエリ言語値。
ga-ie	アイルランド語 (アイルランド) のクエリ言語値。
kn-in	カンナダ語 (インド) のクエリ言語値。
ml-in	マラヤーラム語 (インド) のクエリ言語値。
mr-in	マラーティー語 (インド) のクエリ言語値。
fa-ae	ペルシア語 (UAE) のクエリ言語値。
pa-in	パンジャブ語 (インド) のクエリ言語値。
te-in	テルグ語 (インド) のクエリ言語値。
ur-pk	ウルドゥー語 (パキスタン) のクエリ言語値。

QueryResultDocumentRerankerInput

Object

セマンティック・エンリッチメント・プロセスに送信された生の連結ストリング。

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

QueryResultDocumentSemanticField

Object

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

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

QueryResultDocumentSubscores

Object

このドキュメントの検索クエリのテキストクエリコンポーネントとベクトルクエリコンポーネント間のサブスコアの内訳。各ベクトルクエリは、受信したのと同じ順序で個別のオブジェクトとして表示されます。

名前	型	説明
documentBoost	number (double)	クエリのテキスト部分の BM25 またはクラシックスコア。
text	TextResult	クエリのテキスト部分の BM25 またはクラシックスコア。
vectors	<string, SingleVectorFieldResult>	各ベクトルクエリのベクトル類似度と @search.score 値。

QueryRewritesDebugInfo

Object

クエリの書き換えに固有のデバッグ情報が含まれています。

名前	型	説明
text	QueryRewritesValuesDebugInfo	テキストクエリに対して生成されたクエリの書き換えのリスト。
vectors	QueryRewritesValuesDebugInfo[]	ベクトル化可能なテキストクエリに対して生成されたクエリの書き換えのリスト。

QueryRewritesType

列挙

検索クエリを拡張するためにクエリの書き換えを生成するかどうかを指定する値。

値	説明
none	このクエリに対して追加のクエリ書き換えを生成しないでください。
generative	代替クエリ用語を生成して、検索要求の再現率を高めます。

QueryRewritesValuesDebugInfo

Object

クエリの書き換えに固有のデバッグ情報が含まれています。

名前	型	説明
inputQuery	string	生成クエリ書き換えモデルへの入力テキスト。ユーザークエリと生成モデルへの入力が同一でない場合がある場合があります。
rewrites	string[]	クエリの書き換えのリスト。

QuerySpellerType

列挙

個々の検索クエリ用語のスペル修正に使用するスペルチェックのタイプを指定する値。

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

QueryType

列挙

検索クエリの構文を指定します。デフォルトは「シンプル」です。クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。

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

RawVectorQuery

Object

未加工のベクトル値が指定されている場合にベクトル検索に使用するクエリパラメーター。

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して網羅的な k 最近傍検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクトルに含める Collection(Edm.Single) 型のベクトルフィールド。
filterOverride	string	この特定のベクトルクエリに適用する OData フィルター式。ベクトルレベルでフィルター式が定義されていない場合は、代わりにトップレベルのフィルターパラメーターで定義された式が使用されます。
k	integer (int32)	トップヒットとして返される最近傍の数。
kind	string: vector	実行されているベクトルクエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。これは、インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors'がtrueの場合にのみ設定できます。このパラメーターは、基礎となるベクトルフィールドで圧縮方法が使用されている場合にのみ許可されます。
perDocumentVectorLimit	integer (int32)	ベクトル検索クエリ内の各ドキュメントから一致できるベクトルの数を制御します。 1 に設定すると、ドキュメントごとに最大 1 つのベクトルが一致し、個別のドキュメントから結果が得られることが保証されます。 0 (無制限) に設定すると、同じドキュメントの複数の関連するベクトルを照合できます。既定値は 0 です。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクトルクエリに使用されるしきい値。これは、すべての「フィールド」が同じ類似性指標を使用している場合にのみ設定できることに注意してください。
vector	number[] (float)	検索クエリのベクトル表現。
weight	number (float)	同じ検索要求内の他のベクトルクエリやテキストクエリと比較した場合のベクトルクエリの相対的な重み。この値は、異なるベクトルクエリによって生成された複数のランキングリストの結果、および/またはテキストクエリで取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終ランキングで上位にランクされます。デフォルトは 1.0 で、値は 0 より大きい正の数である必要があります。

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[]	検索操作の回答クエリ結果。answers クエリパラメーターが指定されていないか、'none' に設定されている場合は null。
@search.coverage	number (double)	クエリに含まれたインデックスの割合を示す値、または要求で minimumCoverage が指定されていない場合は null。
@search.debug	DebugInfo	検索結果全体に適用される情報をデバッグします。
@search.facets	object	検索操作のファセットクエリ結果は、各ファセットフィールドのバケットのコレクションとして編成されます。クエリにファセット式が含まれていない場合は null。
@search.nextPageParameters	SearchRequest	継続 JSON ペイロードは、クエリが要求されたすべての結果を 1 つの応答で返すことができない場合に返されます。この JSON を @odata.nextLink とともに使用して、別の POST 検索要求を作成し、検索応答の次の部分を取得できます。
@search.semanticPartialResponseReason	SemanticErrorReason	セマンティックランク付け要求に対して部分的な応答が返された理由。
@search.semanticPartialResponseType	SemanticSearchResultsType	セマンティックランク付け要求に対して返された部分応答の種類。
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	ドキュメントの取得に使用されたクエリの書き換えの種類。
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>です。
hybridSearch	HybridSearch	ハイブリッド検索動作を構成するためのクエリパラメーター。
minimumCoverage	number (double)	クエリが成功として報告されるために、検索クエリでカバーする必要があるインデックスの割合を示す 0 から 100 までの数値。このパラメーターは、レプリカが 1 つしかないサービスでも検索の可用性を確保するのに役立ちます。既定値は、100 です。
orderby	string	結果を並べ替えるための OData $orderby式のコンマ区切りリスト。各式は、フィールド名、または geo.distance() 関数または search.score() 関数の呼び出しのいずれかです。各式の後に asc を付けて昇順を示し、desc を付けて降順を示すことができます。デフォルトは昇順です。同点は書類の試合スコアによって破られます。 $orderbyが指定されていない場合、デフォルトのソート順序はドキュメント一致スコアの降順になります。最大で 32 個の$orderby節が存在する可能性があります。
queryLanguage	QueryLanguage	検索クエリの言語を指定する値。
queryRewrites	QueryRewritesType	検索クエリを拡張するためにクエリの書き換えを生成するかどうかを指定する値。
queryType	QueryType	検索クエリの構文を指定する値。デフォルトは「シンプル」です。クエリで 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 (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[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	ベクトル検索クエリとハイブリッド検索クエリのクエリパラメーター。

SearchResult

Object

検索クエリで見つかったドキュメントと、関連するメタデータが含まれます。

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

SearchScoreThreshold

Object

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

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

SemanticDebugInfo

Object

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

SemanticErrorMode

列挙

セマンティック呼び出しを完全に失敗させるか (既定/現在の動作)、部分的な結果を返すかを選択できます。

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

SemanticErrorReason

列挙

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

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

SemanticFieldState

列挙

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

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

SemanticQueryRewritesResultType

列挙

この要求に使用されたクエリの書き換えの種類。

値	説明
originalQueryOnly	この要求に対してクエリの書き換えが正常に生成されませんでした。結果の取得には、元のクエリのみが使用されました。

SemanticSearchResultsType

列挙

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

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

SingleVectorFieldResult

Object

単一ベクトル場の結果。 @search.score類似度値とベクトル類似度値の両方が返されます。ベクトル類似性は、方程式によって @search.score に関連付けられます。

名前	型	説明
searchScore	number (double)	ベクトル類似性スコアから計算される @search.score 値。これは、純粋な単一フィールドの単一ベクトルクエリに表示されるスコアです。
vectorSimilarity	number (double)	このドキュメントのベクトル類似性スコア。これは類似性メトリックの標準的な定義であり、「距離」バージョンではないことに注意してください。たとえば、コサイン距離の代わりにコサイン類似度などです。

TextResult

Object

クエリのテキスト部分の BM25 またはクラシックスコア。

名前	型	説明
searchScore	number (double)	クエリのテキスト部分の BM25 またはクラシックスコア。

VectorFilterMode

列挙

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

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

VectorizableImageBinaryQuery

Object

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

名前	型	説明
base64Image	string	ベクトル検索クエリを実行するためにベクトル化される画像の基数 64 でエンコードされたバイナリ。
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して網羅的な k 最近傍検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクトルに含める Collection(Edm.Single) 型のベクトルフィールド。
filterOverride	string	この特定のベクトルクエリに適用する OData フィルター式。ベクトルレベルでフィルター式が定義されていない場合は、代わりにトップレベルのフィルターパラメーターで定義された式が使用されます。
k	integer (int32)	トップヒットとして返される最近傍の数。
kind	string: imageBinary	実行されているベクトルクエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。これは、インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors'がtrueの場合にのみ設定できます。このパラメーターは、基礎となるベクトルフィールドで圧縮方法が使用されている場合にのみ許可されます。
perDocumentVectorLimit	integer (int32)	ベクトル検索クエリ内の各ドキュメントから一致できるベクトルの数を制御します。 1 に設定すると、ドキュメントごとに最大 1 つのベクトルが一致し、個別のドキュメントから結果が得られることが保証されます。 0 (無制限) に設定すると、同じドキュメントの複数の関連するベクトルを照合できます。既定値は 0 です。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクトルクエリに使用されるしきい値。これは、すべての「フィールド」が同じ類似性指標を使用している場合にのみ設定できることに注意してください。
weight	number (float)	同じ検索要求内の他のベクトルクエリやテキストクエリと比較した場合のベクトルクエリの相対的な重み。この値は、異なるベクトルクエリによって生成された複数のランキングリストの結果、および/またはテキストクエリで取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終ランキングで上位にランクされます。デフォルトは 1.0 で、値は 0 より大きい正の数である必要があります。

VectorizableImageUrlQuery

Object

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

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して網羅的な k 最近傍検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクトルに含める Collection(Edm.Single) 型のベクトルフィールド。
filterOverride	string	この特定のベクトルクエリに適用する OData フィルター式。ベクトルレベルでフィルター式が定義されていない場合は、代わりにトップレベルのフィルターパラメーターで定義された式が使用されます。
k	integer (int32)	トップヒットとして返される最近傍の数。
kind	string: imageUrl	実行されているベクトルクエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。これは、インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors'がtrueの場合にのみ設定できます。このパラメーターは、基礎となるベクトルフィールドで圧縮方法が使用されている場合にのみ許可されます。
perDocumentVectorLimit	integer (int32)	ベクトル検索クエリ内の各ドキュメントから一致できるベクトルの数を制御します。 1 に設定すると、ドキュメントごとに最大 1 つのベクトルが一致し、個別のドキュメントから結果が得られることが保証されます。 0 (無制限) に設定すると、同じドキュメントの複数の関連するベクトルを照合できます。既定値は 0 です。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクトルクエリに使用されるしきい値。これは、すべての「フィールド」が同じ類似性指標を使用している場合にのみ設定できることに注意してください。
url	string	ベクトル検索クエリを実行するためにベクトル化される画像の URL。
weight	number (float)	同じ検索要求内の他のベクトルクエリやテキストクエリと比較した場合のベクトルクエリの相対的な重み。この値は、異なるベクトルクエリによって生成された複数のランキングリストの結果、および/またはテキストクエリで取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終ランキングで上位にランクされます。デフォルトは 1.0 で、値は 0 より大きい正の数である必要があります。

VectorizableTextQuery

Object

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

名前	型	説明
exhaustive	boolean	true の場合、ベクトルインデックス内のすべてのベクトルに対して網羅的な k 最近傍検索がトリガーされます。グラウンドトゥルース値の決定など、完全一致が重要なシナリオに役立ちます。
fields	string	検索されるベクトルに含める Collection(Edm.Single) 型のベクトルフィールド。
filterOverride	string	この特定のベクトルクエリに適用する OData フィルター式。ベクトルレベルでフィルター式が定義されていない場合は、代わりにトップレベルのフィルターパラメーターで定義された式が使用されます。
k	integer (int32)	トップヒットとして返される最近傍の数。
kind	string: text	実行されているベクトルクエリの種類。
oversampling	number (double)	オーバーサンプリング係数。最小値は 1 です。これは、インデックス定義で構成された 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors'がtrueの場合にのみ設定できます。このパラメーターは、基礎となるベクトルフィールドで圧縮方法が使用されている場合にのみ許可されます。
perDocumentVectorLimit	integer (int32)	ベクトル検索クエリ内の各ドキュメントから一致できるベクトルの数を制御します。 1 に設定すると、ドキュメントごとに最大 1 つのベクトルが一致し、個別のドキュメントから結果が得られることが保証されます。 0 (無制限) に設定すると、同じドキュメントの複数の関連するベクトルを照合できます。既定値は 0 です。
queryRewrites	QueryRewritesType	ジェネレーティブモデルがクエリをベクトル化するために送信する前にクエリを書き換えるように構成できます。
text	string	ベクトル検索クエリを実行するためにベクトル化されるテキスト。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	ベクトルクエリに使用されるしきい値。これは、すべての「フィールド」が同じ類似性指標を使用している場合にのみ設定できることに注意してください。
weight	number (float)	同じ検索要求内の他のベクトルクエリやテキストクエリと比較した場合のベクトルクエリの相対的な重み。この値は、異なるベクトルクエリによって生成された複数のランキングリストの結果、および/またはテキストクエリで取得された結果を組み合わせる場合に使用されます。重みが大きいほど、そのクエリに一致したドキュメントが最終ランキングで上位にランクされます。デフォルトは 1.0 で、値は 0 より大きい正の数である必要があります。

VectorQueryKind

列挙

実行されているベクトルクエリの種類。

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

VectorsDebugInfo

Object

名前	型	説明
subscores	QueryResultDocumentSubscores	RRF などの選択した結果セットの融合/組み合わせ方法の前のドキュメントのサブスコアの内訳。

VectorSimilarityThreshold

Object

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

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

VectorThresholdKind

列挙

実行されているベクトルクエリの種類。

値	説明
vectorSimilarity	ベクトルクエリの結果は、ベクトル類似性メトリックに基づいてフィルタリングされます。これは類似性メトリックの標準的な定義であり、「距離」バージョンではないことに注意してください。しきい値の方向 (大きいまたは小さい) は、フィールドで使用されるメトリックに従って自動的に選択されます。
searchScore	ベクトルクエリの結果は、'@search.score' 値に基づいてフィルター処理されます。これは、検索応答の一部として返される @search.score であることに注意してください。しきい値の方向は、より高い @search.scoreに対して選択されます。

値

説明

vectorSimilarity

searchScore