Documents - Search Post

Referentie

Service:: Search Service

API-versie:: 2024-07-01

Zoekt naar documenten in de index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-07-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 is verzonden met de aanvraag om hulp te bieden 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 standaardwaarde 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 markeringen van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd om markeringen te raken. 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 moet worden gedekt door een zoekquery, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, 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 moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 notatienaamwaarden. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', is de parametertekenreeks 'mylocation--122.2,44.8' (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel om overeenkomende scores voor overeenkomende documenten te evalueren om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u 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 aan alle documenten te voldoen.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarop de zoekopdracht in volledige tekst moet worden afgestemd. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke in een veld geplaatste zoekexpressie 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 overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Indien niet opgegeven, worden alle velden opgenomen die zijn gemarkeerd als ophaalbaar in het schema.
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 gedeeltelijke resultaten moet 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.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische rerankering, semantische bijschriften en semantische antwoorden. Dit is handig voor scenario's waarbij er verschillende query's moeten worden gebruikt tussen de fase basis 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 hergebruiken 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 als sessionId wordt gebruikt, 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 wilt scannen, maar deze beperking niet kunt gebruiken, kunt u in plaats daarvan orderby gebruiken op een volledig geordende sleutel en 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 geven voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd. De standaardwaarde is 'preFilter' voor nieuwe indexen.
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	ErrorResponse	Foutreactie.

Voorbeelden

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Voorbeeldaanvraag

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-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,
      "oversampling": 20,
      "weight": 2
    }
  ],
  "vectorFilterMode": "preFilter"
}

Voorbeeldrespons

Statuscode:: 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=2024-07-01"
}

SearchIndexSearchDocumentsSemanticPost

Voorbeeldaanvraag

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-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
}

Voorbeeldrespons

Statuscode:: 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=2024-07-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 relatief ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type `semantic`.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
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 documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.
SearchDocumentsResult	Antwoord met zoekresultaten van een index.
SearchMode	Hiermee geeft u op of een of alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.
SearchRequest	Parameters voor filteren, sorteren, facet, paging en ander gedrag van zoekquery's.
SearchResult	Bevat een document dat is gevonden door een zoekquery, plus de 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 een gedeeltelijk antwoord is geretourneerd voor een semantische classificatieaanvraag.
SemanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.
VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.
VectorizableTextQuery	De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.
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	Hetzelfde tekstgedeelte als in de eigenschap Tekst met gemarkeerde teksttermen 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	Het tekstfragment dat uit de inhoud van het document is geëxtraheerd als antwoord.

CaptionResult

Bijschriften zijn de meest representatieve passages uit het document relatief 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	Hetzelfde tekstgedeelte als in de eigenschap Tekst met gemarkeerde woordgroepen die het meest relevant zijn voor de query.
text	string	Een representatieve tekstfragment dat is geëxtraheerd uit het document dat het meest relevant is voor de zoekquery.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

QueryAnswerType

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

Name	Type	Description
extractive	string	Extraheert antwoordkandidaten uit de inhoud van de documenten die worden geretourneerd als reactie 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, evenals andere geavanceerde functies mogelijk zijn.
semantic	string	Het meest geschikt voor query's die in natuurlijke taal worden uitgedrukt in plaats van trefwoorden. Verbetert de nauwkeurigheid van zoekresultaten door de bovenste zoekresultaten opnieuw te rangschikken met behulp van een classificatiemodel dat is getraind op het web-corpus.
simple	string	Gebruikt de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige querytaal waarmee symbolen zoals +, * en '' kunnen worden gebruikt. 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	Wanneer waar, activeert u een uitgebreide k-dichtstbijzijnde buurzoekopdracht voor alle vectoren binnen de vectorindex. Handig voor scenario's waarbij exacte overeenkomsten essentieel zijn, zoals het bepalen van waarden voor de grondwaarheid.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de vector die wordt doorzocht.
k	integer	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: vector	Het type vectorquery dat wordt uitgevoerd.
oversampling	number	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
vector	number[]	De vectorweergave van een zoekquery.
weight	number	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

ScoringStatistics

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

