Compartilhar via

SearchDocumentsPageResult interface

  • Referência
Pacote:
@azure/search-documents

Resposta que contém os resultados da página de pesquisa de um índice.

Extends
SearchDocumentsResultBase

Propriedades

continuationToken

Um token usado para recuperar a próxima página de resultados quando o servidor impõe paginação.
results

A sequência de resultados retornados pela consulta. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Propriedades herdadas

answers

Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta de respostas não foi especificado ou definido como 'none'. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
count

A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não foi solicitada. Se presente, a contagem poderá ser maior do que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se o Azure Cognitive Search não puder retornar todos os documentos solicitados em uma única resposta de Pesquisa. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
coverage

Um valor que indica o percentual do índice que foi incluído na consulta ou nulo se minimumCoverage não foi especificado na solicitação. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
facets

Os resultados da consulta de faceta para a operação de pesquisa, organizada como uma coleção de buckets para cada campo facetado; nulo se a consulta não incluir nenhuma expressão de faceta. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
semanticErrorReason

Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de pesquisa semântica. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
semanticSearchResultsType

Tipo de resposta parcial retornada para uma solicitação de pesquisa semântica. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

continuationToken

Um token usado para recuperar a próxima página de resultados quando o servidor impõe paginação.

continuationToken?: string

Valor da propriedade

string

results

A sequência de resultados retornados pela consulta. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

results: SearchResult<TModel, TFields>[]

Valor da propriedade

SearchResult<TModel, TFields>[]

Detalhes das propriedades herdadas

answers

Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta de respostas não foi especificado ou definido como 'none'. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

answers?: QueryAnswerResult[]

Valor da propriedade

QueryAnswerResult[]

Herdado deSearchDocumentsResultBase.answers

count

A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não foi solicitada. Se presente, a contagem poderá ser maior do que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se o Azure Cognitive Search não puder retornar todos os documentos solicitados em uma única resposta de Pesquisa. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

count?: number

Valor da propriedade

number

herdado deSearchDocumentsResultBase.count

coverage

Um valor que indica o percentual do índice que foi incluído na consulta ou nulo se minimumCoverage não foi especificado na solicitação. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

coverage?: number

Valor da propriedade

number

herdado deSearchDocumentsResultBase.coverage

facets

Os resultados da consulta de faceta para a operação de pesquisa, organizada como uma coleção de buckets para cada campo facetado; nulo se a consulta não incluir nenhuma expressão de faceta. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

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

Valor da propriedade

{[propertyName: string]: FacetResult[]}

Herdado deSearchDocumentsResultBase.facets

semanticErrorReason

Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de pesquisa semântica. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

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

Valor da propriedade

"maxWaitExceeded" | "capacityOverloaded" | "transient"

Herdado deSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Tipo de resposta parcial retornada para uma solicitação de pesquisa semântica. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Valor da propriedade

"baseResults" | "rerankedResults"

Herdado deSearchDocumentsResultBase.semanticSearchResultsType