Dela via


Documents - Search Get

Söker efter dokument i indexet.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-09-01-preview
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=2024-09-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&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 falskt. Att ställa in det här värdet på sant kan ha en prestandapåverkan. Observera att antalet returnerade är en uppskattning.

$filter
query

string

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

$orderby
query

string[]

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 och desc för att indikera fallande. Standardvärdet är stigande ordning. Banden kommer att brytas av matchningspoängen för dokument. Om ingen OrderBy har angetts är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.

$select
query

string[]

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

$skip
query

integer

int32

Antalet sökresultat att hoppa över. Det här värdet får inte vara större än 100 000. Om du behöver genomsöka dokument i ordning, 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 ordnad 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 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.

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 nyckelavsnitt i de högst rankade dokumenten. Antalet svar som returneras kan konfigureras genom att lägga till pipe-tecknet | följt av alternativet count-<number of answers> efter parametervärdet svar, till exempel extractive|count-3. Standardantalet är 1. Konfidenströskelvärdet kan konfigureras genom att lägga till pipe-tecknet | följt av alternativet threshold-<confidence threshold> efter parametervärdet svar, till exempel extractive|threshold-0.9. Standardtröskelvärdet är 0,7.

captions
query

QueryCaptionType

Den här parametern är endast giltig om frågetypen är semantic. Om den anges returnerar frågan undertexter som extraherats från nyckelpassagen i de högst rankade dokumenten. När Bildtexter är inställt på extractiveaktiveras markering som standard och kan konfigureras genom att lägga till pipe-tecknet | följt av alternativet highlight-<true/false>, till exempel extractive|highlight-true. Standardvärdet är None.

debug
query

QueryDebugMode

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

facet
query

string[]

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

highlight
query

string[]

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

highlightPostTag
query

string

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

highlightPreTag
query

string

En strängtagg som förbereds för att träffa markeringar. 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 omfattas av en sökfråga för att frågan ska rapporteras som en lyckad fråga. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 100.

queryLanguage
query

QueryLanguage

Frågans språk.

queryType
query

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.

scoringParameter
query

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
query

string

Namnet på en bedömningsprofil för att utvärdera matchningspoäng 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 lägre svarstid.

search
query

string

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

searchFields
query

string[]

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
query

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.

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

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

semanticFields
query

string[]

Listan över fältnamn som används för semantisk rangordning.

semanticMaxWaitInMilliseconds
query

integer

int32

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
query

string

Tillåter att du anger en separat sökfråga som endast ska användas för semantisk reranking, semantiska bildtexter och semantiska svar. Är användbart för scenarier där det finns ett behov av att använda olika frågor mellan bashämtnings- och rangordningsfasen och L2-semantikfasen.

sessionId
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. Var försiktig så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och påverka söktjänstens prestanda negativt. Värdet som används som sessionId kan inte börja med ett _-tecken.

speller
query

Speller

Förbättra sökåterkallningen genom att stavningskorrigering av enskilda sökfrågetermer.

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.

Svar

Name Typ Description
200 OK

SearchDocumentsResult

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

Other Status Codes

ErrorResponse

Felsvar.

Exempel

SearchIndexSearchDocumentsGet
SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Exempelbegäran

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=2024-09-01-preview&speller={speller}

Exempelsvar

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

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

Exempelsvar

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "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 textavsnitt som extraherats från innehållet i de mest relevanta dokument som matchade frågan. Svaren extraheras från de bästa sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.

CaptionResult

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

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 endast de dokument som hämtas i fönstret "maxTextRecallSize". Standardvärdet är "countAllResults".

HybridSearch

TFrågeparametrarna för att konfigurera hybridsökningsbeteenden.

QueryAnswerType

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

QueryCaptionType

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

QueryDebugMode

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

QueryLanguage

Frågans språk.

QueryResultDocumentRerankerInput

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

QueryResultDocumentSemanticField

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

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.

QuerySpellerType

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

QueryType

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

RawVectorQuery

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

ScoringStatistics

Ett värde som anger om vi vill beräkna bedömningsstatistik (till exempel dokumentfrekvens) globalt för mer konsekvent bedömning eller lokalt för lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.

SearchDocumentsResult

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

