Documents - Suggest Get

Riferimento

Servizio:: Search Service

Versione API:: 2023-11-01

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

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

Con parametri facoltativi:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-11-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.
search	query	True	string	Testo di ricerca da usare per suggerire documenti. Deve essere composto da un minimo di 1 carattere e da un massimo di 100 caratteri.
suggesterName	query	True	string	Nome del suggeritore come specificato nell'insieme di suggeritori che fa parte della definizione dell'indice.
$filter	query		string	Espressione OData che filtra i documenti considerati per i suggerimenti.
$orderby	query		string[]	Elenco di espressioni di $orderby OData in base al quale 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'crescente o il desc per indicare la decrescente. Per impostazione predefinita, l'ordinamento è crescente. Le situazioni di parità di priorità vengono risolte in base ai punteggi di corrispondenza dei documenti. Se non viene specificata alcuna $orderby, l'ordine di ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
$select	query		string[]	Elenco di campi da recuperare. Se non specificato, solo il campo chiave verrà incluso nei risultati.
$top	query		integer int32	Numero di suggerimenti da recuperare. Il valore deve essere un numero compreso tra 1 e 100. Il valore predefinito è 5.
fuzzy	query		boolean	Valore che indica se usare la corrispondenza fuzzy per la query di suggerimenti. L'impostazione predefinita è false. Se impostato su true, la query troverà termini anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se questo offre un'esperienza migliore in alcuni scenari, si tratta di un costo di prestazioni come le query di suggerimenti fuzzy sono più lente e utilizzano più risorse.
highlightPostTag	query		string	Tag stringa accodato alle evidenziazioni di hit. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
highlightPreTag	query		string	Tag stringa prependato per l'evidenziazione. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
minimumCoverage	query		number double	Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di suggerimenti per poter segnalare la query come esito positivo. Questo parametro può essere utile per garantire la disponibilità di ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.
searchFields	query		string[]	Elenco dei nomi dei campi da cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.

Intestazione della richiesta

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

Risposte

Nome	Tipo	Descrizione
200 OK	SuggestDocumentsResult	Risposta contenente documenti suggeriti che corrispondono all'input parziale.
Other Status Codes	SearchError	Risposta di errore.

Esempio

SearchIndexSuggestDocumentsGet

Esempio di richiesta

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?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&api-version=2023-11-01

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
SearchError	Descrive una condizione di errore per l'API.
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.

SearchError

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
message	string	Rappresentazione leggibile dell'errore.

SuggestDocumentsResult

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

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

SuggestResult

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

Nome	Tipo	Descrizione
@search.text	string	Testo del risultato del suggerimento.

Condividi tramite