Documents - Suggest Post

  • Riferimento
Servizio:
Search Service
Versione API:
2024-07-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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 da usare per suggerire documenti. Deve essere almeno 1 carattere e non più di 100 caratteri.
suggesterName True

string

Nome del suggerimento come specificato nell'insieme di suggerimenti che fa parte della definizione dell'indice.
filter

string

Espressione OData che filtra i documenti considerati per i suggerimenti.
fuzzy

boolean

Valore che indica se utilizzare la corrispondenza fuzzy per la query di suggerimento. Il valore predefinito è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se questo offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le ricerche di suggerimenti 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 suggerimenti è disabilitata.
highlightPreTag

string

Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
minimumCoverage

number

Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di suggerimento 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.
orderby

string

Elenco delimitato da virgole di espressioni OData $orderby 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 un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
searchFields

string

Elenco delimitato da virgole di nomi di campo in cui cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.
select

string

Elenco delimitato da virgole di campi da recuperare. Se non specificato, nei risultati verrà incluso solo il campo chiave.
top

integer

Numero di suggerimenti da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è 5.

Risposte

Nome Tipo Descrizione
200 OK

SuggestDocumentsResult

Risposta contenente documenti suggeriti che corrispondono all'input parziale.
Other Status Codes

ErrorResponse

Risposta di errore.

Esempio

SearchIndexSuggestDocumentsPost

Esempio di richiesta

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "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
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
SuggestDocumentsResult

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

Parametri per il filtro, l'ordinamento, la corrispondenza fuzzy e altri comportamenti di query di suggerimenti.
SuggestResult

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

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.

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 oppure null se minimumCoverage non è stato impostato nella richiesta.
value

SuggestResult[]

Sequenza di risultati restituiti dalla query.

SuggestRequest

Parametri per il filtro, l'ordinamento, la corrispondenza fuzzy e altri comportamenti di query di suggerimenti.

Nome Tipo Descrizione
filter

string

Espressione OData che filtra i documenti considerati per i suggerimenti.
fuzzy

boolean

Valore che indica se utilizzare la corrispondenza fuzzy per la query di suggerimento. Il valore predefinito è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se questo offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le ricerche di suggerimenti 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 suggerimenti è disabilitata.
highlightPreTag

string

Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
minimumCoverage

number

Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di suggerimento 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.
orderby

string

Elenco delimitato da virgole di espressioni OData $orderby 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 un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
search

string

Testo di ricerca da usare per suggerire documenti. Deve essere almeno 1 carattere e non più di 100 caratteri.
searchFields

string

Elenco delimitato da virgole di nomi di campo in cui cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.
select

string

Elenco delimitato da virgole di campi da recuperare. Se non specificato, nei risultati verrà incluso solo il campo chiave.
suggesterName

string

Nome del suggerimento come specificato nell'insieme di suggerimenti che fa parte della definizione dell'indice.
top

integer

Numero di suggerimenti da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è 5.

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.