SearchDocumentsResult interface

Pakiet:

@azure/search-documents

Odpowiedź zawierająca wyniki wyszukiwania z indeksu.

Rozszerzenie

SearchDocumentsResultBase

Właściwości

results

Sekwencja wyników zwróconych przez zapytanie. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Właściwości dziedziczone

answers	Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania odpowiedzi nie został określony lub ustawiony na wartość "none". UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
count	Łączna liczba wyników znalezionych przez operację wyszukiwania lub wartość null, jeśli liczba nie została żądana. Jeśli istnieje, liczba może być większa niż liczba wyników w tej odpowiedzi. Może się tak zdarzyć, jeśli używasz parametrów $top lub $skip albo jeśli usługa Azure Cognitive Search nie może zwrócić wszystkich żądanych dokumentów w pojedynczej odpowiedzi wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
coverage	Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimalna wartośćCoverage nie została określona w żądaniu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
facets	Wyniki zapytania aspektowego dla operacji wyszukiwania zorganizowane jako kolekcja zasobników dla każdego pola aspektowego; null, jeśli zapytanie nie zawiera żadnych wyrażeń aspektów. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
semanticErrorReason	Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
semanticSearchResultsType	Typ częściowej odpowiedzi zwróconej dla semantycznego żądania wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

results

Sekwencja wyników zwróconych przez zapytanie. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

results: SearchIterator<TModel, TFields>

Wartość właściwości

SearchIterator<TModel, TFields>

Szczegóły właściwości dziedziczonej

answers

Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania odpowiedzi nie został określony lub ustawiony na wartość "none". UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

answers?: QueryAnswerResult[]

Wartość właściwości

QueryAnswerResult[]

dziedziczone zSearchDocumentsResultBase.answers

count

Łączna liczba wyników znalezionych przez operację wyszukiwania lub wartość null, jeśli liczba nie została żądana. Jeśli istnieje, liczba może być większa niż liczba wyników w tej odpowiedzi. Może się tak zdarzyć, jeśli używasz parametrów $top lub $skip albo jeśli usługa Azure Cognitive Search nie może zwrócić wszystkich żądanych dokumentów w pojedynczej odpowiedzi wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

count?: number

Wartość właściwości

number

dziedziczone zSearchDocumentsResultBase.count

coverage

Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimalna wartośćCoverage nie została określona w żądaniu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

coverage?: number

Wartość właściwości

number

dziedziczone zSearchDocumentsResultBase.coverage

facets

Wyniki zapytania aspektowego dla operacji wyszukiwania zorganizowane jako kolekcja zasobników dla każdego pola aspektowego; null, jeśli zapytanie nie zawiera żadnych wyrażeń aspektów. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

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

Wartość właściwości

{[propertyName: string]: FacetResult[]}

dziedziczone zSearchDocumentsResultBase.facets

semanticErrorReason

Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

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

Wartość właściwości

"maxWaitExceeded" | "capacityOverloaded" | "transient"

dziedziczone zSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Typ częściowej odpowiedzi zwróconej dla semantycznego żądania wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Wartość właściwości

"baseResults" | "rerankedResults"

dziedziczone zSearchDocumentsResultBase.semanticSearchResultsType