Documents - Search Get

Tjänst:: Search Service

API-version:: 2025-08-01-preview

Söker efter dokument i indexet.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-01-preview

Med valfria parametrar:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2025-08-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

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.
$count	query		boolean	Ett värde som anger om det totala antalet resultat ska hämtas. Standardvärdet är false. Om du anger det här värdet till true kan det påverka prestandan. Observera att det returnerade antalet är en uppskattning.
$filter	query		string	OData-$filter uttrycket som ska tillämpas på sökfrågan.
$orderby	query		string[]	Listan över OData-$orderby uttryck som resultaten ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till antingen geo.distance() eller search.score() funktionerna. Varje uttryck kan följas av asc för att ange stigande och desc för att indikera fallande. Standardvärdet är stigande ordning. Oavgjorda resultat 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.
$select	query		string[]	Listan över fält som ska hämtas. Om det inte anges inkluderas alla fält som markerats som hämtningsbara i schemat.
$skip	query		integer (int32)	Antalet sökresultat som ska hoppas ö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 $skip på grund av den här begränsningen, bör du överväga att använda $orderby på en helt sorterad nyckel och $filter med en intervallfråga i stället.
$top	query		integer (int32)	Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera sidindelning av sökresultat på klientsidan. Om resultaten trunkeras på grund av växling på serversidan innehåller svaret en fortsättningstoken som kan användas för att utfärda en ny sökbegäran för nästa resultatsida.
answers	query		QueryAnswerType	Den här parametern är endast giltig om frågetypen är `semantic`. Om den anges returnerar frågan svar som extraherats från nyckelpassager i de högst rankade dokumenten. Antalet svar som returneras kan konfigureras genom att lägga till pipe-tecknet `\|` följt av `count-<number of answers>` alternativet efter parametervärdet answers, till `extractive\|count-3`exempel . Standardantalet är 1. Konfidenströskeln kan konfigureras genom att lägga till pipe-tecknet `\|` följt av `threshold-<confidence threshold>` alternativet efter parametervärdet answers, till exempel `extractive\|threshold-0.9`. Standardtröskelvärdet är 0,7. Den maximala teckenlängden för svar kan konfigureras genom att lägga till pipe-tecknet '\|' följt av 'count-number< of maximum character length>', till exempel 'extractive\|maxcharlength-600'.
captions	query		QueryCaptionType	Den här parametern är endast giltig om frågetypen är `semantic`. Om det anges returnerar frågan undertexter som extraherats från nyckelpassager i de högst rankade dokumenten. När Bildtexter är inställt på `extractive`är markering aktiverat som standard och kan konfigureras genom att lägga till pipe-tecknet `\|` följt av `highlight-<true/false>` alternativet, till exempel `extractive\|highlight-true`. Standardinställningen är `None`. Den maximala teckenlängden för bildtexter kan konfigureras genom att lägga till pipe-tecknet "\|" följt av "count-number< of maximum character length>", till exempel "extractive\|maxcharlength-600".
debug	query		QueryDebugMode	Aktiverar ett felsökningsverktyg som kan användas för att utforska dina sökresultat ytterligare.
facet	query		string[]	Listan över fasettuttryck som ska användas för sökfrågan. Varje fasettuttryck innehåller ett fältnamn, eventuellt följt av en kommaavgränsad lista med namn:värde-par.
highlight	query		string[]	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	query		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	query		string	En strängtagg som är förberedd för att träffa höjdpunkter. Måste anges med highlightPostTag. Standardvärdet är <em>.
minimumCoverage	query		number (double)	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ängligheten även för tjänster med bara en replik. Standardvärdet är 100.
queryLanguage	query		QueryLanguage	Språket för frågan.
queryRewrites	query		QueryRewritesType	När QueryRewrites är inställt `generative`på skickas frågetermerna till en genereringsmodell som genererar 10 (standard) omskrivningar för att öka återkallandet av begäran. Det begärda antalet kan konfigureras genom att lägga till pipe-tecknet `\|` följt av `count-<number of rewrites>` alternativet, till exempel `generative\|count-3`. Standardinställningen är `None`. Den här parametern är endast giltig om frågetypen är `semantic`.
queryType	query		QueryType	Ett värde som anger syntaxen för sökfrågan. Standardvärdet är "enkel". Använd "fullständig" om frågan använder Lucene-frågesyntaxen.
scoringParameter	query		string[]	Listan över parametervärden som ska användas i bedömningsfunktioner (till exempel referencePointParameter) med hjälp av formatet name-values. Om bedömningsprofilen till exempel definierar en funktion med en parameter som kallas "mylocation" blir parametersträngen "mylocation--122.2,44.8" (utan citattecken).
scoringProfile	query		string	Namnet på en bedömningsprofil för att utvärdera matchningsresultat för matchande dokument för att sortera resultaten.
scoringStatistics	query		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.
search	query		string	Ett uttryck för fulltextsökningsfråga. Använd "*" eller utelämna den här parametern för att matcha alla dokument.
searchFields	query		string[]	Listan över fältnamn som fulltextsökningen ska begrä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	query		SearchMode	Ett värde som anger om någon eller alla söktermer måste matchas för att dokumentet ska räknas som en matchning.
semanticConfiguration	query		string	Namnet på den semantiska konfigurationen som visar vilka fält som ska användas för semantisk rangordning, undertexter, markeringar och svar
semanticErrorHandling	query		SemanticErrorMode	Gör att användaren kan välja om ett semantiskt anrop ska misslyckas helt eller returnera partiella resultat (standard).
semanticFields	query		string[]	Listan över fältnamn som används för semantisk rangordning.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	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	query		string	Gör det möjligt att ställa in en separat sökfråga som endast kommer att 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 den grundläggande hämtnings- och rangordningsfasen och den semantiska L2-fasen.
sessionId	query		string	Ett värde som ska användas för att skapa en klibbig session, vilket kan hjälpa till att få mer konsekventa resultat. Så länge samma sessionId används görs ett bästa försök att rikta in sig på samma replikuppsättning. Tänk på 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 tecknet "_".
speller	query		QuerySpellerType	Förbättra sökhämtningen genom att stavningskorrigera enskilda söktermer.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Spårnings-ID:t som skickades med begäran för att hjälpa till med felsökning.
x-ms-query-source-authorization		string	Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument.

