Documents - Search Post

  • リファレンス
サービス:
Search Service
API バージョン:
2024-07-01

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

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

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 に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは近似値であることに注意してください。
facets

string[]

検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。
filter

string

検索クエリに適用する OData $filter式。
highlight

string

ヒット強調表示に使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
highlightPostTag

string

ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は /em><です。
highlightPreTag

string

強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は <em>です。
minimumCoverage

number

クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
orderby

string

結果を並べ替える OData $orderby式のコンマ区切りのリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
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

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

integer

ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery

string

セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId

string

スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip

integer

スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
top

integer

取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode

VectorFilterMode

ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。 新しいインデックスの既定値は 'preFilter' です。
vectorQueries VectorQuery[]:

ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

応答

名前 型 説明
200 OK

SearchDocumentsResult

検索条件に一致するドキュメントを含む応答。
Other Status Codes

ErrorResponse

エラー応答。

例

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

要求のサンプル

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,category,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true,
      "oversampling": 20,
      "weight": 2
    }
  ],
  "vectorFilterMode": "preFilter"
}

応答のサンプル

状態コード:
200 
{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

SearchIndexSearchDocumentsSemanticPost

要求のサンプル

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

{
  "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-07-01"
}

定義

名前 説明
AnswerResult

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

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

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

エラーの詳細。
ErrorResponse

エラー応答
QueryAnswerType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AnswerResult

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

名前 型 説明
highlights

string

クエリに最も関連性の高い強調表示されたテキスト フレーズを含む Text プロパティと同じテキストの一節。
key

string

回答が抽出されたドキュメントのキー。
score

number

スコア値は、クエリに対して返される他の回答に対するクエリに対する回答の関連性を表します。
text

string

ドキュメントの内容から回答として抽出されたテキストの一節。

CaptionResult

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

名前 型 説明
highlights

string

クエリに最も関連する強調表示された語句を含む Text プロパティと同じテキストの一節。
text

string

検索クエリに最も関連性の高いドキュメントから抽出された代表的なテキスト の一節。

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

QueryAnswerType

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

名前 型 説明
extractive

string

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

string

クエリの回答を返さないでください。

QueryCaptionType

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

名前 型 説明
extractive

string

検索クエリに関連する一節を含む一致するドキュメントからキャプションを抽出します。
none

string

クエリのキャプションを返さないでください。

QueryType

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

名前 型 説明
full

string

検索に完全な Lucene クエリ構文を使用します。 検索テキストは Lucene クエリ言語を使用して解釈され、フィールド固有の検索や重み付けされた検索、およびその他の高度な機能を使用できます。
semantic

string

キーワードではなく自然言語で表されるクエリに最適です。 Web コーパスでトレーニングされたランク付けモデルを使用して上位の検索結果を再ランク付けすることで、検索結果の精度が向上します。
simple

string

検索に単純なクエリ構文を使用します。 検索テキストは、+、*、"などの記号を使用できる単純なクエリ言語を使用して解釈されます。 searchFields パラメーターが指定されていない限り、クエリはすべての検索可能フィールドで既定で評価されます。

RawVectorQuery

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

名前 型 説明
exhaustive

boolean

true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k ニアレスト ネイバー検索がトリガーされます。 地上の真偽値の決定など、完全一致が重要なシナリオに役立ちます。
fields

string

検索されるベクトルに含める Collection(Edm.Single) 型のベクター フィールド。
k

integer

トップ ヒットとして返される最も近いネイバーの数。
kind string:

vector

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

number

オーバーサンプリング係数。 最小値は 1 です。 インデックス定義で構成されている 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。 このパラメーターは、基になるベクター フィールドで圧縮メソッドを使用する場合にのみ使用できます。
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.facets

object

各ファセット フィールドのバケットのコレクションとして編成された検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。
@search.nextPageParameters

SearchRequest

クエリが要求されたすべての結果を 1 つの応答で返せなかった場合に返される継続 JSON ペイロード。 この JSON を @odata.nextLink と共に使用して、別の POST Search 要求を作成して、検索応答の次の部分を取得できます。
@search.semanticPartialResponseReason

SemanticErrorReason

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

SemanticSearchResultsType

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

SearchResult[]

クエリによって返される結果のシーケンス。

SearchMode

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

名前 型 説明
all

string

ドキュメントを一致としてカウントするには、すべての検索語句が一致する必要があります。
any

string

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

SearchRequest

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

名前 型 説明
answers

QueryAnswerType

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

QueryCaptionType

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

boolean

結果の合計数をフェッチするかどうかを指定する値。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは近似値であることに注意してください。
facets

string[]

検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。
filter

string

検索クエリに適用する OData $filter式。
highlight

string

ヒット強調表示に使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
highlightPostTag

string

ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は /em><です。
highlightPreTag

string

強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は <em>です。
minimumCoverage

number

クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
orderby

string

結果を並べ替える OData $orderby式のコンマ区切りのリスト。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
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

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

integer

ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。
semanticQuery

string

セマンティックの再ランク付け、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。
sessionId

string

スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
skip

integer

スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
top

integer

取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
vectorFilterMode

VectorFilterMode

ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。 新しいインデックスの既定値は 'preFilter' です。
vectorQueries VectorQuery[]:

ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

SearchResult

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

名前 型 説明
@search.captions

CaptionResult[]

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

object

該当する各フィールドで編成された、一致する検索用語を示すドキュメントのテキスト フラグメント。クエリに対してヒット強調表示が有効になっていない場合は null。
@search.rerankerScore

number

上位の検索結果のセマンティック ランカーによって計算された関連性スコア。 検索結果は、最初に RerankerScore、次にスコアで並べ替えられます。 RerankerScore は、型 'semantic' のクエリに対してのみ返されます。
@search.score

number

クエリによって返される他のドキュメントと比較したドキュメントの関連性スコア。

SemanticErrorMode

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

名前 型 説明
fail

string

セマンティック処理手順中に例外がある場合、クエリは失敗し、エラーに応じて適切な HTTP コードが返されます。
partial

string

セマンティック処理が失敗した場合でも、部分的な結果が返されます。 部分的な結果の定義は、失敗したセマンティック ステップと失敗の理由によって異なります。

SemanticErrorReason

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

名前 型 説明
capacityOverloaded

string

要求が調整されました。 基本結果のみが返されました。
maxWaitExceeded

string

semanticMaxWaitInMilliseconds が設定され、セマンティック処理期間がその値を超えた場合。 基本結果のみが返されました。
transient

string

セマンティック プロセスの少なくとも 1 つのステップが失敗しました。

SemanticSearchResultsType

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

名前 型 説明
baseResults

string

セマンティック エンリッチメントや再ランク付けのない結果。
rerankedResults

string

結果は再ランカー モデルで再ランク付けされ、セマンティック キャプションが含まれます。 回答、回答のハイライト、キャプションの強調表示は含まれません。

VectorFilterMode

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

名前 型 説明
postFilter

string

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

string

フィルターは、検索クエリの前に適用されます。

VectorizableTextQuery

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

名前 型 説明
exhaustive

boolean

true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k ニアレスト ネイバー検索がトリガーされます。 地上の真偽値の決定など、完全一致が重要なシナリオに役立ちます。
fields

string

検索されるベクトルに含める Collection(Edm.Single) 型のベクター フィールド。
k

integer

トップ ヒットとして返される最も近いネイバーの数。
kind string:

text

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

number

オーバーサンプリング係数。 最小値は 1 です。 インデックス定義で構成されている 'defaultOversampling' パラメーターをオーバーライドします。 'rerankWithOriginalVectors' が true の場合にのみ設定できます。 このパラメーターは、基になるベクター フィールドで圧縮メソッドを使用する場合にのみ使用できます。
text

string

ベクター検索クエリを実行するためにベクター化されるテキスト。
weight

number

同じ検索要求内の他のベクター クエリやテキスト クエリと比較した場合のベクター クエリの相対的な重み。 この値は、さまざまなベクター クエリによって生成された複数のランク付けリストの結果や、テキスト クエリを使用して取得された結果を組み合わせる場合に使用されます。 重みが大きいほど、そのクエリに一致したドキュメントが最終的なランク付けになります。 既定値は 1.0 で、値は 0 より大きい正の数値である必要があります。

VectorQueryKind

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

名前 型 説明
text

string

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

string

生のベクター値が提供されるベクター クエリ。