Content Analyzers - Create Or Replace

Service:

Azure AI Services

API-versie:

2025-11-01

Maak asynchroon een nieuwe analyzer.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	De unieke identificatie van de analyzer.
endpoint	path	True	string (uri)	Contentbegrip service-endpoint.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
allowReplace	query		boolean	Laat de operatie een bestaande bron vervangen.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name	Type	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	De analyzer om incrementeel van te trainen.
config	ContentAnalyzerConfig	Instellingen voor de configuratie van de analyzer.
description	string	Een beschrijving van de analyzer.
dynamicFieldSchema	boolean	Geeft aan of het resultaat extra velden kan bevatten buiten het gedefinieerde schema.
fieldSchema	ContentFieldSchema	Het schema van velden die geëxtraheerd moeten worden.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Extra kennisbronnen die worden gebruikt om de analyzer te verbeteren.
models	object	Koppeling van modelrollen aan specifieke modelnamen. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	De locatie waar de gegevens verwerkt kunnen worden. Standaard staat hij op globaal.
tags	object	Tags die gekoppeld zijn aan de analyzer.

Antwoorden

Name	Type	Description
200 OK	ContentAnalyzer	De aanvraag is voltooid. Kopteksten Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	De aanvraag is geslaagd en er is een nieuwe resource gemaakt. Kopteksten Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Sleutelgebaseerde authenticatie met behulp van de toegangssleutel van de Azure-bron.

Type: apiKey
In: header

EntraIdToken

Microsoft Entra ID OAuth2-authenticatie met behulp van een toegangstoken.

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Create or Replace Analyzer

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AnnotationFormat	Representatieformaat van annotaties in analyse resultaatmarkdown.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object dat meer specifieke informatie over de fout bevat. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
ChartFormat	Representatieformaat van grafieken in analyseresultaatmarkdown.
ContentAnalyzer	Analyzer die inhoud en velden uit multimodale documenten haalt.
ContentAnalyzerConfig	Configuratie-instellingen voor een analyzer.
ContentAnalyzerStatus	Status van een hulpbron.
ContentCategoryDefinition	Definitie van inhoudscategorie.
ContentFieldDefinition	Definitie van het veld met behulp van een JSON-schema-achtige syntaxis.
ContentFieldSchema	Schema van velden die uit documenten worden gehaald.
ContentFieldType	Semantisch gegevenstype van de veldwaarde.
GenerationMethod	Generatiemethode.
KnowledgeSourceKind	Kennisbron-soort.
LabeledDataKnowledgeSource	Gelabelde kennisbron van data.
ProcessingLocation	De locatie waar de gegevens verwerkt kunnen worden. Standaard staat hij op globaal.
SupportedModels	Chatvoltooiings- en embeddingmodellen ondersteund door de analyzer.
TableFormat	Representatieformaat van tabellen in analyse resultaatmarkdown.

AnnotationFormat

Opsomming

Representatieformaat van annotaties in analyse resultaatmarkdown.

Waarde	Description
none	Geef geen annotaties aan.
markdown	Geef basisinformatie over annotatie weer met markdown-opmaak.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object dat meer specifieke informatie over de fout bevat. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Innerlijke fout.

ChartFormat

Opsomming

Representatieformaat van grafieken in analyseresultaatmarkdown.

Waarde	Description
chartJs	Vertegenwoordig grafieken als Chart.js codeblokken.
markdown	Vertegenwoordig tabellen als markdown-tabellen.

ContentAnalyzer

Object

Analyzer die inhoud en velden uit multimodale documenten haalt.

Name	Type	Default value	Description
analyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$		De unieke identificatie van de analyzer.
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$		De analyzer om incrementeel van te trainen.
config	ContentAnalyzerConfig		Instellingen voor de configuratie van de analyzer.
createdAt	string (date-time)		De datum en tijd waarop de analyzer is gemaakt.
description	string		Een beschrijving van de analyzer.
dynamicFieldSchema	boolean	False	Geeft aan of het resultaat extra velden kan bevatten buiten het gedefinieerde schema.
fieldSchema	ContentFieldSchema		Het schema van velden die geëxtraheerd moeten worden.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]		Extra kennisbronnen die worden gebruikt om de analyzer te verbeteren.
lastModifiedAt	string (date-time)		De datum en tijd waarop de analyzer voor het laatst is aangepast.
models	object		Koppeling van modelrollen aan specifieke modelnamen. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	global	De locatie waar de gegevens verwerkt kunnen worden. Standaard staat hij op globaal.
status	ContentAnalyzerStatus		De status van de analyzer.
supportedModels	SupportedModels		Chatvoltooiings- en embeddingmodellen ondersteund door de analyzer.
tags	object		Tags die gekoppeld zijn aan de analyzer.
warnings	Azure.Core.Foundations.Error[]		Waarschuwingen die werden tegengekomen bij het maken van de analyzer.

ContentAnalyzerConfig

Object

Configuratie-instellingen voor een analyzer.