Svar

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

Exempel

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Exempelbegäran

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2025-08-01-preview&speller={speller}

Exempelsvar

Statuskod:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

Statuskod:: 206

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Exempelbegäran

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-08-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

Exempelsvar

Statuskod:: 200

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

Statuskod:: 206

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

Definitioner

Name	Description
AnswerResult	Ett svar är ett textstycke som extraheras från innehållet i de mest relevanta dokumenten som matchade frågan. Svaren extraheras från de översta sökresultaten. Svarskandidaterna poängsätts och de bästa svaren väljs.
CaptionResult	Bildtexter är de mest representativa avsnitten i dokumentet i förhållande till sökfrågan. De används ofta som dokumentsammanfattningar. Undertexter returneras endast för frågor av typen `semantic`.
DebugInfo	Innehåller felsökningsinformation som kan användas för att utforska sökresultaten ytterligare.
DocumentDebugInfo	Innehåller felsökningsinformation som kan användas för att utforska sökresultaten ytterligare.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HybridCountAndFacetMode	Avgör om antalet och fasetter 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 dina sökresultat ytterligare. Du kan aktivera flera felsökningslägen samtidigt genom att separera dem med en \| tecknet, till exempel: semantisk\|queryRewrites.
QueryLanguage	Språket för frågan.
QueryResultDocumentRerankerInput	De råa sammanfogade strängarna som skickades till den semantiska berikningsprocessen.
QueryResultDocumentSemanticField	Beskrivning av fält som skickades till den semantiska berikningsprocessen, samt hur de användes
QueryResultDocumentSubscores	Uppdelningen av delpoäng mellan text- och vektorfrågekomponenterna i sökfrågan för det här dokumentet. Varje vektorfråga visas som ett separat objekt i samma ordning som de togs emot.
QueryRewritesDebugInfo	Innehåller felsökningsinformation som är specifik för omskrivningar av frågor.
QueryRewritesType	Ett värde som anger om omskrivningar av frågor ska genereras för att utöka sökfrågan.
QueryRewritesValuesDebugInfo	Innehåller felsökningsinformation som är specifik för omskrivningar av frågor.
QuerySpellerType	Ett värde som angav vilken typ av stavningsverktyg som ska användas för att stava enskilda söktermer.
QueryType	Anger syntaxen för sökfrågan. Standardvärdet är "enkel". Använd "fullständig" om frågan använder Lucene-frågesyntaxen och "semantisk" om frågesyntaxen inte behövs.
RawVectorQuery	De frågeparametrar 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 "local". Använd "global" för att aggregera poängstatistik globalt innan du gör poäng. Om du använder global bedömningsstatistik kan du öka svarstiden för sökfrågor.
SearchDocumentsResult	Svar som innehåller sökresultat från ett index.
SearchMode	Anger om någon eller alla söktermer måste matchas för att dokumentet ska räknas 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 @search.score detta returneras som en del av söksvaret. Tröskelriktningen kommer att väljas för högre @search.score.
SemanticDebugInfo
SemanticErrorMode	Gör det möjligt för användaren att välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller om partiella resultat ska returneras.
SemanticErrorReason	Orsak till att ett partiellt svar returnerades för en semantisk rangordningsbegäran.
SemanticFieldState	Hur fältet användes för den semantiska berikningsprocessen (fullständigt använt, delvis använt eller oanvänt)
SemanticQueryRewritesResultType	Typ av omskrivning av frågor som användes för den här begäran.
SemanticSearchResultsType	Typ av partiellt svar som returnerades för en semantisk rangordningsbegäran.
SingleVectorFieldResult	Ett resultat med ett enda vektorfält. Både @search.score och vektorlikhetsvärden returneras. Vektorlikhet relateras till @search.score av en ekvation.
TextResult	BM25- eller Classic-poängen för textdelen av frågan.
VectorFilterMode	Avgör om filter ska användas före eller efter att vektorsökningen har utförts.
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 behöver 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 behöver vektoriseras anges.
VectorizableTextQuery	De frågeparametrar som ska användas för vektorsökning när ett textvärde som behöver vektoriseras anges.
VectorQueryKind	Vilken typ av vektorfråga som utförs.
VectorsDebugInfo
VectorSimilarityThreshold	Resultatet av vektorfrågan filtreras baserat på måttet för vektorlikhet. Observera att detta är den kanoniska definitionen av likhetsmått, inte "avstånd"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.
VectorThresholdKind	Vilken typ av vektorfråga som utförs.

