Document Models - Analyze Document

Servizio:

Azure AI Services

Versione API:

2022-08-31

Analizza il documento con il modello di documento.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2022-08-31

Con parametri facoltativi:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2022-08-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
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	ApiVersion	Versione dell'API richiesta.
locale	query		string	Hint per le impostazioni locali per il riconoscimento del testo e l'analisi dei documenti. Il valore può contenere solo il codice lingua (ad esempio "en", "fr") o il tag di lingua BCP 47 (ad esempio "en-US").
pages	query		string	Elenco di numeri di pagina basati su 1 da analizzare. Ex. "1-3,5,7-9" Criterio di espressione regolare: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

Intestazione della richiesta

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Corpo della richiesta

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Nome	Tipo	Descrizione
base64Source	string	Codifica Base64 del documento da analizzare
urlSource	string	URL documento da analizzare

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta viene accodata correttamente. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Errore rilevato.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Esempio di richiesta

HTTP

POST {endpoint}/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "base64Source": ""
}

Risposta di esempio

Codice di stato:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version=2022-08-31

AnalyzeDocument_Url

Esempio di richiesta

HTTP

POST {endpoint}/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "urlSource": "http://host.com/doc.pdf"
}

Risposta di esempio

Codice di stato:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version=2022-08-31

Definizioni

Nome	Descrizione
AnalyzeDocumentRequest	Parametri di analisi dei documenti.
ApiVersion	Versione dell'API.
Error	Informazioni sugli errori.
ErrorResponse	Oggetto risposta di errore.
InnerError	Errore dettagliato.
StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

AnalyzeDocumentRequest

Parametri di analisi dei documenti.

Nome	Tipo	Descrizione
base64Source	string	Codifica Base64 del documento da analizzare
urlSource	string	URL documento da analizzare

ApiVersion

Versione dell'API.

Nome	Tipo	Descrizione
2022-08-31	string

Error

Informazioni sugli errori.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	Error[]	Elenco degli errori dettagliati.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sugli errori.

InnerError

Errore dettagliato.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.

StringIndexType

Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

Nome	Tipo	Descrizione
textElements	string
unicodeCodePoint	string
utf16CodeUnit	string