Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

Zoekt naar documenten in de index.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag is verzonden om te helpen bij foutopsporing.

Aanvraagbody

Name	Type	Description
answers	QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.
captions	QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.
count	boolean	Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardinstelling is onwaar. Het instellen van deze waarde op true kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.
debug	QueryDebugMode	Hiermee schakelt u een hulpprogramma voor foutopsporing in dat kan worden gebruikt om uw opnieuw gerankte resultaten verder te verkennen.
facets	string[]	De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, optioneel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.
filter	string	De OData $filter expressie die moet worden toegepast op de zoekquery.
highlight	string	De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor hit-highlights. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.
highlightPreTag	string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em>.
minimumCoverage	number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een zoekquery moet worden gedekt om de query als geslaagd te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.
orderby	string	De door komma's gescheiden lijst met OData-$orderby expressies waarmee de resultaten kunnen worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Bindingen worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby componenten zijn.
queryLanguage	QueryLanguage	Een waarde die de taal van de zoekquery aangeeft.
queryType	QueryType	Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis.
scoringParameters	string[]	De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met de parameter 'mylocation', is de parametertekenreeks 'mylocation-122.2,44.8' (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel voor het evalueren van matchscores voor overeenkomende documenten om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. De standaardwaarde is 'lokaal'. Gebruik 'globaal' om scorestatistieken globaal samen te voegen voordat ze worden scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.
search	string	Een zoekquery-expressie in volledige tekst; Gebruik *of laat deze parameter weg om overeen te komen met alle documenten.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarop de volledige tekst moet worden gezocht. Wanneer u veldzoekopdrachten (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.
searchMode	SearchMode	Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, worden alle velden die zijn gemarkeerd als ophalen mogelijk in het schema opgenomen.
semanticConfiguration	string	De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch.
semanticErrorHandling	SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten moet retourneren (standaard).
semanticFields	string	De door komma's gescheiden lijst met veldnamen die worden gebruikt voor semantische rangschikking.
semanticMaxWaitInMilliseconds	integer	Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is voor semantische verrijking om de verwerking te voltooien voordat de aanvraag mislukt.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die alleen wordt gebruikt voor semantische herrankering, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin er verschillende query's moeten worden gebruikt tussen de basisfase voor ophalen en rangschikken en de semantische L2-fase.
sessionId	string	Een waarde die moet worden gebruikt om een sticky-sessie te maken, waarmee u consistentere resultaten kunt krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk opnieuw gebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen tussen replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die wordt gebruikt als sessionId, kan niet beginnen met een '_'-teken.
skip	integer	Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde moet scannen, maar vanwege deze beperking niet kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
speller	QuerySpellerType	Een waarde die het type spellingcontrole opgeeft dat moet worden gebruikt om afzonderlijke zoekquerytermen te spellen.
top	integer	Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te voeren voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd. De standaardwaarde is 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

Antwoorden

Name	Type	Description
200 OK	SearchDocumentsResult	Antwoord met documenten die voldoen aan de zoekcriteria.
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

SearchIndexSearchDocumentsPost

Sample Request

HTTP

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

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

Sample Response

Status code:

200

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

Definities

Name	Description
AnswerResult	Een antwoord is een tekstfragment dat is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de query. Antwoorden worden geëxtraheerd uit de bovenste zoekresultaten. Antwoordkandidaten worden beoordeeld en de belangrijkste antwoorden worden geselecteerd.
CaptionResult	Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.
DocumentDebugInfo	Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.
QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.
QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.
QueryDebugMode	Hiermee schakelt u een hulpprogramma voor foutopsporing in dat kan worden gebruikt om uw zoekresultaten verder te verkennen.
QueryLanguage	De taal van de query.
QueryResultDocumentRerankerInput	De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.
QueryResultDocumentSemanticField	Beschrijving van velden die zijn verzonden naar het semantische verrijkingsproces en hoe ze zijn gebruikt
QuerySpellerType	Een waarde die het type spellingcontrole aangeeft dat moet worden gebruikt om afzonderlijke zoekquerytermen te corrigeren.
QueryType	Hiermee geeft u de syntaxis van de zoekquery. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.
RawVectorQuery	De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde wordt opgegeven.
ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. De standaardwaarde is 'lokaal'. Gebruik 'globaal' om scorestatistieken globaal samen te voegen voordat ze worden scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.
SearchDocumentsResult	Antwoord met zoekresultaten uit een index.
SearchError	Beschrijft een foutvoorwaarde voor de API.
SearchMode	Hiermee geeft u op of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen.
SearchRequest	Parameters voor filteren, sorteren, faceting, paging en ander zoekquerygedrag.
SearchResult	Bevat een document dat is gevonden door een zoekquery, plus bijbehorende metagegevens.
SemanticDebugInfo
SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of om gedeeltelijke resultaten te retourneren (standaard).
SemanticErrorReason	Reden dat er een gedeeltelijke reactie is geretourneerd voor een semantische classificatieaanvraag.
SemanticFieldState	De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)
SemanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.
VectorFilterMode	Bepaalt of filters worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.
VectorizableTextQuery	De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.
VectorQueryKind	Het soort vectorquery dat wordt uitgevoerd.

AnswerResult

Een antwoord is een tekstfragment dat is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de query. Antwoorden worden geëxtraheerd uit de bovenste zoekresultaten. Antwoordkandidaten worden beoordeeld en de belangrijkste antwoorden worden geselecteerd.

Name	Type	Description
highlights	string	Dezelfde tekstpassage als in de eigenschap Text met gemarkeerde tekstzinnen die het meest relevant zijn voor de query.
key	string	De sleutel van het document waaruit het antwoord is geëxtraheerd.
score	number	De scorewaarde geeft aan hoe relevant het antwoord is voor de query ten opzichte van andere antwoorden die voor de query worden geretourneerd.
text	string	De tekst die als antwoord uit de inhoud van het document is geëxtraheerd.

CaptionResult

Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.

Name	Type	Description
highlights	string	Dezelfde tekstpassage als in de eigenschap Text met gemarkeerde woordgroepen die het meest relevant zijn voor de query.
text	string	Een representatieve tekstpassage die is geëxtraheerd uit het document dat het meest relevant is voor de zoekquery.

DocumentDebugInfo

Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.

Name	Type	Description
semantic	SemanticDebugInfo	Bevat informatie over foutopsporing die specifiek is voor semantische classificatieaanvragen.

QueryAnswerType

Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.

Name	Type	Description
extractive	string	Hiermee worden antwoordkandidaten geëxtraheerd uit de inhoud van de documenten die worden geretourneerd als antwoord op een query die wordt uitgedrukt als een vraag in natuurlijke taal.
none	string	Retourneert geen antwoorden voor de query.

QueryCaptionType

Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.

Name	Type	Description
extractive	string	Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekquery.
none	string	Retourneer geen bijschriften voor de query.

QueryDebugMode

Hiermee schakelt u een hulpprogramma voor foutopsporing in dat kan worden gebruikt om uw zoekresultaten verder te verkennen.

Name	Type	Description
disabled	string	Er worden geen foutopsporingsgegevens voor query's geretourneerd.
semantic	string	Hiermee kan de gebruiker de opnieuw gerankte resultaten verder verkennen.

QueryLanguage

De taal van de query.

Name	Type	Description
ar-eg	string	Querytaalwaarde voor Arabisch (Egypte).
ar-jo	string	Querytaalwaarde voor Arabisch (Jordanië).
ar-kw	string	Querytaalwaarde voor Arabisch (Koeweit).
ar-ma	string	Querytaalwaarde voor Arabisch (Marokko).
ar-sa	string	Querytaalwaarde voor Arabisch (Saoedi-Arabië).
bg-bg	string	Waarde van querytaal voor Bulgaars (Bulgarije).
bn-in	string	Querytaalwaarde voor Bengaals (India).
ca-es	string	Querytaalwaarde voor Catalaans.
cs-cz	string	Querytaalwaarde voor Tsjechisch (Tsjechië).
da-dk	string	Querytaalwaarde voor Deens (Denemarken).
de-de	string	Querytaalwaarde voor Duits (Duitsland).
el-gr	string	Querytaalwaarde voor Grieks (Griekenland).
en-au	string	Querytaalwaarde voor Engels (Australië).
en-ca	string	Querytaalwaarde voor Engels (Canada).
en-gb	string	Querytaalwaarde voor Engels (Groot-Brittannië).
en-in	string	Waarde van querytaal voor Engels (India).
en-us	string	Querytaalwaarde voor Engels (Verenigde Staten).
es-es	string	Querytaalwaarde voor Spaans (Spanje).
es-mx	string	Querytaalwaarde voor Spaans (Mexico).
et-ee	string	Querytaalwaarde voor Estisch (Estland).
eu-es	string	Querytaalwaarde voor Baskisch.
fa-ae	string	Querytaalwaarde voor Perzisch (U.A.E.).
fi-fi	string	Querytaalwaarde voor Fins (Finland).
fr-ca	string	Querytaalwaarde voor Frans (Canada).
fr-fr	string	Querytaalwaarde voor Frans (Frankrijk).
ga-ie	string	Waarde van querytaal voor Iers (Ierland).
gl-es	string	Querytaalwaarde voor Galicisch.
gu-in	string	Querytaalwaarde voor Gujarati (India).
he-il	string	Querytaalwaarde voor Hebreeuws (Israël).
hi-in	string	Querytaalwaarde voor Hindi (India).
hr-ba	string	Querytaalwaarde voor Kroatisch (Bosnië en Herzegovina).
hr-hr	string	Querytaalwaarde voor Kroatisch (Kroatië).
hu-hu	string	Waarde van querytaal voor Hongaars (Hongarije).
hy-am	string	Querytaalwaarde voor Armeens (Armenië).
id-id	string	Querytaalwaarde voor Indonesisch (Indonesië).
is-is	string	Querytaalwaarde voor IJslands (IJsland).
it-it	string	Querytaalwaarde voor Italiaans (Italië).
ja-jp	string	Waarde van querytaal voor Japans (Japan).
kn-in	string	Querytaalwaarde voor Kannada (India).
ko-kr	string	Waarde van querytaal voor Koreaans (Korea).
lt-lt	string	Querytaalwaarde voor Litouws (Litouwen).
lv-lv	string	Querytaalwaarde voor Lets (Letland).
ml-in	string	Querytaalwaarde voor Malayalam (India).
mr-in	string	Querytaalwaarde voor Marathi (India).
ms-bn	string	Querytaalwaarde voor Maleis (Brunei Darussalam).
ms-my	string	Querytaalwaarde voor Maleis (Maleisië).
nb-no	string	Querytaalwaarde voor Noors (Noorwegen).
nl-be	string	Querytaalwaarde voor Nederlands (België).
nl-nl	string	Querytaalwaarde voor Nederlands (Nederland).
no-no	string	Querytaalwaarde voor Noors (Noorwegen).
none	string	Querytaal niet opgegeven.
pa-in	string	Querytaalwaarde voor Punjabi (India).
pl-pl	string	Querytaalwaarde voor Pools (Polen).
pt-br	string	Querytaalwaarde voor Portugees (Brazilië).
pt-pt	string	Querytaalwaarde voor Portugees (Portugal).
ro-ro	string	Querytaalwaarde voor Roemeens (Roemenië).
ru-ru	string	Querytaalwaarde voor Russisch (Rusland).
sk-sk	string	Querytaalwaarde voor Slowaaks (Slowakije).
sl-sl	string	Querytaalwaarde voor Sloveens (Slovenië).
sr-ba	string	Querytaalwaarde voor Servisch (Bosnië en Herzegovina).
sr-me	string	Querytaalwaarde voor Servisch (Montenegro).
sr-rs	string	Querytaalwaarde voor Servisch (Servië).
sv-se	string	Querytaalwaarde voor Zweeds (Zweden).
ta-in	string	Querytaalwaarde voor Tamil (India).
te-in	string	Querytaalwaarde voor Telugu (India).
th-th	string	Querytaalwaarde voor Thai (Thailand).
tr-tr	string	Querytaalwaarde voor Turks (Turkije).
uk-ua	string	Querytaalwaarde voor Oekraïens (Oekraïne).
ur-pk	string	Querytaalwaarde voor Urdu (Pakistan).
vi-vn	string	Querytaalwaarde voor Vietnamees (Vietnamees).
zh-cn	string	Waarde van querytaal voor Chinees (China).
zh-tw	string	Waarde van querytaal voor Chinees (Taiwan).

QueryResultDocumentRerankerInput

De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.

Name	Type	Description
content	string	De onbewerkte samengevoegde tekenreeksen voor de inhoudsvelden die zijn gebruikt voor semantische verrijking.
keywords	string	De onbewerkte samengevoegde tekenreeksen voor de trefwoordvelden die zijn gebruikt voor semantische verrijking.
title	string	De onbewerkte tekenreeks voor het titelveld dat is gebruikt voor semantische verrijking.

QueryResultDocumentSemanticField

Beschrijving van velden die zijn verzonden naar het semantische verrijkingsproces en hoe ze zijn gebruikt

Name	Type	Description
name	string	De naam van het veld dat naar het semantische verrijkingsproces is verzonden
state	SemanticFieldState	De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)

