Content Analyzers - Create Or Replace

Servicio:: Azure AI Services

Versión de la API:: 2025-11-01

Crea un nuevo analizador de forma asincrónica.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único del analizador.
endpoint	path	True	string (uri)	Contenido Entendiendo el punto final del servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
allowReplace	query		boolean	Permite que la operación reemplace un recurso existente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	El analizador para entrenar incrementalmente desde entonces.
config	ContentAnalyzerConfig	Configuración del analizador.
description	string	Una descripción del analizador.
dynamicFieldSchema	boolean	Indica si el resultado puede contener campos adicionales fuera del esquema definido.
fieldSchema	ContentFieldSchema	El esquema de campos a extraer.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Fuentes de conocimiento adicionales utilizadas para mejorar el analizador.
models	object	Mapeación de roles de modelos a nombres específicos de modelos. Por ejemplo, { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	El lugar donde se pueden procesar los datos. Por defecto es global.
tags	object	Etiquetas asociadas al analizador.

Respuestas

Nombre	Tipo	Description
200 OK	ContentAnalyzer	La solicitud se ha realizado correctamente. Encabezados Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado. Encabezados Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

ContentAnalyzer

La solicitud se ha realizado correctamente.

Encabezados

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

201 Created

ContentAnalyzer

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Encabezados

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Autenticación basada en claves usando la clave de acceso del recurso de Azure.

Tipo: apiKey
En: header

EntraIdToken

Autenticación OAuth2 de Microsoft Entra ID usando un token de acceso.

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Create or Replace Analyzer

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
AnnotationFormat	Formato de representación de anotaciones en analizar la reducción de resultados.
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Formato de representación de gráficos en analizar el resultado de la marcadilla.
ContentAnalyzer	Analizador que extrae contenido y campos de documentos multimodales.
ContentAnalyzerConfig	Configuración de un analizador.
ContentAnalyzerStatus	Estado de un recurso.
ContentCategoryDefinition	Definición de categoría de contenido.
ContentFieldDefinition	Definición del campo usando una sintaxis similar a un esquema JSON.
ContentFieldSchema	Esquema de campos que se extraen de los documentos.
ContentFieldType	Tipo de datos semántico del valor de campo.
GenerationMethod	Método de generación.
KnowledgeSourceKind	Fuente de conocimiento.
LabeledDataKnowledgeSource	Fuente de datos etiquetada.
ProcessingLocation	El lugar donde se pueden procesar los datos. Por defecto es global.
SupportedModels	Completación de chats y modelos de incrustación soportados por el analizador.
TableFormat	Formato de representación de tablas en analizar el resultado de marquación.

AnnotationFormat

Enumeración

Formato de representación de anotaciones en analizar la reducción de resultados.

Valor	Description
none	No representes anotaciones.
markdown	Representa información básica de anotación usando formato markdown.

Azure.Core.Foundations.Error

Objeto

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Objeto

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

ChartFormat

Enumeración

Formato de representación de gráficos en analizar el resultado de la marcadilla.

Valor	Description
chartJs	Representa los gráficos como bloques de código Chart.js.
markdown	Representa los gráficos como tablas de descuento.