Documents - Search Post

Service:

Search Service

API Version:

2023-11-01

Hiermee zoekt u naar documenten in de index.

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

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 wordt 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.
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.
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 (standaard/huidig gedrag) of om gedeeltelijke resultaten te retourneren.
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.
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 opeenvolgend moet scannen, maar vanwege deze beperking geen overslaan kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
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' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[]	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

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Sample Request

HTTP

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

{
  "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,category,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-11-01"
}

SearchIndexSearchDocumentsSemanticPost

Sample Request

HTTP

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

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Sample Response

Status code:

200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "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"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}

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 semantic.
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.
QueryType	Hiermee geeft u de syntaxis van de zoekquery. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis.
RawVectorQuery	De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten 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 te aggregeren voordat u scoret. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.
SearchDocumentsResult	Antwoord met zoekresultaten van 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.
SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard/huidig gedrag) of gedeeltelijke resultaten moet retourneren.
SemanticErrorReason	Reden dat er een gedeeltelijke reactie is geretourneerd voor een semantische classificatieaanvraag.
SemanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.
VectorFilterMode	Bepaalt of filters worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.
VectorQueryKind	Het type 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 semantic.

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.

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.

QueryType

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

Name	Type	Description
full	string	Gebruikt de volledige Lucene-querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal waarmee veldspecifieke en gewogen zoekopdrachten mogelijk zijn, 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 hoogste zoekresultaten opnieuw te rangschikten 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 vectorzoekopdrachten wanneer een onbewerkte vectorwaarde wordt opgegeven.

Name	Type	Description
exhaustive	boolean	Als dit waar is, wordt een uitgebreide k-dichtstbijzijnde burenzoekopdracht geactiveerd voor 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 belangrijkste treffers moet worden geretourneerd.
kind	string: vector	Het soort 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 te aggregeren voordat u scoret. 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 van een index.

Name	Type	Description
@odata.count	integer	Het totale aantal resultaten dat is gevonden door de zoekbewerking, 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 te krijgen. Zorg ervoor dat u hetzelfde werkwoord (GET of POST) gebruikt als de aanvraag die dit antwoord heeft gegenereerd.
@search.answers	AnswerResult[]	De antwoordenqueryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of is 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 te krijgen.
@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 overeenkomen 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.
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.
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 het bereik van de zoekopdracht in volledige tekst moet worden bereikt. 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 meer zoektermen moeten worden vergeleken om het document als een overeenkomst te kunnen tellen.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Als u dit niet hebt opgegeven, worden alle velden die zijn gemarkeerd als ophaalbaar 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 (standaard/huidig gedrag) of om gedeeltelijke resultaten te retourneren.
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.
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 opeenvolgend moet scannen, maar vanwege deze beperking geen overslaan kunt gebruiken, kunt u overwegen om orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
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' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[]	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 semantic.
@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 semantic.
@search.score	number	De relevantiescore van het document vergeleken met andere documenten die door de query worden geretourneerd.

SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard/huidig gedrag) of gedeeltelijke resultaten moet retourneren.

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 gedeeltelijke resultaten nog steeds 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.

SemanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.

Name	Type	Description
baseResults	string	Resultaten zonder semantische verrijking of herrankering.
rerankedResults	string	Resultaten zijn opnieuw gerankt met het rerankermodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, antwoordpunten of onderschrift highlights.

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

VectorQueryKind

Het type vectorquery dat wordt uitgevoerd.

Name	Type	Description
vector	string	Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven.