Documents - Search Post

Tjänst:

Search Service

API-version:

2023-10-01-Preview

Söker efter dokument i indexet.

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

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 falskt. Att ställa in det här värdet på sant kan ha en prestandapåverkan. Observera att antalet returnerade är en uppskattning.
debug	QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att utforska dina rangordnade resultat ytterligare.
facets	string[]	Listan med 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	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 markeringar. Måste anges med highlightPreTag. Standardvärdet är </em>.
highlightPreTag	string	En strängtagg som förbereds för att träffa markeringar. Måste anges med highlightPostTag. Standardvärdet är <em>.
minimumCoverage	number (double)	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 rapporteras som en lyckad fråga. 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 sjunker standardsorteringsordningen efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
queryLanguage	QueryLanguage	Ett värde som anger sökfrågans språk.
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 mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.
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 alla 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	Tillåter användaren att välja om ett semantiskt anrop ska misslyckas helt eller att returnera partiella resultat (standard).
semanticFields	string	Kommaavgränsad lista över fältnamn som används för semantisk rangordning.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	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.
semanticQuery	string	Tillåter att du anger en separat sökfråga som endast ska användas för semantisk reranking, semantiska bildtexter och semantiska svar. Är användbart för scenarier där det finns ett behov av att använda olika frågor mellan bashämtnings- och rangordningsfasen och L2-semantikfasen.
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 så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och påverka söktjänstens prestanda negativt. Värdet som används som sessionId kan inte börja med ett _-tecken.
skip	integer (int32)	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.
speller	QuerySpellerType	Ett värde som angav vilken typ av stavningsfel som ska användas för att stavningskorrigering av enskilda sökord.
top	integer (int32)	Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera växling 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 resultatsida.
vectorFilterMode	VectorFilterMode	Avgör om filter tillämpas före eller efter att vektorsökningen har utförts. Standardvärdet är "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	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

Exempelbegäran

HTTP

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

