Text Analysis Authoring - Import

  • Reference
Service:
Cognitive Services - Language
API Version:
2023-04-01

Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.

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

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName
 path True

string

The name of the project to use.
api-version
 query True

string

Client API version.

Request Body

Name Required Type Description
metadata True

TextAnalysisAuthoringCreateProjectOptions

Represents the project metadata.
projectFileVersion True

string

The version of the exported file.
stringIndexType True

StringIndexType

Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.
assets TextAnalysisAuthoringExportedProjectAssets:

Represents the project assets.

Responses

Name Type Description
202 Accepted

A successful call results with an Operation-Location header used to check the status of the job.

Headers

operation-location: string
Other Status Codes

ErrorResponse

Error response.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

  • Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Import Project

Sample request

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
              }
            ]
          }
        ]
      }
    ]
  }
}

Sample response

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

Definitions

Name Description
Error

The error object.
ErrorCode

Human-readable error code.
ErrorResponse

Error response.
InnerErrorCode

Human-readable error code.
InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind

The project kind.
StringIndexType

Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions

Represents the options used to create or update a project.
TextAnalysisAuthoringExportedClass

Represents a class of an exported project.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Represents an exported document for a custom entity recognition project.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Represents the exported assets for a entity recognition project.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Represents an exported document of a custom multi-label classification project.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Represents the exported assets for a custom multi-label classification project.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Represents an exported document for a custom single-label classification project.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Represents the exported assets for a single-label classification project.
TextAnalysisAuthoringExportedDocumentClass

Represents a classification label for a document.
TextAnalysisAuthoringExportedDocumentEntityLabel

Represents an entity label for a document.
TextAnalysisAuthoringExportedDocumentRegion

Represents a region in a document for entity labeling.
TextAnalysisAuthoringExportedEntity

Represents an entity in an exported project.
TextAnalysisAuthoringExportedProject

Represents an exported project.
TextAnalysisAuthoringProjectSettings

Represents the settings used to define the project behavior.

Error

The error object.

Name Type Description
code

ErrorCode

One of a server-defined set of error codes.
details

Error[]

An array of details about specific errors that led to this reported error.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

ErrorCode

Human-readable error code.

Name 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

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Human-readable error code.

Name 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

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

InnerErrorCode

One of a server-defined set of error codes.
details

object

Error details.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

Error message.
target

string

Error target.

ProjectKind

The project kind.

Name Type Description
CustomEntityRecognition

string

For building an extraction model to identify your domain categories using your own data.
CustomMultiLabelClassification

string

For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C.
CustomSingleLabelClassification

string

For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B.

StringIndexType

Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.

Name Type Description
Utf16CodeUnit

string

The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Represents the options used to create or update a project.

Name Type Description
description

string

The project description.
language

string

The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
multilingual

boolean

Whether the project would be used for multiple languages or not.
projectKind

ProjectKind

The project kind.
projectName

string

The new project name.
settings

TextAnalysisAuthoringProjectSettings

The project settings.
storageInputContainerName

string

The storage container name.

TextAnalysisAuthoringExportedClass

Represents a class of an exported project.

Name Type Description
category

string

The class category.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Represents an exported document for a custom entity recognition project.

Name Type Description
dataset

string

The dataset for this document. Allowed values are 'Train' and 'Test'.
entities

TextAnalysisAuthoringExportedDocumentRegion[]

The list of entity labels belonging to the document.
language

string

Represents the document language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
location

string

The location of the document in the storage.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Represents the exported assets for a entity recognition project.

Name Type Description
documents

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]

The list of documents belonging to the project.
entities

TextAnalysisAuthoringExportedEntity[]

The list of entities belonging to the project.
projectKind string:

CustomEntityRecognition

The type of the project the assets belong to.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Represents an exported document of a custom multi-label classification project.

Name Type Description
classes

TextAnalysisAuthoringExportedDocumentClass[]

The document classes.
dataset

string

The dataset for this document. Allowed values are 'Train' and 'Test'.
language

string

Represents the document language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
location

string

The location of the document in the storage.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Represents the exported assets for a custom multi-label classification project.

Name Type Description
classes

TextAnalysisAuthoringExportedClass[]

The list of classes in the project.
documents

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]

The list of documents in the project.
projectKind string:

CustomMultiLabelClassification

The type of the project the assets belong to.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Represents an exported document for a custom single-label classification project.

Name Type Description
class

TextAnalysisAuthoringExportedDocumentClass

The class of the documents.
dataset

string

The dataset for this document. Allowed values are 'Train' and 'Test'.
language

string

Represents the document language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
location

string

The location of the document in the storage.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Represents the exported assets for a single-label classification project.

Name Type Description
classes

TextAnalysisAuthoringExportedClass[]

The list of classes belonging to this project.
documents

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]

The list of documents belonging to this project.
projectKind string:

CustomSingleLabelClassification

The type of the project the assets belong to.

TextAnalysisAuthoringExportedDocumentClass

Represents a classification label for a document.

Name Type Description
category

string

TextAnalysisAuthoringExportedDocumentEntityLabel

Represents an entity label for a document.

Name Type Description
category

string

The entity category.
length

integer

Length for the entity text.
offset

integer

Start position for the entity text.

TextAnalysisAuthoringExportedDocumentRegion

Represents a region in a document for entity labeling.

Name Type Description
labels

TextAnalysisAuthoringExportedDocumentEntityLabel[]

The list of entity labels belonging to this region.
regionLength

integer

Length for the region text.
regionOffset

integer

Start position for the region.

TextAnalysisAuthoringExportedEntity

Represents an entity in an exported project.

Name Type Description
category

string

The entity category.

TextAnalysisAuthoringExportedProject

Represents an exported project.

Name Type Description
assets TextAnalysisAuthoringExportedProjectAssets:

Represents the project assets.
metadata

TextAnalysisAuthoringCreateProjectOptions

Represents the project metadata.
projectFileVersion

string

The version of the exported file.
stringIndexType

StringIndexType

Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.

TextAnalysisAuthoringProjectSettings

Represents the settings used to define the project behavior.

Name Type Description
confidenceThreshold

number

The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive.