Documents - Search Post
Zoekt naar documenten in de index.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-04-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
De eindpunt-URL van de zoekservice. |
|
index
|
path | True |
string |
De naam van de index. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Accept |
De Accepteer kop. |
||
| x-ms-client-request-id |
string (uuid) |
Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag. |
Aanvraagbody
| Name | Type | Description |
|---|---|---|
| answers |
Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord. |
|
| captions |
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 vals. Het instellen van deze waarde op True kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is. |
| debug |
Schakelt een foutopsporingstool in die kan worden gebruikt om uw opnieuw gerangschikte resultaten verder te verkennen. |
|
| facets |
string[] |
De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen. |
| filter |
string |
De OData $filter-expressie die moet worden toegepast op de zoekquery. |
| highlight |
string |
De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor 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 (double) |
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 waarop 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 |
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 |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, 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 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 |
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 u wilt ophalen. 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 |
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren. |
|
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
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 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. 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 (int32) |
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 (int32) |
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 |
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. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Geslaagd |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
api-key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiken
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Voorbeelden
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Voorbeeldaanvraag
POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1
}
],
"vectorFilterMode": "preFilter"
}
Voorbeeldrespons
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "This is a caption from the document.",
"highlights": "This is a <em>caption</em> from the document."
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsSemanticPost
Voorbeeldaanvraag
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-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
{
"@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=2026-04-01"
}
{
"@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=2026-04-01"
}
Definities
| Name | Description |
|---|---|
| Accept |
De Accepteer kop. |
|
Document |
Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.) |
|
Query |
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. |
|
Query |
Deze parameter is alleen geldig als het querytype . |
|
Query |
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 |
|
Query |
Deze parameter is alleen geldig als het querytype . |
|
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 uitsplitsing van substrepingstekens tussen de onderdelen van de tekst- en vectorquery van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde als ze zijn ontvangen. |
|
Query |
Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardwaarde is 'eenvoudig'. Gebruik 'full' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is. |
|
Scoring |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, 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 |
Antwoord met zoekresultaten van 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, facet, paging en ander gedrag van zoekquery's. |
|
Search |
Bevat een document dat is gevonden door een zoekquery, plus de bijbehorende metagegevens. |
|
Semantic |
Stelt de gebruiker in staat te kiezen of een semantische aanroep volledig moet mislukken, of dat gedeeltelijke resultaten worden teruggegeven. |
|
Semantic |
Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
Semantic |
Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek. |
|
Single |
Eén vectorveldresultaat. Both |
|
Text |
De BM25- of Klassieke score voor het tekstgedeelte van de query. |
|
Vector |
Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een met base 64 gecodeerd binair bestand van een afbeelding wordt opgegeven die moet worden gevectoriseerd. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een URL die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd, wordt opgegeven. |
|
Vectorizable |
De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd. |
|
Vectorized |
De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een onbewerkte vectorwaarde wordt opgegeven. |
|
Vector |
Het soort vectorquery dat wordt uitgevoerd. |
|
Vectors |
"Bevat debugging-informatie specifiek voor vector- en hybride zoekopdrachten.") |
Accept
De Accepteer kop.
| Waarde | Description |
|---|---|
| application/json;odata.metadata=none |
DocumentDebugInfo
Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.
| Name | Type | Description |
|---|---|---|
| vectors |
Bevat foutopsporingsinformatie die specifiek is voor vector- en hybride zoekopdrachten. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
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 foutdoelwit. |
ErrorResponse
Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
QueryAnswerResult
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 (double) |
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. |
QueryAnswerType
Deze parameter is alleen geldig als het querytype .semantic Indien ingesteld, retourneert de query antwoorden die zijn geëxtraheerd uit belangrijke passages in de hoogste gerangschikte documenten. Het aantal geretourneerde antwoorden kan worden geconfigureerd door het pipe-teken | toe te voegen, gevolgd door de count-<number of answers> optie na de parameterwaarde voor antwoorden, zoals extractive|count-3. De standaardtelling is 1. De betrouwbaarheidsdrempel kan worden geconfigureerd door het pipe-teken | toe te voegen, gevolgd door de threshold-<confidence threshold> optie na de parameterwaarde van het antwoord, zoals extractive|threshold-0.9. De standaarddrempel is 0,7. De maximale tekenlengte van antwoorden kan worden geconfigureerd door het pipe-teken '|' toe te voegen, gevolgd door het 'count-number< of maximum character length>', zoals 'extractive|maxcharlength-600'.
| Waarde | Description |
|---|---|
| none |
Geef geen antwoorden op de zoekopdracht. |
| extractive |
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. |
QueryCaptionResult
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. |
QueryCaptionType
Deze parameter is alleen geldig als het querytype .semantic Als deze optie is ingesteld, retourneert de query bijschriften die zijn geëxtraheerd uit belangrijke passages in de hoogste gerangschikte documenten. Wanneer Bijschriften is ingesteld op extractive, is markeren standaard ingeschakeld en kan dit worden geconfigureerd door het pipe-teken | toe te voegen, gevolgd door de highlight-<true/false> optie, zoals extractive|highlight-true. Wordt standaard ingesteld op None. De maximale tekenlengte van bijschriften kan worden geconfigureerd door het pipe-teken '|' toe te voegen, gevolgd door het 'count-number< of maximum character length>', zoals 'extractive|maxcharlength-600'.
| Waarde | Description |
|---|---|
| none |
Retourneer geen ondertiteling voor de zoekopdracht. |
| extractive |
Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekquery. |
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. |
QueryResultDocumentSubscores
De uitsplitsing van substrepingstekens tussen de onderdelen van de tekst- en vectorquery van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde als ze zijn ontvangen.
| Name | Type | Description |
|---|---|---|
| documentBoost |
number (double) |
De BM25- of Klassieke score voor het tekstgedeelte van de query. |
| text |
De BM25- of Klassieke score voor het tekstgedeelte van de query. |
|
| vectors |
<string,
Single |
De vectorgelijkenis en |
QueryType
Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardwaarde 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. |
ScoringStatistics
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, 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
Antwoord met zoekresultaten van een index.
| Name | Type | Description |
|---|---|---|
| @odata.count |
integer (int64) |
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 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 antwoordenqueryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of is ingesteld op 'none'. |
|
| @search.coverage |
number (double) |
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 |
De JSON-payload voor voortzetting wordt geretourneerd wanneer de query niet alle gevraagde resultaten in één antwoord kan retourneren. Je kunt deze JSON gebruiken samen met |
|
| @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. |
|
| value |
De reeks 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, facet, paging en ander gedrag van zoekquery's.
| Name | Type | Description |
|---|---|---|
| answers |
Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord. |
|
| captions |
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 vals. Het instellen van deze waarde op True kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is. |
| debug |
Schakelt een foutopsporingstool in die kan worden gebruikt om uw opnieuw gerangschikte resultaten verder te verkennen. |
|
| facets |
string[] |
De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen. |
| filter |
string |
De OData $filter-expressie die moet worden toegepast op de zoekquery. |
| highlight |
string |
De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor 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 (double) |
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 waarop 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 |
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 |
Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, 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 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 |
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 u wilt ophalen. 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 |
Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren. |
|
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
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 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. 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 (int32) |
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 (int32) |
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 |
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 zoekquery, plus de bijbehorende metagegevens.
| Name | Type | Description |
|---|---|---|
| @search.captions |
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.documentDebugInfo |
Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen. |
|
| @search.highlights |
object |
Tekstfragmenten uit het document die de overeenkomende zoektermen aangeven, geordend op elk toepasselijk veld; Null als het markeren van treffers niet is ingeschakeld voor de query. |
| @search.rerankerBoostedScore |
number (double) |
De relevantiescore die wordt berekend door de Reranker Score te verhogen. Zoekresultaten zijn gesorteerd op RerankerScore/RerankerBoostedScore op basis van useScoringProfileBoostedRanking in de Semantic Config. RerankerBoostedScore wordt alleen teruggegeven voor zoekopdrachten van type 'semantiek'. |
| @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. |
SemanticErrorMode
Stelt de gebruiker in staat te kiezen of een semantische aanroep volledig moet mislukken, of dat gedeeltelijke resultaten worden teruggegeven.
| Waarde | Description |
|---|---|
| partial |
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. |
| fail |
Als er een uitzondering is tijdens de semantische verwerkingsstap, mislukt de query en retourneert de juiste HTTP-code, afhankelijk van de fout. |
SemanticErrorReason
Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek.
| Waarde | Description |
|---|---|
| maxWaitExceeded |
Als |
| capacityOverloaded |
De aanvraag is beperkt. Alleen de basisresultaten zijn geretourneerd. |
| transient |
Ten minste één stap van het semantische proces is mislukt. |
SemanticSearchResultsType
Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek.
| Waarde | Description |
|---|---|
| baseResults |
Resultaten zonder semantische verrijking of herrankering. |
| rerankedResults |
De resultaten zijn gererankeerd met het rerankermodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, antwoorden met markeringen of bijschriften. |
SingleVectorFieldResult
Eén vectorveldresultaat. Both
| Name | Type | Description |
|---|---|---|
| searchScore |
number (double) |
De |
| vectorSimilarity |
number (double) |
De vectorgelijkenisscore voor dit document. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. Bijvoorbeeld cosinusovereenkomst in plaats van cosinusafstand. |
TextResult
De BM25- of Klassieke score voor het tekstgedeelte van de query.
| Name | Type | Description |
|---|---|---|
| searchScore |
number (double) |
De BM25- of Klassieke score voor het tekstgedeelte van de query. |
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 kandidaatset vectorresultaten is geretourneerd. Afhankelijk van de filterselectiviteit kan dit resulteren in minder resultaten dan is aangevraagd door de parameter k. |
| preFilter |
Het filter wordt toegepast vóór de zoekquery. |
| 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 vectorzoekopdrachten wanneer een met base 64 gecodeerd binair bestand van een afbeelding wordt opgegeven die moet worden gevectoriseerd.
| 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 |
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 (int32) |
Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd. |
| kind |
string:
image |
Type query. |
| oversampling |
number (double) |
Oversampling-factor. 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. |
| weight |
number (float) |
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. |
VectorizableImageUrlQuery
De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een URL die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd, 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 (int32) |
Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd. |
| kind |
string:
image |
Type query. |
| oversampling |
number (double) |
Oversampling-factor. 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. |
| url |
string |
De URL van een afbeelding die moet worden gevectoriseerd om een vectorzoekquery uit te voeren. |
| weight |
number (float) |
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. |
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 (int32) |
Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd. |
| kind |
string:
text |
Type query. |
| oversampling |
number (double) |
Oversampling-factor. 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 (float) |
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. |
VectorizedQuery
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 (int32) |
Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd. |
| kind |
string:
vector |
Type query. |
| oversampling |
number (double) |
Oversampling-factor. 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[] (float) |
De vectorweergave van een zoekquery. |
| weight |
number (float) |
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 soort vectorquery dat wordt uitgevoerd.
| Waarde | Description |
|---|---|
| vector |
Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven. |
| text |
Vectorquery waarbij een tekstwaarde die moet worden gevectoriseerd wordt opgegeven. |
| 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
"Bevat debugging-informatie specifiek voor vector- en hybride zoekopdrachten.")
| Name | Type | Description |
|---|---|---|
| subscores |
De uitsplitsing van subscores van het document voorafgaand aan de gekozen resultatenset fusie-/combinatiemethode zoals RRF. |