SearchDocumentsResult interface

クエリによって返される結果のシーケンス。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

results: SearchIterator<TModel, TFields>

プロパティ値

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

answers?: QueryAnswerResult[]

プロパティ値

SearchDocumentsResultBase.answers から継承された

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

count?: number

プロパティ値

SearchDocumentsResultBase.count から継承された

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

coverage?: number

プロパティ値

SearchDocumentsResultBase.coverage から継承された

検索結果全体に適用されるデバッグ情報。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

debugInfo?: DebugInfo

プロパティ値

継承元SearchDocumentsResultBase.debugInfo

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

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

プロパティ値

SearchDocumentsResultBase.facets から継承

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

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

プロパティ値

SearchDocumentsResultBase.semanticErrorReason から継承された

ドキュメントの取得に使用されたクエリ書き換えの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

semanticQueryRewritesResultType?: string

プロパティ値

継承元SearchDocumentsResultBase.semanticQueryRewritesResultType

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

semanticSearchResultsType?: "baseResults" | "rerankedResults"

プロパティ値

SearchDocumentsResultBase.semanticSearchResultsType から継承