Get Synonym Map (API REST Ricerca cognitiva di Azure)

  • Articolo
  • 2 minuti per la lettura

L'operazione Get Synonym Map ottiene la definizione della mappa sinonimo da Ricerca cognitiva di Azure.

GET https://[service name].search.windows.net/synonymmaps/[synonymmap name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

Parametri dell'URI

Parametro Descrizione
nome servizio Obbligatorio. Impostare questo valore sul nome univoco definito dall'utente del servizio di ricerca.
nome mappa sinonimo Obbligatorio. L'URI della richiesta specifica il nome della mappa sinonimo da restituire.
api-version Obbligatorio. La versione stabile corrente è api-version=2020-06-30. Per altre versioni, vedere Versioni API .

Intestazioni richiesta

La tabella seguente descrive le intestazioni della richiesta obbligatorie e facoltative.

Campi Descrizione
Content-Type Obbligatorio. Impostare il valore su application/json
api-key Obbligatorio. La chiave API viene usata per autenticare la richiesta all'servizio di ricerca. È un valore stringa univoco per il servizio. Ottenere richieste per una definizione dell'oggetto nel servizio deve includere un campo chiave API impostato sulla chiave di amministrazione , anziché una chiave di query. È possibile trovare la chiave API nel dashboard del servizio di ricerca nella portale di Azure.

Corpo della richiesta

Nessuno.

Risposta

Se la risposta ha esito positivo, viene restituito il codice di stato 200 OK.

La risposta è simile agli esempi in Create Synonym Map (Ricerca cognitiva di Azure API REST).

{
    "name" : "synonymmap1",  
    "format" : "solr",  
    "synonyms" : "United States, United States of America, USA\n
    Washington, Wash. => WA",
    "encryptionKey": null
}

Nota

Se la mappa sinonimia ha una chiave di crittografia, il servizio di ricerca deve avere accesso alla chiave di crittografia per recuperare la definizione della mappa sinonimo. Senza accesso alla chiave di crittografia, viene restituita una richiesta non valida 400. Il ripristino dell'accesso alla chiave consente al servizio di ricerca di recuperare nuovamente la definizione della mappa sinonimo.

Vedi anche