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

Content Analyzers - Create Or Replace

服务:: Azure AI Services

API 版本:: 2025-11-01

异步创建一个新的分析仪。

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01

具有可选参数:

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01&allowReplace={allowReplace}

URI 参数

名称	在	必需	类型	说明
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	分析仪的唯一标识符。
endpoint	path	True	string (uri)	内容理解服务端点。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
allowReplace	query		boolean	允许作替换现有资源。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

请求正文

名称	类型	说明
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	分析器可以逐步训练。
config	ContentAnalyzerConfig	分析仪配置设置。
description	string	分析仪的描述。
dynamicFieldSchema	boolean	表示结果是否可能包含定义模式之外的其他字段。
fieldSchema	ContentFieldSchema	需要提取的场图式。
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	用于增强分析仪的额外知识来源。
models	object	将模型角色映射到特定型号名称。例如： { “完成”： “gpt-4.1”， “embedding”： “text-embedding-3-large” }.
processingLocation	ProcessingLocation	数据可能被处理的地点。默认是全局。
tags	object	与分析仪相关的标签。

响应

名称	类型	说明
200 OK	ContentAnalyzer	请求已成功。标头 Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	请求已成功，因此创建了一个新资源。标头 Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

ContentAnalyzer

请求已成功。

标头

Operation-Location: string
x-ms-client-request-id: string

201 Created

ContentAnalyzer

请求已成功，因此创建了一个新资源。

标头

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

基于密钥的认证，使用Azure资源的访问密钥。

类型: apiKey
在: header

EntraIdToken

Microsoft Entra ID OAuth2 使用访问令牌进行认证。

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

作用域

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

示例

Create or Replace Analyzer

示例请求

HTTP

PUT {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2025-11-01

{
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

示例响应

状态代码:: 200

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

{
  "analyzerId": "myAnalyzer",
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableOcr": true,
    "enableLayout": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

状态代码:: 201

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

{
  "analyzerId": "myAnalyzer",
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableOcr": true,
    "enableLayout": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

定义

名称	说明
AnnotationFormat	分析结果标记的表示格式。
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
ChartFormat	分析结果 Markdown 中图表的表示格式。
ContentAnalyzer	分析器，可以从多模态文档中提取内容和字段。
ContentAnalyzerConfig	分析仪的配置设置。
ContentAnalyzerStatus	资源状态。
ContentCategoryDefinition	内容类别定义。
ContentFieldDefinition	用类似语法的 JSON Schema 来定义字段。
ContentFieldSchema	从文档中提取字段的结构。
ContentFieldType	字段值的语义数据类型。
GenerationMethod	生成方法。
KnowledgeSourceKind	知识来源类型。
LabeledDataKnowledgeSource	标记为数据知识源。
ProcessingLocation	数据可能被处理的地点。默认是全局。
SupportedModels	分析仪支持的聊天完成和嵌入模型。
TableFormat	分析结果 Markdown 中表格的表示格式。

AnnotationFormat

枚举

分析结果标记的表示格式。

值	说明
none	不表示注释。
markdown	使用markdown格式表示基本注释信息。

Azure.Core.Foundations.Error

对象

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

对象

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

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

对象

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

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

ChartFormat

枚举

分析结果 Markdown 中图表的表示格式。

值	说明
chartJs	将图表表示为 Chart.js 代码块。
markdown	用降价表表示图表。