Content Analyzers - Create Or Replace

Dienst:: Azure AI Services

API-Version:: 2025-11-01

Erstellen Sie asynchron einen neuen Analyzer.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Die eindeutige Kennung des Analysators.
endpoint	path	True	string (uri)	Inhaltsverständnis des Service-Endpunkts.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
allowReplace	query		boolean	Erlauben Sie der Operation, eine bestehende Ressource zu ersetzen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Name	Typ	Beschreibung
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Der Analysator, von dem man schrittweise trainieren kann.
config	ContentAnalyzerConfig	Konfigurationseinstellungen des Analyzers.
description	string	Eine Beschreibung des Analysators.
dynamicFieldSchema	boolean	Gibt an, ob das Ergebnis zusätzliche Felder außerhalb des definierten Schemas enthalten kann.
fieldSchema	ContentFieldSchema	Das Schema der zu extrahierenden Felder.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Zusätzliche Wissensquellen werden verwendet, um den Analysator zu verbessern.
models	object	Abbildung von Modellrollen auf spezifische Modellnamen. Ex. { "completetion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	Der Ort, an dem die Daten verarbeitet werden können. Standardmäßig steht es auf global.
tags	object	Tags, die mit dem Analyzer verbunden sind.

Antworten

Name	Typ	Beschreibung
200 OK	ContentAnalyzer	Die Anforderung ist erfolgreich. Header Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt. Header Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

ContentAnalyzer

Die Anforderung ist erfolgreich.

Header

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

201 Created

ContentAnalyzer

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.

Header

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Schlüsselbasierte Authentifizierung mit dem Zugangsschlüssel der Azure-Ressource.

Typ: apiKey
In: header

EntraIdToken

Microsoft Entra ID OAuth2-Authentifizierung mit einem Zugangstoken.

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Create or Replace Analyzer

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
AnnotationFormat	Darstellungsformat der Annotationen im Analyseergebnis-Markdown.
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
ChartFormat	Darstellungsformat von Diagrammen in Analyse der Ergebnismarkierung.
ContentAnalyzer	Analysator, der Inhalte und Felder aus multimodalen Dokumenten extrahiert.
ContentAnalyzerConfig	Konfigurationseinstellungen für einen Analyzer.
ContentAnalyzerStatus	Status einer Ressource.
ContentCategoryDefinition	Definition von Inhaltskategorien.
ContentFieldDefinition	Definition des Feldes mit einer JSON-Schema-ähnlichen Syntax.
ContentFieldSchema	Schema der Felder, die aus Dokumenten extrahiert werden sollen.
ContentFieldType	Semantischer Datentyp des Feldwerts.
GenerationMethod	Erzeugungsmethode.
KnowledgeSourceKind	Wissensquelle.
LabeledDataKnowledgeSource	Beschriftete Datenwissensquelle.
ProcessingLocation	Der Ort, an dem die Daten verarbeitet werden können. Standardmäßig steht es auf global.
SupportedModels	Chat-Abschluss- und Einbettungsmodelle, die vom Analyzer unterstützt werden.
TableFormat	Darstellungsformat der Tabellen in Analyse von Ergebnismarkdown.

AnnotationFormat

Enumeration

Darstellungsformat der Annotationen im Analyseergebnis-Markdown.

Wert	Beschreibung
none	Keine Anmerkungen darstellen.
markdown	Stellen Sie grundlegende Annotationsinformationen mit Markdown-Formatierung dar.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

ChartFormat

Enumeration

Darstellungsformat von Diagrammen in Analyse der Ergebnismarkierung.

Wert	Beschreibung
chartJs	Diagramme als Chart.js Codeblöcke darstellen.
markdown	Darstelle Diagramme als Markdown-Tabellen.