Documents - Search Get
Zoekt naar documenten in de index.
GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-01-preview
GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2025-08-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
De eindpunt-URL van de zoekservice. |
|
index
|
path | True |
string |
De naam van de index. |
|
api-version
|
query | True |
string |
Client-API-versie. |
|
$count
|
query |
boolean |
Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is vals. Als u deze waarde instelt op waar, kan dit gevolgen hebben voor de prestaties. Merk op dat de geretourneerde telling een benadering is. |
|
|
$filter
|
query |
string |
De OData $filter expressie die op de zoekquery moet worden toegepast. |
|
|
$orderby
|
query |
string[] |
De 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 uitdrukking kan worden gevolgd door asc om oplopend aan te geven, en desc om aflopend aan te geven. De standaardinstelling is oplopende volgorde. Gelijkspel wordt verbroken door de wedstrijdscores van documenten. Als er geen OrderBy is opgegeven, is de standaard sorteervolgorde aflopend op documentovereenkomstscore. Er kunnen maximaal 32 $orderby clausules zijn. |
|
|
$select
|
query |
string[] |
De lijst met velden die u wilt ophalen. Als dit niet is opgegeven, worden alle velden opgenomen die in het schema zijn gemarkeerd als opvraagbaar. |
|
|
$skip
|
query |
integer (int32) |
Het aantal zoekresultaten dat u moet overslaan. Deze waarde mag niet groter zijn dan 100.000. Als u documenten in volgorde moet scannen, maar vanwege deze beperking geen $skip kunt gebruiken, kunt u overwegen $orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te $filter met een bereikquery. |
|
|
$top
|
query |
integer (int32) |
Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paginering van zoekresultaten aan de clientzijde te implementeren. Als de resultaten worden afgekapt als gevolg van pagerijdbaarheid aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een nieuwe zoekopdracht uit te geven voor de volgende pagina met resultaten. |
|
|
answers
|
query |
Deze parameter is alleen geldig als het querytype . |
||
|
captions
|
query |
Deze parameter is alleen geldig als het querytype . |
||
|
debug
|
query |
Schakelt een foutopsporingstool in die kan worden gebruikt om uw zoekresultaten verder te verkennen. |
||
|
facet
|
query |
string[] |
De lijst met facetexpressies die op de zoekopdracht moeten worden toegepast. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met name:value-paren. |
|
|
highlight
|
query |
string[] |
De lijst met veldnamen die u moet gebruiken voor hoogtepunten van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers. |
|
|
highlight
|
query |
string |
Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. De standaardinstelling is </em>. |
|
|
highlight
|
query |
string |
Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Standaard is <em>. |
|
|
minimum
|
query |
number (double) |
Een getal tussen 0 en 100 geeft het percentage van de index aan dat door een zoekopdracht moet worden gedekt om de zoekopdracht als succesvol 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. |
|
|
query
|
query |
De taal van de zoekopdracht. |
||
|
query
|
query |
Wanneer QueryRewrites is ingesteld op |
||
|
query
|
query |
Een waarde die de syntaxis van de zoekopdracht aangeeft. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis. |
||
|
scoring
|
query |
string[] |
De lijst met parameterwaarden die moeten worden gebruikt in scoringsfuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', zou de parametertekenreeks "mylocation--122.2,44.8" zijn (zonder de aanhalingstekens). |
|
|
scoring
|
query |
string |
De naam van een scoreprofiel om overeenkomstscores voor overeenkomende documenten te evalueren om de resultaten te sorteren. |
|
|
scoring
|
query |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. |
||
|
search
|
query |
string |
Een expressie voor een zoekopdracht in volledige tekst; Gebruik "*" of laat deze parameter weg om alle documenten te matchen. |
|
|
search
|
query |
string[] |
De lijst met veldnamen waarop u de volledige tekst wilt doorzoeken. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op de veldnamen die in deze parameter worden vermeld. |
|
|
search
|
query |
Een waarde die aangeeft of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen. |
||
|
semantic
|
query |
string |
De naam van de semantische configuratie die aangeeft welke velden moeten worden gebruikt voor semantische rangschikking, bijschriften, markeringen en antwoorden |
|
|
semantic
|
query |
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of dat gedeeltelijke resultaten moeten worden geretourneerd (standaard). |
||
|
semantic
|
query |
string[] |
De lijst met veldnamen die worden gebruikt voor semantische rangschikking. |
|
|
semantic
|
query |
integer (int32) minimum: 700 |
Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is om de semantische verrijking te verwerken voordat de aanvraag mislukt. |
|
|
semantic
|
query |
string |
Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische herrangschikking, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin het nodig is om verschillende query's te gebruiken tussen de fase voor het ophalen en rangschikken van de basis en de semantische fase van L2. |
|
|
session
|
query |
string |
Een waarde die kan worden gebruikt om een sticky sessie te maken, wat kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Houd er rekening mee dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen op 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. |
|
|
speller
|
query |
Verbeter het herinneren van zoekopdrachten door de spelling van afzonderlijke zoektermen te corrigeren. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen. |
|
| x-ms-query-source-authorization |
string |
Token dat de gebruiker identificeert waarvoor de query wordt uitgevoerd. Dit token wordt gebruikt om beveiligingsbeperkingen op documenten af te dwingen. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
Reactie met documenten die voldoen aan de zoekcriteria. |
|
| Other Status Codes |
Antwoord met gedeeltelijke documenten die voldoen aan de zoekcriteria. |
|
| Other Status Codes |
Foutreactie. |
Voorbeelden
|
Search |
|
Search |
SearchIndexSearchDocumentsGet
Voorbeeldaanvraag
GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2025-08-01-preview&speller={speller}
Voorbeeldrespons
{
"@odata.count": 25,
"@search.coverage": 80,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"value": [
{
"@search.score": 1.5,
"@search.highlights": {
"title": [
"<em>Nice</em> <em>Hotel</em>"
]
},
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.score": 0.7,
"@search.highlights": {
"title": [
"Fancy <em>Hotel</em>"
]
},
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
]
}
{
"@odata.count": 25,
"@search.coverage": 80,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"value": [
{
"@search.score": 1.5,
"@search.highlights": {
"title": [
"<em>Nice</em> <em>Hotel</em>"
]
},
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.score": 0.7,
"@search.highlights": {
"title": [
"Fancy <em>Hotel</em>"
]
},
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
]
}
SearchIndexSearchDocumentsSemanticGet
Voorbeeldaanvraag
GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-08-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}
Voorbeeldrespons
{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).",
"highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).",
"score": 0.94639826
}
],
"value": [
{
"@search.score": 0.5479723,
"@search.rerankerScore": 1.0321671911515296,
"@search.captions": [
{
"text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
"highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
]
}
{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).",
"highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).",
"score": 0.94639826
}
],
"value": [
{
"@search.score": 0.5479723,
"@search.rerankerScore": 1.0321671911515296,
"@search.captions": [
{
"text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
"highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
]
}
Definities
| Name | Description |
|---|---|
|
Answer |
Een antwoord is een tekstpassage die is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de zoekopdracht. Antwoorden worden geëxtraheerd uit de beste zoekresultaten. Antwoordkandidaten worden gescoord en de beste antwoorden worden geselecteerd. |
|
Caption |
Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type |
|
Debug |
Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen. |
|
Document |
Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
Hybrid |
Hiermee bepaalt u of het aantal en de facetten alle documenten moeten omvatten die overeenkomen met de zoekopdracht, of alleen de documenten die worden opgehaald in het venster 'maxTextRecallSize'. De standaardwaarde is 'countAllResults'. |
|
Hybrid |
De queryparameters om hybride zoekgedrag te configureren. |
|
Query |
Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht. |
|
Query |
Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht. |
|
Query |
Schakelt een foutopsporingstool in die kan worden gebruikt om uw zoekresultaten verder te verkennen. U kunt meerdere foutopsporingsmodi tegelijk inschakelen door ze te scheiden met een | teken, bijvoorbeeld: semantisch|queryHerschrijft. |
|
Query |
De taal van de zoekopdracht. |
|
Query |
De ruwe aaneengeschakelde tekenreeksen die naar het semantische verrijkingsproces zijn gestuurd. |
|
Query |
Beschrijving van velden die naar het semantische verrijkingsproces zijn gestuurd, en hoe ze zijn gebruikt |
|
Query |
De uitsplitsing van subscores tussen de tekst- en vectorquerycomponenten van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde waarin ze zijn ontvangen. |
|
Query |
Bevat foutopsporingsinformatie die specifiek is voor het herschrijven van query's. |
|
Query |
Een waarde die aangeeft of het herschrijven van query's moet worden gegenereerd om de zoekquery te vergroten. |
|
Query |
Bevat foutopsporingsinformatie die specifiek is voor het herschrijven van query's. |
|
Query |
Een waarde die het type speller opgeeft dat moet worden gebruikt om de spelling van afzonderlijke zoektermen te corrigeren. |
|
Query |
Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is. |
|
Raw |
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde is opgegeven. |
|
Scoring |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen. |
|
Search |
Reactie met zoekresultaten uit een index. |
|
Search |
Hiermee geeft u aan of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen. |
|
Search |
Parameters voor filteren, sorteren, facetteren, pagineren en ander zoekquerygedrag. |
|
Search |
Bevat een document dat is gevonden door een zoekopdracht, plus bijbehorende metagegevens. |
|
Search |
De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Houd er rekening mee dat dit het @search.score resultaat is dat wordt geretourneerd als onderdeel van het zoekantwoord. De drempelrichting wordt gekozen voor hoger @search.score. |
|
Semantic |
|
|
Semantic |
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren. |
|
Semantic |
Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
Semantic |
De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt) |
|
Semantic |
Type query herschrijven dat voor deze aanvraag is gebruikt. |
|
Semantic |
Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
Single |
Een enkel vectorveldresultaat. Zowel als @search.score vectorgelijkeniswaarden worden geretourneerd. Vectorgelijkenis is gerelateerd aan @search.score door een vergelijking. |
|
Text |
De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht. |
|
Vector |
Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een binair bestand met basis 64 van een afbeelding die moet worden gevectoriseerd, wordt verstrekt. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een url wordt opgegeven die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd. |
|
Vector |
Het soort vectorquery dat wordt uitgevoerd. |
|
Vectors |
|
|
Vector |
De resultaten van de vectorquery worden gefilterd op basis van de vectorgelijkenismetriek. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. De drempelrichting (groter of kleiner) wordt automatisch gekozen op basis van de metriek die door het veld wordt gebruikt. |
|
Vector |
Het soort vectorquery dat wordt uitgevoerd. |
AnswerResult
Een antwoord is een tekstpassage die is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de zoekopdracht. Antwoorden worden geëxtraheerd uit de beste zoekresultaten. Antwoordkandidaten worden gescoord en de beste antwoorden worden geselecteerd.
| Name | Type | Description |
|---|---|---|
| highlights |
string |
Dezelfde tekstpassage als in de eigenschap Tekst 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 (double) |
De scorewaarde geeft aan hoe relevant het antwoord is voor de query in vergelijking met andere antwoorden die voor de query zijn geretourneerd. |
| text |
string |
De tekstpassage die uit het document is geëxtraheerd, is het antwoord waard. |
CaptionResult
Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. 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 Tekst met gemarkeerde zinnen die het meest relevant zijn voor de query. |
| text |
string |
Een representatieve tekstpassage uit het document dat het meest relevant is voor de zoekopdracht. |
DebugInfo
Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen.
| Name | Type | Description |
|---|---|---|
| queryRewrites |
Bevat foutopsporingsinformatie die specifiek is voor het herschrijven van query's. |
DocumentDebugInfo
Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen.
| Name | Type | Description |
|---|---|---|
| innerHits |
object |
Bevat foutopsporingsinformatie die specifiek is voor vectoren die overeenkomen binnen een verzameling complexe typen. |
| semantic |
Bevat foutopsporingsinformatie die specifiek is voor semantische rangschikkingsverzoeken. |
|
| vectors |
Bevat foutopsporingsinformatie die specifiek is voor vector- en hybride zoekopdrachten. |
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 |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
HybridCountAndFacetMode
Hiermee bepaalt u of het aantal en de facetten alle documenten moeten omvatten die overeenkomen met de zoekopdracht, of alleen de documenten die worden opgehaald in het venster 'maxTextRecallSize'. De standaardwaarde is 'countAllResults'.
| Waarde | Description |
|---|---|
| countRetrievableResults |
Neem alleen documenten op die zijn gematcht in het zoekvenster 'maxTextRecallSize' bij het berekenen van 'aantal' en 'facetten'. |
| countAllResults |
Neem alle documenten op die zijn gematcht door de zoekopdracht bij het berekenen van 'aantal' en 'facetten', ongeacht of die documenten zich binnen het ophaalvenster 'maxTextRecallSize' bevinden. |
HybridSearch
De queryparameters om hybride zoekgedrag te configureren.
| Name | Type | Description |
|---|---|---|
| countAndFacetMode |
Hiermee bepaalt u of het aantal en de facetten alle documenten moeten omvatten die overeenkomen met de zoekopdracht, of alleen de documenten die worden opgehaald in het venster 'maxTextRecallSize'. |
|
| maxTextRecallSize |
integer (int32) |
Bepaalt het maximale aantal documenten dat moet worden opgehaald door het tekstquerygedeelte van een hybride zoekopdracht. Die documenten worden gecombineerd met de documenten die overeenkomen met de vectorquery's om één definitieve lijst van resultaten te produceren. Als u een grotere maxTextRecallSize-waarde kiest, kunt u meer documenten ophalen en doorzoeken (met behulp van de parameters boven en overslaan), ten koste van een hoger resourcegebruik en een hogere latentie. De waarde moet tussen de 1 en 10.000 liggen. De standaardwaarde is 1000. |
QueryAnswerType
Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht.
| Waarde | Description |
|---|---|
| none |
Geef geen antwoorden op de zoekopdracht. |
| extractive |
Extraheert antwoorden van kandidaten uit de inhoud van de documenten die worden geretourneerd in antwoord op een vraag die als een vraag in natuurlijke taal is uitgedrukt. |
QueryCaptionType
Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht.
| Waarde | Description |
|---|---|
| none |
Retourneer geen ondertiteling voor de zoekopdracht. |
| extractive |
Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekopdracht. |
QueryDebugMode
Schakelt een foutopsporingstool in die kan worden gebruikt om uw zoekresultaten verder te verkennen. U kunt meerdere foutopsporingsmodi tegelijk inschakelen door ze te scheiden met een | teken, bijvoorbeeld: semantisch|queryHerschrijft.
| Waarde | Description |
|---|---|
| disabled |
Er wordt geen informatie over het opsporen van query's geretourneerd. |
| semantic |
Hiermee kan de gebruiker zijn opnieuw gerangschikte resultaten verder verkennen. |
| vector |
Hiermee kan de gebruiker de resultaten van hybride en vectorquery's verder verkennen. |
| queryRewrites |
Hiermee kan de gebruiker de lijst met herschrijvingen van query's verkennen die zijn gegenereerd voor hun zoekopdracht. |
| innerHits |
Hiermee kan de gebruiker score-informatie ophalen met betrekking tot vectoren die overeenkomen binnen een verzameling complexe typen. |
| all |
Schakel alle foutopsporingsopties in. |
QueryLanguage
De taal van de zoekopdracht.
| Waarde | Description |
|---|---|
| none |
Querytaal niet opgegeven. |
| en-us |
Query taalwaarde voor Engels (Verenigde Staten). |
| en-gb |
Query taalwaarde voor Engels (Groot-Brittannië). |
| en-in |
Query taalwaarde voor Engels (India). |
| en-ca |
Query taalwaarde voor Engels (Canada). |
| en-au |
Query taalwaarde voor Engels (Australië). |
| fr-fr |
Query taalwaarde voor Frans (Frankrijk). |
| fr-ca |
Query taalwaarde voor Frans (Canada). |
| de-de |
Query taalwaarde voor Duits (Duitsland). |
| es-es |
Query taalwaarde voor Spaans (Spanje). |
| es-mx |
Query taalwaarde voor Spaans (Mexico). |
| zh-cn |
Query taalwaarde voor Chinees (China). |
| zh-tw |
Query taalwaarde voor Chinees (Taiwan). |
| pt-br |
Query taalwaarde voor Portugees (Brazilië). |
| pt-pt |
Query taalwaarde voor Portugees (Portugal). |
| it-it |
Query taalwaarde voor Italiaans (Italië). |
| ja-jp |
Query taalwaarde voor Japans (Japan). |
| ko-kr |
Query taalwaarde voor Koreaans (Korea). |
| ru-ru |
Query taalwaarde voor Russisch (Rusland). |
| cs-cz |
Query taalwaarde voor Tsjechisch (Tsjechië). |
| nl-be |
Query taal waarde voor Nederlands (België). |
| nl-nl |
Query taalwaarde voor Nederlands (Nederland). |
| hu-hu |
Query taalwaarde voor Hongaars (Hongarije). |
| pl-pl |
Query taalwaarde voor Pools (Polen). |
| sv-se |
Query taalwaarde voor Zweeds (Zweden). |
| tr-tr |
Query taalwaarde voor Turks (Turkije). |
| hi-in |
Query taalwaarde voor Hindi (India). |
| ar-sa |
Query taalwaarde voor Arabisch (Saoedi-Arabië). |
| ar-eg |
Query taalwaarde voor Arabisch (Egypte). |
| ar-ma |
Query taalwaarde voor Arabisch (Marokko). |
| ar-kw |
Query taalwaarde voor Arabisch (Koeweit). |
| ar-jo |
Query taalwaarde voor Arabisch (Jordanië). |
| da-dk |
Query taalwaarde voor Deens (Denemarken). |
| no-no |
Query taalwaarde voor Noors (Noorwegen). |
| bg-bg |
Query taalwaarde voor Bulgaars (Bulgarije). |
| hr-hr |
Query taalwaarde voor Kroatisch (Kroatië). |
| hr-ba |
Query taalwaarde voor Kroatisch (Bosnië en Herzegovina). |
| ms-my |
Query taalwaarde voor Maleis (Maleisië). |
| ms-bn |
Query taalwaarde voor Maleis (Brunei Darussalam). |
| sl-sl |
Query taalwaarde voor Sloveens (Slovenië). |
| ta-in |
Query taalwaarde voor Tamil (India). |
| vi-vn |
Query taalwaarde voor Vietnamees (Vietnam). |
| el-gr |
Query taalwaarde voor Grieks (Griekenland). |
| ro-ro |
Query taalwaarde voor Roemeens (Roemenië). |
| is-is |
Query taalwaarde voor IJslands (IJsland). |
| id-id |
Query taalwaarde voor Indonesisch (Indonesië). |
| th-th |
Query taalwaarde voor Thais (Thailand). |
| lt-lt |
Query taalwaarde voor Litouws (Litouwen). |
| uk-ua |
Query taalwaarde voor Oekraïens (Oekraïne). |
| lv-lv |
Query taalwaarde voor Lets (Letland). |
| et-ee |
Query taalwaarde voor Ests (Estland). |
| ca-es |
Query taalwaarde voor Catalaans. |
| fi-fi |
Query taalwaarde voor Fins (Finland). |
| sr-ba |
Query taalwaarde voor Servisch (Bosnië en Herzegovina). |
| sr-me |
Query taalwaarde voor Servisch (Montenegro). |
| sr-rs |
Query taalwaarde voor Servisch (Servië). |
| sk-sk |
Query taalwaarde voor Slowaaks (Slowakije). |
| nb-no |
Query taalwaarde voor Noors (Noorwegen). |
| hy-am |
Query taalwaarde voor Armeens (Armenië). |
| bn-in |
Query taalwaarde voor Bengaals (India). |
| eu-es |
Query taalwaarde voor Baskisch. |
| gl-es |
Query taalwaarde voor Galicisch. |
| gu-in |
Query taalwaarde voor Gujarati (India). |
| he-il |
Query taalwaarde voor Hebreeuws (Israël). |
| ga-ie |
Query taalwaarde voor Iers (Ierland). |
| kn-in |
Query taalwaarde voor Kannada (India). |
| ml-in |
Query taalwaarde voor Malayalam (India). |
| mr-in |
Query taalwaarde voor Marathi (India). |
| fa-ae |
Query taalwaarde voor Perzisch (V.A.E.). |
| pa-in |
Query taalwaarde voor Punjabi (India). |
| te-in |
Query taalwaarde voor Telugu (India). |
| ur-pk |
Query taalwaarde voor Urdu (Pakistan). |
QueryResultDocumentRerankerInput
De ruwe aaneengeschakelde tekenreeksen die naar het semantische verrijkingsproces zijn gestuurd.
| Name | Type | Description |
|---|---|---|
| content |
string |
De onbewerkte aaneengeschakelde tekenreeksen voor de inhoudsvelden die zijn gebruikt voor semantische verrijking. |
| keywords |
string |
De onbewerkte aaneengeschakelde tekenreeksen voor de trefwoordvelden die zijn gebruikt voor semantische verrijking. |
| title |
string |
De ruwe tekenreeks voor het titelveld dat is gebruikt voor semantische verrijking. |
QueryResultDocumentSemanticField
Beschrijving van velden die naar het semantische verrijkingsproces zijn gestuurd, en hoe ze zijn gebruikt
| Name | Type | Description |
|---|---|---|
| name |
string |
De naam van het veld dat naar het semantische verrijkingsproces is gestuurd |
| state |
De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt) |
QueryResultDocumentSubscores
De uitsplitsing van subscores tussen de tekst- en vectorquerycomponenten van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde waarin ze zijn ontvangen.
| Name | Type | Description |
|---|---|---|
| documentBoost |
number (double) |
De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht. |
| text |
De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht. |
|
| vectors |
<string,
Single |
De vectorovereenkomst en @search.score -waarden voor elke vectorquery. |
QueryRewritesDebugInfo
Bevat foutopsporingsinformatie die specifiek is voor het herschrijven van query's.
| Name | Type | Description |
|---|---|---|
| text |
Lijst met herschrijvingen van query's die zijn gegenereerd voor de tekstquery. |
|
| vectors |
Lijst met herschrijvingen van query's die zijn gegenereerd voor de vectoriseerbare tekstquery's. |
QueryRewritesType
Een waarde die aangeeft of het herschrijven van query's moet worden gegenereerd om de zoekquery te vergroten.
| Waarde | Description |
|---|---|
| none |
Genereer geen extra herschrijvingen van query's voor deze query. |
| generative |
Genereer alternatieve zoektermen om de herinnering aan een zoekopdracht te vergroten. |
QueryRewritesValuesDebugInfo
Bevat foutopsporingsinformatie die specifiek is voor het herschrijven van query's.
| Name | Type | Description |
|---|---|---|
| inputQuery |
string |
De invoertekst voor het herschrijfmodel voor generatieve query's. Er kunnen zich gevallen voordoen waarin de gebruikersquery en de invoer in het generatieve model niet identiek zijn. |
| rewrites |
string[] |
Lijst met herschrijvingen van query's. |
QuerySpellerType
Een waarde die het type speller opgeeft dat moet worden gebruikt om de spelling van afzonderlijke zoektermen te corrigeren.
| Waarde | Description |
|---|---|
| none |
Spelling niet ingeschakeld. |
| lexicon |
Speller corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven door de parameter queryLanguage. |
QueryType
Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.
| Waarde | Description |
|---|---|
| simple |
Gebruikt de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige zoektaal die symbolen zoals +, * en "" mogelijk maakt. Query's worden standaard geëvalueerd in alle doorzoekbare velden, tenzij de parameter searchFields is opgegeven. |
| full |
Gebruikt de volledige syntaxis van de Lucene-query voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal die veldspecifieke en gewogen zoekopdrachten mogelijk maakt, evenals andere geavanceerde functies. |
| semantic |
Het meest geschikt voor zoekopdrachten die worden uitgedrukt in natuurlijke taal in tegenstelling tot trefwoorden. Verbetert de precisie van zoekresultaten door de hoogste rangschikking van de belangrijkste zoekresultaten opnieuw te bepalen met behulp van een rangschikkingsmodel dat is getraind op het webcorpus. |
RawVectorQuery
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde is opgegeven.
| Name | Type | Description |
|---|---|---|
| exhaustive |
boolean |
Als dit waar is, wordt een uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden. |
| fields |
string |
Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector. |
| filterOverride |
string |
De OData-filterexpressie die u wilt toepassen op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau. |
| k |
integer (int32) |
Aantal naaste buren dat terugkeert als tophits. |
| kind |
string:
vector |
Het soort vectorquery dat wordt uitgevoerd. |
| oversampling |
number (double) |
Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld. |
| perDocumentVectorLimit |
integer (int32) |
Hiermee bepaalt u hoeveel vectoren kunnen worden gekoppeld uit elk document in een vectorzoekquery. Als u deze instelling op 1 zet, zorgt u ervoor dat maximaal één vector per document overeenkomt, zodat de resultaten uit verschillende documenten afkomstig zijn. Door deze in te stellen op 0 (onbeperkt) kunnen meerdere relevante vectoren uit hetzelfde document worden gematcht. De standaardwaarde is 0. |
| threshold | VectorThreshold: |
De drempelwaarde die wordt gebruikt voor vectorquery's. Let op: dit kan alleen worden ingesteld als alle 'velden' dezelfde gelijkenismetriek gebruiken. |
| vector |
number[] (float) |
De vectorweergave van een zoekopdracht. |
| weight |
number (float) |
Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn 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 aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. 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) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen.
| Waarde | Description |
|---|---|
| local |
De scorestatistieken worden lokaal berekend voor een lagere latentie. |
| global |
De scorestatistieken worden wereldwijd berekend voor een consistentere score. |
SearchDocumentsResult
Reactie met zoekresultaten uit een index.
| Name | Type | Description |
|---|---|---|
| @odata.count |
integer (int64) |
Het totale aantal resultaten dat door de zoekbewerking is gevonden, of null als de telling niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in deze respons. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als de query niet alle gevraagde documenten in één antwoord kan retourneren. |
| @odata.nextLink |
string |
Vervolg-URL wordt geretourneerd wanneer de query niet alle gevraagde 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 de zoekrespons op te halen. Zorg ervoor dat u hetzelfde werkwoord (GET of POST) gebruikt als het verzoek dat dit antwoord heeft opgeleverd. |
| @search.answers |
De resultaten van de antwoordenquery voor de zoekbewerking; NULL als de parameter voor de antwoordquery niet is opgegeven of is ingesteld op 'Geen'. |
|
| @search.coverage |
number (double) |
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.debug |
Fouten opsporen in informatie die van toepassing is op de zoekresultaten als geheel. |
|
| @search.facets |
object |
De resultaten van de facetquery voor de zoekbewerking, georganiseerd als een verzameling buckets voor elk veld met facetten; Null als de query geen facetexpressies bevatte. |
| @search.nextPageParameters |
De JSON-payload voor voortzetting wordt geretourneerd wanneer de query niet alle gevraagde resultaten in één antwoord kan retourneren. U kunt deze JSON gebruiken @odata.nextLink om een andere POST-zoekopdracht te formuleren om het volgende deel van de zoekreactie op te halen. |
|
| @search.semanticPartialResponseReason |
Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
| @search.semanticPartialResponseType |
Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
| @search.semanticQueryRewritesResultType |
Type query herschrijven dat is gebruikt om documenten op te halen. |
|
| value |
De volgorde van de resultaten die door de query worden geretourneerd. |
SearchMode
Hiermee geeft u aan of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.
| Waarde | Description |
|---|---|
| any |
Elk van de zoektermen moet overeenkomen om het document als een overeenkomst te tellen. |
| all |
Alle zoektermen moeten overeenkomen om het document als een overeenkomst te tellen. |
SearchRequest
Parameters voor filteren, sorteren, facetteren, pagineren en ander zoekquerygedrag.
| Name | Type | Description |
|---|---|---|
| answers |
Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht. |
|
| captions |
Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht. |
|
| count |
boolean |
Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is vals. Als u deze waarde instelt op waar, kan dit gevolgen hebben voor de prestaties. Merk op dat de geretourneerde telling een benadering is. |
| debug |
Schakelt een foutopsporingstool in die kan worden gebruikt om uw opnieuw gerangschikte resultaten verder te verkennen. |
|
| facets |
string[] |
De lijst met facetexpressies die op de zoekopdracht moeten worden toegepast. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met name:value-paren. |
| filter |
string |
De OData $filter expressie die op de zoekquery moet worden toegepast. |
| highlight |
string |
De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor hoogtepunten van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers. |
| highlightPostTag |
string |
Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. De standaardinstelling is </em>. |
| highlightPreTag |
string |
Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Standaard is <em>. |
| hybridSearch |
De queryparameters om hybride zoekgedrag te configureren. |
|
| minimumCoverage |
number (double) |
Een getal tussen 0 en 100 geeft het percentage van de index aan dat door een zoekopdracht moet worden gedekt om de zoekopdracht als succesvol 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 waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke uitdrukking kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardinstelling is oplopende volgorde. Gelijkspel wordt verbroken door de wedstrijdscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentovereenkomstscore. Er kunnen maximaal 32 $orderby clausules zijn. |
| queryLanguage |
Een waarde die de taal van de zoekopdracht aangeeft. |
|
| queryRewrites |
Een waarde die aangeeft of het herschrijven van query's moet worden gegenereerd om de zoekquery te vergroten. |
|
| queryType |
Een waarde die de syntaxis van de zoekopdracht aangeeft. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis. |
|
| scoringParameters |
string[] |
De lijst met parameterwaarden die moeten worden gebruikt in scoringsfuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', zou de parametertekenreeks "mylocation--122.2,44.8" zijn (zonder de aanhalingstekens). |
| scoringProfile |
string |
De naam van een scoreprofiel om overeenkomstscores voor overeenkomende documenten te evalueren om de resultaten te sorteren. |
| scoringStatistics |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen. |
|
| search |
string |
Een expressie voor een zoekopdracht in volledige tekst; Gebruik "*" of laat deze parameter weg om alle documenten te matchen. |
| searchFields |
string |
De door komma's gescheiden lijst met veldnamen waarnaar u de zoekopdracht in volledige tekst wilt uitvoeren. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op de veldnamen die in deze parameter worden vermeld. |
| searchMode |
Een waarde die aangeeft of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen. |
|
| select |
string |
De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, worden alle velden opgenomen die in het schema zijn gemarkeerd als opvraagbaar. |
| semanticConfiguration |
string |
De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch. |
| semanticErrorHandling |
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren. |
|
| semanticFields |
string |
De door komma's gescheiden lijst met veldnamen die worden gebruikt voor de semantische rangschikking. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is om de semantische verrijking te verwerken voordat de aanvraag mislukt. |
| semanticQuery |
string |
Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische herrangschikking, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin het nodig is om verschillende query's te gebruiken tussen de fase voor het ophalen en rangschikken van de basis en de semantische fase van L2. |
| sessionId |
string |
Een waarde die kan worden gebruikt om een sticky sessie te maken, wat kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Houd er rekening mee dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen op 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 (int32) |
Het aantal zoekresultaten dat u moet overslaan. Deze waarde mag niet groter zijn dan 100.000. Als u documenten in volgorde moet scannen, maar vanwege deze beperking geen skip kunt gebruiken, kunt u overwegen orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery. |
| speller |
Een waarde die het type speller opgeeft dat moet worden gebruikt om de spelling van afzonderlijke zoektermen te corrigeren. |
|
| top |
integer (int32) |
Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paginering van zoekresultaten aan de clientzijde te implementeren. Als de resultaten worden afgekapt als gevolg van pagerijdbaarheid aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een nieuwe zoekopdracht uit te geven voor de volgende pagina met resultaten. |
| vectorFilterMode |
Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren. De standaardinstelling is 'preFilter' voor nieuwe indexen. |
|
| vectorQueries | VectorQuery[]: |
De queryparameters voor vector- en hybride zoekquery's. |
SearchResult
Bevat een document dat is gevonden door een zoekopdracht, plus bijbehorende metagegevens.
| Name | Type | Description |
|---|---|---|
| @search.captions |
Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'. |
|
| @search.documentDebugInfo |
Bevat foutopsporingsinformatie die kan 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.rerankerBoostedScore |
number (double) |
De relevantiescore die wordt berekend door de Reranker Score te verhogen. Zoekresultaten worden gesorteerd op de RerankerScore/RerankerBoostedScore op basis van useScoringProfileBoostedRanking in de semantische config. RerankerBoostedScore wordt alleen geretourneerd voor query's van het type 'semantisch' |
| @search.rerankerScore |
number (double) |
De relevantiescore die wordt berekend door de semantische rangschikker voor de beste 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 (double) |
De relevantiescore van het document in vergelijking met andere documenten die door de query worden geretourneerd. |
SearchScoreThreshold
De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Houd er rekening mee dat dit het @search.score resultaat is dat wordt geretourneerd als onderdeel van het zoekantwoord. De drempelrichting wordt gekozen voor hoger @search.score.
| Name | Type | Description |
|---|---|---|
| kind |
string:
search |
Het soort drempel dat wordt gebruikt om vectorquery's te filteren |
| value |
number (double) |
De drempel wordt gefilterd op basis van de waarde '@search.score'. Houd er rekening mee dat dit het @search.score resultaat is dat wordt geretourneerd als onderdeel van het zoekantwoord. De drempelrichting wordt gekozen voor hoger @search.score. |
SemanticDebugInfo
| Name | Type | Description |
|---|---|---|
| contentFields |
De inhoudsvelden die naar het semantische verrijkingsproces zijn gestuurd en hoe ze zijn gebruikt |
|
| keywordFields |
De trefwoordvelden die naar het semantische verrijkingsproces zijn gestuurd, en hoe ze zijn gebruikt |
|
| rerankerInput |
De ruwe aaneengeschakelde tekenreeksen die naar het semantische verrijkingsproces zijn gestuurd. |
|
| titleField |
Het titelveld dat naar het semantische verrijkingsproces is gestuurd en hoe het is gebruikt |
SemanticErrorMode
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren.
| Waarde | Description |
|---|---|
| partial |
Als de semantische verwerking mislukt, worden gedeeltelijke resultaten nog steeds geretourneerd. De definitie van gedeeltelijke resultaten hangt af van welke semantische stap mislukte en wat de reden voor mislukking was. |
| fail |
Als er een uitzondering is tijdens de semantische verwerkingsstap, mislukt de query en wordt de juiste HTTP-code geretourneerd, afhankelijk van de fout. |
SemanticErrorReason
Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek.
| Waarde | Description |
|---|---|
| maxWaitExceeded |
Als |
| capacityOverloaded |
Het verzoek werd gesmoord. Alleen de basisresultaten werden geretourneerd. |
| transient |
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)
| Waarde | Description |
|---|---|
| used |
Het veld werd volledig gebruikt voor semantische verrijking. |
| unused |
Het veld werd niet gebruikt voor semantische verrijking. |
| partial |
Het veld werd gedeeltelijk gebruikt voor semantische verrijking. |
SemanticQueryRewritesResultType
Type query herschrijven dat voor deze aanvraag is gebruikt.
| Waarde | Description |
|---|---|
| originalQueryOnly |
Het herschrijven van query's is niet gegenereerd voor deze aanvraag. Alleen de oorspronkelijke query is gebruikt om de resultaten op te halen. |
SemanticSearchResultsType
Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek.
| Waarde | Description |
|---|---|
| baseResults |
Resultaten zonder enige semantische verrijking of herrangschikking. |
| rerankedResults |
De resultaten zijn opnieuw gerangschikt met het herindelingsmodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, hoogtepunten van antwoorden of hoogtepunten van ondertiteling. |
SingleVectorFieldResult
Een enkel vectorveldresultaat. Zowel als @search.score vectorgelijkeniswaarden worden geretourneerd. Vectorgelijkenis is gerelateerd aan @search.score door een vergelijking.
| Name | Type | Description |
|---|---|---|
| searchScore |
number (double) |
De @search.score waarde die wordt berekend op basis van de vectorgelijkenisscore. Dit is de score die zichtbaar is in een pure single-field single-vector query. |
| vectorSimilarity |
number (double) |
De vectorgelijkenisscore voor dit document. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. Bijvoorbeeld cosinusovereenkomst in plaats van cosinusafstand. |
TextResult
De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.
| Name | Type | Description |
|---|---|---|
| searchScore |
number (double) |
De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht. |
VectorFilterMode
Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren.
| Waarde | Description |
|---|---|
| postFilter |
Het filter wordt toegepast nadat de kandidaat-set vectorresultaten is geretourneerd. Afhankelijk van de filterselectiviteit kan dit resulteren in minder resultaten dan gevraagd door de parameter 'k'. |
| preFilter |
Het filter wordt toegepast vóór de zoekopdracht. |
| strictPostFilter |
Het filter wordt toegepast nadat de wereldwijde top-k kandidaat-set met vectorresultaten is geretourneerd. Dit zal resulteren in minder resultaten dan gevraagd door de parameter 'k'. |
VectorizableImageBinaryQuery
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een binair bestand met basis 64 van een afbeelding die moet worden gevectoriseerd, wordt verstrekt.
| Name | Type | Description |
|---|---|---|
| base64Image |
string |
De basis 64 gecodeerd binair van een afbeelding die moet worden gevectoriseerd om een vectorzoekopdracht uit te voeren. |
| exhaustive |
boolean |
Als dit waar is, wordt een uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden. |
| fields |
string |
Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector. |
| filterOverride |
string |
De OData-filterexpressie die u wilt toepassen op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau. |
| k |
integer (int32) |
Aantal naaste buren dat terugkeert als tophits. |
| kind |
string:
image |
Het soort vectorquery dat wordt uitgevoerd. |
| oversampling |
number (double) |
Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld. |
| perDocumentVectorLimit |
integer (int32) |
Hiermee bepaalt u hoeveel vectoren kunnen worden gekoppeld uit elk document in een vectorzoekquery. Als u deze instelling op 1 zet, zorgt u ervoor dat maximaal één vector per document overeenkomt, zodat de resultaten uit verschillende documenten afkomstig zijn. Door deze in te stellen op 0 (onbeperkt) kunnen meerdere relevante vectoren uit hetzelfde document worden gematcht. De standaardwaarde is 0. |
| threshold | VectorThreshold: |
De drempelwaarde die wordt gebruikt voor vectorquery's. Let op: dit kan alleen worden ingesteld als alle 'velden' dezelfde gelijkenismetriek gebruiken. |
| weight |
number (float) |
Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn 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 aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul. |
VectorizableImageUrlQuery
De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een url wordt opgegeven die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd.
| Name | Type | Description |
|---|---|---|
| exhaustive |
boolean |
Als dit waar is, wordt een uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden. |
| fields |
string |
Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector. |
| filterOverride |
string |
De OData-filterexpressie die u wilt toepassen op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau. |
| k |
integer (int32) |
Aantal naaste buren dat terugkeert als tophits. |
| kind |
string:
image |
Het soort vectorquery dat wordt uitgevoerd. |
| oversampling |
number (double) |
Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld. |
| perDocumentVectorLimit |
integer (int32) |
Hiermee bepaalt u hoeveel vectoren kunnen worden gekoppeld uit elk document in een vectorzoekquery. Als u deze instelling op 1 zet, zorgt u ervoor dat maximaal één vector per document overeenkomt, zodat de resultaten uit verschillende documenten afkomstig zijn. Door deze in te stellen op 0 (onbeperkt) kunnen meerdere relevante vectoren uit hetzelfde document worden gematcht. De standaardwaarde is 0. |
| threshold | VectorThreshold: |
De drempelwaarde die wordt gebruikt voor vectorquery's. Let op: dit kan alleen worden ingesteld als alle 'velden' dezelfde gelijkenismetriek gebruiken. |
| url |
string |
De URL van een afbeelding die moet worden gevectoriseerd om een vectorzoekopdracht uit te voeren. |
| weight |
number (float) |
Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn 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 aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul. |
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 uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden. |
| fields |
string |
Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector. |
| filterOverride |
string |
De OData-filterexpressie die u wilt toepassen op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau. |
| k |
integer (int32) |
Aantal naaste buren dat terugkeert als tophits. |
| kind |
string:
text |
Het soort vectorquery dat wordt uitgevoerd. |
| oversampling |
number (double) |
Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld. |
| perDocumentVectorLimit |
integer (int32) |
Hiermee bepaalt u hoeveel vectoren kunnen worden gekoppeld uit elk document in een vectorzoekquery. Als u deze instelling op 1 zet, zorgt u ervoor dat maximaal één vector per document overeenkomt, zodat de resultaten uit verschillende documenten afkomstig zijn. Door deze in te stellen op 0 (onbeperkt) kunnen meerdere relevante vectoren uit hetzelfde document worden gematcht. De standaardwaarde is 0. |
| queryRewrites |
Kan worden geconfigureerd om een generatief model de query te laten herschrijven voordat deze wordt verzonden om te worden gevectoriseerd. |
|
| text |
string |
De tekst die moet worden gevectoriseerd om een vectorzoekopdracht uit te voeren. |
| threshold | VectorThreshold: |
De drempelwaarde die wordt gebruikt voor vectorquery's. Let op: dit kan alleen worden ingesteld als alle 'velden' dezelfde gelijkenismetriek gebruiken. |
| weight |
number (float) |
Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn 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 aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul. |
VectorQueryKind
Het soort vectorquery dat wordt uitgevoerd.
| Waarde | Description |
|---|---|
| vector |
Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven. |
| text |
Vectorquery waarbij een tekstwaarde wordt opgegeven die moet worden gevectoriseerd. |
| imageUrl |
Vectorquery waarbij een url wordt opgegeven die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd. |
| imageBinary |
Vectorquery waarbij een met grondtal 64 gecodeerd binair bestand van een afbeelding die moet worden gevectoriseerd, wordt verstrekt. |
VectorsDebugInfo
| Name | Type | Description |
|---|---|---|
| subscores |
De uitsplitsing van subscores van het document voorafgaand aan de gekozen resultatenset fusie-/combinatiemethode zoals RRF. |
VectorSimilarityThreshold
De resultaten van de vectorquery worden gefilterd op basis van de vectorgelijkenismetriek. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. De drempelrichting (groter of kleiner) wordt automatisch gekozen op basis van de metriek die door het veld wordt gebruikt.
| Name | Type | Description |
|---|---|---|
| kind |
string:
vector |
Het soort drempel dat wordt gebruikt om vectorquery's te filteren |
| value |
number (double) |
De drempelwaarde wordt gefilterd op basis van de metrische waarde voor gelijkenis. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. De drempelrichting (groter of kleiner) wordt automatisch gekozen op basis van de metriek die door het veld wordt gebruikt. |
VectorThresholdKind
Het soort vectorquery dat wordt uitgevoerd.
| Waarde | Description |
|---|---|
| vectorSimilarity |
De resultaten van de vectorquery worden gefilterd op basis van de vectorgelijkenismetriek. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. De drempelrichting (groter of kleiner) wordt automatisch gekozen op basis van de metriek die door het veld wordt gebruikt. |
| searchScore |
De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Houd er rekening mee dat dit het @search.score resultaat is dat wordt geretourneerd als onderdeel van het zoekantwoord. De drempelrichting wordt gekozen voor hoger @search.score. |