Documents - Suggest Get

Servizio:: Search Service

Versione API:: 2025-11-01-preview

Suggerisce i documenti nell'indice che corrispondono al testo della query parziale specificato.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}

Con parametri facoltativi:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$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	Testo di ricerca da usare per suggerire documenti. Deve essere almeno 1 carattere e non più di 100 caratteri.
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 considerati per i suggerimenti.
$orderby	query		string[]	L'elenco di OData $orderby espressioni in base alle quali ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare l'ascendente o desc per indicare l'ascendente. Il valore predefinito è l'ordine crescente. I pareggi saranno risolti dai punteggi dei documenti. Se non viene specificata alcuna $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Ci possono essere al massimo 32 $orderby clausole.
$select	query		string[]	L'elenco dei campi da recuperare. Se non specificato, nei risultati verrà incluso solo il campo chiave.
$top	query		integer (int32)	Il numero di suggerimenti da recuperare. Il valore deve essere un numero compreso tra 1 e 100. L'impostazione predefinita è 5.
fuzzy	query		boolean	Valore che indica se utilizzare la corrispondenza fuzzy per la query dei suggerimenti. 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 suggerimenti fuzzy sono più lente e utilizzano più risorse.
highlightPostTag	query		string	Un tag stringa che viene aggiunto per colpire le evidenziazioni. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
highlightPreTag	query		string	Un tag stringa anteposto per colpire le evidenziazioni. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è 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 suggerimenti 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[]	Elenco di nomi di campi per la ricerca del testo di ricerca specificato. 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	SuggestDocumentsResult	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

SearchIndexSuggestDocumentsGet

Esempio di richiesta

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2025-11-01-preview&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
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.
SuggestDocumentsResult	Risposta contenente i risultati della query di suggerimento da un indice.
SuggestResult	Risultato contenente un documento trovato da una query di suggerimento, oltre ai metadati associati.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=none

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.

SuggestDocumentsResult

Oggetto

Risposta contenente i risultati della query di suggerimento da un indice.

Nome	Tipo	Descrizione
@search.coverage	number (double)	Valore che indica la percentuale dell'indice inclusa nella query oppure null se minimumCoverage non è stato impostato nella richiesta.
value	SuggestResult[]	Sequenza di risultati restituiti dalla query.

SuggestResult

Oggetto

Risultato contenente un documento trovato da una query di suggerimento, oltre ai metadati associati.

Nome	Tipo	Descrizione
@search.text	string	Il testo del risultato del suggerimento.