Content Analyzers - Create Or Replace

Serviço:: Azure AI Services

Versão da API:: 2025-11-01

Crie um novo analisador de forma assíncrona.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	O identificador único do analisador.
endpoint	path	True	string (uri)	Entendendo conteúdo do endpoint do serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
allowReplace	query		boolean	Permitir que a operação substitua um recurso existente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

Nome	Tipo	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	O analisador para treinar incrementalmente.
config	ContentAnalyzerConfig	Configurações do analisador.
description	string	Uma descrição do analisador.
dynamicFieldSchema	boolean	Indica se o resultado pode conter campos adicionais fora do esquema definido.
fieldSchema	ContentFieldSchema	O esquema dos campos para extrair.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Fontes adicionais de conhecimento usadas para aprimorar o analisador.
models	object	Mapeamento dos papéis dos modelos para nomes específicos de modelos. Ex.: { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	O local onde os dados podem ser processados. O padrão é global.
tags	object	Tags associadas ao analisador.

Respostas

Nome	Tipo	Description
200 OK	ContentAnalyzer	A solicitação foi bem-sucedida. Cabeçalhos Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado. Cabeçalhos Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

ContentAnalyzer

A solicitação foi bem-sucedida.

Cabeçalhos

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

201 Created

ContentAnalyzer

A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Cabeçalhos

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Autenticação baseada em chave usando a chave de acesso do recurso Azure.

Tipo: apiKey
Em: header

EntraIdToken

Autenticação OAuth2 do ID Microsoft Entra usando um token de acesso.

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Create or Replace Analyzer

Solicitação de exemplo

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"
    }
  ]
}

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
AnnotationFormat	Formato de representação de anotações em analisar o resultado de marcação.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Formato de representação dos gráficos em analisar o resultado de marcação.
ContentAnalyzer	Analisador que extrai conteúdo e campos de documentos multimodais.
ContentAnalyzerConfig	Configurações de configuração para um analisador.
ContentAnalyzerStatus	Status de um recurso.
ContentCategoryDefinition	Definição de categoria de conteúdo.
ContentFieldDefinition	Definição do campo usando uma sintaxe semelhante a um esquema JSON.
ContentFieldSchema	Esquema dos campos a serem extraídos de documentos.
ContentFieldType	Tipo de dados semânticos do valor do campo.
GenerationMethod	Método de geração.
KnowledgeSourceKind	Fonte de conhecimento.
LabeledDataKnowledgeSource	Fonte de conhecimento de dados rotulada.
ProcessingLocation	O local onde os dados podem ser processados. O padrão é global.
SupportedModels	Modelos de completamento e incorporação de chat suportados pelo analisador.
TableFormat	Formato de representação de tabelas em analisar o resultado de marcação.

AnnotationFormat

Enumeração

Formato de representação de anotações em analisar o resultado de marcação.

Valor	Description
none	Não represente anotações.
markdown	Represente informações básicas de anotação usando formatação markdown.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta contendo detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

ChartFormat

Enumeração

Formato de representação dos gráficos em analisar o resultado de marcação.

Valor	Description
chartJs	Represente gráficos como blocos de código Chart.js.
markdown	Represente gráficos como tabelas de marcação.