Dela via


Documents - Search Post

Söker efter dokument i indexet.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-01

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string

Slutpunkts-URL:en för söktjänsten.

indexName
path True

string

Namnet på indexet.

api-version
query True

string

Klient-API-version.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

uuid

Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Begärandetext

Name Typ Description
answers

QueryAnswerType

Ett värde som anger om svar ska returneras som en del av söksvaret.

captions

QueryCaptionType

Ett värde som anger om undertexter ska returneras som en del av söksvaret.

count

boolean

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 sant kan ha en prestandapåverkan. Observera att det antal som returneras är en uppskattning.

facets

string[]

Listan över fastuttryck som ska tillämpas på sökfrågan. Varje aspektuttryck innehåller ett fältnamn, eventuellt följt av en kommaavgränsad lista med namn:värdepar.

filter

string

OData-$filter uttryck som ska tillämpas på sökfrågan.

highlight

string

Kommaavgränsad lista över fältnamn som ska användas för träffhöjdpunkter. Endast sökbara fält kan användas för träffmarkering.

highlightPostTag

string

En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Standardvärdet är </em>.

highlightPreTag

string

En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Standardvärdet är <em>.

minimumCoverage

number

Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste omfattas av en sökfråga för att frågan ska kunna 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.

orderby

string

Kommaavgränsad lista ö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. Banden kommer att brytas av matchningspoängen för dokument. Om ingen $orderby har angetts är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.

queryType

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.

scoringParameters

string[]

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).

scoringProfile

string

Namnet på en bedömningsprofil för att utvärdera matchningspoäng för matchande dokument för att sortera resultaten.

scoringStatistics

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 lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör poäng. Användning av global bedömningsstatistik kan öka svarstiden för sökfrågor.

search

string

Ett frågeuttryck för fulltextsökning; Använd "*" eller utelämna den här parametern för att matcha alla dokument.

searchFields

string

Kommaavgränsad lista över fältnamn som fulltextsökningen ska omfatta. 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 eventuella fältnamn som anges i den här parametern.

searchMode

SearchMode

Ett värde som anger om något eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

select

string

Kommaavgränsad lista över fält som ska hämtas. Om det är ospecificerat inkluderas alla fält som markerats som hämtningsbara i schemat.

semanticConfiguration

string

Namnet på en semantisk konfiguration som ska användas vid bearbetning av dokument för frågor av typen semantik.

semanticErrorHandling

SemanticErrorMode

Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller att returnera partiella resultat.

semanticMaxWaitInMilliseconds

integer

Tillåter att användaren anger en övre gräns för hur lång tid det tar för semantisk berikning att slutföra bearbetningen innan begäran misslyckas.

sessionId

string

Ett värde som ska användas för att skapa en klibbig session, vilket kan hjälpa dig 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 med 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

integer

Antalet sökresultat som ska 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

integer

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.

vectorFilterMode

VectorFilterMode

Avgör om filter tillämpas före eller efter att vektorsökningen utförs. Standardvärdet är "preFilter" för nya index.

vectorQueries VectorQuery[]:

RawVectorQuery[]

Frågeparametrarna för vektor- och hybridsökfrågor.

Svar

Name Typ Description
200 OK

SearchDocumentsResult

Svar som innehåller dokument som matchar sökvillkoren.

Other Status Codes

SearchError

Felsvar.

Exempel

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Exempelbegäran

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,category,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Exempelsvar

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}

SearchIndexSearchDocumentsSemanticPost

Exempelbegäran

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Exempelsvar

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}

Definitioner

Name Description
AnswerResult

Ett svar är ett textavsnitt som extraherats från innehållet i de mest relevanta dokumenten som matchade frågan. Svaren extraheras från de vanligaste sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.

CaptionResult

Undertexter är de mest representativa avsnitten från dokumentet relativt till sökfrågan. De används ofta som dokumentsammanfattning. Undertexter returneras endast för frågor av typen semantic.

