Documents - Search Post

サービス:

Search Service

API バージョン:

2026-05-01-preview

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-05-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-query-source-authorization		string	クエリが実行されているユーザーを識別するトークン。 このトークンは、ドキュメントにセキュリティ制限を適用するために使用されます。
x-ms-enable-elevated-read		boolean	クエリ操作のドキュメント レベルのアクセス許可チェックをバイパスする管理者特権の読み取りを有効にする値。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	型	説明
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	検索クエリの構文を指定する値。 既定値は "simple" です。 クエリで Lucene クエリ構文を使用する場合は、'full' を使用します。
scoringParameters	string[]	形式名と値を使用してスコアリング関数 (referencePointParameter など) で使用するパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation-122.2,44.8" になります (引用符は使用しません)。
scoringProfile	string	結果を並べ替えるために一致するドキュメントの一致スコアを評価するスコアリング プロファイルの名前。
scoringStatistics	ScoringStatistics	スコアリングの統計情報 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルに計算するかを指定する値。待機時間を短縮します。 デフォルトは「local」です。 スコアリングの前にスコアリング統計をグローバルに集計するには、「global」を使用します。 グローバルスコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
search	string	全文検索クエリ式。「*」を使用するか、このパラメータを省略して、すべてのドキュメントに一致させます。
searchFields	string	フルテキスト検索の範囲を指定するフィールド名のコンマ区切りのリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターに記載されているフィールド名よりも優先されます。
searchMode	SearchMode	ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを指定する値。
select	string	取得するフィールドのコンマ区切りリスト。 指定しない場合、スキーマで取得可能としてマークされているすべてのフィールドが含まれます。
semanticConfiguration	string	セマンティック型のクエリのドキュメントを処理するときに使用されるセマンティック構成の名前。
semanticErrorHandling	SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか (既定/現在の動作)、部分的な結果を返すかを選択できます。
semanticFields	string	セマンティック ランク付けに使用されるフィールド名のコンマ区切りリスト。
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	より一貫性のある結果を得るのに役立つスティッキーセッションを作成するために使用される値。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer (int32)	スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	スペル作成者のタイプを指定し、個々の検索クエリのスペル修正を行います。
top	integer (int32)	取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode	VectorFilterMode	ベクトル検索の実行前または実行後にフィルターを適用するかどうかを決定します。 新しいインデックスのデフォルトは 'preFilter' です。
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

応答

名前	型	説明
200 OK	SearchDocumentsResult	要求は成功しました。
Other Status Codes	SearchDocumentsResult	成功
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsPostOsV2

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

要求のサンプル

HTTP

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




{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "queryLanguage": "en-us",
  "speller": "lexicon",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "queryRewrites": "generative",
  "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.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 27.725889205932617
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 39.23316955566406
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 23.01456642150879
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

状態コード:

206

{
  "value": []
}

SearchIndexSearchDocumentsPostOsV2

要求のサンプル

HTTP

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




{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "queryLanguage": "en-us",
  "speller": "lexicon",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "queryRewrites": "generative",
  "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.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.012987012974917889,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 15.319689750671387
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013333333656191826,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 18.800146102905273
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012195121496915817,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 15.319689750671387
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 15.319689750671387
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 11.507283210754395
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013513513840734959,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 18.800146102905273
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01315789483487606,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 15.319689750671387
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 33.067142486572266
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.016393441706895828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 33.067142486572266
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

状態コード:

206

{
  "value": []
}

SearchIndexSearchDocumentsSemanticPost

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-05-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=2025-05-01-preview"
}

状態コード:

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
    }
  ],
  "@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=2025-05-01-preview"
}

定義

