BaseSearchRequestOptions interface
Parametrar för filtrering, sortering, fasettering, sidindelning och andra sökfrågebeteenden.
Egenskaper
facets | Listan över fasetteringsuttryck som ska tillämpas på sökfrågan. Varje fasetteringsuttryck innehåller ett fältnamn, eventuellt följt av en kommaavgränsad lista med namn:värdepar. |
filter | OData-$filter uttryck som ska tillämpas på sökfrågan. |
highlight |
Den kommaavgränsade listan med fältnamn som ska användas för träffhöjdpunkter. Endast sökbara fält kan användas för träffmarkering. |
highlight |
En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Standardvärdet är </em>. |
highlight |
En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Standardvärdet är <em>. |
include |
Ett värde som anger om det totala antalet resultat ska hämtas. Standardvärdet är false. Att ange det här värdet till true kan ha en prestandapåverkan. Observera att det antal som returneras är en uppskattning. |
minimum |
Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste täckas av en sökfråga för att frågan ska rapporteras som lyckad. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 100. |
order |
Listan över OData-$orderby uttryck som resultatet ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till funktionerna geo.distance() eller search.score(). Varje uttryck kan följas av asc för att indikera stigande eller desc för att indikera fallande. Standardvärdet är stigande ordning. Oavgjort kommer att brytas av matchningspoängen för dokument. Om ingen $orderby anges är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser. |
query |
Ett värde som anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen. Möjliga värden är: "simple", "full", "semantic" |
scoring |
Listan över parametervärden som ska användas i bedömningsfunktioner (till exempel referencePointParameter) med formatet name-values. Om bedömningsprofilen till exempel definierar en funktion med parametern "mylocation" skulle parametersträngen vara "mylocation--122.2,44.8" (utan citattecken). |
scoring |
Namnet på en bedömningsprofil för att utvärdera matchningspoäng för matchande dokument för att sortera resultaten. |
scoring |
Ett värde som anger om vi vill beräkna bedömningsstatistik (till exempel dokumentfrekvens) globalt för mer konsekvent bedömning eller lokalt för kortare svarstider. Möjliga värden är: "Lokal", "Global" |
search |
Den kommaavgränsade listan med fältnamn som fulltextsökningen ska omfångsbegränsas till. När du använder fältsökning (fieldName:searchExpression) i en fullständig Lucene-fråga har fältnamnen för varje fältsökuttryck företräde framför alla fältnamn som anges i den här parametern. |
search |
Ett värde som anger om några eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning. Möjliga värden är: "any", "all" |
select | Listan över fält som ska hämtas. Om det inte anges inkluderas alla fält som markerats som hämtningsbara i schemat. |
session |
Ett värde som ska användas för att skapa en fäst session, vilket kan hjälpa till att få mer konsekventa resultat. Så länge samma sessionId används görs ett bästa försök att rikta in sig på samma replikuppsättning. Var försiktig så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och negativt påverka söktjänstens prestanda. Värdet som används som sessionId kan inte börja med ett _-tecken. |
skip | Antalet sökresultat att hoppa över. Det här värdet får inte vara större än 100 000. Om du behöver skanna dokument i följd, men inte kan använda hoppa över på grund av den här begränsningen, bör du överväga att använda orderby på en helt ordnad nyckel och filtrera med en intervallfråga i stället. |
top | Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera sidindelning på klientsidan av sökresultat. Om resultaten trunkeras på grund av sidindelning på serversidan innehåller svaret en fortsättningstoken som kan användas för att utfärda en annan sökbegäran för nästa sida med resultat. |
vector |
Definierar alternativ för vektorsökningsfrågor |
Egenskapsinformation
facets
Listan över fasetteringsuttryck som ska tillämpas på sökfrågan. Varje fasetteringsuttryck innehåller ett fältnamn, eventuellt följt av en kommaavgränsad lista med namn:värdepar.
facets?: string[]
Egenskapsvärde
string[]
filter
OData-$filter uttryck som ska tillämpas på sökfrågan.
filter?: string
Egenskapsvärde
string
highlightFields
Den kommaavgränsade listan med fältnamn som ska användas för träffhöjdpunkter. Endast sökbara fält kan användas för träffmarkering.
highlightFields?: string
Egenskapsvärde
string
highlightPostTag
En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Standardvärdet är </em>.
highlightPostTag?: string
Egenskapsvärde
string
highlightPreTag
En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Standardvärdet är <em>.
highlightPreTag?: string
Egenskapsvärde
string
includeTotalCount
Ett värde som anger om det totala antalet resultat ska hämtas. Standardvärdet är false. Att ange det här värdet till true kan ha en prestandapåverkan. Observera att det antal som returneras är en uppskattning.
includeTotalCount?: boolean
Egenskapsvärde
boolean
minimumCoverage
Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste täckas av en sökfråga för att frågan ska rapporteras som lyckad. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 100.
minimumCoverage?: number
Egenskapsvärde
number
orderBy
Listan över OData-$orderby uttryck som resultatet ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till funktionerna geo.distance() eller search.score(). Varje uttryck kan följas av asc för att indikera stigande eller desc för att indikera fallande. Standardvärdet är stigande ordning. Oavgjort kommer att brytas av matchningspoängen för dokument. Om ingen $orderby anges är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
orderBy?: string[]
Egenskapsvärde
string[]
queryType
Ett värde som anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen. Möjliga värden är: "simple", "full", "semantic"
queryType?: QueryType
Egenskapsvärde
scoringParameters
Listan över parametervärden som ska användas i bedömningsfunktioner (till exempel referencePointParameter) med formatet name-values. Om bedömningsprofilen till exempel definierar en funktion med parametern "mylocation" skulle parametersträngen vara "mylocation--122.2,44.8" (utan citattecken).
scoringParameters?: string[]
Egenskapsvärde
string[]
scoringProfile
Namnet på en bedömningsprofil för att utvärdera matchningspoäng för matchande dokument för att sortera resultaten.
scoringProfile?: string
Egenskapsvärde
string
scoringStatistics
Ett värde som anger om vi vill beräkna bedömningsstatistik (till exempel dokumentfrekvens) globalt för mer konsekvent bedömning eller lokalt för kortare svarstider. Möjliga värden är: "Lokal", "Global"
scoringStatistics?: ScoringStatistics
Egenskapsvärde
searchFields
Den kommaavgränsade listan med fältnamn som fulltextsökningen ska omfångsbegränsas till. När du använder fältsökning (fieldName:searchExpression) i en fullständig Lucene-fråga har fältnamnen för varje fältsökuttryck företräde framför alla fältnamn som anges i den här parametern.
searchFields?: SearchFieldArray<TModel>
Egenskapsvärde
SearchFieldArray<TModel>
searchMode
Ett värde som anger om några eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning. Möjliga värden är: "any", "all"
searchMode?: SearchMode
Egenskapsvärde
select
Listan över fält som ska hämtas. Om det inte anges inkluderas alla fält som markerats som hämtningsbara i schemat.
select?: SelectArray<TFields>
Egenskapsvärde
SelectArray<TFields>
sessionId
Ett värde som ska användas för att skapa en fäst session, vilket kan hjälpa till att få mer konsekventa resultat. Så länge samma sessionId används görs ett bästa försök att rikta in sig på samma replikuppsättning. Var försiktig så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och negativt påverka söktjänstens prestanda. Värdet som används som sessionId kan inte börja med ett _-tecken.
sessionId?: string
Egenskapsvärde
string
skip
Antalet sökresultat att hoppa över. Det här värdet får inte vara större än 100 000. Om du behöver skanna dokument i följd, men inte kan använda hoppa över på grund av den här begränsningen, bör du överväga att använda orderby på en helt ordnad nyckel och filtrera med en intervallfråga i stället.
skip?: number
Egenskapsvärde
number
top
Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera sidindelning på klientsidan av sökresultat. Om resultaten trunkeras på grund av sidindelning på serversidan innehåller svaret en fortsättningstoken som kan användas för att utfärda en annan sökbegäran för nästa sida med resultat.
top?: number
Egenskapsvärde
number
vectorSearchOptions
Definierar alternativ för vektorsökningsfrågor
vectorSearchOptions?: VectorSearchOptions<TModel>
Egenskapsvärde
VectorSearchOptions<TModel>