Documents - Search Post

Referens

Tjänst:: Search Service

API-version:: 2024-05-01-preview

Söker efter dokument i indexet.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-05-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 false. Att ange det här värdet till true kan ha en prestandapåverkan. Observera att det antal som returneras är en uppskattning.
debug	QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att ytterligare utforska dina rangordnade resultat.
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>.
hybridSearch	HybridSearch[]	Frågeparametrarna för att konfigurera hybridsökningsbeteenden.
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.
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 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	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	Tillåter användaren att välja om ett semantiskt anrop ska misslyckas helt eller returnera partiella resultat (standard).
semanticFields	string	Kommaavgränsad lista över fältnamn som används för semantisk rangordning.
semanticMaxWaitInMilliseconds	integer	Gör att användaren kan ange 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 inställning av en separat sökfråga som endast ska användas för semantisk omrankning, semantiska undertexter 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 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 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.
speller	QuerySpellerType	Ett värde som angav vilken typ av stavning som ska användas för att stavningsrätta enskilda sökfrågetermer.
top	integer	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[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	Frågeparametrarna för vektor- och hybridsökningsfrågor.

Svar

Name	Typ	Description
200 OK	SearchDocumentsResult	Svar som innehåller dokument som matchar sökvillkoren.
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchIndexSearchDocumentsPost

Exempelbegäran

HTTP

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  },
  "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,
      "oversampling": 20,
      "weight": 2,
      "threshold": {
        "kind": "vectorSimilarity",
        "value": 0.8
      }
    }
  ],
  "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>",
    "hybridSearch": {
      "maxTextRecallSize": 100,
      "countAndFacetMode": "countAllResults"
    },
    "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=2024-05-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. Svar extraheras från de främsta sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.