SearchMode

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

SearchRequest

Parametrar för filtrering, sortering, fasettering, växling och andra sökfrågebeteenden.

SearchResult

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

SearchScoreThreshold

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

SemanticDebugInfo
SemanticErrorMode

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

SemanticErrorReason

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

SemanticFieldState

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

SemanticSearchResultsType

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

SingleVectorFieldResult

Ett enda vektorfältresultat. Både @search.score- och vektorlikhetsvärden returneras. Vektorlikhet är relaterad till @search.score av en ekvation.

Speller

Förbättra sökåterkallningen genom att stavningskorrigering av enskilda sökfrågetermer.

TextResult

BM25- eller klassisk poäng för textdelen av frågan.

VectorFilterMode

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

VectorizableImageBinaryQuery

Frågeparametrarna som ska användas för vektorsökning när en base 64-kodad binärfil för en bild som måste vektoriseras tillhandahålls.

VectorizableImageUrlQuery

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

VectorizableTextQuery

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

VectorQueryKind

Den typ av vektorfråga som utförs.

VectorsDebugInfo
VectorSimilarityThreshold

Resultatet av vektorfrågan filtreras baserat på vektorlikhetsmåttet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "avståndsversionen". Tröskelvärdesriktningen (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. Svaren extraheras från de bästa sökresultaten. Svarskandidaterna poängsätts och de vanligaste svaren väljs.

Name Typ Description
highlights

string

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

key

string

Nyckeln i dokumentet som svaret extraherades från.

score

number

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

text

string

Textavsnittet som extraheras från dokumentinnehållet som svar.

CaptionResult

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

Name Typ Description
highlights

string

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

text

string

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

DocumentDebugInfo

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

Name Typ Description
semantic

SemanticDebugInfo

Innehåller felsökningsinformation som är specifik för semantiska rangordningsbegäranden.

vectors

VectorsDebugInfo

Innehåller felsökningsinformation som är specifik för vektor- och hybridsökning.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

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 fasetter ska innehålla alla dokument som matchade sökfrågan eller endast 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 du beräknar "antal" och "fasetter", oavsett om dokumenten finns i hämtningsfönstret "maxTextRecallSize" eller inte.

countRetrievableResults

string

Inkludera endast dokument som matchades i hämtningsfönstret "maxTextRecallSize" när "antal" och "fasetter" beräknas.

HybridSearch

TFrågeparametrarna för att konfigurera hybridsökningsbeteenden.

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 lista med resultat. Om du väljer ett större maxTextRecallSize-värde kan du hämta och söka igenom fler dokument (med hjälp av parametrarna överst 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 information om frågefelsökning 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 persiska (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ändska (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åksvärde för svenska.

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 råa sammanfogade strängarna som skickades till den semantiska berikande processen.

Name Typ Description
content

string

De råa sammanfogade strängarna för de innehållsfält som användes för semantisk berikning.

keywords

string

De råa sammanfogade strängarna för nyckelordsfälten som användes för semantisk berikning.

title

string

Råsträngen för rubrikfältet som användes för semantisk berikning.

QueryResultDocumentSemanticField

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

Name Typ Description
name

string

Namnet på det fält som skickades till semantisk berikningsprocess

state

SemanticFieldState

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

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.

Name Typ Description
documentBoost

number

BM25- eller klassisk poäng för textdelen av frågan.

text

TextResult

BM25- eller klassisk poäng för textdelen av frågan.

vectors

<string,  SingleVectorFieldResult>

Vektorlikheten och @search.score värden för varje vektorfråga.

QuerySpellerType

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

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

Stavningsprogrammet är inte aktiverat.

QueryType

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

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 i naturligt språk i stället för nyckelord. Förbättrar precisionen i sökresultaten genom att rangordna om de bästa sökresultaten med hjälp av en rangordningsmodell som tränats på webb corpus.

simple

string

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

RawVectorQuery

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

Name Typ Description
exhaustive

boolean

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

fields

string

Vektorfält av typen Collection(Edm.Single) som ska ingå i den sökbara vektorn.

filterOverride

string

Det OData-filteruttryck som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck definieras på vektornivå används uttrycket som definierats i filterparametern på den översta nivån i stället.

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. Minimivärdet ä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:

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 resultaten från flera rangordningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtas 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 lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.

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

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 hämta nästa del av söksvaret. Se till att använda samma verb (GET eller POST) som begäran som skapade det här svaret.

@search.answers

AnswerResult[]

Svaren på frågeresultaten för sökåtgärden; null om frågeparametern answers inte har angetts eller angetts till "none".

@search.coverage

number

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

@search.facets

object

Fasetteringsfrågans resultat för sökåtgärden, ordnade som en samling bucketar för varje fasetterat fält. null om frågan inte innehåller några fasetteringsuttryck.

@search.nextPageParameters

SearchRequest

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

@search.semanticPartialResponseReason

SemanticErrorReason

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

@search.semanticPartialResponseType

SemanticSearchResultsType

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

value

SearchResult[]

Resultatsekvensen som returneras av frågan.

SearchMode

Anger om något 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, växling och andra sökfrågebeteenden.

Name Typ Description
answers

QueryAnswerType

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

captions

QueryCaptionType

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

count

boolean

Ett värde som anger om det totala antalet resultat ska hämtas. Standardvärdet är falskt. Att ställa in det här värdet på sant kan ha en prestandapåverkan. Observera att antalet returnerade är en uppskattning.

debug

QueryDebugMode

Aktiverar ett felsökningsverktyg som kan användas för att utforska dina rangordnade resultat ytterligare.

facets

string[]

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

filter

string

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

highlight

string

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

highlightPostTag

string

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

highlightPreTag

string

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

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 omfattas av en sökfråga för att frågan ska rapporteras som en lyckad fråga. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 100.

orderby

string

Kommaavgränsad lista över OData-$orderby uttryck som resultatet ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till funktionerna geo.distance() eller search.score(). Varje uttryck kan följas av asc för att indikera stigande eller desc för att indikera fallande. Standardvärdet är stigande ordning. Banden kommer att brytas av matchningspoängen för dokument. Om ingen $orderby har angetts sjunker standardsorteringsordningen efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.

queryLanguage

QueryLanguage

Ett värde som anger sökfrågans språk.

queryType

QueryType

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

scoringParameters

string[]

Listan över parametervärden som ska användas i bedömningsfunktioner (till exempel referencePointParameter) med formatet name-values. Om bedömningsprofilen till exempel definierar en funktion med parametern "mylocation" skulle parametersträngen vara "mylocation--122.2,44.8" (utan citattecken).

scoringProfile

string

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

scoringStatistics

ScoringStatistics

Ett värde som anger om vi vill beräkna bedömningsstatistik (till exempel dokumentfrekvens) globalt för mer konsekvent bedömning eller lokalt för lägre svarstid. Standardvärdet är "local". Använd "global" för att aggregera bedömningsstatistik globalt innan du gör mål. Om du använder global bedömningsstatistik kan svarstiden för sökfrågor öka.

search

string

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

searchFields

string

Kommaavgränsad lista över fältnamn som fulltextsökningen ska omfatta. När du använder fältsökning (fieldName:searchExpression) i en fullständig Lucene-fråga har fältnamnen för varje fältsökuttryck företräde framför alla fältnamn som anges i den här parametern.

searchMode

SearchMode

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

select

string

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

semanticConfiguration

string

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

semanticErrorHandling

SemanticErrorMode

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

semanticFields

string

Kommaavgränsad lista över 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 att du anger en separat sökfråga som endast ska användas för semantisk reranking, semantiska bildtexter och semantiska svar. Är användbart för scenarier där det finns ett behov av att använda olika frågor mellan bashämtnings- och rangordningsfasen och L2-semantikfasen.

sessionId

string

Ett värde som ska användas för att skapa en klibbig session, vilket kan hjälpa dig att få mer konsekventa resultat. Så länge samma sessionId används görs ett bästa försök att rikta in sig på samma replikuppsättning. Var försiktig så att återanvändning av samma sessionID-värden upprepade gånger kan störa belastningsutjämningen av begäranden mellan repliker och påverka söktjänstens prestanda negativt. Värdet som används som sessionId kan inte börja med ett _-tecken.

skip

integer

Antalet sökresultat att hoppa över. Det här värdet får inte vara större än 100 000. Om du behöver skanna dokument i följd, men inte kan använda hoppa över på grund av den här begränsningen, bör du överväga att använda orderby på en helt ordnad nyckel och filtrera med en intervallfråga i stället.

speller

QuerySpellerType

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

top

integer

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" för nya index.

vectorQueries VectorQuery[]:

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[]

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

@search.documentDebugInfo

DocumentDebugInfo[]

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

@search.highlights

object

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

@search.rerankerScore

number

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

@search.score

number

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 @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 @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 berikande processen samt hur de användes

keywordFields

QueryResultDocumentSemanticField[]

Nyckelordsfälten som skickades till den semantiska berikningsprocessen samt hur de användes

rerankerInput

QueryResultDocumentRerankerInput

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

titleField

QueryResultDocumentSemanticField

Rubrikfältet som skickades till den semantiska berikande processen, samt hur det användes

SemanticErrorMode

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

Name Typ Description
fail

string

Om det finns ett undantag under 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 den semantiska processen misslyckades.

SemanticFieldState

Hur fältet användes för semantisk berikningsprocess (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 reranking.

rerankedResults

string

Resultaten har rangordnats om med rerankermodellen och innehåller semantiska bildtexter. De innehåller inga svar, svarshöjdpunkter eller bildtexthöjdpunkter.

SingleVectorFieldResult

Ett enda vektorfältresultat. Både @search.score- och vektorlikhetsvärden returneras. Vektorlikhet är relaterad till @search.score av en ekvation.

Name Typ Description
searchScore

number

Det @search.score värde som beräknas utifrån vektorlikhetspoängen. Det här är poängen som visas i en ren enfältsfråga med en enda vektor.

vectorSimilarity

number

Vektorlikhetspoängen för det här dokumentet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "avståndsversionen". Till exempel cosinin likhet i stället för cosiné avstånd.

Speller

Förbättra sökåterkallningen genom att stavningskorrigering av enskilda sökfrågetermer.

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

Stavningsprogrammet är inte aktiverat.

TextResult

BM25- eller klassisk poäng för textdelen av frågan.

Name Typ Description
searchScore

number

BM25- eller klassisk poäng för textdelen av frågan.

VectorFilterMode

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

Name Typ Description
postFilter

string

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

preFilter

string

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

VectorizableImageBinaryQuery

Frågeparametrarna som ska användas för vektorsökning när en base 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ökbara vektorn.

filterOverride

string

Det OData-filteruttryck som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck definieras på vektornivå används uttrycket som definierats i filterparametern på den översta nivån i stället.

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. Minimivärdet ä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:

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 resultaten från flera rangordningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtas 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

Frågeparametrarna 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ökbara vektorn.

filterOverride

string

Det OData-filteruttryck som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck definieras på vektornivå används uttrycket som definierats i filterparametern på den översta nivån i stället.

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. Minimivärdet ä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:

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 resultaten från flera rangordningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtas 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

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

Name Typ Description
exhaustive

boolean

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

fields

string

Vektorfält av typen Collection(Edm.Single) som ska ingå i den sökbara vektorn.

filterOverride

string

Det OData-filteruttryck som ska tillämpas på den här specifika vektorfrågan. Om inget filteruttryck definieras på vektornivå används uttrycket som definierats i filterparametern på den översta nivån i stället.

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. Minimivärdet ä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:

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 resultaten från flera rangordningslistor som skapats av de olika vektorfrågorna och/eller de resultat som hämtas 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 måste 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 raw-vektorvärde anges.

VectorsDebugInfo

Name Typ Description
subscores

QueryResultDocumentSubscores

Uppdelningen av delpoäng i dokumentet före den valda metoden för fusion/kombination av resultatuppsättningar, till exempel RRF.

VectorSimilarityThreshold

Resultatet av vektorfrågan filtreras baserat på vektorlikhetsmåttet. Observera att det här är den kanoniska definitionen av likhetsmått, inte "avståndsversionen". Tröskelvärdesriktningen (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 "avståndsversionen". Tröskelvärdesriktningen (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.

Name Typ Description
searchScore

string

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

vectorSimilarity

string

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