AnswerResult

Objekt

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

Name	Typ	Description
highlights	string	Samma textpassage som i egenskapen Text med markerade textfraser som är mest relevanta för frågan.
key	string	Nyckeln till 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	Det textavsnitt som extraheras från dokumentets innehåll som svar.

CaptionResult

Objekt

Bildtexter är de mest representativa avsnitten i dokumentet i förhållande till sökfrågan. De används ofta som dokumentsammanfattningar. Undertexter returneras endast för frågor av typen semantic.

Name	Typ	Description
highlights	string	Samma textpassage som i egenskapen Text med markerade fraser som är mest relevanta för frågan.
text	string	Ett representativt textavsnitt som extraheras från det dokument som är mest relevant för sökfrågan.

DebugInfo

Objekt

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

Name	Typ	Description
queryRewrites	QueryRewritesDebugInfo	Innehåller felsökningsinformation som är specifik för omskrivningar av frågor.

DocumentDebugInfo

Objekt

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

Name	Typ	Description
innerHits	object	Innehåller felsökningsinformation som är specifik för vektorer som matchas i en samling komplexa typer.
semantic	SemanticDebugInfo	Innehåller felsökningsinformation som är specifik för semantiska rangordningsbegäranden.
vectors	VectorsDebugInfo	Innehåller felsökningsinformation som är specifik för vektor- och hybridsökning.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HybridCountAndFacetMode

Uppräkning

Avgör om antalet och fasetter 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".

Värde	Description
countRetrievableResults	Inkludera endast dokument som matchades i hämtningsfönstret "maxTextRecallSize" vid beräkning av "antal" och "fasetter".
countAllResults	Inkludera alla dokument som matchades av sökfrågan vid beräkning av "antal" och "fasetter", oavsett om dessa dokument finns i hämtningsfönstret "maxTextRecallSize" eller inte.

HybridSearch