QueryAnswerType

Ett värde som anger om svar ska returneras som en del av söksvaret.

QueryCaptionType

Ett värde som anger om undertexter ska returneras som en del av söksvaret.

QueryType

Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen.

RawVectorQuery

Frågeparametrarna som ska användas för vektorsökning när ett råvektorvärde anges.

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 lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör poäng. Användning av global bedömningsstatistik kan öka svarstiden för sökfrågor.

SearchDocumentsResult

Svar som innehåller sökresultat från ett index.

SearchError

Beskriver ett felvillkor för API:et.

SearchMode

Anger om några eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

SearchRequest

Parametrar för filtrering, sortering, fasettering, sidindelning och andra sökfrågebeteenden.

SearchResult

Innehåller ett dokument som hittas av en sökfråga, plus associerade metadata.

SemanticErrorMode

Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller att returnera partiella resultat.

SemanticErrorReason

Orsak till att ett partiellt svar returnerades för en semantisk rangordningsbegäran.

SemanticSearchResultsType

Typ av partiellt svar som returnerades för en semantisk rangordningsbegäran.

VectorFilterMode

Avgör om filter tillämpas före eller efter att vektorsökningen har utförts.

VectorQueryKind

Den typ av vektorfråga som utförs.

AnswerResult

Ett svar är ett textavsnitt som extraherats från innehållet i de mest relevanta dokumenten som matchade frågan. Svaren extraheras från de vanligaste sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.

Name Typ Description
highlights

string

Samma textavsnitt som i egenskapen Text med markerade textfraser som är mest relevanta för frågan.

key

string

Nyckeln för dokumentet som svaret extraherades från.

score

number

Poängvärdet representerar hur relevant svaret är för frågan i förhållande till andra svar som returneras för frågan.

text

string

Textavsnittet som extraheras från dokumentets innehåll som svar.

CaptionResult

Undertexter är de mest representativa avsnitten från dokumentet relativt till sökfrågan. De används ofta som dokumentsammanfattning. Undertexter returneras endast för frågor av typen semantic.

Name Typ Description
highlights

string

Samma textavsnitt som i egenskapen Text med markerade fraser som är mest relevanta för frågan.

text

string

Ett representativt textavsnitt som extraherats från dokumentet som är mest relevant för sökfrågan.

QueryAnswerType

Ett värde som anger om svar ska returneras som en del av söksvaret.

Name Typ Description
extractive

string

Extraherar svarskandidater från innehållet i de dokument som returneras som svar på en fråga som uttrycks som en fråga på naturligt språk.

none

string

Returnera inte svar för frågan.

QueryCaptionType

Ett värde som anger om undertexter ska returneras som en del av söksvaret.

Name Typ Description
extractive

string

Extraherar undertexter från matchande dokument som innehåller avsnitt som är relevanta för sökfrågan.

none

string

Returnera inte undertexter för frågan.

QueryType

Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen.

Name Typ Description
full

string

Använder den fullständiga Lucene-frågesyntaxen för sökningar. Söktext tolkas med hjälp av Lucene-frågespråket som tillåter fältspecifika och viktade sökningar samt andra avancerade funktioner.

semantic

string

Passar bäst för frågor som uttrycks på naturligt språk i stället för nyckelord. Förbättrar precisionen i sökresultaten genom att rangordna om de bästa sökresultaten med hjälp av en rangordningsmodell som tränats på webb corpus.

simple

string

Använder den enkla frågesyntaxen för sökningar. Söktext tolkas med ett enkelt frågespråk som tillåter symboler som +, * och "". Frågor utvärderas i alla sökbara fält som standard, såvida inte parametern searchFields har angetts.

RawVectorQuery

Frågeparametrarna som ska användas för vektorsökning när ett råvektorvärde anges.

Name Typ Description
exhaustive

boolean

När det är sant utlöser en fullständig k-närmaste granne-sökning över alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.

fields

string

