Share via

Text Analysis Authoring - Create Project

  • Reference
Service:
Azure AI Services
API Version:
2022-05-01

Creates a new project or updates an existing one.

PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2022-05-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

maxLength: 100

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

string

Client API version.

Request Header

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

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

A subscription key for a Language service resource.

Request Body

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

Name Required Type Description
language True

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.
projectKind True

ProjectKind

The project kind.
projectName True

string

The new project name.
storageInputContainerName True

string

The storage container name.
description

string

The project description.
multilingual

boolean

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

object

The project settings.

Responses

Name Type Description
200 OK

TextAnalysisAuthoringProjectMetadata

The metadata of the updated project, if it already exists.
201 Created

TextAnalysisAuthoringProjectMetadata

The metadata of the created project.
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Create Project

Sample request

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2022-05-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"
}

Sample response

Status code:
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"
}
Status code:
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"
}

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.
TextAnalysisAuthoringCreateProjectOptions

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

Represents the metadata of a project.

Error

Object

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

Enumeration

Human-readable error code.

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

ErrorResponse

Object

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

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

Enumeration

The project kind.

Value Description
CustomEntityRecognition

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

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

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.

TextAnalysisAuthoringCreateProjectOptions

Object

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

object

The project settings.
storageInputContainerName

string

The storage container name.

TextAnalysisAuthoringProjectMetadata

Object

Represents the metadata of a project.

Name Type Description
createdDateTime

string (date-time)

Represents the project creation datetime.
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.
lastDeployedDateTime

string (date-time)

Represents the project last deployment datetime.
lastModifiedDateTime

string (date-time)

Represents the project last modification datetime.
lastTrainedDateTime

string (date-time)

Represents the project last training datetime.
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

object

The project settings.
storageInputContainerName

string

The storage container name.