Objekt

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 bara de dokument som hämtas i fönstret "maxTextRecallSize".
maxTextRecallSize	integer (int32)	Avgör det maximala antalet dokument som ska hämtas av textfrågedelen av en hybridsökningsbegäran. Dessa dokument kombineras med de dokument som matchar vektorfrågorna för att skapa en enda slutlig lista med resultat. Om du väljer ett större maxTextRecallSize-värde kan du hämta och bläddra igenom fler dokument (med hjälp av parametrarna top och skip), på bekostnad av högre resursutnyttjande och längre svarstider. Värdet måste vara mellan 1 och 10 000. Standardvärdet är 1 000.

QueryAnswerType

Uppräkning

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

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

QueryCaptionType

Uppräkning

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

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

QueryDebugMode

Uppräkning

Aktiverar ett felsökningsverktyg som kan användas för att utforska dina sökresultat ytterligare. Du kan aktivera flera felsökningslägen samtidigt genom att separera dem med en | tecknet, till exempel: semantisk|queryRewrites.

Värde	Description
disabled	Ingen felsökningsinformation för frågor returneras.
semantic	Gör det möjligt för användaren att ytterligare utforska sina omrankade resultat.
vector	Gör det möjligt för användaren att ytterligare utforska sina hybrid- och vektorfrågeresultat.
queryRewrites	Gör att användaren kan utforska listan över frågeomskrivningar som genererats för deras sökbegäran.
innerHits	Gör det möjligt för användaren att hämta bedömningsinformation om vektorer som matchas i en samling komplexa typer.
all	Aktivera alla felsökningsalternativ.

QueryLanguage

Uppräkning

Språket för frågan.

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

QueryResultDocumentRerankerInput

Objekt

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

Name	Typ	Description
content	string	De råa sammanfogade strängarna för innehållsfälten 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	Den råa strängen för titelfältet som användes för semantisk berikning.

QueryResultDocumentSemanticField

Objekt

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

Name	Typ	Description
name	string	Namnet på fältet som skickades till den semantiska berikningsprocessen
state	SemanticFieldState	Hur fältet användes för den semantiska berikningsprocessen (fullständigt använt, delvis använt eller oanvänt)

QueryResultDocumentSubscores

Objekt

Uppdelningen av delpoäng mellan text- och vektorfrågekomponenterna i sökfrågan för det här dokumentet. Varje vektorfråga visas som ett separat objekt i samma ordning som de togs emot.

Name	Typ	Description
documentBoost	number (double)	BM25- eller Classic-poängen för textdelen av frågan.
text	TextResult	BM25- eller Classic-poängen för textdelen av frågan.
vectors	<string, SingleVectorFieldResult>	Vektorlikheten och @search.score värdena för varje vektorfråga.

QueryRewritesDebugInfo

Objekt

Innehåller felsökningsinformation som är specifik för omskrivningar av frågor.

Name	Typ	Description
text	QueryRewritesValuesDebugInfo	Lista över omskrivningar av frågor som genererats för textfrågan.
vectors	QueryRewritesValuesDebugInfo[]	Lista över frågeomskrivningar som genererats för vektoriserbara textfrågor.

QueryRewritesType

Uppräkning

Ett värde som anger om omskrivningar av frågor ska genereras för att utöka sökfrågan.

Värde	Description
none	Generera inte ytterligare frågeomskrivningar för den här frågan.
generative	Generera alternativa frågetermer för att öka återkallandet av en sökbegäran.

QueryRewritesValuesDebugInfo

Objekt

Innehåller felsökningsinformation som är specifik för omskrivningar av frågor.

Name	Typ	Description
inputQuery	string	Indatatexten till den generativa frågeomskrivningsmodellen. Det kan finnas fall där användarfrågan och indata till den generativa modellen inte är identiska.
rewrites	string[]	Lista över omskrivningar av frågor.

QuerySpellerType

Uppräkning

Ett värde som angav vilken typ av stavningsverktyg som ska användas för att stava enskilda söktermer.

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

QueryType

Uppräkning

Anger syntaxen för sökfrågan. Standardvärdet är "enkel". Använd "fullständig" om frågan använder Lucene-frågesyntaxen och "semantisk" om frågesyntaxen inte behövs.

