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 devolvida pela consulta. NOTA: esta propriedade não será serializada. 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 tiver sido especificado ou definido como "nenhum". NOTA: esta propriedade não será serializada. 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 tiver sido pedida. Se estiver presente, a contagem pode ser maior do que o número de resultados nesta resposta. Isto pode acontecer se utilizar os parâmetros $top ou $skip ou se Azure Cognitive Search não conseguir devolver todos os documentos pedidos numa única resposta de Pesquisa. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
coverage	Um valor que indica a percentagem do índice incluído na consulta ou nulo se minimumCoverage não tiver sido especificado no pedido. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
facets	Os resultados da consulta faceta para a operação de pesquisa, organizados como uma coleção de registos para cada campo facetado; nulo se a consulta não incluir expressões de facetas. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
semanticErrorReason	Motivo pelo qual foi devolvida uma resposta parcial para um pedido de pesquisa semântica. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
semanticSearchResultsType	Tipo de resposta parcial que foi devolvida para um pedido de pesquisa semântica. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

Detalhes de Propriedade

results

A sequência de resultados devolvida pela consulta. NOTA: esta propriedade não será serializada. 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 de respostas não tiver sido especificado ou definido como "nenhum". NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

answers?: QueryAnswerResult[]

Valor de Propriedade

QueryAnswerResult[]

Herdado deSearchDocumentsResultBase.answers

count

A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não tiver sido pedida. Se estiver presente, a contagem pode ser maior do que o número de resultados nesta resposta. Isto pode acontecer se utilizar os parâmetros $top ou $skip ou se Azure Cognitive Search não conseguir devolver todos os documentos pedidos numa única resposta de Pesquisa. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

count?: number

Valor de Propriedade

number

Herdado deSearchDocumentsResultBase.count

coverage

Um valor que indica a percentagem do índice incluído na consulta ou nulo se minimumCoverage não tiver sido especificado no pedido. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

coverage?: number

Valor de Propriedade

number

Herdado deSearchDocumentsResultBase.coverage

facets

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

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

Valor de Propriedade

{[propertyName: string]: FacetResult[]}

Herdado deSearchDocumentsResultBase.facets

semanticErrorReason

Motivo pelo qual foi devolvida uma resposta parcial para um pedido de pesquisa semântica. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

semanticErrorReason?: SemanticErrorReason

Valor de Propriedade

SemanticErrorReason

Herdado deSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Tipo de resposta parcial que foi devolvida para um pedido de pesquisa semântica. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

semanticSearchResultsType?: SemanticSearchResultsType

Valor de Propriedade

SemanticSearchResultsType

Herdado deSearchDocumentsResultBase.semanticSearchResultsType