Question Answering Projects - Get Synonyms

Servizio:

Azure AI Services

Versione API:

2021-10-01

Ottiene tutti i sinonimi di un progetto.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01

Con parametri facoltativi:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'API client.
maxpagesize	query		integer (int32)	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer (int32)	Offset nella raccolta della prima risorsa da restituire.
top	query		integer (int32)	Numero massimo di risorse da restituire dalla raccolta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	SynonymAssets	Tutti i sinonimi di un progetto.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/synonyms?api-version=2021-10-01

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Tutti gli asset sinonimi per questo progetto.
WordAlterations	Raccolta di modifiche delle parole.

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

SynonymAssets

Object

Tutti gli asset sinonimi per questo progetto.

Nome	Tipo	Descrizione
nextLink	string
value	WordAlterations[]	Raccolta di sinonimi.

WordAlterations

Object

Raccolta di modifiche delle parole.

Nome	Tipo	Descrizione
alterations	string[]	Raccolta di modifiche delle parole.