Värde	Description
simple	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 har angetts.
full	Använder den fullständiga Lucene-frågesyntaxen för sökningar. Söktexten tolkas med hjälp av frågespråket Lucene, som tillåter fältspecifika och viktade sökningar, samt andra avancerade funktioner.
semantic	Passar bäst för frågor som uttrycks på naturligt språk i motsats till nyckelord. Förbättrar precisionen i sökresultaten genom att rangordna om de främsta sökresultaten med hjälp av en rankningsmodell som tränats på webbkorpusen.

RawVectorQuery

Objekt

De frågeparametrar som ska användas för vektorsökning när ett råvektorvärde anges.

Name	Typ	Description
exhaustive	boolean	När värdet är true utlöses en uttömmande k-närmaste grannsökning, för alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.
fields	string	Vector Fields av typen Collection(Edm.Single) som ska ingå i den sökta vektorn.
filterOverride	string	OData-filteruttrycket som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck har definierats på vektornivå används i stället det uttryck som definieras i filterparametern på den översta nivån.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: vector	Vilken typ av vektorfråga som utförs.
oversampling	number (double)	Översamplingsfaktor. Minimivärdet är 1. Den åsidosätter parametern "defaultOversampling" som konfigurerats i indexdefinitionen. Den kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern är endast tillåten när en komprimeringsmetod används på det underliggande vektorfältet.
perDocumentVectorLimit	integer (int32)	Styr hur många vektorer som kan matchas från varje dokument i en vektorsökningsfråga. Om du ställer in den på 1 ser du till att högst en vektor per dokument matchas, vilket garanterar att resultaten kommer från olika dokument. Om du ställer in den på 0 (obegränsat) kan flera relevanta vektorer från samma dokument matchas. Standardvärdet är 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta endast kan ställas in om alla "fält" använder samma likhetsmått.
vector	number[] (float)	Vektorrepresentationen av en sökfråga.
weight	number (float)	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 resultaten från flera rankningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtats via textfrågan. Ju högre vikt, desto högre blir de dokument 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

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 kortare svarstider. Standardvärdet är "local". Använd "global" för att aggregera poängstatistik globalt innan du gör poäng. Om du använder global bedömningsstatistik kan du öka svarstiden för sökfrågor.

Värde	Description
local	Bedömningsstatistiken beräknas lokalt för kortare svarstider.
global	Poängstatistiken kommer att beräknas globalt för mer konsekvent poängsättning.

SearchDocumentsResult

Objekt

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

Name	Typ	Description
@odata.count	integer (int64)	Det totala antalet resultat som hittas 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:en returneras 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 frågeresultat 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.debug	DebugInfo	Felsök information som gäller för sökresultaten som helhet.
@search.facets	object	Fasettfrågeresultaten för sökåtgärden, ordnade som en samling buckets för varje fasetterat fält. null om frågan inte innehöll några fasettuttryck.
@search.nextPageParameters	SearchRequest	JSON-nyttolast för fortsättning returneras 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-sökningsbegäran för att hämta 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.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Typ av omskrivning av frågor som användes för att hämta dokument.
value	SearchResult[]	Sekvensen med resultat som returneras av frågan.

SearchMode

Uppräkning

Anger om någon eller alla söktermer måste matchas för att dokumentet ska räknas som en matchning.

Värde	Description
any	Något av sökorden måste matchas för att dokumentet ska kunna räknas som en matchning.
all	Alla söktermer måste matchas för att dokumentet ska kunna räknas som en matchning.

SearchRequest

