Microsoft Cognitive Language Service - Text Analysis (preview:2022-05-15)

2025/07/24 • 4 deleted methods

AnalyzeText (removed)
Description :  Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.
Reference :  Link ¶

⚼ Request

POST:  /:analyze-text
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
showStats:
{
Description: (Optional) if set to true, response will contain request and document level statistics. ,
Required: False ,
}
boolean ,
body:
{
Description: Collection of documents to analyze and a single task to execute. ,
Required: True ,
}
{
kind:
{
Description: Enumeration of supported Text Analysis tasks. ,
Enum:
{
SentimentAnalysis: No description available. ,
EntityRecognition: No description available. ,
PiiEntityRecognition: No description available. ,
KeyPhraseExtraction: No description available. ,
LanguageDetection: No description available. ,
EntityLinking: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Enumeration of supported Text Analysis task results. ,
Enum:
{
SentimentAnalysisResults: No description available. ,
EntityRecognitionResults: No description available. ,
PiiEntityRecognitionResults: No description available. ,
KeyPhraseExtractionResults: No description available. ,
LanguageDetectionResults: No description available. ,
EntityLinkingResults: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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 ,
}
,
}
,
}
AnalyzeText_SubmitJob (removed)
Description :  Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /analyze-text/jobs
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
body:
{
Description: Collection of documents to analyze and one or more tasks to execute. ,
Required: True ,
}
{
displayName:
{
Description: Optional display name for the analysis job. ,
Required: False ,
}
string ,
analysisInput:
{
Required: True ,
}
{
documents:
{
Required: False ,
}
[
{
id:
{
Description: A unique, non-empty document identifier. ,
Required: True ,
}
string ,
text:
{
Description: The input text to process. ,
Required: True ,
}
string ,
language:
{
Description: (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tasks:
{
Description: The set of tasks to execute on the input documents. ,
Required: True ,
}
[
{
kind:
{
Description: Enumeration of supported long-running Text Analysis tasks. ,
Enum:
{
SentimentAnalysis: No description available. ,
EntityRecognition: No description available. ,
PiiEntityRecognition: No description available. ,
KeyPhraseExtraction: No description available. ,
EntityLinking: No description available. ,
Healthcare: No description available. ,
ExtractiveSummarization: No description available. ,
CustomEntityRecognition: No description available. ,
CustomSingleLabelClassification: No description available. ,
CustomMultiLabelClassification: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location: 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 ,
}
,
}
,
}
AnalyzeText_JobStatus (removed)
Description :  Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.
Reference :  Link ¶

⚼ Request

GET:  /analyze-text/jobs/{jobId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
jobId:
{
Description: Job ID ,
Format: uuid ,
Required: True ,
}
string ,
showStats:
{
Description: (Optional) if set to true, response will contain request and document level statistics. ,
Required: False ,
}
boolean ,
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 ,
}

⚐ Response (200)

{
$schema: 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 ,
}
,
}
,
}
AnalyzeText_CancelJob (removed)
Description :  Cancel a long-running Text Analysis job.
Reference :  Link ¶

⚼ Request

POST:  /analyze-text/jobs/{jobId}:cancel
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
jobId:
{
Description: Job ID ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location: 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 ,
}
,
}
,
}