Document Models - Analyze Batch Documents

Analysiert Batchdokumente mit Dokumentmodell.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

uri

Der Document Intelligence-Dienstendpunkt.

modelId
path True

string

Eindeutiger Dokumentmodellname.

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

api-version
query True

string

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

features
query

DocumentAnalysisFeature[]

Liste der optionalen Analysefeatures.

locale
query

string

Gebietsschemahinweise für die Texterkennung und Dokumentanalyse. Der Wert darf nur den Sprachcode (z. B. "en", "fr") oder BCP 47-Sprachtag (z. B. "en-US") enthalten.

output
query

AnalyzeOutputOption[]

Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.

outputContentFormat
query

ContentFormat

Format des Inhalts auf oberster Ebene des Analyseergebnisses.

pages
query

string

Liste der zu analysierenden 1-basierten Seitenzahlen. Ex. "1-3,5,7-9"

RegEx-Muster: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$

queryFields
query

string[]

Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"

stringIndexType
query

StringIndexType

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Anforderungstext

Name Erforderlich Typ Beschreibung
resultContainerUrl True

string

Azure Blob Storage-Container-URL, in der Analyseergebnisdateien gespeichert werden.

azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage-Dateiliste, die die Batchdokumente angibt. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.

azureBlobSource

AzureBlobContentSource

Azure Blob Storage-Speicherort, der die Batchdokumente enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.

overwriteExisting

boolean

Vorhandene Analyseergebnisdateien überschreiben?

resultPrefix

string

Blob-Namenspräfix von Ergebnisdateien.

Antworten

Name Typ Beschreibung
202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

  • Operation-Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

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

Analyze Batch Documents

Beispielanforderung

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyzeBatch?api-version=2024-07-31-preview&pages=1-5&locale=en-US&stringIndexType=textElements

{
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
  "resultPrefix": "trainingDocsResult/",
  "overwriteExisting": true
}

Beispiel für eine Antwort

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Definitionen

Name Beschreibung
AnalyzeBatchDocumentsRequest

Parameter für die Batchdokumentanalyse.

AnalyzeOutputOption

Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.

AzureBlobContentSource

Azure Blob Storage-Inhalt.

AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.

ContentFormat

Format des Inhalts im analysierten Ergebnis.

DocumentAnalysisFeature

Dokumentanalysefeatures, die aktiviert werden sollen.

Error

Das Fehlerobjekt.

ErrorResponse

Fehlerantwortobjekt.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

StringIndexType

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

AnalyzeBatchDocumentsRequest

Parameter für die Batchdokumentanalyse.

Name Typ Standardwert Beschreibung
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage-Dateiliste, die die Batchdokumente angibt. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.

azureBlobSource

AzureBlobContentSource

Azure Blob Storage-Speicherort, der die Batchdokumente enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.

overwriteExisting

boolean

False

Vorhandene Analyseergebnisdateien überschreiben?

resultContainerUrl

string

Azure Blob Storage-Container-URL, in der Analyseergebnisdateien gespeichert werden.

resultPrefix

string

Blob-Namenspräfix von Ergebnisdateien.

AnalyzeOutputOption

Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.

Name Typ Beschreibung
figures

string

Generieren Sie zugeschnittene Bilder von erkannten Zahlen.

pdf

string

Generieren Sie durchsuchbare PDF-Ausgabe.

AzureBlobContentSource

Azure Blob Storage-Inhalt.

Name Typ Beschreibung
containerUrl

string

Azure Blob Storage-Container-URL.

prefix

string

Blobnamenpräfix.

AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.

Name Typ Beschreibung
containerUrl

string

Azure Blob Storage-Container-URL.

fileList

string

Pfad zu einer JSONL-Datei innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

ContentFormat

Format des Inhalts im analysierten Ergebnis.

Name Typ Beschreibung
markdown

string

Markdowndarstellung des Dokumentinhalts mit Abschnittsüberschriften, Tabellen usw.

text

string

Nur-Text-Darstellung des Dokumentinhalts ohne Formatierung.

DocumentAnalysisFeature

Dokumentanalysefeatures, die aktiviert werden sollen.

Name Typ Beschreibung
barcodes

string

Aktivieren Sie die Erkennung von Barcodes im Dokument.

formulas

string

Aktivieren Sie die Erkennung mathematischer Ausdrücke im Dokument.

keyValuePairs

string

Aktivieren Sie die Erkennung allgemeiner Schlüsselwertpaare (Formularfelder) im Dokument.

languages

string

Aktivieren Sie die Erkennung der Textinhaltssprache.

ocrHighResolution

string

Führen Sie OCR mit einer höheren Auflösung aus, um Dokumente mit Feindruck zu verarbeiten.

queryFields

string

Aktivieren Sie die Extraktion zusätzlicher Felder über den QueryFields-Abfrageparameter.

styleFont

string

Aktivieren Sie die Erkennung verschiedener Schriftformate.

Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

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.

ErrorResponse

Fehlerantwortobjekt.

Name Typ Beschreibung
error

Error

Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

innererror

InnerError

Innerer Fehler.

message

string

Eine lesbare Darstellung des Fehlers.

StringIndexType

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Name Typ Beschreibung
textElements

string

Vom Benutzer wahrgenommenes Anzeigezeichen oder Graphemecluster, wie durch Unicode 8.0.0 definiert.

unicodeCodePoint

string

Zeicheneinheit dargestellt durch einen einzelnen Unicode-Codepunkt. Wird von Python 3 verwendet.

utf16CodeUnit

string

Zeicheneinheit dargestellt durch eine 16-Bit-Unicode-Codeeinheit. Wird von JavaScript, Java und .NET verwendet.