SearchDocumentsResultBase interface

パッケージ:

@azure/search-documents

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

プロパティ

answers	検索操作のクエリ結果に応答します。answers クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
count	検索操作によって検出された結果の合計数。カウントが要求されなかった場合は null。 存在する場合、この応答の結果の数よりもカウントが大きくなる可能性があります。 これは、$topまたは$skipパラメーターを使用する場合、またはAzure Cognitive Searchが 1 つの検索応答ですべての要求されたドキュメントを返さない場合に発生する可能性があります。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
coverage	クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
facets	各ファセット フィールドのバケットのコレクションとして編成された、検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
semanticErrorReason	セマンティック検索要求に対して部分的な応答が返された理由。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
semanticSearchResultsType	セマンティック検索要求に対して返された部分応答の型。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

プロパティの詳細

answers

検索操作のクエリ結果に応答します。answers クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

answers?: QueryAnswerResult[]

プロパティ値

QueryAnswerResult[]

count

検索操作によって検出された結果の合計数。カウントが要求されなかった場合は null。 存在する場合、この応答の結果の数よりもカウントが大きくなる可能性があります。 これは、$topまたは$skipパラメーターを使用する場合、またはAzure Cognitive Searchが 1 つの検索応答ですべての要求されたドキュメントを返さない場合に発生する可能性があります。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

count?: number

プロパティ値

number

coverage

クエリに含まれていたインデックスの割合を示す値。minimumCoverage が要求で指定されていない場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

coverage?: number

プロパティ値

number

facets

各ファセット フィールドのバケットのコレクションとして編成された、検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

facets?: {[propertyName: string]: FacetResult[]}

プロパティ値

{[propertyName: string]: FacetResult[]}

semanticErrorReason

セマンティック検索要求に対して部分的な応答が返された理由。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

semanticErrorReason?: "maxWaitExceeded" | "capacityOverloaded" | "transient"

プロパティ値

"maxWaitExceeded" | "capacityOverloaded" | "transient"

semanticSearchResultsType

セマンティック検索要求に対して返された部分応答の型。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

semanticSearchResultsType?: "baseResults" | "rerankedResults"

プロパティ値

"baseResults" | "rerankedResults"