名前	説明
Accept	Acceptヘッダーです。
DebugInfo	検索結果をさらに探索するために使用できるデバッグ情報が含まれています。
DocumentDebugInfo	検索結果をさらに探索するために使用できるデバッグ情報が含まれています。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
HybridCountAndFacetMode	カウントとファセットに、検索クエリに一致したすべてのドキュメントを含めるか、'maxTextRecallSize' ウィンドウ内で取得されたドキュメントのみを含めるかを決定します。 デフォルト値は 'countAllResults' です。
HybridSearch	ハイブリッド検索の動作を構成するためのクエリ パラメーター。
QueryAnswerResult	回答は、クエリに一致した最も関連性の高いドキュメントの内容から抽出されたテキストの一節です。 回答は上位の検索結果から抽出されます。 回答候補がスコア付けされ、上位の回答が選択されます。
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') を追加することで構成できます。
QueryCaptionResult	キャプションは、ドキュメントから検索クエリまでの最も代表的な一節です。 多くの場合、ドキュメントの概要として使用されます。 キャプションは、semantic型のクエリに対してのみ返されます。
QueryCaptionType	このパラメータは、クエリタイプが semanticの場合にのみ有効です。 設定した場合、クエリは、最もランクの高いドキュメントの主要な通路から抽出されたキャプションを返します。 キャプションが extractive に設定されている場合、強調表示はデフォルトで有効になり、パイプ文字|の後に highlight-<true/false> などのextractive|highlight-true オプションを追加することで構成できます。 既定値は None です。 キャプションの最大文字長は、パイプ文字 '|' の後に 'count-<number of maximum character length>' (例: 'extractive|maxcharlength-600') を追加することで構成できます。
QueryDebugMode	検索結果をさらに調べるために使用できるデバッグ ツールを有効にします。 複数のデバッグモードを |文字 (例: semantic|queryRewrites) です。
QueryLanguage	クエリの言語。
QueryResultDocumentRerankerInput	セマンティック エンリッチメント プロセスに送信された未加工の連結文字列。
QueryResultDocumentSemanticField	セマンティック エンリッチメント プロセスに送信されたフィールドの説明と、その使用方法
QueryResultDocumentSubscores	このドキュメントの検索クエリのテキスト クエリ コンポーネントとベクター クエリ コンポーネント間のサブスコアの内訳。 各ベクター クエリは、受信したのと同じ順序で個別のオブジェクトとして表示されます。
QueryRewritesDebugInfo	クエリの書き換えに固有のデバッグ情報が含まれています。
QueryRewritesType	このパラメータは、クエリタイプが semanticの場合にのみ有効です。 QueryRewrites が generative に設定されている場合、クエリ用語は生成モデルに送信され、要求の再現率を高めるために 10 回 (既定) の書き換えが生成されます。 要求されたカウントは、パイプ文字 | の後に count-<number of rewrites> オプション ( generative|count-3 など) を追加することで構成できます。 既定値は None です。
QueryRewritesValuesDebugInfo	クエリの書き換えに固有のデバッグ情報が含まれています。
QuerySpellerType	個々の検索クエリ用語をスペル修正することで、検索の再現率を向上させます。
QueryType	検索クエリの構文を指定します。 既定値は "simple" です。 クエリで Lucene クエリ構文を使用する場合は 'full' を使用し、クエリ構文が必要ない場合は 'semantic' を使用します。
ScoringStatistics	スコアリングの統計情報 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルに計算するかを指定する値。待機時間を短縮します。 デフォルトは「local」です。 スコアリングの前にスコアリング統計をグローバルに集計するには、「global」を使用します。 グローバルスコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
SearchDocumentsResult	インデックスからの検索結果を含む応答。
SearchMode	ドキュメントを一致としてカウントするために、検索語のいずれかまたはすべてを一致させる必要があるかどうかを指定します。
SearchRequest	フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。
SearchResult	検索クエリによって検出されたドキュメントと、関連するメタデータが含まれます。
SearchScoreThreshold	ベクトルクエリの結果は ' に基づいてフィルタリングされます。
SemanticDebugInfo	セマンティック ランク付け要求に固有のデバッグ情報が含まれています。
SemanticErrorMode	セマンティックコールを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できます。
SemanticErrorReason	セマンティック ランク付け要求に対して部分的な応答が返された理由。
SemanticFieldState	この分野が意味的豊か化プロセスにどのように利用されたかについて。
SemanticQueryRewritesResultType	この要求に使用されたクエリの書き換えの種類。
SemanticSearchResultsType	セマンティック ランク付け要求に対して返された部分応答の種類。
SingleVectorFieldResult	1 つのベクター フィールドの結果。 両方とも
TextResult	クエリのテキスト部分の BM25 またはクラシック スコア。
VectorFilterMode	ベクトル検索の実行前または実行後にフィルターを適用するかどうかを決定します。
VectorizableImageBinaryQuery	ベクター化する必要があるイメージの base 64 でエンコードされたバイナリが指定されている場合に、ベクター検索に使用するクエリ パラメーター。
VectorizableImageUrlQuery	ベクター化する必要がある画像値を表す URL が指定されている場合に、ベクター検索に使用するクエリ パラメーター。
VectorizableTextQuery	ベクター化する必要があるテキスト値が指定されている場合にベクター検索に使用するクエリ パラメーター。
VectorizedQuery	生のベクター値が指定されたときにベクター検索に使用するクエリ パラメーター。
VectorQueryKind	実行されているベクトル クエリの種類。
VectorsDebugInfo	「ベクトルおよびハイブリッド探索に特化したデバッグ情報を含みます。」)
VectorSimilarityThreshold	ベクター クエリの結果は、ベクトルの類似性メトリックに基づいてフィルター処理されます。 これは、'distance' バージョンではなく、類似性メトリックの正規の定義であることに注意してください。 しきい値の方向 (大きいか小さいか) は、フィールドで使用されるメトリックに従って自動的に選択されます。
VectorThresholdKind	ベクタークエリをフィルタリングする際に使われる閾値の種類です。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=none

