Microsoft Cognitive Language Service - Analyze Text Authoring (preview:2022-10-01)

2025/07/24 • 37 deleted methods

TextAnalysisAuthoring_ListProjects (removed)
Description :  Lists the existing projects.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects
{
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of projects. ,
Required: True ,
}
[
{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_CreateProject (removed)
Description :  Creates a new project or updates an existing one.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/analyze-text/projects/{projectName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The project parameters. ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetProject (removed)
Description :  Gets the details of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteProject (removed)
Description :  Deletes a project.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_Export (removed)
Description :  Triggers a job to export a project's data.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:export
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
assetKind:
{
Description: Kind of asset to export. ,
Required: False ,
}
string ,
trainedModelLabel:
{
Description: Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_Import (removed)
Description :  Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:import
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The project data to import. ,
Required: True ,
}
{
projectFileVersion:
{
Description: The version of the exported file. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Enum:
{
Utf16CodeUnit: 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. ,
}
,
Required: True ,
}
enum ,
metadata:
{
Description: Represents the project metadata. ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
assets:
{
Description: Represents the project assets. ,
Required: False ,
}
{
projectKind:
{
Description: The type of the project the assets belong to. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
format:
{
Description: The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_Train (removed)
Description :  Triggers a training job for a project.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:train
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The training input parameters. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents the output model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
evaluationOptions:
{
Description: Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20. ,
Required: False ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListDeployments (removed)
Description :  Lists the deployments belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of retrieved deployments. ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
assignedResources:
{
Description: Represents the metadata of the assigned Azure resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: Represents the Azure resource Id. ,
Required: True ,
}
string ,
region:
{
Description: Represents the resource region. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_SwapDeployments (removed)
Description :  Swaps two existing deployments with each other.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/:swap
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The job object to swap two deployments. ,
Required: True ,
}
{
firstDeploymentName:
{
Description: Represents the first deployment name. ,
Required: True ,
}
string ,
secondDeploymentName:
{
Description: Represents the second deployment name. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeployment (removed)
Description :  Gets the details of a deployment.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
assignedResources:
{
Description: Represents the metadata of the assigned Azure resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: Represents the Azure resource Id. ,
Required: True ,
}
string ,
region:
{
Description: Represents the resource region. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_DeployProject (removed)
Description :  Creates a new deployment or replaces an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The new deployment info. ,
Required: True ,
}
{
trainedModelLabel:
{
Description: Represents the trained model label. ,
Required: True ,
}
string ,
assignedResourceIds:
{
Description: Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteDeployment (removed)
Description :  Deletes a project deployment.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteDeploymentFromResources (removed)
Description :  Deletes a project deployment from the specified assigned resources.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The options for deleting the deployment. ,
Required: True ,
}
{
assignedResourceIds:
{
Description: Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus (removed)
Description :  Gets the status of an existing delete deployment from specific resources job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a deployment job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeploymentStatus (removed)
Description :  Gets the status of an existing deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a deployment job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetSwapDeploymentsStatus (removed)
Description :  Gets the status of an existing swap deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a deployment job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetExportStatus (removed)
Description :  Gets the status of an export job. Once job completes, returns the project metadata, and assets.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resultUrl:
{
Description: The URL to use in order to download the exported project. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetImportStatus (removed)
Description :  Gets the status for an import.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of an import job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainedModels (removed)
Description :  Lists the trained models belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of retrieved jobs. ,
Required: True ,
}
[
{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetTrainedModel (removed)
Description :  Gets the details of a trained model.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteTrainedModel (removed)
Description :  Deletes an existing trained model.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_LoadSnapshot (removed)
Description :  Restores the snapshot of this trained model to be the current working directory of the project.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetModelEvaluationResults (removed)
Description :  Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: THe list of documents evaluation results. ,
Required: True ,
}
[
{
location:
{
Description: Represents the document path. ,
Required: True ,
}
string ,
language:
{
Description: 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. ,
Required: True ,
}
string ,
projectKind:
{
Description: Represents the project kind. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetModelEvaluationSummary (removed)
Description :  Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
projectKind:
{
Description: Represents the project type that the evaluation ran on. ,
Enum:
{
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. ,
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. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
}
,
Required: True ,
}
enum ,
evaluationOptions:
{
Description: Represents the options used running the evaluation. ,
Required: True ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetLoadSnapshotStatus (removed)
Description :  Gets the status for loading a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of loading a snapshot job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListDeploymentResources (removed)
Description :  Lists the deployments resources assigned to the project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of assigned deployment resources. ,
Required: True ,
}
[
{
azureResourceId:
{
Description: The resource ID. ,
Required: True ,
}
string ,
region:
{
Description: The resource region. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_AssignDeploymentResources (removed)
Description :  Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/resources/:assign
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The new project resources info. ,
Required: True ,
}
{
resourcesMetadata:
{
Description: Represents the metadata for the resources to be assigned. ,
Required: True ,
}
[
{
azureResourceId:
{
Description: Represents the Azure resource ID. ,
Required: True ,
}
string ,
customDomain:
{
Description: Represents the Azure resource custom domain. ,
Required: True ,
}
string ,
region:
{
Description: Represents the Azure resource region. ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_UnassignDeploymentResources (removed)
Description :  Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/resources/:unassign
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The info for the deployment resources to be deleted. ,
Required: True ,
}
{
assignedResourceIds:
{
Description: Represents the assigned resource IDs to be unassigned. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the created job. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetAssignDeploymentResourcesStatus (removed)
Description :  Gets the status of an existing assign deployment resources job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a deployment resources job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetUnassignDeploymentResourcesStatus (removed)
Description :  Gets the status of an existing unassign deployment resources job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a deployment resources job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainingJobs (removed)
Description :  Lists the non-expired training jobs created for a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of jobs. ,
Required: True ,
}
[
{
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetTrainingStatus (removed)
Description :  Gets the status for a training job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_CancelTrainingJob (removed)
Description :  Triggers a cancellation for a running training job.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of the status API for monitoring the job cancellation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetProjectDeletionStatus (removed)
Description :  Gets the status for a project deletion job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/deletion-jobs/{jobId}
{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents the state of a project deletion job. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListAssignedResourceDeployments (removed)
Description :  Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/deployments/resources
{
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of retrieved assigned project deployments. ,
Required: True ,
}
[
{
projectName:
{
Description: Represents the project name. ,
Required: True ,
}
string ,
deploymentsMetadata:
{
Description: Represents the resource region. ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents the deployment name. ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_GetSupportedLanguages (removed)
Description :  Lists the supported languages.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/languages
{
projectKind:
{
Description: The project kind, default value is CustomSingleLabelClassification. ,
Required: False ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the languages. ,
Required: True ,
}
[
{
languageName:
{
Description: The language name. ,
Required: True ,
}
string ,
languageCode:
{
Description: The language code. This is BCP-47 representation of a language. For example, "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainingConfigVersions (removed)
Description :  Lists the support training config version for a given project type.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/training-config-versions
{
projectKind:
{
Description: The project kind. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the training config versions. ,
Required: True ,
}
[
{
trainingConfigVersion:
{
Description: Represents the version of the config. ,
Required: True ,
}
string ,
modelExpirationDate:
{
Description: Represents the training config version expiration date. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next page link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}