Text Analysis Authoring - Create Project
The most basic operation that applies to a resource.
PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?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). |
project
|
path | True |
string |
The new project name. |
api-version
|
query | True |
string |
The API version to use for this operation. |
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 |
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 |
The project settings. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
201 Created |
The request has succeeded and a new resource has been created as a result. |
|
Other Status Codes |
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
Successful Create Project
Sample request
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"
}
Sample response
{
"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"
}
{
"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 |
---|---|
Create |
Represents the options used to create or update a project. |
Error |
The error object. |
Error |
Human-readable error code. |
Error |
Error response. |
Inner |
Human-readable error code. |
Inner |
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. |
Project |
|
Project |
Represents the settings used to define the project behavior. |
Text |
Represents the metadata of a 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 |
The project kind. |
|
projectName |
string |
The new project name. |
settings |
The project settings. |
|
storageInputContainerName |
string |
The storage container name. |
Error
The error object.
Name | Type | Description |
---|---|---|
code |
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 |
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 |
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 |
One of a server-defined set of error codes. |
|
details |
object |
Error details. |
innererror |
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. |
TextAnalysisAuthoringProjectMetadata
Represents the metadata of a project.
Name | Type | Description |
---|---|---|
createdDateTime |
string |
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 |
Represents the project last deployment datetime. |
lastModifiedDateTime |
string |
Represents the project last modification datetime. |
lastTrainedDateTime |
string |
Represents the project last training datetime. |
multilingual |
boolean |
Whether the project would be used for multiple languages or not. |
projectKind |
The project kind. |
|
projectName |
string |
The new project name. |
settings |
The project settings. |
|
storageInputContainerName |
string |
The storage container name. |