DebugInfo

Object

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

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

DocumentDebugInfo

Object

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
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 です。

QueryAnswerResult

Object

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

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

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') を追加することで構成できます。

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

QueryCaptionResult

Object

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

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

QueryCaptionType

列挙

このパラメータは、クエリタイプが semanticの場合にのみ有効です。 設定した場合、クエリは、最もランクの高いドキュメントの主要な通路から抽出されたキャプションを返します。 キャプションが extractive に設定されている場合、強調表示はデフォルトで有効になり、パイプ文字|の後に highlight-<true/false> などのextractive|highlight-true オプションを追加することで構成できます。 既定値は None です。 キャプションの最大文字長は、パイプ文字 '|' の後に 'count-<number of maximum character length>' (例: 'extractive|maxcharlength-600') を追加することで構成できます。

値	説明
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>	ベクトル類似性と

QueryRewritesDebugInfo

Object

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

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

QueryRewritesType

列挙

このパラメータは、クエリタイプが semanticの場合にのみ有効です。 QueryRewrites が generative に設定されている場合、クエリ用語は生成モデルに送信され、要求の再現率を高めるために 10 回 (既定) の書き換えが生成されます。 要求されたカウントは、パイプ文字 | の後に count-<number of rewrites> オプション ( generative|count-3 など) を追加することで構成できます。 既定値は None です。

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

QueryRewritesValuesDebugInfo

Object

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

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

QuerySpellerType

列挙

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

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

QueryType

