Question Answering Projects - Create Project

Service:: Azure AI Services

Version d'API:: 2023-04-01

Créer ou mettre à jour un projet.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?api-version=2023-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string (uri)	Point de terminaison Cognitive Services pris en charge (par exemple, https://< nom-ressource.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nom du projet.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
description	string	Description du projet.
language	string	Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
multilingualResource	boolean	Ressource activée pour plusieurs langages entre les projets ou non.
settings	ProjectSettings	Paramètres configurables du projet.

Réponses

Nom	Type	Description
200 OK	QuestionAnsweringProjectMetadata	La demande a réussi.
201 Created	QuestionAnsweringProjectMetadata	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

QuestionAnsweringProjectMetadata

La demande a réussi.

201 Created

QuestionAnsweringProjectMetadata

La requête a réussi et une nouvelle ressource a été créée en conséquence.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

Successful query

Exemple de requête

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1?api-version=2023-04-01

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Exemple de réponse

Code d’état:: 200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Code d’état:: 201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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.
ProjectSettings	Paramètres configurables du projet.
QuestionAnsweringProjectMetadata	Représente le projet.
QuestionAnsweringProjectMetadataCreateOrUpdate	Représente le projet.

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	Erreur de requête non valide
InvalidArgument	Erreur d’argument non valide
Unauthorized	Erreur d’accès non autorisé
Forbidden	Erreur d’accès interdit
NotFound	Erreur introuvable
ProjectNotFound	Erreur de projet introuvable
OperationNotFound	Erreur d’opération introuvable
AzureCognitiveSearchNotFound	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchIndexNotFound	Erreur introuvable dans l’index Recherche cognitive Azure
TooManyRequests	Trop d’erreurs de requêtes
AzureCognitiveSearchThrottling	Erreur de limitation de Recherche cognitive Azure
AzureCognitiveSearchIndexLimitReached	Erreur atteinte à la limite d’index Recherche cognitive Azure
InternalServerError	Erreur interne du serveur
ServiceUnavailable	Erreur d’indisponibilité du service
Timeout	Erreur de délai d’expiration
QuotaExceeded	Erreur de dépassement du quota
Conflict	Erreur de conflit
Warning	Erreur d’avertissement

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	Erreur de requête non valide
InvalidParameterValue	Erreur de valeur de paramètre non valide
KnowledgeBaseNotFound	Erreur introuvable dans la base de connaissances
AzureCognitiveSearchNotFound	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchThrottling	Erreur de limitation de Recherche cognitive Azure
ExtractionFailure	Erreur d’échec d’extraction
InvalidRequestBodyFormat	Erreur de format du corps de la demande non valide
EmptyRequest	Erreur de requête vide
MissingInputDocuments	Erreur des documents d’entrée manquants
InvalidDocument	Erreur de document non valide
ModelVersionIncorrect	Erreur incorrecte de version du modèle
InvalidDocumentBatch	Erreur de lot de documents non valide
UnsupportedLanguageCode	Erreur de code de langue non prise en charge
InvalidCountryHint	Erreur d’indicateur de pays non valide

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.

ProjectSettings

Object

Paramètres configurables du projet.

Nom	Type	Description
defaultAnswer	string	Réponse par défaut quand aucune bonne correspondance n’est trouvée dans la base de connaissances.

QuestionAnsweringProjectMetadata

Object

Représente le projet.

Nom	Type	Description
createdDateTime	string (date-time)	Date de création du projet.
description	string	Description du projet.
language	string	Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
lastDeployedDateTime	string (date-time)	Représente la date du dernier déploiement du projet.
lastModifiedDateTime	string (date-time)	Représente l’heure de la dernière modification du projet.
multilingualResource	boolean	Ressource activée pour plusieurs langages entre les projets ou non.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nom du projet.
settings	ProjectSettings	Paramètres configurables du projet.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

Représente le projet.

Nom	Type	Description
description	string	Description du projet.
language	string	Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
multilingualResource	boolean	Ressource activée pour plusieurs langages entre les projets ou non.
settings	ProjectSettings	Paramètres configurables du projet.

Partager via

Question Answering Projects - Create Project

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

OAuth2Auth

Étendues

Exemples

Successful query

Exemple de requête

Exemple de réponse

Définitions

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectSettings

QuestionAnsweringProjectMetadata

QuestionAnsweringProjectMetadataCreateOrUpdate