Text Analysis Authoring - Import

Service:

Azure AI Services

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 url	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	The API version to use for this operation.

Request Body

Name	Required	Type	Description
metadata	True	CreateProjectOptions	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		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Represents the project assets.

Responses

Name	Type	Description
202 Accepted		The request has been accepted for processing, but processing has not yet completed. Headers Operation-Location: string
Other Status Codes	ErrorResponse	An unexpected error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Examples

SuccessfulImportProject

Sample request

HTTP

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
CreateProjectOptions	Represents the options used to create or update a project.
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
ExportedProject	Represents an exported project.
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
ProjectSettings	Represents the settings used to define the project behavior.
StringIndexType
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.
TextAnalysisAuthoringExportedDocumentEntityRegion	Represents a region in a document for entity labeling.
TextAnalysisAuthoringExportedEntity	Represents an entity in an exported project.

CreateProjectOptions

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	ProjectSettings	The project settings.
storageInputContainerName	string	The storage container name.

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.

ExportedProject

Represents an exported project.

Name	Type	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Represents the project assets.
metadata	CreateProjectOptions	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.

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

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.

ProjectSettings

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.

StringIndexType

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.

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	TextAnalysisAuthoringExportedDocumentEntityRegion[]	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

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

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

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.

TextAnalysisAuthoringExportedDocumentEntityRegion

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.