Documents - Autocomplete Post

Riferimento

Servizio:: Search Service

Versione API:: 2024-07-01

Completamento automatico di termini di query incompleti in base al testo di input e ai termini corrispondenti nell'indice.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
indexName	path	True	string	Nome dell'indice.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	ID di rilevamento inviato con la richiesta per facilitare il debug.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
search	True	string	Testo di ricerca su cui basare i risultati del completamento automatico.
suggesterName	True	string	Nome del suggerimento come specificato nell'insieme di suggerimenti che fa parte della definizione dell'indice.
autocompleteMode		AutocompleteMode	Specifica la modalità per completamento automatico. Il valore predefinito è "oneTerm". Usare "twoTerms" per ottenere glishingles e "oneTermWithContext" per usare il contesto corrente durante la produzione di termini completati automaticamente.
filter		string	Espressione OData che filtra i documenti utilizzati per produrre termini completati per il risultato del completamento automatico.
fuzzy		boolean	Valore che indica se utilizzare la corrispondenza fuzzy per la query di completamento automatico. Il valore predefinito è false. Se impostato su true, la query esegue il completamento automatico dei termini anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le query di completamento automatico fuzzy sono più lente e consumano più risorse.
highlightPostTag		string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei passaggi è disabilitata.
highlightPreTag		string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei passaggi è disabilitata.
minimumCoverage		number	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		string	Elenco delimitato da virgole di nomi di campo da considerare quando si eseguono query per i termini completati automaticamente. I campi di destinazione devono essere inclusi nel suggerimento specificato.
top		integer	Numero di termini completati automaticamente da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è 5.

Risposte

Nome	Tipo	Descrizione
200 OK	AutocompleteResult	Risposta contenente i termini di query suggeriti che completano l'input parziale.
Other Status Codes	ErrorResponse	Risposta di errore.

Esempio

SearchIndexAutocompleteDocumentsPost

Esempio di richiesta

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-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
}

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
AutocompleteItem	Risultato delle richieste di completamento automatico.
AutocompleteMode	Specifica la modalità per completamento automatico. Il valore predefinito è "oneTerm". Usare "twoTerms" per ottenere lo shingles e "oneTermWithContext" per usare il contesto corrente nella produzione di termini di completamento automatico.
AutocompleteRequest	Parametri per la corrispondenza fuzzy e altri comportamenti di query 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

AutocompleteItem

Risultato delle richieste di completamento automatico.

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

AutocompleteMode

Specifica la modalità per completamento automatico. Il valore predefinito è "oneTerm". Usare "twoTerms" per ottenere lo shingles e "oneTermWithContext" per usare il contesto corrente nella produzione di termini di completamento automatico.

Nome	Tipo	Descrizione
oneTerm	string	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 "medicine".
oneTermWithContext	string	Completa l'ultimo termine di una query con due o più termini, in cui 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".
twoTerms	string	Verrà suggerita la corrispondenza di frasi a due termini nell'indice. Ad esempio, se l'input è "medico", i termini suggeriti potrebbero includere "copertura medicare" e "assistente medico".

AutocompleteRequest

Parametri per la corrispondenza fuzzy e altri comportamenti di query di completamento automatico.

Nome	Tipo	Descrizione
autocompleteMode	AutocompleteMode	Specifica la modalità per completamento automatico. Il valore predefinito è "oneTerm". Usare "twoTerms" per ottenere glishingles e "oneTermWithContext" per usare il contesto corrente durante la produzione di termini completati automaticamente.
filter	string	Espressione OData che filtra i documenti utilizzati per produrre termini completati per il risultato del completamento automatico.
fuzzy	boolean	Valore che indica se utilizzare la corrispondenza fuzzy per la query di completamento automatico. Il valore predefinito è false. Se impostato su true, la query esegue il completamento automatico dei termini anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le query di completamento automatico fuzzy sono più lente e consumano più risorse.
highlightPostTag	string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei passaggi è disabilitata.
highlightPreTag	string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei passaggi è disabilitata.
minimumCoverage	number	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.
search	string	Testo di ricerca su cui basare i risultati del completamento automatico.
searchFields	string	Elenco delimitato da virgole di nomi di campo da considerare quando si eseguono query per i termini completati automaticamente. I campi di destinazione devono essere inclusi nel suggerimento specificato.
suggesterName	string	Nome del suggerimento come specificato nell'insieme di suggerimenti che fa parte della definizione dell'indice.
top	integer	Numero di termini completati automaticamente da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è 5.

AutocompleteResult

Risultato della query di completamento automatico.

Nome	Tipo	Descrizione
@search.coverage	number	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

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

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

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Condividi tramite