BaseSearchRequestOptions interface

Pakiet:

@azure/search-documents

Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.

Właściwości

facets	Lista wyrażeń aspektowych, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value.
filter	Wyrażenie OData $filter, które ma być stosowane do zapytania wyszukiwania.
highlightFields	Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania.
highlightPostTag	Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Wartość domyślna to </em>.
highlightPreTag	Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Wartość domyślna to <em>.
includeTotalCount	Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to false. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwrócona liczba jest przybliżeniem.
minimumCoverage	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania 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 100.
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.
queryType	Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. Możliwe wartości to: "simple", "full", "semantic"
scoringParameters	Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru będzie "mylocation--122.2,44.8" (bez cudzysłowów).
scoringProfile	Nazwa profilu oceniania w celu oceny wyników dopasowania pasujących dokumentów w celu sortowania wyników.
scoringStatistics	Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Możliwe wartości to: "Local", "Global"
searchFields	Rozdzielona przecinkami lista nazw pól, do których ma być włączona funkcja wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszelkimi nazwami pól wymienionymi w tym parametrze.
searchMode	Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania. Możliwe wartości to: "any", "all"
select	Lista pól do pobrania. Jeśli nieokreślone, zostaną uwzględnione wszystkie pola oznaczone jako możliwe do pobrania w schemacie.
sessionId	Wartość, która ma zostać użyta do utworzenia sesji lepkiej, co może pomóc uzyskać bardziej spójne wyniki. Tak długo, jak jest używany ten sam identyfikator sesji, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy pamiętać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_".
skip	Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pomijania ze względu na to ograniczenie, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtrze za pomocą zapytania zakresu.
top	Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki są obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania wyszukiwania dla następnej strony wyników.
vectorSearchOptions	Definiuje opcje zapytań wyszukiwania wektorowego

Szczegóły właściwości

facets

Lista wyrażeń aspektowych, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value.

facets?: string[]

Wartość właściwości

string[]

filter

Wyrażenie OData $filter, które ma być stosowane do zapytania wyszukiwania.

filter?: string

Wartość właściwości

string

highlightFields

Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania.

highlightFields?: 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. Wartość domyślna to </em>.

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. Wartość domyślna to <em>.

highlightPreTag?: string

Wartość właściwości

string

includeTotalCount

Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to false. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwrócona liczba jest przybliżeniem.

includeTotalCount?: boolean

Wartość właściwości

boolean

minimumCoverage

Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania 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 100.

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[]

queryType

Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. Możliwe wartości to: "simple", "full", "semantic"

queryType?: QueryType

Wartość właściwości

QueryType

scoringParameters

Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru będzie "mylocation--122.2,44.8" (bez cudzysłowów).

scoringParameters?: string[]

Wartość właściwości

string[]

scoringProfile

Nazwa profilu oceniania w celu oceny wyników dopasowania pasujących dokumentów w celu sortowania wyników.

scoringProfile?: string

Wartość właściwości

string

scoringStatistics

Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Możliwe wartości to: "Local", "Global"

scoringStatistics?: ScoringStatistics

Wartość właściwości

ScoringStatistics

searchFields

Rozdzielona przecinkami lista nazw pól, do których ma być włączona funkcja wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszelkimi nazwami pól wymienionymi w tym parametrze.

searchFields?: SearchFieldArray<TModel>

Wartość właściwości

SearchFieldArray<TModel>

searchMode

Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania. Możliwe wartości to: "any", "all"

searchMode?: SearchMode

Wartość właściwości

SearchMode

select

Lista pól do pobrania. Jeśli nieokreślone, zostaną uwzględnione wszystkie pola oznaczone jako możliwe do pobrania w schemacie.

select?: SelectArray<TFields>

Wartość właściwości

SelectArray<TFields>

sessionId

Wartość, która ma zostać użyta do utworzenia sesji lepkiej, co może pomóc uzyskać bardziej spójne wyniki. Tak długo, jak jest używany ten sam identyfikator sesji, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy pamiętać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_".

sessionId?: string

Wartość właściwości

string

skip

Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pomijania ze względu na to ograniczenie, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtrze za pomocą zapytania zakresu.

skip?: number

Wartość właściwości

number

top

Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki są obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania wyszukiwania dla następnej strony wyników.

top?: number

Wartość właściwości

number

vectorSearchOptions

Definiuje opcje zapytań wyszukiwania wektorowego

vectorSearchOptions?: VectorSearchOptions<TModel>

Wartość właściwości

VectorSearchOptions<TModel>