SearchDocumentsResultBase interface

Pacote:

@azure/search-documents

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

Propriedades

answers	Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta answers não tiver sido 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 encontrada pela operação de pesquisa ou nula se a contagem não foi solicitada. Se presente, a contagem pode ser maior que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se 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 a porcentagem 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, organizados 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 que 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.

Detalhes da propriedade

answers

Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta answers não tiver sido 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[]

count

A contagem total de resultados encontrada pela operação de pesquisa ou nula se a contagem não foi solicitada. Se presente, a contagem pode ser maior que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se 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

coverage

Um valor que indica a porcentagem 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

facets

Os resultados da consulta de faceta para a operação de pesquisa, organizados 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[]}

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"

semanticSearchResultsType

Tipo de resposta parcial que 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?: "baseResults" | "rerankedResults"

Valor da propriedade

"baseResults" | "rerankedResults"