Documents - Autocomplete Get

Referentie

Service:: Search Service

API-versie:: 2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2024-07-01&search={search}&suggesterName={suggesterName}

Met optionele parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2024-07-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

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.
search	query	True	string	De onvolledige term die automatisch moet worden voltooid.
suggesterName	query	True	string	De naam van de suggestie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
$filter	query		string	Een OData-expressie waarmee de documenten worden gefilterd die worden gebruikt om voltooide termen te produceren voor het resultaat automatisch aanvullen.
$top	query		integer int32	Het aantal automatisch voltooide termen dat moet worden opgehaald. Dit moet een waarde tussen 1 en 100 zijn. De standaardwaarde is 5.
autocompleteMode	query		AutocompleteMode	Hiermee geeft u de modus voor automatisch aanvullen. De standaardwaarde is 'oneTerm'. Gebruik 'twoTerms' om shingles en 'oneTermWithContext' te krijgen om de huidige context te gebruiken terwijl automatisch voltooide termen worden geproduceerd.
fuzzy	query		boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de query voor automatisch aanvullen. De standaardwaarde is onwaar. Als deze optie is ingesteld op true, vindt de query termen, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, worden er prestatiekosten in rekening gebracht omdat fuzzy automatisch aanvullen query's langzamer zijn en meer resources verbruiken.
highlightPostTag	query		string	Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is markeren van treffers uitgeschakeld.
highlightPreTag	query		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	query		number double	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een query met automatisch aanvullen om de query te kunnen melden als een succes. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 80.
searchFields	query		string[]	De lijst met veldnamen waarmee u rekening moet houden bij het uitvoeren van query's op automatisch ingevulde termen. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.

Aanvraagkoptekst

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

Antwoorden

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

Voorbeelden

SearchIndexAutocompleteDocumentsGet

Voorbeeldaanvraag

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2024-07-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Voorbeeldrespons

Statuscode:: 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 en 'oneTermWithContext' te krijgen om de huidige context te gebruiken bij het produceren van termen voor automatisch aanvullen.
AutocompleteResult	Het resultaat van de query voor automatisch aanvullen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

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 en 'oneTermWithContext' te krijgen 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 'geneeskunde' bevatten.
oneTermWithContext	string	Voltooit 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 tweetermzinnen in de index worden voorgesteld. Als de invoer bijvoorbeeld 'medic' is, kunnen de voorgestelde termen 'medicare dekking' en 'medische assistent' bevatten.

AutocompleteResult

Het resultaat van de query voor automatisch aanvullen.

Name	Type	Description
@search.coverage	number	Een waarde die het percentage aangeeft van de index die is overwogen 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.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

De foutdetails.

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

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Delen via