Content Analyzers - Create Or Replace

Serviço:: Azure AI Services

Versão 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 URI

Nome	Em	Necessário	Tipo	Descrição
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)	Conteúdo Compreender o ponto final do serviço.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
allowReplace	query		boolean	Permitir que a operação substitua um recurso existente.

Cabeçalho de Pedido

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

Órgão do Pedido

Nome	Tipo	Descrição
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	O analisador para treinar incrementalmente.
config	ContentAnalyzerConfig	Definiçõ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 melhorar 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. Por defeito é global.
tags	object	Etiquetas associadas ao analisador.

Respostas

Nome	Tipo	Descrição
200 OK	ContentAnalyzer	O pedido foi bem-sucedido. Cabeçalhos Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso. 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

Descrição

200 OK

ContentAnalyzer

O pedido foi bem-sucedido.

Cabeçalhos

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

201 Created

ContentAnalyzer

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

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 chaves 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
Token URL: https://login.microsoftonline.com/common/oauth2/token

Alcances

Nome	Descrição
https://cognitiveservices.azure.com/.default

Exemplos

Create or Replace Analyzer

Pedido 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 estado:: 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 estado:: 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	Descrição
AnnotationFormat	Formato de representação das anotações em analisar a marcação de resultados.
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 a marcação de resultados.
ContentAnalyzer	Analisador que extrai conteúdo e campos de documentos multimodais.
ContentAnalyzerConfig	Definições de configuração para um analisador.
ContentAnalyzerStatus	Estado 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 de campos a extrair de documentos.
ContentFieldType	Tipo de dados semânticos do valor do campo.
GenerationMethod	Método de geração.
KnowledgeSourceKind	Fonte de conhecimento.
LabeledDataKnowledgeSource	Etiquetado como fonte de conhecimento de dados.
ProcessingLocation	O local onde os dados podem ser processados. Por defeito é global.
SupportedModels	Modelos de conclusão e incorporação de chat suportados pelo analisador.
TableFormat	Formato de representação de tabelas em analisar a marcação de resultados.

AnnotationFormat

Enumeração

Formato de representação das anotações em analisar a marcação de resultados.

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

Azure.Core.Foundations.Error

Objetivo

O objeto de erro.

Nome	Tipo	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Objetivo

Uma resposta contendo detalhes do erro.

Nome	Tipo	Descrição
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objetivo

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	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

ChartFormat

Enumeração

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

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