QuerySpellerType

Een waarde die het type spellingcontrole aangeeft dat moet worden gebruikt om afzonderlijke zoekquerytermen te corrigeren.

Name	Type	Description
lexicon	string	De spellingfunctie corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven met de parameter queryLanguage.
none	string	Spellingcontrole is niet ingeschakeld.

QueryType

Hiermee geeft u de syntaxis van de zoekquery. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.

Name	Type	Description
full	string	Gebruikt de volledige Lucene-querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal die veldspecifieke en gewogen zoekopdrachten mogelijk maakt, evenals andere geavanceerde functies.
semantic	string	Het meest geschikt voor query's die worden uitgedrukt in natuurlijke taal in plaats van trefwoorden. Verbetert de nauwkeurigheid van zoekresultaten door de rangschikking van de belangrijkste zoekresultaten opnieuw te bepalen met behulp van een classificatiemodel dat is getraind op het webcorpus.
simple	string	Maakt gebruik van de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige querytaal die symbolen zoals +, * en '' toestaat. Query's worden standaard geëvalueerd in alle doorzoekbare velden, tenzij de parameter searchFields is opgegeven.

RawVectorQuery

De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde wordt opgegeven.

Name	Type	Description
exhaustive	boolean	Als dit waar is, wordt een volledige k-dichtstbijzijnde buur gezocht op alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten essentieel zijn, zoals het bepalen van grondwaarwaarden.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector.
k	integer	Het aantal dichtstbijzijnde buren dat als toptreffers moet worden geretourneerd.
kind	string: vector	Het type vectorquery dat wordt uitgevoerd.
vector	number[]	De vectorweergave van een zoekquery.

ScoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. De standaardwaarde is 'lokaal'. Gebruik 'globaal' om scorestatistieken globaal samen te voegen voordat ze worden scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.

Name	Type	Description
global	string	De scorestatistieken worden globaal berekend voor een consistentere score.
local	string	De scorestatistieken worden lokaal berekend voor een lagere latentie.

SearchDocumentsResult

Antwoord met zoekresultaten uit een index.

Name	Type	Description
@odata.count	integer	Het totale aantal resultaten dat door de zoekbewerking is gevonden, of null als het aantal niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in dit antwoord. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als de query niet alle aangevraagde documenten in één antwoord kan retourneren.
@odata.nextLink	string	Vervolg-URL die wordt geretourneerd wanneer de query niet alle aangevraagde resultaten in één antwoord kan retourneren. U kunt deze URL gebruiken om een andere GET- of POST-zoekopdracht te formuleren om het volgende deel van het zoekantwoord op te halen. Zorg ervoor dat u hetzelfde werkwoord (GET of POST) gebruikt als de aanvraag die dit antwoord heeft gegenereerd.
@search.answers	AnswerResult[]	De antwoorden op queryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of ingesteld op 'none'.
@search.coverage	number	Een waarde die het percentage van de index aangeeft dat is opgenomen in de query, of null als minimumCoverage niet is opgegeven in de aanvraag.
@search.facets	object	De resultaten van de facetquery voor de zoekbewerking, ingedeeld als een verzameling buckets voor elk facetveld; null als de query geen facetexpressies bevat.
@search.nextPageParameters	SearchRequest	Vervolg-JSON-nettolading die wordt geretourneerd wanneer de query niet alle aangevraagde resultaten in één antwoord kan retourneren. U kunt deze JSON samen met @odata.nextLink gebruiken om een andere POST Search-aanvraag te formuleren om het volgende deel van het zoekantwoord op te halen.
@search.semanticPartialResponseReason	SemanticErrorReason	Reden dat er een gedeeltelijke reactie is geretourneerd voor een semantische classificatieaanvraag.
@search.semanticPartialResponseType	SemanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.
value	SearchResult[]	De volgorde van de resultaten die door de query worden geretourneerd.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.

