Partager via

Text Analysis Authoring - Import

  • Référence
Service:
Azure AI Services
Version d'API:
2023-04-01

Déclenche un travail pour importer un projet. Si un projet portant le même nom existe déjà, les données de ce projet sont remplacées.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?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

Nom du projet à utiliser.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
metadata True

CreateProjectOptions

Représente les métadonnées du projet.
projectFileVersion True

string

Version du fichier exporté.
stringIndexType True

StringIndexType

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
assets ExportedProjectAssets:

Représente les ressources du projet.

Réponses

Nom Type Description
202 Accepted

La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.

En-têtes

Operation-Location: string
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

SuccessfulImportProject

Exemple de requête

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

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "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"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

Exemple de réponse

Code d’état:
202 
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Définitions

Nom Description
CreateProjectOptions

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

Objet d’erreur.
ErrorCode

Code d’erreur lisible par l’homme.
ErrorResponse

Réponse d’erreur.
ExportedProject

Représente un projet exporté.
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.
StringIndexType
TextAnalysisAuthoringExportedClass

Représente une classe d’un projet exporté.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Représente un document exporté pour un projet de reconnaissance d’entité personnalisé.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Représente les ressources exportées pour un projet de reconnaissance d’entité.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Représente un document exporté d’un projet de classification multi-étiquette personnalisé.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Représente les ressources exportées pour un projet de classification multi-étiquette personnalisé.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Représente un document exporté pour un projet de classification d’étiquette unique personnalisé.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Représente les ressources exportées pour un projet de classification à étiquette unique.
TextAnalysisAuthoringExportedDocumentClass

Représente une étiquette de classification pour un document.
TextAnalysisAuthoringExportedDocumentEntityLabel

Représente une étiquette d’entité pour un document.
TextAnalysisAuthoringExportedDocumentEntityRegion

Représente une région dans un document pour l’étiquetage d’entité.
TextAnalysisAuthoringExportedEntity

Représente une entité dans un projet exporté.

CreateProjectOptions

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.

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.

ExportedProject

Représente un projet exporté.

Nom Type Description
assets ExportedProjectAssets:

Représente les ressources du projet.
metadata

CreateProjectOptions

Représente les métadonnées du projet.
projectFileVersion

string

Version du fichier exporté.
stringIndexType

StringIndexType

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

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.

StringIndexType

Nom Type Description
Utf16CodeUnit

string

Les valeurs de décalage et de longueur correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple JavaScript.

TextAnalysisAuthoringExportedClass

Représente une classe d’un projet exporté.

Nom Type Description
category

string

Catégorie de classe.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Représente un document exporté pour un projet de reconnaissance d’entité personnalisé.

Nom Type Description
dataset

string

Jeu de données de ce document. Les valeurs autorisées sont « Train » et « Test ».
entities

TextAnalysisAuthoringExportedDocumentEntityRegion[]

Liste des étiquettes d’entité appartenant au document.
language

string

Représente la langue du document. 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.
location

string

Emplacement du document dans le stockage.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Représente les ressources exportées pour un projet de reconnaissance d’entité.

Nom Type Description
documents

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]

Liste des documents appartenant au projet.
entities

TextAnalysisAuthoringExportedEntity[]

Liste des entités appartenant au projet.
projectKind string:

CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Représente un document exporté d’un projet de classification multi-étiquette personnalisé.

Nom Type Description
classes

TextAnalysisAuthoringExportedDocumentClass[]

Classes de document.
dataset

string

Jeu de données de ce document. Les valeurs autorisées sont « Train » et « Test ».
language

string

Représente la langue du document. 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.
location

string

Emplacement du document dans le stockage.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Représente les ressources exportées pour un projet de classification multi-étiquette personnalisé.

Nom Type Description
classes

TextAnalysisAuthoringExportedClass[]

Liste des classes dans le projet.
documents

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]

Liste des documents dans le projet.
projectKind string:

CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Représente un document exporté pour un projet de classification d’étiquette unique personnalisé.

Nom Type Description
class

TextAnalysisAuthoringExportedDocumentClass

Classe des documents.
dataset

string

Jeu de données de ce document. Les valeurs autorisées sont « Train » et « Test ».
language

string

Représente la langue du document. 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.
location

string

Emplacement du document dans le stockage.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Représente les ressources exportées pour un projet de classification à étiquette unique.

Nom Type Description
classes

TextAnalysisAuthoringExportedClass[]

Liste des classes appartenant à ce projet.
documents

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]

Liste des documents appartenant à ce projet.
projectKind string:

CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Représente une étiquette de classification pour un document.

Nom Type Description
category

string

TextAnalysisAuthoringExportedDocumentEntityLabel

Représente une étiquette d’entité pour un document.

Nom Type Description
category

string

Catégorie d’entité.
length

integer

Longueur du texte de l’entité.
offset

integer

Position de début du texte de l’entité.

TextAnalysisAuthoringExportedDocumentEntityRegion

Représente une région dans un document pour l’étiquetage d’entité.

Nom Type Description
labels

TextAnalysisAuthoringExportedDocumentEntityLabel[]

Liste des étiquettes d’entité appartenant à cette région.
regionLength

integer

Longueur du texte de la région.
regionOffset

integer

Position de début de la région.

TextAnalysisAuthoringExportedEntity

Représente une entité dans un projet exporté.

Nom Type Description
category

string

Catégorie d’entité.