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
Flow: 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	Формат представления аннотаций в анализе результатов markdown.
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.
ContentFieldSchema	Схема полей, которые нужно извлекать из документов.
ContentFieldType	Семантический тип данных значения поля.
GenerationMethod	Метод генерации.
KnowledgeSourceKind	Источник знаний.
LabeledDataKnowledgeSource	Обозначенный источник данных о знаниях.
ProcessingLocation	Место, где могут обрабатываться данные. По умолчанию — глобальный.
SupportedModels	Модели завершения и вложения чата, поддерживаемые анализатором.
TableFormat	Формат представления таблиц в анализе результата markdown.

AnnotationFormat

Перечисление

Формат представления аннотаций в анализе результатов markdown.

Значение	Описание
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	Представляйте графики в виде таблиц с уценками.