Documents - Autocomplete Get

Servizio:: Search Service

Versione API:: 2026-04-01

Completa automaticamente i termini di query incompleti in base al testo di input e ai termini corrispondenti nell'indice.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	URL dell'endpoint del servizio di ricerca.
indexName	path	True	string	Nome dell'indice.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
search	query	True	string	Il termine incompleto che deve essere completato automaticamente.
suggesterName	query	True	string	Nome del suggerimento come specificato nell'insieme di suggerimenti che fa parte della definizione dell'indice.
$filter	query		string	Espressione OData che filtra i documenti utilizzati per produrre termini completati per il risultato di completamento automatico.
$top	query		integer (int32)	Il numero di termini completati automaticamente da recuperare. Deve essere un valore compreso tra 1 e 100. L'impostazione predefinita è 5.
autocompleteMode	query		AutocompleteMode	Specifica la modalità per il completamento automatico. Il valore predefinito è 'oneTerm'. Usa 'twoTerms' per ottenere le tegole e 'oneTermWithContext' per usare il contesto corrente mentre produci termini completati automaticamente.
fuzzy	query		boolean	Valore che indica se utilizzare la corrispondenza fuzzy per la query di completamento automatico. Il valore predefinito è false. Se impostata su true, la query troverà i termini anche se nel testo di ricerca è presente un carattere sostituito o mancante. Sebbene ciò offra un'esperienza migliore in alcuni scenari, ha un costo in termini di prestazioni poiché le query di completamento automatico fuzzy sono più lente e utilizzano più risorse.
highlightPostTag	query		string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei colpi è disabilitata.
highlightPreTag	query		string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei colpi è disabilitata.
minimumCoverage	query		number (double)	Un numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di completamento automatico affinché la query venga segnalata come riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.
searchFields	query		string[]	L'elenco dei nomi dei campi da considerare quando si esegue una query per i termini completati automaticamente. I campi di destinazione devono essere inclusi nel suggerimento specificato.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Accept		Accept	L'intestazione Accetta.
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	AutocompleteResult	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://search.azure.com/.default

Esempio

SearchIndexAutocompleteDocumentsGet

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
AutocompleteItem	Risultato delle richieste di completamento automatico.
AutocompleteMode	Specifica la modalità per il completamento automatico. Il valore predefinito è 'oneTerm'. Utilizzare 'twoTerms' per ottenere le tegole e 'oneTermWithContext' per utilizzare il contesto corrente nella produzione di termini di completamento automatico.
AutocompleteResult	Risultato della query di completamento automatico.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=none

AutocompleteItem

Oggetto

Risultato delle richieste di completamento automatico.

Nome	Tipo	Descrizione
queryPlusText	string	Query insieme al termine completato.
text	string	Termine completato.

AutocompleteMode

Enumerazione

Specifica la modalità per il completamento automatico. Il valore predefinito è 'oneTerm'. Utilizzare 'twoTerms' per ottenere le tegole e 'oneTermWithContext' per utilizzare il contesto corrente nella produzione di termini di completamento automatico.

Valore	Descrizione
oneTerm	Viene suggerito un solo termine. Se la query ha due termini, viene completato solo l'ultimo termine. Ad esempio, se l'input è "washington medic", i termini suggeriti potrebbero includere "medicaid", "medicare" e "medicina".
twoTerms	Verrà suggerito di abbinare frasi a due termini nell'indice. Ad esempio, se l'input è "medico", i termini suggeriti potrebbero includere "copertura medicare" e "assistente medico".
oneTermWithContext	Completa l'ultimo termine di una query con due o più termini, dove gli ultimi due termini sono una frase presente nell'indice. Ad esempio, se l'input è "washington medic", i termini suggeriti potrebbero includere "washington medicaid" e "washington medical".

AutocompleteResult

Oggetto

Risultato della query di completamento automatico.

Nome	Tipo	Descrizione
@search.coverage	number (double)	Valore che indica la percentuale dell'indice considerato dalla richiesta di completamento automatico oppure null se minimumCoverage non è stato specificato nella richiesta.
value	AutocompleteItem[]	Elenco di elementi restituiti con completamento automatico.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.