Documents - Autocomplete Post

Referentie

Service:: Search Service

API Version:: 2023-11-01

Onvolledige querytermen worden automatisch aangevuld op basis van invoertekst en overeenkomende termen in de index.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag wordt verzonden om te helpen bij foutopsporing.

Aanvraagbody

Name	Vereist	Type	Description
search	True	string	De zoektekst waarop de resultaten voor automatisch aanvullen moeten worden gebaseerd.
suggesterName	True	string	De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesters die deel uitmaakt van de indexdefinitie.
autocompleteMode		AutocompleteMode	Hiermee geeft u de modus voor Automatisch aanvullen. De standaardwaarde is 'oneTerm'. Gebruik 'twoTerms' om shingles op te halen en 'oneTermWithContext' om de huidige context te gebruiken tijdens het produceren van automatisch ingevulde termen.
filter		string	Een OData-expressie die de documenten filtert die worden gebruikt om voltooide termen te produceren voor het resultaat automatisch aanvullen.
fuzzy		boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de query voor automatisch aanvullen. De standaardinstelling is onwaar. Als de query is ingesteld op true, worden termen automatisch aangevuld, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, brengt dit prestatiekosten met zich mee omdat fuzzy query's voor automatisch aanvullen langzamer zijn en meer resources verbruiken.
highlightPostTag		string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is markeren van treffers uitgeschakeld.
highlightPreTag		string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is markeren van treffers uitgeschakeld.
minimumCoverage		number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een query voor automatisch aanvullen om de query als geslaagd te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
searchFields		string	De door komma's gescheiden lijst met veldnamen om rekening mee te houden bij het uitvoeren van query's op automatisch ingevulde termen. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.
top		integer	Het aantal automatisch ingevulde termen dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

Antwoorden

Name	Type	Description
200 OK	AutocompleteResult	Antwoord met voorgestelde querytermen die de gedeeltelijke invoer voltooien.
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

SearchIndexAutocompleteDocumentsPost

Sample Request

HTTP

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

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

Sample Response

Status code:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definities

Name	Description
AutocompleteItem	Het resultaat van aanvragen voor automatisch aanvullen.
AutocompleteMode	Hiermee geeft u de modus voor Automatisch aanvullen. De standaardwaarde is 'oneTerm'. Gebruik 'twoTerms' om shingles op te halen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van termen voor automatisch aanvullen.
AutocompleteRequest	Parameters voor fuzzy overeenkomsten en ander gedrag voor automatisch aanvullen van query's.
AutocompleteResult	Het resultaat van de query automatisch aanvullen.
SearchError	Beschrijft een foutvoorwaarde voor de API.

AutocompleteItem

Het resultaat van aanvragen voor automatisch aanvullen.

Name	Type	Description
queryPlusText	string	De query samen met de voltooide term.
text	string	De voltooide term.

AutocompleteMode

Hiermee geeft u de modus voor Automatisch aanvullen. De standaardwaarde is 'oneTerm'. Gebruik 'twoTerms' om shingles op te halen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van termen voor automatisch aanvullen.

Name	Type	Description
oneTerm	string	Er wordt slechts één term voorgesteld. Als de query twee termen heeft, wordt alleen de laatste term voltooid. Als de invoer bijvoorbeeld 'washington medic' is, kunnen de voorgestelde termen 'medicaid', 'medicare' en 'medicine' zijn.
oneTermWithContext	string	Hiermee voltooit u de laatste term in een query met twee of meer termen, waarbij de laatste twee termen een woordgroep in de index zijn. Als de invoer bijvoorbeeld 'washington medic' is, kunnen de voorgestelde termen 'washington medicaid' en 'washington medical' bevatten.
twoTerms	string	Overeenkomende woordgroepen in de index worden voorgesteld. Als de invoer bijvoorbeeld 'medic' is, kunnen de voorgestelde termen 'medicare-dekking' en 'medische assistent' bevatten.

AutocompleteRequest

Parameters voor fuzzy overeenkomsten en ander gedrag voor automatisch aanvullen van query's.

Name	Type	Description
autocompleteMode	AutocompleteMode	Hiermee geeft u de modus voor Automatisch aanvullen. De standaardwaarde is 'oneTerm'. Gebruik 'twoTerms' om shingles op te halen en 'oneTermWithContext' om de huidige context te gebruiken tijdens het produceren van automatisch ingevulde termen.
filter	string	Een OData-expressie die de documenten filtert die worden gebruikt om voltooide termen te produceren voor het resultaat automatisch aanvullen.
fuzzy	boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de query voor automatisch aanvullen. De standaardinstelling is onwaar. Als de query is ingesteld op true, worden termen automatisch aangevuld, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, brengt dit prestatiekosten met zich mee omdat fuzzy query's voor automatisch aanvullen langzamer zijn en meer resources verbruiken.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is markeren van treffers uitgeschakeld.
highlightPreTag	string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is markeren van treffers uitgeschakeld.
minimumCoverage	number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een query voor automatisch aanvullen om de query als geslaagd te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
search	string	De zoektekst waarop de resultaten voor automatisch aanvullen moeten worden gebaseerd.
searchFields	string	De door komma's gescheiden lijst met veldnamen om rekening mee te houden bij het uitvoeren van query's op automatisch ingevulde termen. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.
suggesterName	string	De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesters die deel uitmaakt van de indexdefinitie.
top	integer	Het aantal automatisch ingevulde termen dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

AutocompleteResult

Het resultaat van de query automatisch aanvullen.

Name	Type	Description
@search.coverage	number	Een waarde die het percentage van de index aangeeft dat in aanmerking is genomen door de aanvraag voor automatisch aanvullen, of null als minimumCoverage niet is opgegeven in de aanvraag.
value	AutocompleteItem[]	De lijst met geretourneerde automatisch aangevulde items.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.

Share via