CaptionResult	Undertexter är de mest representativa passagerna från dokumentet relativt till sökfrågan. De används ofta som dokumentsammanfattning. Undertexter returneras endast för frågor av typen "semantik".
DocumentDebugInfo	Innehåller felsökningsinformation som kan användas för att ytterligare utforska sökresultaten.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HybridCountAndFacetMode	Avgör om antalet och fasorna ska innehålla alla dokument som matchade sökfrågan eller bara de dokument som hämtas i fönstret "maxTextRecallSize". Standardvärdet är "countAllResults".
HybridSearch	Frågeparametrarna för att konfigurera hybridsökbeteenden.
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 sammanfogade råsträngarna som skickades till den semantiska berikande processen.
QueryResultDocumentSemanticField	Beskrivning av fält som skickades till den semantiska berikandeprocessen, samt hur de användes
QuerySpellerType	Ett värde som angav vilken typ av stavningsberäkning som ska användas för att stavningsrätta enskilda sökfrågevillkor.
QueryType	Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "full" om frågan använder Lucene-frågesyntaxen och "semantiken" om frågesyntaxen inte behövs.
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 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.
SearchDocumentsResult	Svar som innehåller sökresultat från ett index.
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.
SearchScoreThreshold	Resultatet av vektorfrågan filtreras baserat på värdet "@search.score". Observera att det här är den @search.score som returneras som en del av söksvaret. Tröskelriktningen väljs för högre @search.score.
SemanticDebugInfo
SemanticErrorMode	Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt eller 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 den semantiska berikande processen (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 utförs.
VectorizableImageBinaryQuery	De frågeparametrar som ska användas för vektorsökning när en bas 64-kodad binärfil för en bild som måste vektoriseras tillhandahålls.
VectorizableImageUrlQuery	De frågeparametrar som ska användas för vektorsökning när en URL som representerar ett bildvärde som måste vektoriseras tillhandahålls.
VectorizableTextQuery	De frågeparametrar som ska användas för vektorsökning när ett textvärde som behöver vektoriseras tillhandahålls.
VectorQueryKind	Den typ av vektorfråga som utförs.
VectorSimilarityThreshold	Resultatet av vektorfrågan filtreras baserat på vektorlikhetsmåttet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "distance"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.
VectorThresholdKind	Den typ av vektorfråga som utförs.

AnswerResult

Ett svar är ett textavsnitt som extraherats från innehållet i de mest relevanta dokument som matchade frågan. Svar extraheras från de främsta 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 i 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 extraherats från dokumentinnehållet som svar.

CaptionResult

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

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.

DocumentDebugInfo

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

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

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HybridCountAndFacetMode

Avgör om antalet och fasorna ska innehålla alla dokument som matchade sökfrågan eller bara de dokument som hämtas i fönstret "maxTextRecallSize". Standardvärdet är "countAllResults".

Name	Typ	Description
countAllResults	string	Inkludera alla dokument som matchades av sökfrågan när databehandlingen "count" och "facets", oavsett om dokumenten finns i hämtningsfönstret "maxTextRecallSize" eller inte.
countRetrievableResults	string	Inkludera endast dokument som matchades i hämtningsfönstret "maxTextRecallSize" vid beräkning av "count" och "facets".

HybridSearch

Frågeparametrarna för att konfigurera hybridsökbeteenden.

Name	Typ	Description
countAndFacetMode	HybridCountAndFacetMode	Avgör om antalet och fasetter ska innehålla alla dokument som matchade sökfrågan eller endast de dokument som hämtas i fönstret "maxTextRecallSize".
maxTextRecallSize	integer	Avgör det maximala antalet dokument som ska hämtas av textfrågedelen i en hybridsökningsbegäran. Dessa dokument kombineras med dokument som matchar vektorfrågorna för att skapa en enda slutlig resultatlista. Om du väljer ett större maxTextRecallSize-värde kan du hämta och växla genom fler dokument (med hjälp av parametrarna längst upp och hoppa över) på bekostnad av högre resursanvändning och högre svarstid. Värdet måste vara mellan 1 och 10 000. Standardvärdet är 1 000.

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.

QueryDebugMode

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

Name	Typ	Description
disabled	string	Ingen felsökningsinformation för frågor returneras.
semantic	string	Gör att användaren kan utforska sina omrankade resultat ytterligare.

QueryLanguage

Frågans språk.

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

QueryResultDocumentRerankerInput

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

Name	Typ	Description
content	string	De sammanfogade rådatasträngarna för innehållsfälten som användes för semantisk berikning.
keywords	string	De sammanfogade rådatasträ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

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

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

QuerySpellerType

Ett värde som angav vilken typ av stavningsberäkning som ska användas för att stavningsrätta enskilda sökfrågevillkor.

Name	Typ	Description
lexicon	string	Stavningsverktyget korrigerar enskilda frågetermer med hjälp av ett statiskt lexikon för det språk som anges av parametern queryLanguage.
none	string	Stavningsfunktionen är inte aktiverad.

QueryType

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

Name	Typ	Description
full	string	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	string	Passar bäst för frågor som uttrycks på naturligt språk i stället för nyckelord. Förbättrar precisionen för sökresultaten genom att rangordna om de bästa sökresultaten med hjälp av en rangordningsmodell som tränats på webbkorusen.
simple	string	Använder den enkla frågesyntaxen för sökningar. Söktext tolkas med hjälp av 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 anges.

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.
oversampling	number	Översamplingsfaktor. Minsta värde är 1. Den åsidosätter parametern defaultOversampling som konfigurerats i indexdefinitionen. Det kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern tillåts endast när en komprimeringsmetod används i det underliggande vektorfältet.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta bara kan anges om alla fält använder samma likhetsmått.
vector	number[]	Vektorrepresentationen av en sökfråga.
weight	number	Relativ vikt för vektorfrågan jämfört med andra vektorfrågor och/eller textfrågan i samma sökbegäran. Det här värdet används när du kombinerar resultatet av flera rangordningslistor som skapats av de olika vektorfrågorna och/eller resultaten som hämtats via textfrågan. Ju högre vikt desto högre blir dokumenten som matchade frågan i den slutliga rangordningen. Standardvärdet är 1,0 och värdet måste vara ett positivt tal som är större än noll.

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.

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.

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.
debug	QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att ytterligare utforska dina omrankade resultat.
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>.
hybridSearch	HybridSearch[]	Frågeparametrarna för att konfigurera hybridsökningsbeteenden.
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.
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 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 eller returnera partiella resultat (standard).
semanticFields	string	Den kommaavgränsade listan med fältnamn som används för semantisk rangordning.
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.
semanticQuery	string	Tillåter inställning av en separat sökfråga som endast ska användas för semantisk omrankning, semantiska undertexter 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 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.
speller	QuerySpellerType	Ett värde som angav vilken typ av stavningsberäkning som ska användas för att stavningsrätta enskilda sökfrågevillkor.
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".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	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 "semantik".
@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	Relevanspoängen som beräknas av semantikrankern 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 "semantik".
@search.score	number	Relevanspoängen för dokumentet jämfört med andra dokument som returneras av frågan.

SearchScoreThreshold

Resultatet av vektorfrågan filtreras baserat på värdet "@search.score". Observera att det här är den @search.score som returneras som en del av söksvaret. Tröskelriktningen väljs för högre @search.score.

Name	Typ	Description
kind	string: searchScore	Den typ av tröskelvärde som används för att filtrera vektorfrågor
value	number	Tröskelvärdet filtreras baserat på värdet "@search.score". Observera att det här är den @search.score som returneras som en del av söksvaret. Tröskelriktningen väljs för högre @search.score.

SemanticDebugInfo

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

SemanticErrorMode

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

Name	Typ	Description
fail	string	Om det finns ett undantag under det semantiska bearbetningssteget 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 semantiskt steg 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" angavs och varaktigheten för semantisk bearbetning överskred det värdet. Endast basresultaten returnerades.
transient	string	Minst ett steg i semantikprocessen misslyckades.

SemanticFieldState

Hur fältet användes för den semantiska berikande processen (fullständigt använd, delvis använd eller oanvänd)

Name	Typ	Description
partial	string	Fältet användes delvis för semantisk berikning.
unused	string	Fältet användes inte för semantisk berikning.
used	string	Fältet användes fullt ut för semantisk berikning.

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 utförs.

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 som begärdes av parametern "k".
preFilter	string	Filtret tillämpas före sökfrågan.

VectorizableImageBinaryQuery

De frågeparametrar som ska användas för vektorsökning när en bas 64-kodad binärfil för en bild som måste vektoriseras tillhandahålls.

Name	Typ	Description
base64Image	string	Den grundläggande 64-kodade binärfilen för en bild som ska vektoriseras för att utföra en vektorsökningsfråga.
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ökda vektorn.
k	integer	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: imageBinary	Den typ av vektorfråga som utförs.
oversampling	number	Översamplingsfaktor. Minsta värde är 1. Den åsidosätter parametern defaultOversampling som konfigurerats i indexdefinitionen. Det kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern tillåts endast när en komprimeringsmetod används i det underliggande vektorfältet.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta bara kan anges om alla fält använder samma likhetsmått.
weight	number	Relativ vikt för vektorfrågan jämfört med andra vektorfrågor och/eller textfrågan i samma sökbegäran. Det här värdet används när du kombinerar resultatet av flera rangordningslistor som skapats av de olika vektorfrågorna och/eller resultaten som hämtats via textfrågan. Ju högre vikt desto högre blir dokumenten som matchade frågan i den slutliga rangordningen. Standardvärdet är 1,0 och värdet måste vara ett positivt tal som är större än noll.

VectorizableImageUrlQuery

De frågeparametrar som ska användas för vektorsökning när en URL som representerar ett bildvä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ökda vektorn.
k	integer	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: imageUrl	Den typ av vektorfråga som utförs.
oversampling	number	Översamplingsfaktor. Minsta värde är 1. Den åsidosätter parametern defaultOversampling som konfigurerats i indexdefinitionen. Det kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern tillåts endast när en komprimeringsmetod används i det underliggande vektorfältet.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta bara kan anges om alla fält använder samma likhetsmått.
url	string	URL:en för en bild som ska vektoriseras för att utföra en vektorsökningsfråga.
weight	number	Relativ vikt för vektorfrågan jämfört med andra vektorfrågor och/eller textfrågan i samma sökbegäran. Det här värdet används när du kombinerar resultatet av flera rangordningslistor som skapats av de olika vektorfrågorna och/eller resultaten som hämtats via textfrågan. Ju högre vikt desto högre blir dokumenten som matchade frågan i den slutliga rangordningen. Standardvärdet är 1,0 och värdet måste vara ett positivt tal som är större än noll.

VectorizableTextQuery

De frågeparametrar som ska användas för vektorsökning när ett textvärde som behöver 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ökda vektorn.
k	integer	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: text	Den typ av vektorfråga som utförs.
oversampling	number	Översamplingsfaktor. Minsta värde är 1. Den åsidosätter parametern defaultOversampling som konfigurerats i indexdefinitionen. Det kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern tillåts endast när en komprimeringsmetod används i det underliggande vektorfältet.
text	string	Texten som ska vektoriseras för att utföra en vektorsökningsfråga.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta bara kan anges om alla fält använder samma likhetsmått.
weight	number	Relativ vikt för vektorfrågan jämfört med andra vektorfrågor och/eller textfrågan i samma sökbegäran. Det här värdet används när du kombinerar resultatet av flera rangordningslistor som skapats av de olika vektorfrågorna och/eller resultaten som hämtats via textfrågan. Ju högre vikt desto högre blir dokumenten som matchade frågan i den slutliga rangordningen. Standardvärdet är 1,0 och värdet måste vara ett positivt tal som är större än noll.

VectorQueryKind

Den typ av vektorfråga som utförs.

Name	Typ	Description
imageBinary	string	Vektorfråga där en base 64-kodad binärfil för en bild som behöver vektoriseras tillhandahålls.
imageUrl	string	Vektorfråga där en URL som representerar ett bildvärde som måste vektoriseras tillhandahålls.
text	string	Vektorfråga där ett textvärde som måste vektoriseras tillhandahålls.
vector	string	Vektorfråga där ett råvektorvärde anges.

VectorSimilarityThreshold

Resultatet av vektorfrågan filtreras baserat på vektorlikhetsmåttet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "distance"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.

Name	Typ	Description
kind	string: vectorSimilarity	Den typ av tröskelvärde som används för att filtrera vektorfrågor
value	number	Tröskelvärdet filtreras baserat på likhetsmåttvärdet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "distance"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.

VectorThresholdKind