Name	Type	Default value	Description
annotationFormat	AnnotationFormat	markdown	Representatieformaat van annotaties in analyse resultaatmarkdown.
chartFormat	ChartFormat	chartJs	Representatieformaat van grafieken in analyseresultaatmarkdown.
contentCategories	<string,  ContentCategoryDefinition>		Kaart van categorieën om de invoerinhoud(en) te classificeren.
disableFaceBlurring	boolean		Schakel het standaard vervagen van gezichten uit voor privacy tijdens het verwerken van de inhoud.
enableFigureAnalysis	boolean		Maak analyse van figuren mogelijk, zoals grafieken en diagrammen.
enableFigureDescription	boolean		Schakel het genereren van de figuurbeschrijving in.
enableFormula	boolean		Schakel wiskundige formuledetectie in.
enableLayout	boolean		Schakel layout-analyse in.
enableOcr	boolean		Schakel optische tekenherkenning (OCR) in.
enableSegment	boolean		Schakel segmentatie van de invoer in op contentCategorieën in.
estimateFieldSourceAndConfidence	boolean		Terugkerend veld gronding bron en vertrouwen.
locales	string[]		Lijst met locatie-tips voor spraaktranscriptie.
omitContent	boolean		Laat de inhoud van deze analyzer weg uit het analyseresultaat. Alleen inhoud (of -en) van aanvullende analyzers die zijn gespecificeerd in contentCategories, indien aanwezig.
returnDetails	boolean		Stuur alle inhoudsgegevens terug.
segmentPerPage	boolean		Forceer segmentatie van documentinhoud per pagina.
tableFormat	TableFormat	html	Representatieformaat van tabellen in analyse resultaatmarkdown.

ContentAnalyzerStatus

Opsomming

Status van een hulpbron.

Waarde	Description
creating	De resource wordt gemaakt.
ready	De bron is klaar.
deleting	De resource wordt verwijderd.
failed	De bron faalde tijdens de creatie.

ContentCategoryDefinition

Object

Definitie van inhoudscategorie.

Name	Type	Description
analyzer	ContentAnalyzer	Optionele inline definitie van de analyzer die wordt gebruikt om de inhoud te verwerken.
analyzerId	string	Optionele analyzer gebruikt om de inhoud te verwerken.
description	string	De beschrijving van de categorie.

ContentFieldDefinition

Object

Definitie van het veld met behulp van een JSON-schema-achtige syntaxis.

Name	Type	Description
$ref	string	Verwijzing naar een andere velddefinitie.
description	string	Veldbeschrijving.
enum	string[]	Opsomming van mogelijke veldwaarden.
enumDescriptions	object	Beschrijvingen voor elke opsommingswaarde.
estimateSourceAndConfidence	boolean	Geef de grondingsbron en vertrouwen terug.
examples	string[]	Voorbeelden van veldwaarden.
items	ContentFieldDefinition	Veldtypeschema van elk array-element, als type array is.
method	GenerationMethod	Generatiemethode.
properties	<string,  ContentFieldDefinition>	Benoemde subvelden, als type object is.
type	ContentFieldType	Semantisch gegevenstype van de veldwaarde.

ContentFieldSchema

Object

Schema van velden die uit documenten worden gehaald.

Name	Type	Description
definitions	<string,  ContentFieldDefinition>	Aanvullende definities worden aangehaald door de velden in het schema.
description	string	Een beschrijving van het veldschema.
fields	<string,  ContentFieldDefinition>	De velden die in het schema zijn gedefinieerd.
name	string	De naam van het veldschema.

ContentFieldType

Opsomming

Semantisch gegevenstype van de veldwaarde.

Waarde	Description
string	Platte tekst.
date	Datum, genormaliseerd naar ISO 8601 (YYYY-MM-DD) formaat.
time	Tijd, genormaliseerd naar ISO 8601 (hh:mm:ss) formaat.
number	Nummer als dubbele precisie floating point.
integer	Geheel getal als 64-bits getekend geheel getal.
boolean	Booleaanse waarde.
array	Lijst van subvelden van hetzelfde type.
object	Benoemde lijst van subvelden.
json	JSON-object.

GenerationMethod

Opsomming

Generatiemethode.

Waarde	Description
generate	Waarden worden vrij gegenereerd op basis van de inhoud.
extract	Waarden worden geëxtraheerd zodra ze in de inhoud verschijnen.
classify	Waarden worden geclassificeerd aan de hand van een vooraf gedefinieerde set categorieën.

KnowledgeSourceKind

Opsomming

Kennisbron-soort.

Waarde	Description
labeledData	Een gelabelde kennisbron van data.

LabeledDataKnowledgeSource

Object

Gelabelde kennisbron van data.

Name	Type	Description
containerUrl	string (uri)	De URL van de blobcontainer met gelabelde gegevens.
fileListPath	string	Een optioneel pad naar een bestand met specifieke blobs om op te nemen.
kind	string: labeledData	Het soort kennisbron.
prefix	string	Een optioneel prefix om blobs binnen de container te filteren.

ProcessingLocation

Opsomming

De locatie waar de gegevens verwerkt kunnen worden. Standaard staat hij op globaal.

Waarde	Description
geography	Data kan worden verwerkt in dezelfde geografie als de bron.
dataZone	Data kan in dezelfde datazone als de bron worden verwerkt.
global	Data kan in elk Azure-datacenter wereldwijd worden verwerkt.

SupportedModels

Object

Chatvoltooiings- en embeddingmodellen ondersteund door de analyzer.

Name	Type	Description
completion	string[]	Chatvoltooiingsmodellen ondersteund door de analyzer.
embedding	string[]	Embeddingmodellen ondersteund door de analyzer.

TableFormat

Opsomming

Representatieformaat van tabellen in analyse resultaatmarkdown.

Waarde	Description
html	Vertegenwoordig tabellen met HTML-tabelelementen: <tabel>, <th>, <tr>, <td>.
markdown	Vertegenwoordig tabellen met behulp van GitHub Flavored Markdown tabelsyntaxis, die geen merged cells of rich headers ondersteunt.