Documents - Search Post

サービス:

Search Service

API バージョン:

2024-11-01-preview

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-11-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>です。
hybridSearch	HybridSearch	ハイブリッド検索の動作を構成するためのクエリ パラメーター。
minimumCoverage	number	クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
orderby	string	結果を並べ替える OData $orderby式のコンマ区切りのリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
queryLanguage	QueryLanguage	検索クエリの言語を指定する値。
queryRewrites	QueryRewritesType	検索クエリを拡張するためにクエリの書き換えを生成するかどうかを指定する値。
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	ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer	スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	個々の検索クエリ用語のスペル修正に使用するスペル チェックの種類を指定した値。
top	integer	取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode	VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。 新しいインデックスの既定値は 'preFilter' です。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

応答

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

例

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

要求のサンプル

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2024-11-01-preview


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "orderby": "id desc",
  "queryType": "simple",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1,
      "threshold": {
        "value": 0.984,
        "kind": "vectorSimilarity"
      },
      "filterOverride": "ownerId eq 'sam'"
    }
  ],
  "vectorFilterMode": "preFilter",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  }
}

応答のサンプル

状態コード:

200

{
  "@odata.count": 27,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "9",
      "name": "test",
      "description": "test9 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "6",
      "name": "test",
      "description": "test6 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "3",
      "name": "test",
      "description": "test3 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "24",
      "name": "test",
      "description": "test24 hello",
      "category": "purple",
      "ownerId": "ryan"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-01-preview

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

応答のサンプル

状態コード:

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
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "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"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-01-preview"
}

定義

名前	説明
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	検索クエリの構文を指定します。 既定値は "simple" です。 クエリで 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	1 つのベクター フィールドの結果。 @search.score とベクターの類似性の値の両方が返されます。 ベクトルの類似性は、数式によって @search.score に関連します。
TextResult	クエリのテキスト部分の BM25 またはクラシック スコア。
VectorFilterMode	ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。
VectorizableImageBinaryQuery	ベクター化する必要があるイメージの base 64 でエンコードされたバイナリが指定されている場合に、ベクター検索に使用するクエリ パラメーター。
VectorizableImageUrlQuery	ベクター化する必要がある画像値を表す URL が指定されている場合に、ベクター検索に使用するクエリ パラメーター。
VectorizableTextQuery	ベクター化する必要があるテキスト値が指定されている場合にベクター検索に使用するクエリ パラメーター。
VectorQueryKind	実行されるベクター クエリの種類。
VectorsDebugInfo
VectorSimilarityThreshold	ベクター クエリの結果は、ベクトルの類似性メトリックに基づいてフィルター処理されます。 これは、'distance' バージョンではなく、類似性メトリックの正規の定義であることに注意してください。 しきい値の方向 (大きいか小さいか) は、フィールドで使用されるメトリックに従って自動的に選択されます。
VectorThresholdKind	実行されるベクター クエリの種類。

AnswerResult

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

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

CaptionResult

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

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

DebugInfo

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

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

DocumentDebugInfo

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

名前	型	説明
semantic	SemanticDebugInfo	セマンティック ランク付け要求に固有のデバッグ情報が含まれています。
vectors	VectorsDebugInfo	ベクター検索とハイブリッド検索に固有のデバッグ情報が含まれています。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

HybridCountAndFacetMode

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

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

HybridSearch

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

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

QueryAnswerType

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

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

QueryCaptionType

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

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

QueryDebugMode

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

名前	型	説明
all	string	すべてのデバッグ オプションをオンにします。
disabled	string	クエリ デバッグ情報は返されません。
queryRewrites	string	ユーザーが検索要求に対して生成されたクエリ書き換えの一覧を調べることができます。
semantic	string	ユーザーが再ランク付けされた結果をさらに探索できるようにします。
vector	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	マラヤーラム語 (インド) のクエリ言語値。
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	セマンティック エンリッチメントに使用されたキーワード フィールドの未加工の連結文字列。
title	string	セマンティック エンリッチメントに使用されたタイトル フィールドの生文字列。

QueryResultDocumentSemanticField

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

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

QueryResultDocumentSubscores

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

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

QueryRewritesDebugInfo

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

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

QueryRewritesType

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

名前	型	説明
generative	string	検索要求の呼び戻しを増やすために、代替クエリ用語を生成します。
none	string	このクエリに対して追加のクエリ書き換えを生成しないでください。

QueryRewritesValuesDebugInfo

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

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

QuerySpellerType

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

名前	型	説明
lexicon	string	Speller は、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) 型のベクター フィールド。
filterOverride	string	この特定のベクター クエリに適用する OData フィルター式。 ベクター レベルでフィルター式が定義されていない場合は、最上位レベルのフィルター パラメーターで定義されている式が代わりに使用されます。
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[]	検索操作のクエリ結果に回答します。応答クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。
@search.coverage	number	クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。
@search.debug	DebugInfo	検索結果全体に適用されるデバッグ情報。
@search.facets	object	各ファセット フィールドのバケットのコレクションとして編成された検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。
@search.nextPageParameters	SearchRequest	クエリが要求されたすべての結果を 1 つの応答で返せなかった場合に返される継続 JSON ペイロード。 この JSON を @odata.nextLink と共に使用して、別の POST Search 要求を作成して、検索応答の次の部分を取得できます。
@search.semanticPartialResponseReason	SemanticErrorReason	セマンティック ランク付け要求に対して部分的な応答が返された理由。
@search.semanticPartialResponseType	SemanticSearchResultsType	セマンティック ランク付け要求に対して返された部分応答の型。
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	ドキュメントの取得に使用されたクエリ書き換えの種類。
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	検索クエリの言語を指定する値。
queryRewrites	QueryRewritesType	検索クエリを拡張するためにクエリの書き換えを生成するかどうかを指定する値。
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	ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer	スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで 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[]	セマンティック エンリッチメント プロセスに送信されたキーワード フィールドと、その使用方法
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	このフィールドは、セマンティック エンリッチメントに完全に使用されました。

SemanticQueryRewritesResultType

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

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

SemanticSearchResultsType

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

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

SingleVectorFieldResult

1 つのベクター フィールドの結果。 @search.score とベクターの類似性の値の両方が返されます。 ベクトルの類似性は、数式によって @search.score に関連します。

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

TextResult

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

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

VectorFilterMode

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

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

VectorizableImageBinaryQuery

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

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

VectorQueryKind

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

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

VectorsDebugInfo

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

VectorSimilarityThreshold

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

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

VectorThresholdKind

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

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