{
  "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,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

Statuskod:

200

{
  "@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-10-01-Preview"
}

Definitioner

Name	Description
AnswerResult	Ett svar är ett textavsnitt som extraherats från innehållet i de mest relevanta dokument som matchade frågan. Svaren extraheras från de bästa sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.
CaptionResult	Bildtexter ä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 "semantisk".
DocumentDebugInfo	Innehåller felsökningsinformation som kan användas för att utforska sökresultaten ytterligare.
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.
QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att utforska sökresultaten ytterligare.
QueryLanguage	Frågans språk.
QueryResultDocumentRerankerInput	De råa sammanfogade strängarna som skickades till den semantiska berikande processen.
QueryResultDocumentSemanticField	Beskrivning av fält som skickades till den semantiska berikande processen, samt hur de användes
QuerySpellerType	Ett värde som angav vilken typ av stavningsfel som ska användas för att stavningskorrigering av enskilda sökord.
QueryType	Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen och "semantik" om frågesyntaxen inte behövs.
RawVectorQuery	Frågeparametrarna som ska användas för vektorsökning när ett raw-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 mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.
SearchDocumentsResult	Svar som innehåller sökresultat från ett index.
SearchError	Beskriver ett felvillkor för API:et.
SearchMode	Anger om något eller alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.
SearchRequest	Parametrar för filtrering, sortering, fasettering, växling och andra sökfrågebeteenden.
SearchResult	Innehåller ett dokument som hittas av en sökfråga, plus associerade metadata.
SemanticDebugInfo
SemanticErrorMode	Tillåter användaren att välja om ett semantiskt anrop ska misslyckas helt eller att returnera partiella resultat (standard).
SemanticErrorReason	Orsak till att ett partiellt svar returnerades för en semantisk rangordningsbegäran.
SemanticFieldState	Hur fältet användes för semantisk berikningsprocess (fullständigt använd, delvis använd eller oanvänd)
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.
VectorizableTextQuery	Frågeparametrarna som ska användas för vektorsökning när ett textvärde som måste vektoriseras tillhandahålls.
VectorQueryKind	Den typ av vektorfråga som utförs.

AnswerResult

Objekt

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

Name	Typ	Description
highlights	string	Samma textpassagenskap som i egenskapen Text med markerade textfraser som är mest relevanta för frågan.
key	string	Nyckeln i dokumentet som svaret extraherades från.
score	number (double)	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 dokumentinnehållet som svar.

CaptionResult

Objekt

Bildtexter ä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 "semantisk".

Name	Typ	Description
highlights	string	Samma textpassagenskap 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.

DocumentDebugInfo

Objekt

Innehåller felsökningsinformation som kan användas för att utforska sökresultaten ytterligare.

Name	Typ	Description
semantic	SemanticDebugInfo	Innehåller felsökningsinformation som är specifik för semantiska rangordningsbegäranden.

QueryAnswerType

Uppräkning

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

Värde	Description
extractive	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	Returnera inte svar för frågan.

QueryCaptionType

Uppräkning

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

Värde	Description
extractive	Extraherar undertexter från matchande dokument som innehåller avsnitt som är relevanta för sökfrågan.
none	Returnera inte undertexter för frågan.

QueryDebugMode

Uppräkning

Aktiverar ett felsökningsverktyg som kan användas för att utforska sökresultaten ytterligare.

Värde	Description
disabled	Ingen information om frågefelsökning returneras.
semantic	Gör att användaren kan utforska sina omrankade resultat ytterligare.

QueryLanguage

Uppräkning

Frågans språk.

Värde	Description
ar-eg	Frågespråkvärde för arabiska (Egypten).
ar-jo	Frågespråkvärde för arabiska (Jordanien).
ar-kw	Frågespråkvärde för arabiska (Kuwait).
ar-ma	Frågespråkvärde för arabiska (Marocko).
ar-sa	Frågespråkvärde för arabiska (Saudiarabien).
bg-bg	Frågespråkvärde för bulgariska (Bulgarien).
bn-in	Frågespråkvärde för bengali (Indien).
ca-es	Frågespråkvärde för katalanska.
cs-cz	Frågespråkvärde för Tjeckiska (Tjeckien).
da-dk	Frågespråkvärde för danska (Danmark).
de-de	Frågespråkvärde för tyska (Tyskland).
el-gr	Frågespråkvärde för grekiska (Grekland).
en-au	Frågespråkvärde för engelska (Australien).
en-ca	Frågespråkvärde för engelska (Kanada).
en-gb	Frågespråkvärde för engelska (Storbritannien).
en-in	Frågespråkvärde för engelska (Indien).
en-us	Frågespråkvärde för engelska (USA).
es-es	Frågespråkvärde för spanska (Spanien).
es-mx	Frågespråkvärde för spanska (Mexiko).
et-ee	Frågespråkvärde för estniska (Estland).
eu-es	Frågespråkvärde för baskiska.
fa-ae	Frågespråkvärde för persiska (U.A.E.).
fi-fi	Frågespråkvärde för finska (Finland).
fr-ca	Frågespråkvärde för franska (Kanada).
fr-fr	Frågespråkvärde för franska (Frankrike).
ga-ie	Frågespråkvärde för iriska (Irland).
gl-es	Frågespråkvärde för galiciska.
gu-in	Frågespråkvärde för Gujarati (Indien).
he-il	Frågespråkvärde för hebreiska (Israel).
hi-in	Frågespråkvärde för Hindi (Indien).
hr-ba	Frågespråkvärde för kroatiska (Bosnien och Hercegovina).
hr-hr	Frågespråkvärde för kroatiska (Kroatien).
hu-hu	Frågespråkvärde för ungerska (Ungern).
hy-am	Frågespråkvärde för armeniska (Armenien).
id-id	Frågespråkvärde för indonesiska (Indonesien).
is-is	Frågespråkvärde för isländska (Island).
it-it	Frågespråkvärde för italienska (Italien).
ja-jp	Frågespråkvärde för japanska (Japan).
kn-in	Frågespråkvärde för Kannada (Indien).
ko-kr	Frågespråkvärde för Koreanska (Korea).
lt-lt	Frågespråkvärde för litauiska (Litauen).
lv-lv	Frågespråkvärde för lettiska (Lettland).
ml-in	Frågespråkvärde för Malayalam (Indien).
mr-in	Frågespråkvärde för Marathi (Indien).
ms-bn	Frågespråkvärde för malay (Brunei Darussalam).
ms-my	Frågespråkvärde för Malay (Malaysia).
nb-no	Frågespråkvärde för norska (Norge).
nl-be	Frågespråkvärde för nederländska (Belgien).
nl-nl	Frågespråkvärde för nederländska (Nederländerna).
no-no	Frågespråkvärde för norska (Norge).
none	Frågespråket har inte angetts.
pa-in	Frågespråkvärde för Punjabi (Indien).
pl-pl	Frågespråkvärde för polska (Polen).
pt-br	Frågespråkvärde för portugisiska (Brasilien).
pt-pt	Frågespråkvärde för portugisiska (Portugal).
ro-ro	Frågespråkvärde för rumänska (Rumänien).
ru-ru	Frågespråkvärde för ryska (Ryssland).
sk-sk	Frågespråkvärde för slovakiska (Slovakien).
sl-sl	Frågespråkvärde för slovenska (Slovenien).
sr-ba	Frågespråkvärde för serbiska (Bosnien och Hercegovina).
sr-me	Frågespråkvärde för serbiska (Montenegro).
sr-rs	Frågespråkvärde för serbiska (Serbien).
sv-se	Frågespråksvärde för svenska.
ta-in	Frågespråkvärde för tamil (Indien).
te-in	Frågespråkvärde för Telugu (Indien).
th-th	Frågespråkvärde för thailändska (Thailand).
tr-tr	Frågespråkvärde för turkiska (Turkiet).
uk-ua	Frågespråkvärde för ukrainska (Ukraina).
ur-pk	Frågespråkvärde för Urdu (Pakistan).
vi-vn	Frågespråkvärde för vietnamesiska (Vietnam).
zh-cn	Frågespråkvärde för kinesiska (Kina).
zh-tw	Frågespråkvärde för kinesiska (Taiwan).

QueryResultDocumentRerankerInput

Objekt

De råa sammanfogade strängarna som skickades till den semantiska berikande processen.

Name	Typ	Description
content	string	De råa sammanfogade strängarna för de innehållsfält som användes för semantisk berikning.
keywords	string	De råa sammanfogade strängarna för nyckelordsfälten som användes för semantisk berikning.
title	string	Råsträngen för rubrikfältet som användes för semantisk berikning.

QueryResultDocumentSemanticField

Objekt

Beskrivning av fält som skickades till den semantiska berikande processen, samt hur de användes

Name	Typ	Description
name	string	Namnet på det fält som skickades till semantisk berikningsprocess
state	SemanticFieldState	Hur fältet användes för semantisk berikningsprocess (fullständigt använd, delvis använd eller oanvänd)

QuerySpellerType

Uppräkning

Ett värde som angav vilken typ av stavningsfel som ska användas för att stavningskorrigering av enskilda sökord.

Värde	Description
lexicon	Stavningsverktyget korrigerar enskilda frågetermer med hjälp av ett statiskt lexikon för det språk som anges av parametern queryLanguage.
none	Stavningsprogrammet är inte aktiverat.

QueryType

Uppräkning

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

Värde	Description
full	Använder den fullständiga Lucene-frågesyntaxen för sökningar. Söktext tolkas med lucene-frågespråket som tillåter fältspecifika och viktade sökningar samt andra avancerade funktioner.
semantic	Passar bäst för frågor som uttrycks i 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	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

Objekt

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

Name	Typ	Description
exhaustive	boolean	När det är sant utlöser en fullständig k-närmaste grannsö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 Collection(Edm.Single) som ska ingå i den sökbara vektorn.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: vector	Den typ av vektorfråga som utförs.
vector	number[] (float)	Vektorrepresentationen av en sökfråga.

ScoringStatistics

Uppräkning

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 mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.

Värde	Description
global	Bedömningsstatistiken beräknas globalt för mer konsekvent bedömning.
local	Bedömningsstatistiken beräknas lokalt för kortare svarstid.

SearchDocumentsResult

Objekt

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

Name	Typ	Description
@odata.count	integer (int64)	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 hämta 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[]	Svaren på frågeresultaten för sökåtgärden; null om frågeparametern answers inte har angetts eller angetts till "none".
@search.coverage	number (double)	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	Fasetteringsfrågans resultat 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 fasetteringsuttryck.
@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 den här JSON-filen 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

Objekt

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

Uppräkning

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

Värde	Description
all	Alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.
any	Alla söktermer måste matchas för att kunna räkna dokumentet som en matchning.

SearchRequest

Objekt

Parametrar för filtrering, sortering, fasettering, växling 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 falskt. Att ställa in det här värdet på sant kan ha en prestandapåverkan. Observera att antalet returnerade är en uppskattning.
debug	QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att utforska dina rangordnade resultat ytterligare.
facets	string[]	Listan med 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	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 markeringar. Måste anges med highlightPreTag. Standardvärdet är </em>.
highlightPreTag	string	En strängtagg som förbereds för att träffa markeringar. Måste anges med highlightPostTag. Standardvärdet är <em>.
minimumCoverage	number (double)	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 rapporteras som en lyckad fråga. 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 sjunker standardsorteringsordningen efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
queryLanguage	QueryLanguage	Ett värde som anger sökfrågans språk.
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 mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.
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 alla 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	Tillåter användaren att välja om ett semantiskt anrop ska misslyckas helt eller att returnera partiella resultat (standard).
semanticFields	string	Kommaavgränsad lista över fältnamn som används för semantisk rangordning.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	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.
semanticQuery	string	Tillåter att du anger en separat sökfråga som endast ska användas för semantisk reranking, semantiska bildtexter och semantiska svar. Är användbart för scenarier där det finns ett behov av att använda olika frågor mellan bashämtnings- och rangordningsfasen och L2-semantikfasen.
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 så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och påverka söktjänstens prestanda negativt. Värdet som används som sessionId kan inte börja med ett _-tecken.
skip	integer (int32)	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.
speller	QuerySpellerType	Ett värde som angav vilken typ av stavningsfel som ska användas för att stavningskorrigering av enskilda sökord.
top	integer (int32)	Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera växling 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 resultatsida.
vectorFilterMode	VectorFilterMode	Avgör om filter tillämpas före eller efter att vektorsökningen har utförts. Standardvärdet är "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Frågeparametrarna för vektor- och hybridsökfrågor.

SearchResult

Objekt

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

Name	Typ	Description
@search.captions	CaptionResult[]	Bildtexter ä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 "semantisk".
@search.documentDebugInfo	DocumentDebugInfo[]	Innehåller felsökningsinformation som kan användas för att utforska sökresultaten ytterligare.
@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 (double)	Relevanspoängen som beräknas av den semantiska rankaren för de bästa sökresultaten. Sökresultat sorteras efter RerankerScore först och sedan efter Poäng. RerankerScore returneras endast för frågor av typen "semantisk".
@search.score	number (double)	Relevanspoängen för dokumentet jämfört med andra dokument som returneras av frågan.

SemanticDebugInfo

Objekt

Name	Typ	Description
contentFields	QueryResultDocumentSemanticField[]	Innehållsfälten som skickades till den semantiska berikande processen samt hur de användes
keywordFields	QueryResultDocumentSemanticField[]	Nyckelordsfälten som skickades till den semantiska berikningsprocessen samt hur de användes
rerankerInput	QueryResultDocumentRerankerInput	De råa sammanfogade strängarna som skickades till den semantiska berikande processen.
titleField	QueryResultDocumentSemanticField	Rubrikfältet som skickades till den semantiska berikande processen, samt hur det användes

SemanticErrorMode

Uppräkning

Tillåter användaren att välja om ett semantiskt anrop ska misslyckas helt eller att returnera partiella resultat (standard).

Värde	Description
fail	Om det finns ett undantag under det semantiska bearbetningssteget misslyckas frågan och returnerar lämplig HTTP-kod beroende på felet.
partial	Om den semantiska bearbetningen misslyckas returneras fortfarande partiella resultat. Definitionen av partiella resultat beror på vilket semantiskt steg som misslyckades och vad som var orsaken till felet.

SemanticErrorReason

Uppräkning

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

Värde	Description
capacityOverloaded	Begäran begränsades. Endast basresultaten returnerades.
maxWaitExceeded	Om "semanticMaxWaitInMilliseconds" angavs och varaktigheten för semantisk bearbetning överskred det värdet. Endast basresultaten returnerades.
transient	Minst ett steg i den semantiska processen misslyckades.

SemanticFieldState

Uppräkning

Hur fältet användes för semantisk berikningsprocess (fullständigt använd, delvis använd eller oanvänd)

Värde	Description
partial	Fältet användes delvis för semantisk berikning.
unused	Fältet användes inte för semantisk berikning.
used	Fältet användes fullt ut för semantisk berikning.

SemanticSearchResultsType

Uppräkning

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

Värde	Description
baseResults	Resultat utan semantisk berikning eller reranking.
rerankedResults	Resultaten har rangordnats om med rerankermodellen och innehåller semantiska bildtexter. De innehåller inga svar, svarshöjdpunkter eller bildtexthöjdpunkter.

VectorFilterMode

Uppräkning

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

Värde	Description
postFilter	Filtret tillämpas när kandidatuppsättningen med vektorresultat returneras. Beroende på filterväljaren kan detta resultera i färre resultat än vad som begärdes av parametern "k".
preFilter	Filtret tillämpas före sökfrågan.

VectorizableTextQuery

Objekt

Frågeparametrarna som ska användas för vektorsökning när ett textvärde som måste vektoriseras tillhandahålls.

Name	Typ	Description
exhaustive	boolean	När det är sant utlöser en fullständig k-närmaste grannsö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 Collection(Edm.Single) som ska ingå i den sökbara vektorn.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: text	Den typ av vektorfråga som utförs.
text	string	Texten som ska vektoriseras för att utföra en vektorsökningsfråga.

VectorQueryKind

Uppräkning

Den typ av vektorfråga som utförs.

Värde	Description
text	Vektorfråga där ett textvärde som måste vektoriseras tillhandahålls.
vector	Vektorfråga där ett raw-vektorvärde anges.