SearchDocumentsPageResult interface

參考

套件:: @azure/search-documents

包含索引搜尋頁面結果的回應。

Extends: SearchDocumentsResultBase

屬性

continuationToken	當伺服器強制執行分頁時，用來擷取下一頁結果的令牌。
results	查詢所傳回的結果序列。注意：這個屬性不會串行化。它只能由伺服器填入。

繼承的屬性

answers	搜尋作業的答案查詢結果;如果未指定答案查詢參數或設定為『none』，則為 null。注意：這個屬性不會串行化。它只能由伺服器填入。
count	搜尋作業所找到的結果總數，如果未要求計數，則為 null。如果存在，計數可能大於此回應中的結果數目。如果您使用$top或$skip參數，或 Azure 認知搜尋無法在單一搜尋回應中傳回所有要求的檔，就會發生這種情況。注意：這個屬性不會串行化。它只能由伺服器填入。
coverage	值，指出查詢中包含的索引百分比，如果要求中未指定 minimumCoverage，則為 null。注意：這個屬性不會串行化。它只能由伺服器填入。
facets	搜尋作業的 Facet 查詢結果，會組織為每個多面向字段的貯體集合;如果查詢未包含任何 Facet 運算式，則為 null。注意：這個屬性不會串行化。它只能由伺服器填入。
semanticErrorReason	語意搜尋要求傳回部分回應的原因。注意：這個屬性不會串行化。它只能由伺服器填入。
semanticSearchResultsType	針對語意搜尋要求傳回的部分回應類型。注意：這個屬性不會串行化。它只能由伺服器填入。

屬性詳細資料

continuationToken

當伺服器強制執行分頁時，用來擷取下一頁結果的令牌。

continuationToken?: string

屬性值

string

results

查詢所傳回的結果序列。 注意：這個屬性不會串行化。它只能由伺服器填入。

results: SearchResult<TModel, TFields>[]

屬性值

SearchResult<TModel, TFields>[]

繼承的屬性詳細資料

answers

搜尋作業的答案查詢結果;如果未指定答案查詢參數或設定為『none』，則為 null。注意：這個屬性不會串行化。它只能由伺服器填入。

answers?: QueryAnswerResult[]

屬性值

QueryAnswerResult[]

繼承自SearchDocumentsResultBase.answers

count

搜尋作業所找到的結果總數，如果未要求計數，則為 null。如果存在，計數可能大於此回應中的結果數目。如果您使用$top或$skip參數，或 Azure 認知搜尋無法在單一搜尋回應中傳回所有要求的檔，就會發生這種情況。 注意：這個屬性不會串行化。它只能由伺服器填入。

count?: number

屬性值

number

繼承自SearchDocumentsResultBase.count

coverage

值，指出查詢中包含的索引百分比，如果要求中未指定 minimumCoverage，則為 null。 注意：這個屬性不會串行化。它只能由伺服器填入。

coverage?: number

屬性值

number

繼承自SearchDocumentsResultBase.coverage

搜尋作業的 Facet 查詢結果，會組織為每個多面向字段的貯體集合;如果查詢未包含任何 Facet 運算式，則為 null。 注意：這個屬性不會串行化。它只能由伺服器填入。

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

屬性值

{[propertyName: string]: FacetResult[]}

繼承自SearchDocumentsResultBase.facets

semanticErrorReason

語意搜尋要求傳回部分回應的原因。注意：這個屬性不會串行化。它只能由伺服器填入。

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

屬性值

"maxWaitExceeded" | "capacityOverloaded" | "transient"

繼承自SearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

針對語意搜尋要求傳回的部分回應類型。注意：這個屬性不會串行化。它只能由伺服器填入。

semanticSearchResultsType?: "baseResults" | "rerankedResults"

屬性值

"baseResults" | "rerankedResults"

繼承自SearchDocumentsResultBase.semanticSearchResultsType

共用方式為