Documents - Suggest Post
Stelt documenten in de index voor die overeenkomen met de opgegeven gedeeltelijke querytekst.
POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2025-09-01URI-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. |
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. |
Aanvraagbody
| Name | Vereist | Type | Description |
|---|---|---|---|
| search | True |
string |
De zoektekst die moet worden gebruikt om documenten voor te stellen. Moet ten minste 1 teken zijn en niet meer dan 100 tekens. |
| suggesterName | True |
string |
De naam van de suggestie zoals opgegeven in de verzameling suggestiezoekers die deel uitmaakt van de indexdefinitie. |
| filter |
string |
Een OData-expressie waarmee de documenten worden gefilterd die in aanmerking komen voor suggesties. |
|
| fuzzy |
boolean |
Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is vals. Als de query is ingesteld op true, worden er suggesties gevonden, zelfs als er een vervangen of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, brengt het prestatiekosten met zich mee omdat vage zoekopdrachten naar suggesties langzamer zijn en meer bronnen verbruiken. |
|
| highlightPostTag |
string |
Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld. |
|
| highlightPreTag |
string |
Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld. |
|
| minimumCoverage |
number (double) |
Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een suggestiequery moet worden gedekt om de query 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 80. |
|
| 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. |
|
| searchFields |
string |
De door komma's gescheiden lijst met veldnamen waarmee naar de opgegeven zoektekst moet worden gezocht. Doelvelden moeten worden opgenomen in de opgegeven suggestie. |
|
| select |
string |
De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, wordt alleen het sleutelveld in de resultaten opgenomen. |
|
| top |
integer (int32) |
Het aantal suggesties om op te halen. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
Antwoord met voorgestelde documenten die overeenkomen met de gedeeltelijke invoer. |
|
| Other Status Codes |
Foutreactie. |
Voorbeelden
SearchIndexSuggestDocumentsPost
Voorbeeldaanvraag
POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.suggest?api-version=2025-09-01
{
"filter": "ownerId eq 'sam' and id lt '15'",
"fuzzy": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"orderby": "id desc",
"search": "p",
"searchFields": "category",
"select": "id,name,category,ownerId",
"suggesterName": "sg",
"top": 10
}
Voorbeeldrespons
{
"@search.coverage": 100,
"value": [
{
"@search.text": "<em>pu</em>rple",
"id": "14",
"name": "test",
"category": "purple",
"ownerId": "sam"
},
{
"@search.text": "<em>pu</em>rple",
"id": "13",
"name": "test",
"category": "purple",
"ownerId": "sam"
},
{
"@search.text": "<em>pu</em>rple",
"id": "11",
"name": "test",
"category": "purple",
"ownerId": "sam"
},
{
"@search.text": "<em>pu</em>rple",
"id": "1",
"name": "test",
"category": "purple",
"ownerId": "sam"
}
]
}Definities
| Name | Description |
|---|---|
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
Suggest |
Antwoord met suggestiequery is het resultaat van een index. |
|
Suggest |
Parameters voor filteren, sorteren, fuzzy matching en andere suggesties querygedrag. |
|
Suggest |
Een resultaat dat een document bevat dat is gevonden door een suggestiequery, plus bijbehorende metagegevens. |
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. |
SuggestDocumentsResult
Antwoord met suggestiequery is het resultaat van een index.
| Name | Type | Description |
|---|---|---|
| @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 ingesteld in de aanvraag. |
| value |
De volgorde van de resultaten die door de query worden geretourneerd. |
SuggestRequest
Parameters voor filteren, sorteren, fuzzy matching en andere suggesties querygedrag.
| Name | Type | Description |
|---|---|---|
| filter |
string |
Een OData-expressie waarmee de documenten worden gefilterd die in aanmerking komen voor suggesties. |
| fuzzy |
boolean |
Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is vals. Als de query is ingesteld op true, worden er suggesties gevonden, zelfs als er een vervangen of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, brengt het prestatiekosten met zich mee omdat vage zoekopdrachten naar suggesties langzamer zijn en meer bronnen verbruiken. |
| highlightPostTag |
string |
Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld. |
| highlightPreTag |
string |
Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld. |
| minimumCoverage |
number (double) |
Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een suggestiequery moet worden gedekt om de query 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 80. |
| 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. |
| search |
string |
De zoektekst die moet worden gebruikt om documenten voor te stellen. Moet ten minste 1 teken zijn en niet meer dan 100 tekens. |
| searchFields |
string |
De door komma's gescheiden lijst met veldnamen waarmee naar de opgegeven zoektekst moet worden gezocht. Doelvelden moeten worden opgenomen in de opgegeven suggestie. |
| select |
string |
De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, wordt alleen het sleutelveld in de resultaten opgenomen. |
| suggesterName |
string |
De naam van de suggestie zoals opgegeven in de verzameling suggestiezoekers die deel uitmaakt van de indexdefinitie. |
| top |
integer (int32) |
Het aantal suggesties om op te halen. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5. |
SuggestResult
Een resultaat dat een document bevat dat is gevonden door een suggestiequery, plus bijbehorende metagegevens.
| Name | Type | Description |
|---|---|---|
| @search.text |
string |
De tekst van het suggestieresultaat. |