Content Analyzers - Create Or Replace

Tjänst:: Azure AI Services

API-versionen:: 2025-11-01

Skapa en ny analysator asynkront.

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

Med valfria parametrar:

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Den unika identifieraren för analysatorn.
endpoint	path	True	string (uri)	Innehållsförståelse av tjänstens slutpunkt.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
allowReplace	query		boolean	Tillåt operationen att ersätta en befintlig resurs.

Begäran-huvud

Namn	Krävs	Typ	Beskrivning
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Begäranarorgan

Namn	Typ	Beskrivning
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Analysatorn att inkrementvis träna från.
config	ContentAnalyzerConfig	Analysatorns konfigurationsinställningar.
description	string	En beskrivning av analysatorn.
dynamicFieldSchema	boolean	Indikerar om resultatet kan innehålla ytterligare fält utanför det definierade schemat.
fieldSchema	ContentFieldSchema	Schemat av fält som ska extraheras.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Ytterligare kunskapskällor används för att förbättra analysatorn.
models	object	Mappning av modellroller till specifika modellnamn. T.ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	Platsen där datan kan bearbetas. Går som standard till globalt.
tags	object	Taggar kopplade till analysatorn.

Svaren

Namn	Typ	Beskrivning
200 OK	ContentAnalyzer	Begäran har slutförts. Headers Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	Begäran har slutförts och en ny resurs har skapats som ett resultat. Headers Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Namn

Typ

Beskrivning

200 OK

ContentAnalyzer

Begäran har slutförts.

Headers

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

201 Created

ContentAnalyzer

Begäran har slutförts och en ny resurs har skapats som ett resultat.

Headers

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Headers

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Nyckelbaserad autentisering med åtkomstnyckeln för Azure-resursen.

Typ: apiKey
I: header

EntraIdToken

Microsoft Entra ID OAuth2-autentisering med en åtkomsttoken.

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

Scope

Namn	Beskrivning
https://cognitiveservices.azure.com/.default

Exempel

Create or Replace Analyzer

Exempelförfrågan

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

Exempelsvar

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

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

Definitioner

Namn	Beskrivning
AnnotationFormat	Representationsformat av anteckningar i analysresultatmarkdown.
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Representationsformat av diagram i analysresultatmarkdown.
ContentAnalyzer	Analysator som extraherar innehåll och fält från multimodala dokument.
ContentAnalyzerConfig	Konfigurationsinställningar för en analysator.
ContentAnalyzerStatus	Status för en resurs.
ContentCategoryDefinition	Definition av innehållskategori.
ContentFieldDefinition	Definition av fältet med hjälp av en JSON-schemaliknande syntax.
ContentFieldSchema	Schema över fält som ska extraheras från dokument.
ContentFieldType	Semantisk datatyp för fältvärdet.
GenerationMethod	Genereringsmetoden.
KnowledgeSourceKind	Kunskapskälla-typ.
LabeledDataKnowledgeSource	Märkt datakunskapskälla.
ProcessingLocation	Platsen där datan kan bearbetas. Går som standard till globalt.
SupportedModels	Chattkomplettering och inbäddningsmodeller som stöds av analysatorn.
TableFormat	Representationsformat av tabeller i analysresultatmarkdown.

AnnotationFormat

Uppräkning

Representationsformat av anteckningar i analysresultatmarkdown.

Värde	Beskrivning
none	Representera inte anteckningar.
markdown	Representera grundläggande annotationsinformation med markdown-formatering.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

ChartFormat

Uppräkning

Representationsformat av diagram i analysresultatmarkdown.

Värde	Beskrivning
chartJs	Representera diagram som Chart.js kodblock.
markdown	Representera diagram som markdown-tabeller.