SearchDocumentsResult interface

Pacote:

@azure/search-documents

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

Extends

SearchDocumentsResultBase

Propriedades

results

A sequência de resultados retornada pela consulta. Observação : esta 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 Respostas não tiver sido especificado ou definido como 'Nenhum'. Observação : esta 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 nula se a contagem não foi solicitada. Se presente, a contagem pode ser maior do que o número de resultados nesta resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se a Pesquisa Cognitiva do Azure não puder retornar todos os documentos solicitados em uma única resposta de Pesquisa. Observação : esta 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 null se minimumCoverage não foi especificado na solicitação. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
facets	Os resultados da consulta de facetas para a operação de pesquisa, organizados como uma coleção de buckets para cada campo facetado; null se a consulta não incluir expressões de faceta. Observação : esta 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 : esta 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes de Propriedade

results

A sequência de resultados retornada pela consulta. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

results: SearchIterator<TModel, TFields>

Valor de Propriedade

SearchIterator<TModel, TFields>

Detalhes da Propriedade Herdada

answers

Os resultados da consulta de respostas para a operação de pesquisa; Nulo se o parâmetro de consulta Respostas não tiver sido especificado ou definido como 'Nenhum'. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

answers?: QueryAnswerResult[]

Valor de Propriedade

QueryAnswerResult[]

herdado de SearchDocumentsResultBase.answers

count

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

count?: number

Valor de Propriedade

number

herdado de SearchDocumentsResultBase.count

coverage

Um valor que indica a porcentagem do índice que foi incluído na consulta, ou null se minimumCoverage não foi especificado na solicitação. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

coverage?: number

Valor de Propriedade

number

herdado de SearchDocumentsResultBase.coverage

facets

Os resultados da consulta de facetas para a operação de pesquisa, organizados como uma coleção de buckets para cada campo facetado; null se a consulta não incluir expressões de faceta. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

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

Valor de Propriedade

{[propertyName: string]: FacetResult[]}

herdado doSearchDocumentsResultBase.facets

semanticErrorReason

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

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

Valor de Propriedade

"maxWaitExceeded" | "capacityOverloaded" | "transient"

herdado do SearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Tipo de resposta parcial que foi retornada para uma solicitação de pesquisa semântica. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Valor de Propriedade

"baseResults" | "rerankedResults"

herdado deSearchDocumentsResultBase.semanticSearchResultsType