Extração de Chave-Valor (NFFs)

A extração de valor de chave pode ser usada para identificar valores para chaves predefinidas em uma NFF. Por exemplo, se uma fatura incluir um nome de fornecedor, total e ID da fatura, o Document Understanding poderá identificar esses valores e retorná-los como um par de chave/valor.

Os recursos suportados são:
  • Extrair valores para pares de chave/valor predefinidos
  • Polígonos de contorno
  • Pontuação de segurança

Os campos suportados são:

Campos Suportados
Campo Descrição:
CustomerName Nome do cliente faturado.
CustomerId Identificador de referência do cliente.
PurchaseOrder Número da ordem de compra.
InvoiceId Identificador da NFF específica.
InvoiceDate Data de emissão na NFF.
DueDate Data de vencimento do pagamento nesta NFF.
VendorName Nome do fornecedor.
VendorAddress Endereço para correspondência do fornecedor.
VendorAddressRecipient Nome referenciado com VendorAddress.
CustomerAddress Endereço de correspondência do Cliente.
CustomerAddressRecipient Nome referenciado com CustomerAddress.
BillingAddress Endereço de faturamento explícito do cliente.
BillingAddressRecipient Nome referenciado com BillingAddress.
ShippingAddress Endereço de remessa explícito do cliente.
ShippingAddressRecipient Nome referenciado com ShippingAddress.
PaymentTerm As condições de pagamento da NFF.
Subtotal Campo de subtotal identificado neste documento fiscal.
TotalTax Valor total do imposto identificado nesta NFF.
InvoiceTotal Valor total do encargo associado à NFF.
AmountDue Valor total devido ao fornecedor.
ServiceAddress Endereço de serviço explícito ou endereço de propriedade do cliente.
ServiceAddressRecipient Nome referenciado com ServiceAddress.
RemittanceAddress Remessa explícita ou endereço de pagamento para o cliente.
RemittanceAddressRecipient Nome referenciado com RemittanceAddress.
ShippingCost Custos totais de expedição ou envio e manuseio associados a uma fatura.
ServiceStartDate Primeira data do período de serviço.
ServiceEndDate Data final do período de serviço.
PreviousUnpaidBalance Saldo não pago explícito anteriormente.

Os itens de linha suportados são:

Itens de Linha Suportados
Item de Linha Descrição
Itens Concatenação de todos os outros valores de item de linha (ou seja, a linha inteira do item de linha).
Nome O nome listado para um produto ou serviço, por exemplo, t-shirt.
Quantidade O valor do item de linha.
Descrição A descrição do texto do item de linha da fatura, por exemplo, camisa rayon masculina, tamanhos pequenos, médios e grandes.
Quantidade A quantidade deste item de linha da NFF.
UnitPrice O preço por item identificado na NFF.
ProductCode Código do produto, número do produto ou SKU referenciado no item de linha. Por exemplo, 123456.
Unidade A unidade do item de linha, por exemplo, kg, lb.
Imposto Imposto explicitamente referenciado no item de linha.
Data Data correspondente a cada item de linha.

Exemplo de Extração de Chave/Valor (Fatura)

Um exemplo do uso da extração de valor-chave de uma fatura no Document Understanding.

Documento de entrada
Solicitação de API Fatura fictícia para cabo e fio. de Entrada de Extração de Valor Chave (Fatura):
{ 
       "processorConfig": {  
       "processorType": "GENERAL", 
       "features": [   
       {    
       "featureType": "KEY_VALUE_EXTRACTION"  
       }, 
       "documentType": "INVOICE" 
       }, 
       "inputLocation": {  
       "sourceType": "OBJECT_STORAGE_LOCATIONS",  
       "objectLocations": [   
       {    
       "source": "OBJECT_STORAGE",   
       "namespaceName": "",    
       "bucketName": "",    
       "objectName": ""   
       }  
       ] 
       }, 
       "compartmentId": "", 
       "outputLocation": {  
       "namespaceName": "",  
       "bucketName": "",  
       "prefix": "" 
       }
       }
Saída:
Resposta da API:
{ 
       "documentMetadata": {  
       "pageCount": 1,  
       "mimeType": "image/png" 
       },  "pages": [  
       {   
       "pageNumber": 1,   
       "dimensions": {    
       "width": 1372,    
       "height": 1732,    
       "unit": "PIXEL"      },   
       "documentFields": [    
       {     
       "fieldType": "KEY_VALUE",     
       "fieldLabel": {      
       "name": "VendorAddress",      
       "confidence": 0.99862003    
       },     
       "fieldValue": {      
       "valueType": "STRING",      
       "text": "657 Clifford Street Allentown, PA",      
       "boundingPolygon": {       
       "normalizedVertices": [        
       {         
       "x": 0.08454810495626822,         
       "y": 0.10219399538106236        
       },        
       {         
       "x": 0.21793002915451895,          
       "y": 0.10219399538106236        
       },       
       {         
       "x": 0.21793002915451895,         
       "y": 0.13048498845265588        
       },       
       {         
       "x": 0.08454810495626822,
       "y": 0.13048498845265588        
       }       
       ]      
       },      
       "wordIndexes": [       
       3,      
       4,      
       5,      
       9,       
       10      
       ],      
       "value": "657 Clifford Street Allentown, PA"     
       }    
       },    
       {     
       "fieldType": "LINE_ITEM_GROUP",     
       "fieldLabel": {      
       "name": "Items"     
       },     
       "fieldValue": {      
       "valueType": "ARRAY",      
       "items": [       
       {        
       "fieldType": "LINE_ITEM",        
       "fieldValue": {         
       "valueType": "ARRAY",          
       "text": "1 Cable165XZ3654681 12.75 $12.75",         
       "items": [          
       {            
       "fieldType": "LINE_ITEM_FIELD",           
       "fieldLabel": {            
       "name": "Quantity",            
       "confidence": 0.9989789           
       },           
       "fieldValue": {             
       "valueType": "NUMBER",            
       "text": "1",           
       "boundingPolygon": {             
       "normalizedVertices": [
       {             
       "x": 0.39941690962099125,                 
       "y": 0.5075057736720554             
       },             
       {               
       "x": 0.39941690962099125,               
       "y": 0.5184757505773672              
       },             
       {              
       "x": 0.24927113702623907,               
       "y": 0.5184757505773672             
       }             
       ]            
       },            
       "wordIndexes": [             
       68           
       ],           
       "value": "Cable165XZ3654681"          
       }          
       },         
       {           
       "fieldType": "LINE_ITEM_FIELD",           
       "fieldLabel": {            
       "name": "UnitPrice",             
       "confidence": 0.9375645           
       },           
       "fieldValue": {            
       "valueType": "NUMBER",            
       "text": "12.75",            
       "boundingPolygon": {            
       "normalizedVertices": [             
       {                
       "x": 0.7594752186588921,              
       "y": 0.50635103926097             
       },            
       {              
       "x": 0.8024781341107872,               
       "y": 0.50635103926097             
       },
       {               
       "x": 0.8024781341107872,              
       "y": 0.5196304849884527              
       },             
       {                
       "x": 0.7594752186588921,              
       "y": 0.5196304849884527              
       }             
       ]            
       },            
       "wordIndexes": [             
       69           
       ],            
       "value": 12.75           
       }          
       },        
       ]        
       }       
       }      
       ]     
       }    
       }   
       ]  
       } 
       ],
       }