BaseSearchRequestOptions interface

Pakket:

@azure/search-documents

Parameters voor filteren, sorteren, faceting, paging en ander zoekquerygedrag.

Eigenschappen

facets	De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.
filter	De OData-$filter expressie die moet worden toegepast op de zoekquery.
highlightFields	De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.
highlightPreTag	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em>.
includeTotalCount	Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardinstelling is onwaar. Het instellen van deze waarde op true kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.
minimumCoverage	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een zoekquery moet worden gedekt om de query als geslaagd te kunnen rapporteren. Deze parameter kan handig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.
orderBy	De lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Ties worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby-componenten zijn.
queryType	Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis. Mogelijke waarden zijn: 'simple', 'full', 'semantic'
scoringParameters	De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met de parameter 'mylocation', is de parametertekenreeks 'mylocation-122.2,44.8' (zonder de aanhalingstekens).
scoringProfile	De naam van een scoreprofiel voor het evalueren van matchscores voor overeenkomende documenten om de resultaten te sorteren.
scoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. Mogelijke waarden zijn: 'Lokaal', 'Globaal'
searchFields	De door komma's gescheiden lijst met veldnamen waarop de volledige tekst moet worden gezocht. Wanneer u veldzoekopdrachten (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.
searchMode	Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen. Mogelijke waarden zijn: 'any', 'all'
select	De lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, worden alle velden die zijn gemarkeerd als ophalen mogelijk in het schema opgenomen.
sessionId	Een waarde die moet worden gebruikt om een plaksessie te maken, die kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk opnieuw gebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen in verschillende replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, mag niet beginnen met een _-teken.
skip	Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde moet scannen, maar vanwege deze beperking niet kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
top	Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te voeren voor de volgende pagina met resultaten.
vectorSearchOptions	Definieert opties voor vectorzoekquery's

Eigenschapdetails

facets

De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.

facets?: string[]

Waarde van eigenschap

string[]

filter

De OData-$filter expressie die moet worden toegepast op de zoekquery.

filter?: string

Waarde van eigenschap

string

highlightFields

De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.

highlightFields?: string

Waarde van eigenschap

string

highlightPostTag

Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.

highlightPostTag?: string

Waarde van eigenschap

string

highlightPreTag

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em>.

highlightPreTag?: string

Waarde van eigenschap

string

includeTotalCount

Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardinstelling is onwaar. Het instellen van deze waarde op true kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.

includeTotalCount?: boolean

Waarde van eigenschap

boolean

minimumCoverage

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een zoekquery moet worden gedekt om de query als geslaagd te kunnen rapporteren. Deze parameter kan handig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.

minimumCoverage?: number

Waarde van eigenschap

number

orderBy

De lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Ties worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby-componenten zijn.

orderBy?: string[]

Waarde van eigenschap

string[]

queryType

Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis. Mogelijke waarden zijn: 'simple', 'full', 'semantic'

queryType?: QueryType

Waarde van eigenschap

QueryType

scoringParameters

De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met de parameter 'mylocation', is de parametertekenreeks 'mylocation-122.2,44.8' (zonder de aanhalingstekens).

scoringParameters?: string[]

Waarde van eigenschap

string[]

scoringProfile

De naam van een scoreprofiel voor het evalueren van matchscores voor overeenkomende documenten om de resultaten te sorteren.

scoringProfile?: string

Waarde van eigenschap

string

scoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. Mogelijke waarden zijn: 'Lokaal', 'Globaal'

scoringStatistics?: ScoringStatistics

Waarde van eigenschap

ScoringStatistics

searchFields

De door komma's gescheiden lijst met veldnamen waarop de volledige tekst moet worden gezocht. Wanneer u veldzoekopdrachten (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.

searchFields?: SearchFieldArray<TModel>

Waarde van eigenschap

SearchFieldArray<TModel>

searchMode

Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen. Mogelijke waarden zijn: 'any', 'all'

searchMode?: SearchMode

Waarde van eigenschap

SearchMode

select

De lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, worden alle velden die zijn gemarkeerd als ophalen mogelijk in het schema opgenomen.

select?: SelectArray<TFields>

Waarde van eigenschap

SelectArray<TFields>

sessionId

Een waarde die moet worden gebruikt om een plaksessie te maken, die kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk opnieuw gebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen in verschillende replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, mag niet beginnen met een _-teken.

sessionId?: string

Waarde van eigenschap

string

skip

Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde moet scannen, maar vanwege deze beperking niet kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.

skip?: number

Waarde van eigenschap

number

top

Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te voeren voor de volgende pagina met resultaten.

top?: number

Waarde van eigenschap

number

vectorSearchOptions

Definieert opties voor vectorzoekquery's

vectorSearchOptions?: VectorSearchOptions<TModel>

Waarde van eigenschap

VectorSearchOptions<TModel>