SearchDocumentsResult interface

Пакет:

@azure/search-documents

Ответ, содержащий результаты поиска из индекса.

Extends

SearchDocumentsResultBase

Свойства

results

Последовательность результатов, возвращаемая запросом. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

Унаследованные свойства

answers	Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
count	Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip, или если Azure AI Search не может вернуть все запрошенные документы в одном ответе поиска. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
coverage	Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
debugInfo	Отладочная информация, которая применяется к результатам поиска в целом. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
facets	Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
semanticErrorReason	Причина того, что частичный ответ был возвращен для семантического поискового запроса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
semanticQueryRewritesResultType	Тип перезаписи запроса, который использовался для извлечения документов. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
semanticSearchResultsType	Тип частичного ответа, возвращаемого для семантического запроса поиска. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

Сведения о свойстве

results

Последовательность результатов, возвращаемая запросом. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

results: SearchIterator<TModel, TFields>

Значение свойства

SearchIterator<TModel, TFields>

Сведения об унаследованном свойстве

answers

Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

answers?: QueryAnswerResult[]

Значение свойства

QueryAnswerResult[]

наследуется отSearchDocumentsResultBase.answers

count

Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip, или если Azure AI Search не может вернуть все запрошенные документы в одном ответе поиска. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

count?: number

Значение свойства

number

наследуется отSearchDocumentsResultBase.count

coverage

Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

coverage?: number

Значение свойства

number

наследуется отSearchDocumentsResultBase.coverage

debugInfo

Отладочная информация, которая применяется к результатам поиска в целом. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

debugInfo?: DebugInfo

Значение свойства

DebugInfo

Наследуется отSearchDocumentsResultBase.debugInfo

facets

Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

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

Значение свойства

{[propertyName: string]: FacetResult[]}

унаследован отSearchDocumentsResultBase.facets

semanticErrorReason

Причина того, что частичный ответ был возвращен для семантического поискового запроса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

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

Значение свойства

"maxWaitExceeded" | "capacityOverloaded" | "transient"

унаследован отSearchDocumentsResultBase.semanticErrorReason

semanticQueryRewritesResultType

Тип перезаписи запроса, который использовался для извлечения документов. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

semanticQueryRewritesResultType?: string

Значение свойства

string

Наследуется отSearchDocumentsResultBase.semanticQueryRewritesResultType

semanticSearchResultsType

Тип частичного ответа, возвращаемого для семантического запроса поиска. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Значение свойства

"baseResults" | "rerankedResults"

унаследован отSearchDocumentsResultBase.semanticSearchResultsType