Udostępnij za pośrednictwem

SuggestRequest interface

  • Odwołanie
Pakiet:
@azure/search-documents

Parametry filtrowania, sortowania, dopasowywania rozmytego i innych sugestii dotyczących zachowań zapytań.

Właściwości

filter

Wyrażenie OData, które filtruje dokumenty rozważane pod kątem sugestii.
highlightPostTag

Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
highlightPreTag

Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
minimumCoverage

Liczba z zakresu od 0 do 100 wskazująca wartość procentową indeksu, która musi być objęta sugestią zapytania w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 80.
orderBy

Lista wyrażeń $orderby OData, według których mają być posortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki meczów dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
searchFields

Rozdzielona przecinkami lista nazw pól do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonym sugestorze.
select

Lista pól do pobrania. Jeśli nie zostanie określona, w wynikach zostaną uwzględnione tylko pole klucza.
top

/**

  • Liczba sugestii do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to .
useFuzzyMatching

Wartość wskazująca, czy używać dopasowania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w tekście wyszukiwania znajduje się zastępczy lub brak znaku. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ wyszukiwania sugestii rozmytych są wolniejsze i zużywają więcej zasobów.

Szczegóły właściwości

filter

Wyrażenie OData, które filtruje dokumenty rozważane pod kątem sugestii.

filter?: string

Wartość właściwości

string

highlightPostTag

Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.

highlightPostTag?: string

Wartość właściwości

string

highlightPreTag

Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.

highlightPreTag?: string

Wartość właściwości

string

minimumCoverage

Liczba z zakresu od 0 do 100 wskazująca wartość procentową indeksu, która musi być objęta sugestią zapytania w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 80.

minimumCoverage?: number

Wartość właściwości

number

orderBy

Lista wyrażeń $orderby OData, według których mają być posortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki meczów dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.

orderBy?: string[]

Wartość właściwości

string[]

searchFields

Rozdzielona przecinkami lista nazw pól do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonym sugestorze.

searchFields?: SearchFieldArray<TModel>

Wartość właściwości

SearchFieldArray<TModel>

select

Lista pól do pobrania. Jeśli nie zostanie określona, w wynikach zostaną uwzględnione tylko pole klucza.

select?: SelectArray<TFields>

Wartość właściwości

SelectArray<TFields>

top

/**

  • Liczba sugestii do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to .
top?: number

Wartość właściwości

number

useFuzzyMatching

Wartość wskazująca, czy używać dopasowania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w tekście wyszukiwania znajduje się zastępczy lub brak znaku. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ wyszukiwania sugestii rozmytych są wolniejsze i zużywają więcej zasobów.

useFuzzyMatching?: boolean

Wartość właściwości

boolean