Question Answering Projects - Get Synonyms

Service:

Azure AI Services

Version d'API:

2021-10-01

Obtient tous les synonymes d’un projet.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://< nom-ressource.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.
maxpagesize	query		integer (int32)	Nombre maximal de ressources à inclure dans une seule réponse.
skip	query		integer (int32)	Décalage dans la collection de la première ressource à retourner.
top	query		integer (int32)	Nombre maximal de ressources à retourner à partir de la collection.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Réponses

Nom	Type	Description
200 OK	SynonymAssets	Tous les synonymes d’un projet.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Successful query

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Toutes les ressources de synonymes pour ce projet.
WordAlterations	Collection de modifications de mots.

Error

Object

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

SynonymAssets

Object

Toutes les ressources de synonymes pour ce projet.

Nom	Type	Description
nextLink	string
value	WordAlterations[]	Collection de synonymes.

WordAlterations

Object

Collection de modifications de mots.

Nom	Type	Description
alterations	string[]	Collection de modifications de mots.