Analyzers - Create Or Replace

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-12-01-preview

Erstellen Sie asynchron einen neuen Analyzer.

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2024-12-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
analyzerId	path	True	string	Der eindeutige Bezeichner des Analyzers. RegEx-Muster: `^[a-zA-Z0-9._-]{1,64}$`
endpoint	path	True	string uri	Inhaltsverständnis-Dienstendpunkt.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

analyzerId

path

True

string

Der eindeutige Bezeichner des Analyzers.

RegEx-Muster: ^[a-zA-Z0-9._-]{1,64}$

endpoint

path

True

string

uri

Inhaltsverständnis-Dienstendpunkt.

api-version

query

True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Operation-Id		string	Eine vom Client bereitgestellte GUID zum Identifizieren des dauerhaften Vorgangs.
x-ms-client-request-id		string uuid	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Name	Typ	Beschreibung
baseAnalyzerId	string	Der Analysator, von dem inkrementell trainiert werden soll.
config	ContentAnalyzerConfig	Konfigurationseinstellungen für die Analyse.
description	string	Eine Beschreibung des Analyzers.
fieldSchema	FieldSchema	Das Schema der zu extrahierenden Felder.
scenario	string	Das Szenario, für das die Analyse optimiert ist.
tags	object	Tags, die der Analyse zugeordnet sind.
trainingData	DataSource: BlobDataSource	Die Datenquelle, die Schulungsdaten für die Analyse enthält.

Antworten

Name	Typ	Beschreibung
200 OK	ContentAnalyzer	Die Anforderung ist erfolgreich. Header Operation-Id: string 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-Id: string 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-Id: string
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-Id: string
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

Typ: apiKey
In: header

OAuth2Auth

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 Custom Analyzer

Beispielanforderung

HTTP

