Text Analysis Authoring - Create Project

Service:

Azure AI Services

Version d'API:

2023-04-01

Opération la plus simple qui s’applique à une ressource.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string url	Point de terminaison Cognitive Services pris en charge, par exemple, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Nouveau nom du projet.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Media Types: "application/merge-patch+json"

Nom	Obligatoire	Type	Description
language	True	string	Langue du projet. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
projectKind	True	ProjectKind	Type de projet.
projectName	True	string	Nouveau nom du projet.
storageInputContainerName	True	string	Nom du conteneur de stockage.
description		string	Description du projet.
multilingual		boolean	Indique si le projet serait utilisé pour plusieurs langues ou non.
settings		ProjectSettings	Paramètres du projet.

Réponses

Nom	Type	Description
200 OK	TextAnalysisAuthoringProjectMetadata	La demande a réussi.
201 Created	TextAnalysisAuthoringProjectMetadata	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.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

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

Exemples

Successful Create Project

Exemple de requête

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

Exemple de réponse

Code d’état:

201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

Code d’état:

200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "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.
ProjectKind
ProjectSettings	Représente les paramètres utilisés pour définir le comportement du projet.
TextAnalysisAuthoringCreateProjectOptions	Représente les options utilisées pour créer ou mettre à jour un projet.
TextAnalysisAuthoringProjectMetadata	Représente les métadonnées d’un projet.

Error

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

Code d’erreur lisible par l’homme.

Nom	Type	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

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.

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.

ProjectKind

Nom	Type	Description
CustomEntityRecognition	string	Pour créer un modèle d’extraction pour identifier vos catégories de domaine à l’aide de vos propres données.
CustomMultiLabelClassification	string	Pour créer un modèle de classification pour classifier du texte à l’aide de vos propres données. Chaque fichier peut avoir une ou plusieurs étiquettes. Par exemple, le fichier 1 est classé comme A, B et C et le fichier 2 est classé en tant que B et C.
CustomSingleLabelClassification	string	Pour créer un modèle de classification pour classifier du texte à l’aide de vos propres données. Chaque fichier n’aura qu’une seule étiquette. Par exemple, le fichier 1 est classé comme A et le fichier 2 est classé comme B.

ProjectSettings

Représente les paramètres utilisés pour définir le comportement du projet.

Nom	Type	Description
confidenceThreshold	number	Seuil de la classe avec la confiance la plus élevée, auquel la prédiction sera automatiquement remplacée par « Aucun ». La valeur du seuil doit être comprise entre 0 et 1 inclus.

TextAnalysisAuthoringCreateProjectOptions

Représente les options utilisées pour créer ou mettre à jour un projet.

Nom	Type	Description
description	string	Description du projet.
language	string	Langue du projet. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
multilingual	boolean	Indique si le projet serait utilisé pour plusieurs langues ou non.
projectKind	ProjectKind	Type de projet.
projectName	string	Nouveau nom du projet.
settings	ProjectSettings	Paramètres du projet.
storageInputContainerName	string	Nom du conteneur de stockage.

TextAnalysisAuthoringProjectMetadata

Représente les métadonnées d’un projet.

Nom	Type	Description
createdDateTime	string	Représente la date de création du projet.
description	string	Description du projet.
language	string	Langue du projet. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
lastDeployedDateTime	string	Représente le dernier date de déploiement du projet.
lastModifiedDateTime	string	Représente la date de dernière modification du projet.
lastTrainedDateTime	string	Représente le dernier datetime de formation du projet.
multilingual	boolean	Indique si le projet serait utilisé pour plusieurs langues ou non.
projectKind	ProjectKind	Type de projet.
projectName	string	Nouveau nom du projet.
settings	ProjectSettings	Paramètres du projet.
storageInputContainerName	string	Nom du conteneur de stockage.