Content Analyzers - Create Or Replace

Service:: Azure AI Services

Version d'API:: 2025-11-01

Créez un nouvel analyseur de façon asynchrone.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	L’identifiant unique de l’analyseur.
endpoint	path	True	string (uri)	Contenu : Compréhension du point de service de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
allowReplace	query		boolean	Permettre à l’opération de remplacer une ressource existante.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Nom	Type	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	L’analyseur pour entraîner progressivement.
config	ContentAnalyzerConfig	Paramètres de configuration de l’analyseur.
description	string	Une description de l’analyseur.
dynamicFieldSchema	boolean	Indique si le résultat peut contenir des champs supplémentaires en dehors du schéma défini.
fieldSchema	ContentFieldSchema	Le schéma des champs à extraire.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Des sources de connaissances supplémentaires servent à améliorer l’analyseur.
models	object	Mappage des rôles des modèles à des noms de modèles spécifiques. Exemple : { « complétion » : « gpt-4.1 », « embedding » : « text-embedding-3-large » }.
processingLocation	ProcessingLocation	L’endroit où les données peuvent être traitées. Par défaut, global.
tags	object	Des balises associées à l’analyseur.

Réponses

Nom	Type	Description
200 OK	ContentAnalyzer	La demande a réussi. En-têtes Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	La requête a réussi et une nouvelle ressource a été créée en conséquence. En-têtes Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

ContentAnalyzer

La demande a réussi.

En-têtes

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

201 Created

ContentAnalyzer

La requête a réussi et une nouvelle ressource a été créée en conséquence.

En-têtes

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Authentification basée sur clé utilisant la clé d’accès de la ressource Azure.

Type: apiKey
Dans: header

EntraIdToken

Authentication OAuth2 par identifiant Microsoft Entra à l’aide d’un jeton d’accès.

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

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

Exemples

Create or Replace Analyzer

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
AnnotationFormat	Format de représentation des annotations dans Analyze result markdown.
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Une réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Format de représentation des graphiques dans l’analyse du marquage des résultats.
ContentAnalyzer	Analyseur qui extrait le contenu et les champs de documents multimodaux.
ContentAnalyzerConfig	Paramètres de configuration pour un analyseur.
ContentAnalyzerStatus	Statut d’une ressource.
ContentCategoryDefinition	Définition de la catégorie de contenu.
ContentFieldDefinition	Définition du champ utilisant une syntaxe de type schéma JSON.
ContentFieldSchema	Schéma des champs à extraire des documents.
ContentFieldType	Type de données sémantiques de la valeur du champ.
GenerationMethod	Méthode de génération.
KnowledgeSourceKind	Source de connaissances.
LabeledDataKnowledgeSource	Source de données de données intitulée.
ProcessingLocation	L’endroit où les données peuvent être traitées. Par défaut, global.
SupportedModels	Complétion de chat et modèles d’intégration pris en charge par l’analyseur.
TableFormat	Format de représentation des tables dans Analyze result markdown.

AnnotationFormat

Énumération

Format de représentation des annotations dans Analyze result markdown.

Valeur	Description
none	Ne représentez pas des annotations.
markdown	Représenter les informations de base sur les annotations en utilisant la mise en forme markdown.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Une réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur intérieure.

ChartFormat

Énumération

Format de représentation des graphiques dans l’analyse du marquage des résultats.

Valeur	Description
chartJs	Représentez les graphiques comme Chart.js blocs de code.
markdown	Représentez les graphiques comme des tableaux à déchiffrement.