Objekt

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. Om du anger det här värdet till true kan det påverka prestandan. Observera att det returnerade antalet ä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 fasettuttryck som ska användas för sökfrågan. Varje fasettuttryck innehåller ett fältnamn, eventuellt följt av en kommaavgränsad lista med namn:värde-par.
filter	string	OData-$filter uttrycket som ska tillämpas på sökfrågan.
highlight	string	Den kommaavgränsade listan med fältnamn som ska användas för träffmarkeringar. 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 är förberedd 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 (double)	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ängligheten även för tjänster med bara en replik. Standardvärdet är 100.
orderby	string	Den kommaavgränsade listan med OData-uttryck $orderby som resultaten ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till antingen geo.distance() eller search.score() funktionerna. Varje uttryck kan följas av asc för att indikera stigande, eller desc för att indikera fallande. Standardvärdet är stigande ordning. Oavgjorda resultat 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 språket för sökfrågan.
queryRewrites	QueryRewritesType	Ett värde som anger om omskrivningar av frågor ska genereras för att utöka sökfrågan.
queryType	QueryType	Ett värde som anger syntaxen för sökfrågan. Standardvärdet är "enkel". Använd "fullständig" 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 hjälp av formatet name-values. Om bedömningsprofilen till exempel definierar en funktion med en parameter som kallas "mylocation" blir parametersträngen "mylocation--122.2,44.8" (utan citattecken).
scoringProfile	string	Namnet på en bedömningsprofil för att utvärdera matchningsresultat 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 "local". Använd "global" för att aggregera poängstatistik globalt innan du gör poäng. Om du använder global bedömningsstatistik kan du öka svarstiden för sökfrågor.
search	string	Ett uttryck för fulltextsökningsfråga. 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 begrä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ågon eller alla söktermer måste matchas för att dokumentet ska räknas som en matchning.
select	string	Den kommaavgränsade listan med 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 semantisk.
semanticErrorHandling	SemanticErrorMode	Gör det möjligt för användaren att välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller om partiella resultat ska returneras.
semanticFields	string	Den kommaavgränsade listan med fältnamn som används för semantisk rangordning.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	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	Gör det möjligt att ställa in en separat sökfråga som endast kommer att 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 den grundläggande hämtnings- och rangordningsfasen och den semantiska L2-fasen.
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. Tänk på 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 tecknet "_".
skip	integer (int32)	Antalet sökresultat som ska hoppas ö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 skip på grund av den här begränsningen, bör du överväga att använda orderby på en helt sorterad nyckel och filtrera med en intervallfråga i stället.
speller	QuerySpellerType	Ett värde som angav vilken typ av stavningsverktyg som ska användas för att stava enskilda söktermer.
top	integer (int32)	Antalet sökresultat som ska hämtas. Detta kan användas tillsammans med $skip för att implementera sidindelning av sökresultat på klientsidan. Om resultaten trunkeras på grund av växling på serversidan innehåller svaret en fortsättningstoken som kan användas för att utfärda en ny sökbegäran för nästa resultatsida.
vectorFilterMode	VectorFilterMode	Avgör om filter ska användas före eller efter att vektorsökningen har utförts. Standardvärdet är "preFilter" för nya index.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Frågeparametrarna för vektor- och hybridsökningsfrå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 i dokumentet i förhållande till sökfrågan. De används ofta som dokumentsammanfattningar. 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.rerankerBoostedScore	number (double)	Relevanspoängen beräknas genom att öka Reranker Score. Sökresultaten sorteras efter RerankerScore/RerankerBoostedScore baserat på useScoringProfileBoostedRanking i den semantiska konfigurationen. RerankerBoostedScore returneras endast för frågor av typen "semantisk"
@search.rerankerScore	number (double)	Relevanspoängen som beräknas av den semantiska rangordningen för de främsta sökresultaten. Sökresultaten sorteras först efter RerankerScore och sedan efter Score. 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.

SearchScoreThreshold

Objekt

Resultatet av vektorfrågan filtreras baserat på värdet "@search.score". Observera att @search.score detta returneras som en del av söksvaret. Tröskelriktningen kommer att väljas 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 (double)	Tröskelvärdet filtreras baserat på värdet "@search.score". Observera att @search.score detta returneras som en del av söksvaret. Tröskelriktningen kommer att väljas för högre @search.score.

SemanticDebugInfo

Objekt

Name	Typ	Description
contentFields	QueryResultDocumentSemanticField[]	Innehållsfälten som skickades till den semantiska berikningsprocessen, 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 berikningsprocessen.
titleField	QueryResultDocumentSemanticField	Titelfältet som skickades till den semantiska berikningsprocessen, samt hur det användes

SemanticErrorMode

Uppräkning

Gör det möjligt för användaren att välja om ett semantiskt anrop ska misslyckas helt (standard/aktuellt beteende) eller om partiella resultat ska returneras.

Värde	Description
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.
fail	Om det finns ett undantag under det semantiska bearbetningssteget misslyckas frågan och returnerar lämplig HTTP-kod beroende på felet.

SemanticErrorReason

