Document Models - Analyze Document
Analisa o documento com o modelo de documento.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-previewPOST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string uri |
O ponto de extremidade do serviço do Document Intelligence. |
|
model
|
path | True |
string |
Nome exclusivo do modelo de documento. Padrão Regex: |
|
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
|
features
|
query |
Lista de recursos de análise opcionais. |
||
|
locale
|
query |
string |
Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US"). |
|
|
output
|
query |
Saídas adicionais a serem geradas durante a análise. |
||
|
output
|
query |
Formato do conteúdo de nível superior do resultado de análise. |
||
|
pages
|
query |
string |
Lista de números de página baseados em 1 a serem analisados. Ex. "1-3,5,7-9" Padrão Regex: |
|
|
query
|
query |
string[] |
Lista de campos adicionais a serem extraídos. Ex. "NumberOfGuests,StoreNumber" |
|
|
string
|
query |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| base64Source |
string |
Codificação base64 do documento a ser analisado. UrlSource ou base64Source devem ser especificados. |
| urlSource |
string |
URL do documento a ser analisada. UrlSource ou base64Source devem ser especificados. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 202 Accepted |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
| Nome | Description |
|---|---|
| https://cognitiveservices.azure.com/.default |
Exemplos
| Analyze Document from Base64 |
| Analyze Document from Url |
Analyze Document from Base64
Solicitação de exemplo
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements
{
"base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}
Resposta de exemplo
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-previewAnalyze Document from Url
Solicitação de exemplo
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Resposta de exemplo
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-previewDefinições
| Nome | Description |
|---|---|
|
Analyze |
Parâmetros de análise de documento. |
|
Analyze |
Saídas adicionais a serem geradas durante a análise. |
|
Content |
Formato do conteúdo no resultado analisado. |
|
Document |
Recursos de análise de documentos a serem habilitados. |
| Error |
O objeto de erro. |
|
Error |
Objeto de resposta de erro. |
|
Inner |
Um objeto que contém informações mais específicas sobre o erro. |
|
String |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
AnalyzeDocumentRequest
Parâmetros de análise de documento.
| Nome | Tipo | Description |
|---|---|---|
| base64Source |
string |
Codificação base64 do documento a ser analisado. UrlSource ou base64Source devem ser especificados. |
| urlSource |
string |
URL do documento a ser analisada. UrlSource ou base64Source devem ser especificados. |
AnalyzeOutputOption
Saídas adicionais a serem geradas durante a análise.
| Nome | Tipo | Description |
|---|---|---|
| figures |
string |
Gerar imagens cortadas de figuras detectadas. |
|
string |
Gerar saída de PDF pesquisável. |
ContentFormat
Formato do conteúdo no resultado analisado.
| Nome | Tipo | Description |
|---|---|---|
| markdown |
string |
Representação markdown do conteúdo do documento com títulos de seção, tabelas etc. |
| text |
string |
Representação de texto sem formatação do conteúdo do documento sem nenhuma formatação. |
DocumentAnalysisFeature
Recursos de análise de documentos a serem habilitados.
| Nome | Tipo | Description |
|---|---|---|
| barcodes |
string |
Habilite a detecção de códigos de barras no documento. |
| formulas |
string |
Habilite a detecção de expressões matemáticas no documento. |
| keyValuePairs |
string |
Habilite a detecção de pares de valor de chave geral (campos de formulário) no documento. |
| languages |
string |
Habilite a detecção do idioma de conteúdo de texto. |
| ocrHighResolution |
string |
Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina. |
| queryFields |
string |
Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields. |
| styleFont |
string |
Habilite o reconhecimento de vários estilos de fonte. |
Error
O objeto de erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação legível pelo ser humano do erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Objeto de resposta de erro.
| Nome | Tipo | Description |
|---|---|---|
| error |
Informações de erro. |
InnerError
Um objeto que contém informações mais específicas sobre o erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| innererror |
Erro interno. |
|
| message |
string |
Uma representação legível pelo ser humano do erro. |
StringIndexType
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
| Nome | Tipo | Description |
|---|---|---|
| textElements |
string |
Caractere de exibição percebido pelo usuário ou cluster grapheme, conforme definido pelo Unicode 8.0.0. |
| unicodeCodePoint |
string |
Unidade de caractere representada por um único ponto de código unicode. Usado pelo Python 3. |
| utf16CodeUnit |
string |
Unidade de caractere representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET. |