列挙

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

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

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	QueryAnswerResult[]	検索操作のクエリ結果に回答します。応答クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。
@search.coverage	number (double)	クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。
@search.debug	DebugInfo	検索結果全体に適用されるデバッグ情報。
@search.facets	object	各ファセット フィールドのバケットのコレクションとして編成された検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。
@search.nextPageParameters	SearchRequest	継続 JSON ペイロードは、クエリが要求されたすべての結果を 1 つの応答で返すことができない場合に返されます。 このJSONを以下と組み合わせて使うことができます。
@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	検索クエリの構文を指定する値。 既定値は "simple" です。 クエリで Lucene クエリ構文を使用する場合は、'full' を使用します。
scoringParameters	string[]	形式名と値を使用してスコアリング関数 (referencePointParameter など) で使用するパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation-122.2,44.8" になります (引用符は使用しません)。
scoringProfile	string	結果を並べ替えるために一致するドキュメントの一致スコアを評価するスコアリング プロファイルの名前。
scoringStatistics	ScoringStatistics	スコアリングの統計情報 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルに計算するかを指定する値。待機時間を短縮します。 デフォルトは「local」です。 スコアリングの前にスコアリング統計をグローバルに集計するには、「global」を使用します。 グローバルスコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。
search	string	全文検索クエリ式。「*」を使用するか、このパラメータを省略して、すべてのドキュメントに一致させます。
searchFields	string	フルテキスト検索の範囲を指定するフィールド名のコンマ区切りのリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターに記載されているフィールド名よりも優先されます。
searchMode	SearchMode	ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを指定する値。
select	string	取得するフィールドのコンマ区切りリスト。 指定しない場合、スキーマで取得可能としてマークされているすべてのフィールドが含まれます。
semanticConfiguration	string	セマンティック型のクエリのドキュメントを処理するときに使用されるセマンティック構成の名前。
semanticErrorHandling	SemanticErrorMode	セマンティック呼び出しを完全に失敗させるか (既定/現在の動作)、部分的な結果を返すかを選択できます。
semanticFields	string	セマンティック ランク付けに使用されるフィールド名のコンマ区切りリスト。
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery	string	セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId	string	より一貫性のある結果を得るのに役立つスティッキーセッションを作成するために使用される値。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip	integer (int32)	スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
speller	QuerySpellerType	スペル作成者のタイプを指定し、個々の検索クエリのスペル修正を行います。
top	integer (int32)	取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode	VectorFilterMode	ベクトル検索の実行前または実行後にフィルターを適用するかどうかを決定します。 新しいインデックスのデフォルトは 'preFilter' です。
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

SearchResult

Object

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

名前	型	説明
@search.captions	QueryCaptionResult[]	キャプションは、ドキュメントから検索クエリまでの最も代表的な一節です。 多くの場合、ドキュメントの概要として使用されます。 キャプションは、'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

ベクトルクエリの結果は ' に基づいてフィルタリングされます。

名前	型	説明
kind	string: searchScore	閾値の種類。
value	number (double)	しきい値は

SemanticDebugInfo

Object

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

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

SemanticErrorMode

列挙

セマンティックコールを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できます。

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

SemanticErrorReason

列挙

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

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

SemanticFieldState

列挙

この分野が意味的豊か化プロセスにどのように利用されたかについて。

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

SemanticQueryRewritesResultType

列挙

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

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

SemanticSearchResultsType

列挙

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

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

SingleVectorFieldResult

Object

1 つのベクター フィールドの結果。 両方とも

名前	型	説明
searchScore	number (double)	その
vectorSimilarity	number (double)	このドキュメントのベクトル類似性スコア。 これは、'distance' バージョンではなく、類似性メトリックの正規の定義であることに注意してください。 たとえば、コサイン距離の代わりにコサイン類似度などです。

TextResult

Object

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

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

VectorFilterMode

列挙

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

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

VectorizableImageBinaryQuery

Object

ベクター化する必要があるイメージの base 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 より大きい正の数値である必要があります。

VectorizedQuery

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 より大きい正の数値である必要があります。

VectorQueryKind

列挙

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

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

VectorsDebugInfo

Object

「ベクトルおよびハイブリッド探索に特化したデバッグ情報を含みます。」)

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

VectorSimilarityThreshold

Object

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

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

VectorThresholdKind

列挙

ベクタークエリをフィルタリングする際に使われる閾値の種類です。

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