通过

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

Content Analyzers - Analyze

服务:
Azure AI Services
API 版本:
2025-05-01-preview

从输入中提取内容和字段。

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2025-05-01-preview
具有可选参数: 
POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2025-05-01-preview&stringEncoding={stringEncoding}&processingLocation={processingLocation}

URI 参数

名称 在 必需 类型 说明
analyzerId
 path True

string

pattern: ^[a-zA-Z0-9._-]{1,64}$

分析器的唯一标识符。
endpoint
 path True

string (uri)

内容理解服务终结点。
api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。
processingLocation
 query

ProcessingLocation

可能处理数据的位置。
stringEncoding
 query

StringEncoding

内容的编码格式在响应中跨度。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string (uuid)

请求的不透明、全局唯一的客户端生成的字符串标识符。

请求正文

名称 类型 说明
data

string (byte)

要分析的主要输入的 Base64 编码的二进制内容。 只应指定 url 或 data 中的一个。
inputs

AnalyzeInput[]

要分析的其他输入。 仅在 mode=pro 的分析器中受支持。
url

string (uri)

要分析的主要输入的 URL。 只应指定 url 或 data 中的一个。

响应

名称 类型 说明
202 Accepted

已接受请求进行处理，但尚未完成处理。

标头

  • Operation-Location: string
  • x-ms-client-request-id: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称 说明
https://cognitiveservices.azure.com/.default

示例

Analyze URL

示例请求

POST {endpoint}/contentunderstanding/analyzers/myAnalyzer:analyze?api-version=2025-05-01-preview

{
  "url": "https://host.com/doc.pdf"
}

示例响应

状态代码:
202 
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzerResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-05-01-preview
{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "NotStarted"
}

定义

名称 说明
AnalyzeInput

要分析的其他输入。
AnalyzeRequest

分析操作请求。
Azure.Core.Foundations.Error

错误对象。
Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。
Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
ProcessingLocation

可能处理数据的位置。
StringEncoding

用于内容 span 的字符串编码。

AnalyzeInput

Object

要分析的其他输入。

名称 类型 说明
data

string (byte)

要分析的输入的 Base64 编码的二进制内容。 只应指定 url 或 data 中的一个。
name

string

输入的名称。
url

string (uri)

要分析的输入的 URL。 只应指定 url 或 data 中的一个。

AnalyzeRequest

Object

分析操作请求。

名称 类型 说明
data

string (byte)

要分析的主要输入的 Base64 编码的二进制内容。 只应指定 url 或 data 中的一个。
inputs

AnalyzeInput[]

要分析的其他输入。 仅在 mode=pro 的分析器中受支持。
url

string (uri)

要分析的主要输入的 URL。 只应指定 url 或 data 中的一个。

Azure.Core.Foundations.Error

Object

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

Azure.Core.Foundations.Error[]

导致此报告错误的特定错误的详细信息数组。
innererror

Azure.Core.Foundations.InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

有关错误的可读的表示形式。
target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
innererror

Azure.Core.Foundations.InnerError

内部错误。

ProcessingLocation

枚举

可能处理数据的位置。

值 说明
geography

数据可以在与资源相同的地理位置进行处理。
dataZone

数据可以在与资源相同的数据区中进行处理。
global

数据可以在全球任何 Azure 数据中心进行处理。

StringEncoding

枚举

用于内容 span 的字符串编码。

值 说明
codePoint

Unicode 码位 （UTF-32） 编码，由 Python 等语言使用。
utf16

UTF-16 编码，由 C#、JavaScript、Java 等语言使用。
utf8

UTF-8 编码，用于 Go、Rust、Ruby、PHP 等语言。