Uppräkning

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

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

SemanticFieldState

Uppräkning

Hur fältet användes för den semantiska berikningsprocessen (fullständigt använt, delvis använt eller oanvänt)

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

SemanticQueryRewritesResultType

Uppräkning

Typ av omskrivning av frågor som användes för den här begäran.

Värde	Description
originalQueryOnly	Det gick inte att generera frågeomskrivningar för den här begäran. Endast den ursprungliga frågan användes för att hämta resultaten.

SemanticSearchResultsType

Uppräkning

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

Värde	Description
baseResults	Resultat utan semantisk berikning eller omrankning.
rerankedResults	Resultaten har rangordnats om med omrankningsmodellen och kommer att innehålla semantiska undertexter. De kommer inte att innehålla några svar, höjdpunkter i svar eller höjdpunkter i bildtexter.

SingleVectorFieldResult

Objekt

Ett resultat med ett enda vektorfält. Både @search.score och vektorlikhetsvärden returneras. Vektorlikhet relateras till @search.score av en ekvation.

Name	Typ	Description
searchScore	number (double)	Värdet @search.score som beräknas från vektorlikhetspoängen. Det här är poängen som visas i en ren fråga med ett fält med en vektor.
vectorSimilarity	number (double)	Vektorlikhetspoängen för det här dokumentet. Observera att detta är den kanoniska definitionen av likhetsmått, inte "avstånd"-versionen. Till exempel cosinuslikhet i stället för cosinusavstånd.

TextResult

Objekt

BM25- eller Classic-poängen för textdelen av frågan.

Name	Typ	Description
searchScore	number (double)	BM25- eller Classic-poängen för textdelen av frågan.

VectorFilterMode

Uppräkning

Avgör om filter ska användas före eller efter att vektorsökningen har utförts.

Värde	Description
postFilter	Filtret kommer att tillämpas efter att kandidatuppsättningen med vektorresultat har returnerats. Beroende på filtrets selektivitet kan detta resultera i färre resultat än vad som begärs av parametern "k".
preFilter	Filtret kommer att tillämpas före sökfrågan.
strictPostFilter	Filtret tillämpas när den globala topp-k-kandidatuppsättningen med vektorresultat returneras. Detta resulterar i färre resultat än vad som begärs av parametern "k".

VectorizableImageBinaryQuery

Objekt

De frågeparametrar som ska användas för vektorsökning när en bas 64-kodad binärfil för en bild som behöver 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ökning.
exhaustive	boolean	När värdet är true utlöses en uttömmande k-närmaste grannsökning, för alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.
fields	string	Vector Fields av typen Collection(Edm.Single) som ska ingå i den sökta vektorn.
filterOverride	string	OData-filteruttrycket som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck har definierats på vektornivå används i stället det uttryck som definieras i filterparametern på den översta nivån.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: imageBinary	Vilken typ av vektorfråga som utförs.
oversampling	number (double)	Översamplingsfaktor. Minimivärdet är 1. Den åsidosätter parametern "defaultOversampling" som konfigurerats i indexdefinitionen. Den kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern är endast tillåten när en komprimeringsmetod används på det underliggande vektorfältet.
perDocumentVectorLimit	integer (int32)	Styr hur många vektorer som kan matchas från varje dokument i en vektorsökningsfråga. Om du ställer in den på 1 ser du till att högst en vektor per dokument matchas, vilket garanterar att resultaten kommer från olika dokument. Om du ställer in den på 0 (obegränsat) kan flera relevanta vektorer från samma dokument matchas. Standardvärdet är 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta endast kan ställas in om alla "fält" använder samma likhetsmått.
weight	number (float)	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 resultaten från flera rankningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtats via textfrågan. Ju högre vikt, desto högre blir de dokument 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

Objekt

De frågeparametrar som ska användas för vektorsökning när en URL som representerar ett bildvärde som behöver vektoriseras anges.

