Document Models - Get Model

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-07-31-preview

Ottiene informazioni dettagliate sul modello di documento.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-07-31-preview

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string uri	Endpoint del servizio Document Intelligence.
modelId	path	True	string	Nome univoco del modello di documento. Criterio di espressione regolare: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

endpoint

path

True

string

uri

Endpoint del servizio Document Intelligence.

modelId

path

True

string

Nome univoco del modello di documento.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	DocumentModelDetails	La richiesta ha avuto esito positivo. Intestazioni x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

DocumentModelDetails

La richiesta ha avuto esito positivo.

Intestazioni

x-ms-client-request-id: string

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

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Esempio di richiesta

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-07-31-preview

Risposta di esempio

Codice di stato:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

Definizioni

Nome	Descrizione
AzureBlobContentSource	Contenuto di Archiviazione BLOB di Azure.
AzureBlobFileListContentSource	Elenco di file in Archiviazione BLOB di Azure.
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.
DocumentModelDetails	Informazioni sul modello di documento.
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.
Warning	Oggetto error.

AzureBlobContentSource

Contenuto di Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string	URL del contenitore di Archiviazione BLOB di Azure.
prefix	string	Prefisso del nome BLOB.

AzureBlobFileListContentSource

Elenco di file in Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string	URL del contenitore di Archiviazione BLOB di Azure.
fileList	string	Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti.

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).

DocumentModelDetails

Informazioni sul modello di documento.

Nome	Tipo	Valore predefinito	Descrizione
apiVersion	string		Versione dell'API usata per creare questo modello di documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Elenco di file di Archiviazione BLOB di Azure che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Percorso di Archiviazione BLOB di Azure contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modalità di compilazione del modello di documento personalizzato.
classifierId	string		Per i modelli composti, il classificatore personalizzato per suddividere e classificare il file di input.
createdDateTime	string		Data e ora (UTC) di creazione del modello di documento.
description	string		Descrizione del modello di documento.
docTypes	<string, DocumentTypeDetails>		Tipi di documento supportati.
expirationDateTime	string		Data e ora (UTC) alla scadenza del modello di documento.
modelId	string		Nome univoco del modello di documento.
split	SplitMode	none	Per i modelli composti, il comportamento di suddivisione dei file.
tags	object		Elenco degli attributi di tag chiave-valore associati al modello di documento.
trainingHours	number		Numero di ore GPU equivalenti V100 utilizzate per il training del modello.
warnings	Warning[]		Elenco di avvisi rilevati durante la compilazione del modello.

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.

Warning

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di avviso.
message	string	Rappresentazione leggibile dell'avviso.
target	string	Destinazione dell'errore.

Condividi tramite

Document Models - Get Model

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Get Custom Document Model

Esempio di richiesta

Risposta di esempio

Get Prebuilt Document Model

Esempio di richiesta

Risposta di esempio

Definizioni

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

Risorse aggiuntive