PUT {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2024-12-01-preview


{
  "description": "My custom analyzer",
  "tags": {
    "createdBy": "John"
  },
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

Operation-Id: 3b31320d-8bab-4f88-b19c-2322a7f11034
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

{
  "analyzerId": "myAnalyzer",
  "description": "My custom analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2024-10-14T18:46:36.051Z",
  "lastModifiedAt": "2024-10-14T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

Statuscode:: 201

Operation-Id: 3b31320d-8bab-4f88-b19c-2322a7f11034
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

{
  "analyzerId": "myAnalyzer",
  "description": "My custom analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2024-10-14T18:46:36.051Z",
  "lastModifiedAt": "2024-10-14T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

Definitionen

Name	Beschreibung
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 Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BlobDataSource	Blob-Speicherdatenquelle.
ContentAnalyzer	Analyzer, der Inhalte und Felder aus multimodalen Dokumenten extrahiert.
ContentAnalyzerConfig	Konfigurationseinstellungen für eine Analyse.
DataSourceKind	Datenquellentyp.
FieldDefinition	Definition des Felds mithilfe eines JSON-Schemas wie syntax.
FieldSchema	Schema der Felder, die aus Dokumenten extrahiert werden sollen.
FieldType	Semantischer Datentyp des Feldwerts.
GenerationMethod	Generation-Methode.
ResourceStatus	Status einer Ressource.

Azure.Core.Foundations.Error

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

Eine Antwort, die Fehlerdetails enthält.

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

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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

BlobDataSource

Blob-Speicherdatenquelle.

Name	Typ	Beschreibung
containerUrl	string	Die URL des Blobcontainers.
fileListPath	string	Ein optionaler Pfad zu einer Datei, die bestimmte blobs enthält.
kind	string: blob	Die Art der Datenquelle.
prefix	string	Ein optionales Präfix zum Filtern von Blobs innerhalb des Containers.

ContentAnalyzer

Analyzer, der Inhalte und Felder aus multimodalen Dokumenten extrahiert.

Name	Typ	Beschreibung
analyzerId	string	Der eindeutige Bezeichner des Analyzers.
baseAnalyzerId	string	Der Analysator, von dem inkrementell trainiert werden soll.
config	ContentAnalyzerConfig	Konfigurationseinstellungen für die Analyse.
createdAt	string	Datum und Uhrzeit der Erstellung der Analyse.
description	string	Eine Beschreibung des Analyzers.
fieldSchema	FieldSchema	Das Schema der zu extrahierenden Felder.
lastModifiedAt	string	Datum und Uhrzeit der letzten Änderung des Analysegeräts.
scenario	string	Das Szenario, für das die Analyse optimiert ist.
status	ResourceStatus	Der Status des Analyzers.
tags	object	Tags, die der Analyse zugeordnet sind.
trainingData	DataSource: BlobDataSource	Die Datenquelle, die Schulungsdaten für die Analyse enthält.
warnings	Azure.Core.Foundations.Error[]	Warnungen beim Erstellen der Analyse.

ContentAnalyzerConfig

Konfigurationseinstellungen für eine Analyse.

Name	Typ	Beschreibung
enableBarcode	boolean	Aktivieren Sie die Barcodeerkennung.
enableFace	boolean	Aktivieren sie die Gesichtserkennung.
enableFormula	boolean	Aktivieren Sie die Erkennung mathematischer Formeln.
enableLayout	boolean	Aktivieren Sie die Layoutanalyse.
enableOcr	boolean	Aktivieren der optischen Zeichenerkennung (OCR).
locales	string[]	Liste der Gebietsschemahinweise für die Sprachtranskription.
returnDetails	boolean	Gibt alle Inhaltsdetails zurück.

DataSourceKind

Datenquellentyp.

Name	Typ	Beschreibung
blob	string	Eine BLOB-Speicherdatenquelle.

FieldDefinition

Definition des Felds mithilfe eines JSON-Schemas wie syntax.

Name	Typ	Standardwert	Beschreibung
$ref	string		Verweisen auf eine andere Felddefinition.
description	string		Feldbeschreibung.
enum	string[]		Aufzählung möglicher Feldwerte.
enumDescriptions	object		Beschreibungen für jeden Enumerationswert.
examples	string[]		Beispiele für Feldwerte.
items	FieldDefinition		Feldtypschema jedes Arrayelements, wenn typ array ist.
method	GenerationMethod	generate	Generation-Methode.
properties	<string, FieldDefinition>		Benannte Unterfelder, wenn Typ Objekt ist.
type	FieldType		Semantischer Datentyp des Feldwerts.

FieldSchema

Schema der Felder, die aus Dokumenten extrahiert werden sollen.

Name	Typ	Beschreibung
definitions	<string, FieldDefinition>	Zusätzliche Definitionen, auf die von den Feldern im Schema verwiesen wird.
description	string	Eine Beschreibung des Feldschemas.
fields	<string, FieldDefinition>	Die im Schema definierten Felder.
name	string	Der Name des Feldschemas.

FieldType

Semantischer Datentyp des Feldwerts.

Name	Typ	Beschreibung
array	string	Liste der Unterfelder desselben Typs.
boolean	string	Boolescher Wert.
date	string	Datum, normalisiert auf ISO 8601 (JJJJ-MM-DD) Format.
integer	string	Ganze Zahl als 64-Bit-Ganzzahl mit Vorzeichen.
number	string	Zahl als Gleitkommazahl mit doppelter Genauigkeit.
object	string	Benannte Liste von Unterfeldern.
string	string	Klartext.
time	string	Zeit, normalisiert auf ISO 8601 (hh:mm:ss)-Format.

GenerationMethod

Generation-Methode.

Name	Typ	Beschreibung
classify	string	Werte werden anhand einer vordefinierten Gruppe von Kategorien klassifiziert.
extract	string	Werte werden extrahiert, sobald sie im Inhalt angezeigt werden.
generate	string	Werte werden frei basierend auf dem Inhalt generiert.

ResourceStatus

Status einer Ressource.

Name	Typ	Beschreibung
creating	string	Die Ressource wird erstellt.
deleting	string	Die Ressource wird gelöscht.
failed	string	Fehler bei der Ressource beim Erstellen.
ready	string	Die Ressource ist bereit.

Freigeben über

Analyzers - Create Or Replace

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Create or Replace Custom Analyzer

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BlobDataSource

ContentAnalyzer

ContentAnalyzerConfig

DataSourceKind

FieldDefinition

FieldSchema

FieldType

GenerationMethod

ResourceStatus

Zusätzliche Ressourcen