SearchDocumentsPageResult interface
インデックスからの検索ページの結果を含む応答。
- Extends
プロパティ
| continuation |
サーバーが改ページを強制するときに結果の次のページを取得するために使用されるトークン。 |
| results | クエリによって返される結果のシーケンス。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
継承されたプロパティ
| answers | 検索操作のクエリ結果に応答します。応答クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| count | 検索操作によって検出された結果の合計数。カウントが要求されなかった場合は null。 存在する場合、この応答の結果の数よりもカウントが大きくなる可能性があります。 これは、$topまたは$skipパラメーターを使用する場合、またはAzure Cognitive Searchが 1 つの Search 応答ですべての要求されたドキュメントを返さない場合に発生する可能性があります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| coverage | クエリに含まれていたインデックスの割合を示す値。要求で minimumCoverage が指定されていない場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| facets | 各ファセット フィールドのバケットのコレクションとして編成された、検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| semantic |
セマンティック検索要求に対して部分的な応答が返された理由。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| semantic |
セマンティック検索要求に対して返された部分応答の型。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
continuationToken
サーバーが改ページを強制するときに結果の次のページを取得するために使用されるトークン。
continuationToken?: stringプロパティ値
string
results
クエリによって返される結果のシーケンス。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
results: SearchResult<TModel, TFields>[]プロパティ値
SearchResult<TModel, TFields>[]
継承されたプロパティの詳細
answers
検索操作のクエリ結果に応答します。応答クエリ パラメーターが指定されていない場合、または 'none' に設定されている場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
answers?: QueryAnswerResult[]プロパティ値
count
検索操作によって検出された結果の合計数。カウントが要求されなかった場合は null。 存在する場合、この応答の結果の数よりもカウントが大きくなる可能性があります。 これは、$topまたは$skipパラメーターを使用する場合、またはAzure Cognitive Searchが 1 つの Search 応答ですべての要求されたドキュメントを返さない場合に発生する可能性があります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
count?: numberプロパティ値
number
coverage
クエリに含まれていたインデックスの割合を示す値。要求で minimumCoverage が指定されていない場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
coverage?: numberプロパティ値
number
facets
各ファセット フィールドのバケットのコレクションとして編成された、検索操作のファセット クエリ結果。クエリにファセット式が含まれていない場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
facets?: {[propertyName: string]: FacetResult[]}プロパティ値
{[propertyName: string]: FacetResult[]}
semanticErrorReason
セマンティック検索要求に対して部分的な応答が返された理由。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
semanticErrorReason?: SemanticErrorReasonプロパティ値
semanticSearchResultsType
セマンティック検索要求に対して返された部分応答の型。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
semanticSearchResultsType?: SemanticSearchResultsType