Vektorfält av typen Samling (Edm.Single) som ska inkluderas i den sökbara vektorn.

k

integer

Antal närmaste grannar som ska returneras som toppträffar.

kind string:

vector

Den typ av vektorfråga som utförs.

vector

number[]

Vektorrepresentationen av en sökfråga.

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 lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör poäng. Användning av global bedömningsstatistik kan öka svarstiden för sökfrågor.

Name Typ Description
global

string

Bedömningsstatistiken beräknas globalt för mer konsekvent bedömning.

local

string

Bedömningsstatistiken beräknas lokalt för kortare svarstider.

SearchDocumentsResult

Svar som innehåller sökresultat från ett index.

Name Typ Description
@odata.count

integer

Det totala antalet resultat som hittades av sökåtgärden eller null om antalet inte begärdes. Om det finns kan antalet vara större än antalet resultat i det här svaret. Detta kan inträffa om du använder parametrarna $top eller $skip, eller om frågan inte kan returnera alla begärda dokument i ett enda svar.

@odata.nextLink

string

Fortsättnings-URL returnerades när frågan inte kan returnera alla begärda resultat i ett enda svar. Du kan använda den här URL:en för att formulera en annan GET- eller POST-sökbegäran för att få nästa del av söksvaret. Se till att använda samma verb (GET eller POST) som begäran som skapade det här svaret.

@search.answers

AnswerResult[]

Svarsfrågans resultat för sökåtgärden; null om frågeparametern answers inte har angetts eller angetts till "none".

@search.coverage

number

Ett värde som anger procentandelen av indexet som ingick i frågan, eller null om minimumCoverage inte angavs i begäran.

@search.facets

object

Fasetterade frågeresultat för sökåtgärden, ordnade som en samling bucketar för varje fasetterat fält; null om frågan inte innehåller några fasetterade uttryck.

@search.nextPageParameters

SearchRequest

Fortsättnings-JSON-nyttolasten returnerades när frågan inte kan returnera alla begärda resultat i ett enda svar. Du kan använda denna JSON tillsammans med @odata.nextLink för att formulera en annan POST Search-begäran för att få nästa del av söksvaret.

@search.semanticPartialResponseReason

SemanticErrorReason

Orsak till att ett partiellt svar returnerades för en semantisk rangordningsbegäran.

@search.semanticPartialResponseType

SemanticSearchResultsType

Typ av partiellt svar som returnerades för en semantisk rangordningsbegäran.

value

SearchResult[]

Resultatsekvensen som returneras av frågan.

SearchError

Beskriver ett felvillkor för API:et.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

details

SearchError[]

En matris med information om specifika fel som ledde till det rapporterade felet.

message

string

En mänsklig läsbar representation av felet.

SearchMode

Anger om några eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

Name Typ Description
all

string

Alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

any

string

Alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

SearchRequest

Parametrar för filtrering, sortering, fasettering, sidindelning och andra sökfrågebeteenden.

Name Typ Description
answers

QueryAnswerType

Ett värde som anger om svar ska returneras som en del av söksvaret.

captions

QueryCaptionType

Ett värde som anger om undertexter ska returneras som en del av söksvaret.

count

boolean

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.

facets

string[]

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

string

OData-$filter uttryck som ska tillämpas på sökfrågan.

highlight

string

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.

highlightPostTag

string

En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Standardvärdet är </em>.

highlightPreTag

string

En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Standardvärdet är <em>.

minimumCoverage

number

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.

orderby

string

Den kommaavgränsade 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.

queryType

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.

scoringParameters

string[]

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).

scoringProfile

string

Namnet på en bedömningsprofil för att utvärdera matchningspoäng för matchande dokument för att sortera resultaten.

scoringStatistics

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. Standardvärdet är "lokal". Använd "global" för att aggregera bedömningsstatistik globalt före bedömning. Användning av global bedömningsstatistik kan öka svarstiden för sökfrågor.

