Document Models - Compose Model

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-07-31-preview

Crea un nuovo modello di documento dai tipi di documento dei modelli di documento esistenti.

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string uri	Endpoint del servizio Document Intelligence.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
classifierId	True	string	Classificatore personalizzato per suddividere e classificare il file di input.
docTypes	True	<string, DocumentTypeDetails>	Mapping dei dizionari docType supportati ai modelli di documento corrispondenti.
modelId	True	string	Nome univoco del modello di documento.
description		string	Descrizione del modello di documento.
split		SplitMode	Comportamento di suddivisione dei file.
tags		object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Intestazioni Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

202 Accepted

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

Operation-Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Compose Document Model

Esempio di richiesta

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Risposta di esempio

Codice di stato:: 202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definizioni

Nome	Descrizione
ComposeDocumentModelRequest	Corpo della richiesta per creare un modello di documento composto dai modelli di documento dei componenti.
DocumentAnalysisFeature	Funzionalità di analisi dei documenti da abilitare.
DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
DocumentFieldSchema	Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON.
DocumentFieldType	Tipo di dati semantico del valore del campo.
DocumentTypeDetails	Informazioni sul tipo di documento.
Error	Oggetto error.
ErrorResponse	Oggetto risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
SplitMode	Comportamento di suddivisione dei file.

ComposeDocumentModelRequest

Corpo della richiesta per creare un modello di documento composto dai modelli di documento dei componenti.

Nome	Tipo	Valore predefinito	Descrizione
classifierId	string		Classificatore personalizzato per suddividere e classificare il file di input.
description	string		Descrizione del modello di documento.
docTypes	<string, DocumentTypeDetails>		Mapping dei dizionari docType supportati ai modelli di documento corrispondenti.
modelId	string		Nome univoco del modello di documento.
split	SplitMode	none	Comportamento di suddivisione dei file.
tags	object		Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentAnalysisFeature

Funzionalità di analisi dei documenti da abilitare.

Nome	Tipo	Descrizione
barcodes	string	Abilitare il rilevamento dei codici a barre nel documento.
formulas	string	Abilitare il rilevamento delle espressioni matematiche nel documento.
keyValuePairs	string	Abilitare il rilevamento delle coppie chiave-valore generale (campi modulo) nel documento.
languages	string	Abilitare il rilevamento della lingua del contenuto del testo.
ocrHighResolution	string	Eseguire OCR con una risoluzione superiore per gestire i documenti con stampa fine.
queryFields	string	Abilitare l'estrazione di campi aggiuntivi tramite il parametro di query QueryFields.
styleFont	string	Abilitare il riconoscimento di vari stili di carattere.

DocumentBuildMode

Modalità di compilazione del modello di documento personalizzato.

Nome	Tipo	Descrizione
generative	string	Abilitare documenti di tutti i tipi usando tecniche di intelligenza artificiale generative.
neural	string	Supportare documenti con modelli visivi diversi.
template	string	Eseguire la destinazione di documenti con modelli di oggetti visivi simili.

DocumentFieldSchema

Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON.

Nome	Tipo	Descrizione
description	string	Descrizione del campo.
example	string	Contenuto del campo di esempio.
items	DocumentFieldSchema	Schema del tipo di campo di ogni elemento della matrice.
properties	<string, DocumentFieldSchema>	Campi secondari denominati del campo oggetto.
type	DocumentFieldType	Tipo di dati semantico del valore del campo.

DocumentFieldType

Tipo di dati semantico del valore del campo.

Nome	Tipo	Descrizione
address	string	Indirizzo analizzato.
array	string	Elenco di campi secondari dello stesso tipo.
boolean	string	Valore booleano, normalizzato in true o false.
countryRegion	string	Paese/area geografica, normalizzato in formato ISO 3166-1 alfa-3 (ad esempio USA).
currency	string	Importo valuta con simbolo di valuta e unità facoltativi.
date	string	Data, normalizzata in formato ISO 8601 (AAAA-MM-DD).
integer	string	Numero intero normalizzato in intero con segno a 64 bit.
number	string	Numero a virgola mobile normalizzato in virgola mobile a precisione doppia.
object	string	Elenco denominato di sottocampi di tipi potenzialmente diversi.
phoneNumber	string	Numero di telefono normalizzato in formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matrice di valori stringa selezionati.
selectionMark	string	Il campo è selezionato?
signature	string	La firma è presente?
string	string	Testo normale.
time	string	Ora normalizzata in formato ISO 8601 (hh:mm:ss).

DocumentTypeDetails

Informazioni sul tipo di documento.

Nome	Tipo	Descrizione
buildMode	DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
confidenceThreshold	number	Eseguire l'analisi solo se l'attendibilità docType è superiore alla soglia.
description	string	Descrizione del modello di documento.
features	DocumentAnalysisFeature[]	Elenco delle funzionalità di analisi facoltative.
fieldConfidence	object	Attendibilità stimata per ogni campo.
fieldSchema	<string, DocumentFieldSchema>	Descrizione dello schema semantico del documento usando una sintassi dello stile dello schema JSON.
maxDocumentsToAnalyze	integer	Numero massimo di documenti di tipo specificato da analizzare. Default=all.
modelId	string	Modello di documento da usare per l'analisi dei documenti con tipo specificato.
queryFields	string[]	Elenco di campi aggiuntivi da estrarre. Ex. "NumberOfGuests,StoreNumber"

Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	InnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.

SplitMode

Comportamento di suddivisione dei file.

Nome	Tipo	Descrizione
auto	string	Suddividere automaticamente il file in documenti.
none	string	Considerare l'intero file come un singolo documento.
perPage	string	Considera ogni pagina del file come documento separato.

Condividi tramite

Document Models - Compose Model

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Compose Document Model

Esempio di richiesta

Risposta di esempio

Definizioni

ComposeDocumentModelRequest

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Risorse aggiuntive