Name	Typ	Description
exhaustive	boolean	När värdet är true utlöses en uttömmande k-närmaste grannsökning, för alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.
fields	string	Vector Fields av typen Collection(Edm.Single) som ska ingå i den sökta vektorn.
filterOverride	string	OData-filteruttrycket som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck har definierats på vektornivå används i stället det uttryck som definieras i filterparametern på den översta nivån.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: imageUrl	Vilken typ av vektorfråga som utförs.
oversampling	number (double)	Översamplingsfaktor. Minimivärdet är 1. Den åsidosätter parametern "defaultOversampling" som konfigurerats i indexdefinitionen. Den kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern är endast tillåten när en komprimeringsmetod används på det underliggande vektorfältet.
perDocumentVectorLimit	integer (int32)	Styr hur många vektorer som kan matchas från varje dokument i en vektorsökningsfråga. Om du ställer in den på 1 ser du till att högst en vektor per dokument matchas, vilket garanterar att resultaten kommer från olika dokument. Om du ställer in den på 0 (obegränsat) kan flera relevanta vektorer från samma dokument matchas. Standardvärdet är 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta endast kan ställas in om alla "fält" använder samma likhetsmått.
url	string	URL:en till en bild som ska vektoriseras för att utföra en vektorsökning.
weight	number (float)	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 resultaten från flera rankningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtats via textfrågan. Ju högre vikt, desto högre blir de dokument 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

Objekt

De frågeparametrar som ska användas för vektorsökning när ett textvärde som behöver vektoriseras anges.

Name	Typ	Description
exhaustive	boolean	När värdet är true utlöses en uttömmande k-närmaste grannsökning, för alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.
fields	string	Vector Fields av typen Collection(Edm.Single) som ska ingå i den sökta vektorn.
filterOverride	string	OData-filteruttrycket som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck har definierats på vektornivå används i stället det uttryck som definieras i filterparametern på den översta nivån.
k	integer (int32)	Antal närmaste grannar som ska returneras som toppträffar.
kind	string: text	Vilken typ av vektorfråga som utförs.
oversampling	number (double)	Översamplingsfaktor. Minimivärdet är 1. Den åsidosätter parametern "defaultOversampling" som konfigurerats i indexdefinitionen. Den kan bara anges när "rerankWithOriginalVectors" är sant. Den här parametern är endast tillåten när en komprimeringsmetod används på det underliggande vektorfältet.
perDocumentVectorLimit	integer (int32)	Styr hur många vektorer som kan matchas från varje dokument i en vektorsökningsfråga. Om du ställer in den på 1 ser du till att högst en vektor per dokument matchas, vilket garanterar att resultaten kommer från olika dokument. Om du ställer in den på 0 (obegränsat) kan flera relevanta vektorer från samma dokument matchas. Standardvärdet är 0.
queryRewrites	QueryRewritesType	Kan konfigureras så att en generativ modell kan skriva om frågan innan den skickas för vektorisering.
text	string	Texten som ska vektoriseras för att utföra en vektorsökning.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Tröskelvärdet som används för vektorfrågor. Observera att detta endast kan ställas in om alla "fält" använder samma likhetsmått.
weight	number (float)	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 resultaten från flera rankningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtats via textfrågan. Ju högre vikt, desto högre blir de dokument 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

Uppräkning

Vilken typ av vektorfråga som utförs.

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

VectorsDebugInfo

Objekt

Name	Typ	Description
subscores	QueryResultDocumentSubscores	Uppdelningen av delpoäng i dokumentet före den valda resultatuppsättningens fusions-/kombinationsmetod, t.ex. RRF.

VectorSimilarityThreshold

Objekt

Resultatet av vektorfrågan filtreras baserat på måttet för vektorlikhet. Observera att detta är den kanoniska definitionen av likhetsmått, inte "avstånd"-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 (double)	Tröskelvärdet filtreras baserat på måttvärdet för likhet. Observera att detta är den kanoniska definitionen av likhetsmått, inte "avstånd"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.

VectorThresholdKind

Uppräkning

Vilken typ av vektorfråga som utförs.

Värde	Description
vectorSimilarity	Resultatet av vektorfrågan filtreras baserat på måttet för vektorlikhet. Observera att detta är den kanoniska definitionen av likhetsmått, inte "avstånd"-versionen. Tröskelriktningen (större eller mindre) väljs automatiskt enligt det mått som används av fältet.
searchScore	Resultatet av vektorfrågan filtreras baserat på värdet "@search.score". Observera att @search.score detta returneras som en del av söksvaret. Tröskelriktningen kommer att väljas för högre @search.score.