search

string

Ett frågeuttryck för fulltextsökning; Använd "*" eller utelämna den här parametern för att matcha alla dokument.

searchFields

string

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.

searchMode

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.

select

string

Den kommaavgränsade listan över fält som ska hämtas. Om det inte anges inkluderas alla fält som markerats som hämtningsbara i schemat.

semanticConfiguration

string

Namnet på en semantisk konfiguration som ska användas vid bearbetning av dokument för frågor av typen semantik.

semanticErrorHandling

SemanticErrorMode

Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller att returnera partiella resultat.

semanticMaxWaitInMilliseconds

integer

Tillåter att användaren anger en övre gräns för hur lång tid det tar för semantisk berikning att slutföra bearbetningen innan begäran misslyckas.

sessionId

string

Ett värde som ska användas för att skapa en fäst session, vilket kan hjälpa dig 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

integer

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

integer

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.

vectorFilterMode

VectorFilterMode

Avgör om filter tillämpas före eller efter att vektorsökningen utförs. Standardvärdet är "preFilter" för nya index.

vectorQueries VectorQuery[]:

RawVectorQuery[]

Frågeparametrarna för vektor- och hybridsökfrågor.

SearchResult

Innehåller ett dokument som hittas av en sökfråga, plus associerade metadata.

Name Typ Description
@search.captions

CaptionResult[]

Undertexter är de mest representativa avsnitten från dokumentet relativt till sökfrågan. De används ofta som dokumentsammanfattning. Undertexter returneras endast för frågor av typen semantic.

@search.highlights

object

Textfragment från dokumentet som anger matchande söktermer, ordnade efter varje tillämpligt fält; null om träffmarkering inte har aktiverats för frågan.

@search.rerankerScore

number

Relevanspoängen som beräknas av den semantiska rankaren för de främsta sökresultaten. Sökresultaten sorteras efter RerankerScore först och sedan efter Poäng. RerankerScore returneras endast för frågor av typen semantic.

@search.score

number

Relevanspoängen för dokumentet jämfört med andra dokument som returneras av frågan.

SemanticErrorMode

Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller att returnera partiella resultat.

Name Typ Description
fail

string

Om det finns ett undantag under semantikbearbetningssteget misslyckas frågan och returnerar lämplig HTTP-kod beroende på felet.

partial

string

Om den semantiska bearbetningen misslyckas returneras fortfarande partiella resultat. Definitionen av partiella resultat beror på vilket semantiksteg som misslyckades och vad som var orsaken till felet.

SemanticErrorReason

Orsak till att ett partiellt svar returnerades för en semantisk rangordningsbegäran.

Name Typ Description
capacityOverloaded

string

Begäran begränsades. Endast basresultaten returnerades.

maxWaitExceeded

string

Om semanticMaxWaitInMilliseconds har angetts och varaktigheten för semantisk bearbetning överskred det värdet. Endast basresultaten returnerades.

transient

string

Minst ett steg i semantikprocessen misslyckades.

SemanticSearchResultsType

Typ av partiellt svar som returnerades för en semantisk rangordningsbegäran.

Name Typ Description
baseResults

string

Resultat utan semantisk berikning eller omrankning.

rerankedResults

string

Resultaten har rangordnats om med rerankermodellen och kommer att innehålla semantiska undertexter. De innehåller inga svar, svarshöjdpunkter eller bildtext höjdpunkter.

VectorFilterMode

Avgör om filter tillämpas före eller efter att vektorsökningen har utförts.

Name Typ Description
postFilter

string

Filtret tillämpas när kandidatuppsättningen med vektorresultat returneras. Beroende på filterväljaren kan detta resultera i färre resultat än vad parametern k har begärt.

preFilter

string

Filtret tillämpas före sökfrågan.

VectorQueryKind

Den typ av vektorfråga som utförs.

Name Typ Description
vector

string

Vektorfråga där ett raw-vektorvärde anges.