你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Analyze - Analyze

提交分析作业
提交用于分析的文本文档的集合。 指定一个或多个要执行的唯一任务。

POST {Endpoint}/text/analytics/v3.1-preview.4/analyze

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点 (协议和主机名,例如: https://westus.api.cognitive.microsoft.com) 。

请求头

Media Types: "application/json", "text/json"

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

请求正文

Media Types: "application/json", "text/json"

Name Required Type Description
analysisInput True

包含一组要由服务分析的输入文档。

tasks True

要对输入文档执行的任务集。 不能多次指定同一任务。

displayName
  • string

分析作业的可选显示名称。

响应

Name Type Description
202 Accepted

具有用于检查分析作业状态的Operation-Location标头的成功调用结果。

Media Types: "application/json", "text/json"

Headers

  • Operation-Location: string
400 Bad Request

错误的请求。

Media Types: "application/json", "text/json"

500 Internal Server Error

内部错误响应

Media Types: "application/json", "text/json"

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful Submit analysis job request

Sample Request

POST {Endpoint}/text/analytics/v3.1-preview.4/analyze

Sample Response

Operation-Location: {endpoint}/text/analytics/v3.1-preview.4/analyze/jobs/{jobId}
{
  "error": {
    "code": "InvalidRequest",
    "message": "Invalid Request.",
    "innererror": {
      "code": "MissingInputRecords",
      "message": "Missing input records."
    }
  }
}
{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error"
  }
}

定义

AnalyzeBatchInput
EntitiesTask
EntityLinkingTask
ErrorCodeValue

错误代码。

ErrorResponse
InnerError
InnerErrorCodeValue

错误代码。

KeyPhrasesTask
MultiLanguageBatchInput

包含一组要由服务分析的输入文档。

MultiLanguageInput

包含要由服务分析的输入文档。

Parameters
PiiTask
StringIndexType
Tasks

要对输入文档执行的任务集。 不能多次指定同一任务。

TextAnalyticsError

AnalyzeBatchInput

Name Type Description
analysisInput

包含一组要由服务分析的输入文档。

displayName
  • string

分析作业的可选显示名称。

tasks

要对输入文档执行的任务集。 不能多次指定同一任务。

EntitiesTask

Name Type Description
parameters

EntityLinkingTask

Name Type Description
parameters

ErrorCodeValue

错误代码。

Name Type Description
InternalServerError
  • string
InvalidArgument
  • string
InvalidRequest
  • string
NotFound
  • string
ServiceUnavailable
  • string

ErrorResponse

Name Type Description
error

文档错误。

InnerError

Name Type Description
code

错误代码。

details
  • object

错误详细信息。

innererror

内部错误包含更具体的信息。

message
  • string

错误消息。

target
  • string

错误目标。

InnerErrorCodeValue

错误代码。

Name Type Description
EmptyRequest
  • string
InvalidCountryHint
  • string
InvalidDocument
  • string
InvalidDocumentBatch
  • string
InvalidParameterValue
  • string
InvalidRequestBodyFormat
  • string
MissingInputRecords
  • string
ModelVersionIncorrect
  • string
UnsupportedLanguageCode
  • string

KeyPhrasesTask

Name Type Description
parameters

MultiLanguageBatchInput

包含一组要由服务分析的输入文档。

Name Type Description
documents

要作为此批处理的一部分处理的文档集。

MultiLanguageInput

包含要由服务分析的输入文档。

Name Type Description
id
  • string

唯一的非空文档标识符。

language
  • string

(可选) 这是语言的 2 个字母 ISO 639-1 表示形式。 例如,对英语使用“en”;“es”用于西班牙语等。如果未设置,请使用“en”作为默认值英语。

text
  • string

要处理的输入文本。

Parameters

Name Type Default Value Description
model-version
  • string
latest
stringIndexType TextElements_v8

PiiTask

Name Type Description
parameters

StringIndexType

Name Type Description
TextElements_v8
  • string

返回的偏移量和长度值将对应于 TextElements (Graphemes 和 Grapheme 群集,) 确认 Unicode 8.0.0 标准。 如果使用 .Net Framework 或 .Net Core 编写应用程序,并且将使用 StringInfo,请使用此选项。

UnicodeCodePoint
  • string

返回的偏移量和长度值将对应于 Unicode 代码点。 如果使用支持 Unicode 的语言(例如 Python)编写应用程序,请使用此选项。

Utf16CodeUnit
  • string

返回的偏移量和长度值对应于 UTF-16 代码单元。 如果使用支持 Unicode 的语言(例如 Java、JavaScript)编写应用程序,请使用此选项。

Tasks

要对输入文档执行的任务集。 不能多次指定同一任务。

Name Type Description
entityLinkingTasks
entityRecognitionPiiTasks
entityRecognitionTasks
keyPhraseExtractionTasks

TextAnalyticsError

Name Type Description
code

错误代码。

details

有关导致此报告错误的特定错误的详细信息。

innererror

内部错误包含更具体的信息。

message
  • string

错误消息。

target
  • string

错误目标。