Name	Type	Description
global	string	De scorestatistieken worden globaal berekend voor consistentere scores.
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 geretourneerd wanneer de query niet alle aangevraagde resultaten in één antwoord kan retourneren. U kunt deze URL gebruiken om een andere GET- of POST-zoekaanvraag 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 geproduceerd.
@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 aangeeft van de index die is opgenomen in de query of null als minimumCoverage niet is opgegeven in de aanvraag.
@search.facets	object	De facetqueryresultaten voor de zoekbewerking, geordend als een verzameling buckets voor elk facetveld; null als de query geen facetexpressies bevat.
@search.nextPageParameters	SearchRequest	Vervolg-JSON-nettolading 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-zoekaanvraag te formuleren om het volgende deel van het zoekantwoord op te halen.
@search.semanticPartialResponseReason	SemanticErrorReason	Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische classificatieaanvraag.
@search.semanticPartialResponseType	SemanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.
value	SearchResult[]	De reeks resultaten die door de query worden geretourneerd.

SearchMode

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

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

SearchRequest

Parameters voor filteren, sorteren, facet, paging en ander gedrag van zoekquery's.

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 standaardwaarde 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 markeringen van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd om markeringen te raken. 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 moet worden gedekt door een zoekquery, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, 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 moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 notatienaamwaarden. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', is de parametertekenreeks 'mylocation--122.2,44.8' (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel om overeenkomende scores voor overeenkomende documenten te evalueren om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u 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 aan alle documenten te voldoen.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarop de zoekopdracht in volledige tekst moet worden afgestemd. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke in een veld geplaatste zoekexpressie 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 overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Indien niet opgegeven, worden alle velden opgenomen die zijn gemarkeerd als ophaalbaar in het schema.
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 gedeeltelijke resultaten moet 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.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische rerankering, semantische bijschriften en semantische antwoorden. Dit is handig voor scenario's waarbij er verschillende query's moeten worden gebruikt tussen de fase basis 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 hergebruiken 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 als sessionId wordt gebruikt, 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 wilt scannen, maar deze beperking niet kunt gebruiken, kunt u in plaats daarvan orderby gebruiken op een volledig geordende sleutel en 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 geven voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd. De standaardwaarde is 'preFilter' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

SearchResult

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

Name	Type	Description
@search.captions	CaptionResult[]	Bijschriften zijn de meest representatieve passages uit het document relatief ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.
@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 berekend door de semantische rangschikking voor de bovenste 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.

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 is tijdens de semantische verwerkingsstap, mislukt de query en retourneert de juiste HTTP-code, afhankelijk van de fout.
partial	string	Als de semantische verwerking mislukt, retourneren gedeeltelijke resultaten nog steeds. De definitie van gedeeltelijke resultaten is afhankelijk van welke semantische stap is mislukt en wat de reden voor de fout was.

SemanticErrorReason

Reden dat een gedeeltelijk antwoord 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	De resultaten zijn gererankeerd met het rerankermodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, antwoorden met markeringen of bijschriften.

VectorFilterMode

Bepaalt of filters al dan niet 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 is aangevraagd door de parameter k.
preFilter	string	Het filter wordt toegepast vóór de zoekquery.

VectorizableTextQuery

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

Name	Type	Description
exhaustive	boolean	Wanneer waar, activeert u een uitgebreide k-dichtstbijzijnde buurzoekopdracht voor alle vectoren binnen de vectorindex. Handig voor scenario's waarbij exacte overeenkomsten essentieel zijn, zoals het bepalen van waarden voor de grondwaarheid.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de vector die wordt doorzocht.
k	integer	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: text	Het type vectorquery dat wordt uitgevoerd.
oversampling	number	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
text	string	De tekst die moet worden gevectoriseerd om een vectorzoekquery uit te voeren.
weight	number	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

VectorQueryKind

Het type vectorquery dat wordt uitgevoerd.

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

Delen via

Documents - Search Post

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Voorbeelden

SearchIndexSearchDocumentsPost

Voorbeeldaanvraag

Voorbeeldrespons

SearchIndexSearchDocumentsSemanticPost

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Aanvullende resources