SearchMode

Hiermee geeft u op of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen.

Name	Type	Description
all	string	Alle zoektermen moeten worden vergeleken om het document als een overeenkomst te kunnen tellen.
any	string	Een van de zoektermen moet worden vergeleken om het document als een overeenkomst te kunnen tellen.

SearchRequest

Parameters voor filteren, sorteren, faceting, paging en ander zoekquerygedrag.

Name	Type	Description
answers	QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.
captions	QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.
count	boolean	Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardinstelling is onwaar. Het instellen van deze waarde op true kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.
debug	QueryDebugMode	Hiermee schakelt u een hulpprogramma voor foutopsporing in dat kan worden gebruikt om uw opnieuw gerankte resultaten verder te verkennen.
facets	string[]	De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.
filter	string	De OData-$filter expressie die moet worden toegepast op de zoekquery.
highlight	string	De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.
highlightPreTag	string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em>.
minimumCoverage	number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een zoekquery moet worden gedekt om de query als geslaagd te kunnen rapporteren. Deze parameter kan handig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.
orderby	string	De door komma's gescheiden lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Ties worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby-componenten zijn.
queryLanguage	QueryLanguage	Een waarde die de taal van de zoekquery aangeeft.
queryType	QueryType	Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis.
scoringParameters	string[]	De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met de parameter 'mylocation', is de parametertekenreeks 'mylocation-122.2,44.8' (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel voor het evalueren van matchscores voor overeenkomende documenten om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals de documentfrequentie) globaal willen berekenen voor een consistentere score of lokaal voor een lagere latentie. De standaardwaarde is 'lokaal'. Gebruik 'globaal' om scorestatistieken globaal te aggregeren voordat u scoret. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.
search	string	Een zoekquery-expressie in volledige tekst; Gebruik *of laat deze parameter weg om overeen te komen met alle documenten.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarop de volledige tekst moet worden gezocht. Wanneer u veldzoekopdrachten (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.
searchMode	SearchMode	Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als een overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, worden alle velden die zijn gemarkeerd als ophalen mogelijk in het schema opgenomen.
semanticConfiguration	string	De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch.
semanticErrorHandling	SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten moet retourneren (standaard).
semanticFields	string	De door komma's gescheiden lijst met veldnamen die worden gebruikt voor semantische rangschikking.
semanticMaxWaitInMilliseconds	integer	Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is voor semantische verrijking om de verwerking te voltooien voordat de aanvraag mislukt.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die alleen wordt gebruikt voor semantische herrankering, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin er verschillende query's moeten worden gebruikt tussen de basisfase voor ophalen en rangschikken en de semantische L2-fase.
sessionId	string	Een waarde die moet worden gebruikt om een plaksessie te maken, waarmee u consistentere resultaten kunt krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk opnieuw gebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen in verschillende replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, mag niet beginnen met een _-teken.
skip	integer	Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde moet scannen, maar vanwege deze beperking niet kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
speller	QuerySpellerType	Een waarde die het type spellingcontrole opgeeft dat moet worden gebruikt om afzonderlijke zoekquerytermen te spellen.
top	integer	Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te voeren voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd. De standaardwaarde is 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

SearchResult

Bevat een document dat is gevonden door een zoekquery, plus bijbehorende metagegevens.

Name	Type	Description
@search.captions	CaptionResult[]	Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.
@search.documentDebugInfo	DocumentDebugInfo[]	Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.
@search.highlights	object	Tekstfragmenten uit het document die de overeenkomende zoektermen aangeven, geordend op elk toepasselijk veld; null als het markeren van treffers niet is ingeschakeld voor de query.
@search.rerankerScore	number	De relevantiescore die wordt berekend door de semantische ranker voor de hoogste zoekresultaten. Zoekresultaten worden eerst gesorteerd op de RerankerScore en vervolgens op de Score. RerankerScore wordt alleen geretourneerd voor query's van het type 'semantisch'.
@search.score	number	De relevantiescore van het document vergeleken met andere documenten die door de query worden geretourneerd.

SemanticDebugInfo

Name	Type	Description
contentFields	QueryResultDocumentSemanticField[]	De inhoudsvelden die naar het semantische verrijkingsproces zijn verzonden en hoe ze zijn gebruikt
keywordFields	QueryResultDocumentSemanticField[]	De trefwoordvelden die naar het semantische verrijkingsproces zijn verzonden en hoe ze zijn gebruikt
rerankerInput	QueryResultDocumentRerankerInput	De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.
titleField	QueryResultDocumentSemanticField	Het titelveld dat naar het semantische verrijkingsproces is verzonden en hoe het is gebruikt

SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of om gedeeltelijke resultaten te retourneren (standaard).

Name	Type	Description
fail	string	Als er een uitzondering optreedt tijdens de semantische verwerkingsstap, mislukt de query en retourneert de juiste HTTP-code, afhankelijk van de fout.
partial	string	Als de semantische verwerking mislukt, worden er nog steeds gedeeltelijke resultaten geretourneerd. De definitie van gedeeltelijke resultaten is afhankelijk van welke semantische stap is mislukt en wat de reden voor de fout was.

SemanticErrorReason

Reden dat er een gedeeltelijke reactie is geretourneerd voor een semantische classificatieaanvraag.

Name	Type	Description
capacityOverloaded	string	De aanvraag is beperkt. Alleen de basisresultaten zijn geretourneerd.
maxWaitExceeded	string	Als 'semanticMaxWaitInMilliseconds' is ingesteld en de duur van de semantische verwerking die waarde heeft overschreden. Alleen de basisresultaten zijn geretourneerd.
transient	string	Ten minste één stap van het semantische proces is mislukt.

SemanticFieldState

De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)

Name	Type	Description
partial	string	Het veld is gedeeltelijk gebruikt voor semantische verrijking.
unused	string	Het veld is niet gebruikt voor semantische verrijking.
used	string	Het veld is volledig gebruikt voor semantische verrijking.

SemanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.

Name	Type	Description
baseResults	string	Resultaten zonder semantische verrijking of herrankering.
rerankedResults	string	De resultaten zijn opnieuw gekoppeld aan het rerankermodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, antwoordpunten of onderschrift hoogtepunten.

VectorFilterMode

Bepaalt of filters worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.

Name	Type	Description
postFilter	string	Het filter wordt toegepast nadat de kandidaatset met vectorresultaten is geretourneerd. Afhankelijk van de filterselectiviteit kan dit resulteren in minder resultaten dan wordt aangevraagd door de parameter 'k'.
preFilter	string	Het filter wordt toegepast vóór de zoekquery.

VectorizableTextQuery

De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

Name	Type	Description
exhaustive	boolean	Als dit waar is, wordt een volledige k-dichtstbijzijnde buur gezocht op alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten essentieel zijn, zoals het bepalen van grondwaarwaarden.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector.
k	integer	Het aantal dichtstbijzijnde buren dat als toptreffers moet worden geretourneerd.
kind	string: text	Het type vectorquery dat wordt uitgevoerd.
text	string	De tekst die moet worden gevectoriseerd om een vectorzoekquery uit te voeren.

VectorQueryKind

Het soort vectorquery dat wordt uitgevoerd.

Name	Type	Description
text	string	Vectorquery waarbij een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.
vector	string	Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven.