document-understanding
latest
false
- Getting Started
- Examples Using the Document Understanding™ Cloud API
- Licensing
- Troubleshooting
Generative classifier
Document Understanding API Guide
Generative classifier
Important:
This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.
Important:
This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.
Tip: The Project ID is obtained from the response received
from the Get project
information call.
curl -X 'POST' \
'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/generative_classifier/classification?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjkxODQzNjM3MzVGRDU1RDgyQ0JBNTM2N0Y1MDdCNEEwOEUzMkUxNkEiLCJ4NXQiOiJrWVEyTnpYOVZkZ3N1bE5uOVFlMG9JNHk0V28iLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FscGhhLnVpcGF0aC5jb20vaWRlbnRpdHlfIiwibmJmIjoxNzAyMjkxOTcwLCJpYXQiOjE3MDIyOTIyNzAsImV4cCI6MTcwMjI5NTg3MCwiYXVkIjoiVWlQYXRoLkRvY3VtZW50VW5kZXJzdGFuZGluZyIsInNjb3BlIjpbIkR1LkNsYXNzaWZpY2F0aW9uLkFwaSIsIkR1LkRpZ2l0aXphdGlvbi5BcGkiLCJEdS5FeHRyYWN0aW9uLkFwaSIsIkR1LlZhbGlkYXRpb24uQXBpIl0sInN1Yl90eXBlIjoic2VydmljZS5leHRlcm5hbCIsInBydF9pZCI6IjQwOTExYTg1LTJiOWQtNDRlYS04NjU1LWFiZjg2OWRlODU4OCIsImNsaWVudF9pZCI6IjhiMGI3MzE1LTUyZWItNDNkZS04NmFhLTAxY2JkMjNmYTY4ZCIsImp0aSI6IkJBRjlCMTczRDcyNkZENjc5MUJGN0NEQjZFNjcyOTdBIn0.DLF7AK_Q2xwnR0VJxagXLNM6kuxjDt0F6d_UEV3AmEhr_Gi8Ykn4UXVfa-YbnnZvx5mLcZdT9kAZIPVi3FvE7R6N_60FS7j72TMjhaBtKVzt7NBxMjdXmuEqoom9wyRhX5IXEdWxhg5GGseL_m7fbLcBJYrHIvmZCIcTVNLMd73E5TzJwaW3TpQ_cZOBtvjhOZ-lIZus_R2hPez3v5E_d2BsmV9kbIf-DnhQm5LfUvD2JYytSiTiiWQVDE4lVDqQri88feUwSMOKp7e1Z_Kg9i7mf7SHjL9uH0tQWczTOP0LDHHN0uOsJsVhmlmMREyMjnjF0X8vA2PVda3uyjUJqg' \
-H 'Content-Type: application/json' \
-d '{
"documentId": "fa83da2a-1498-ee11-8925-000d3a67a01e",
"prompts": [
{
"name": "Invoice",
"description": "A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms."
},
{
"name": "Receipt",
"description": "A written acknowledgment of having received a specified amount of money, goods, or services."
}
]
}'
curl -X 'POST' \
'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/generative_classifier/classification?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjkxODQzNjM3MzVGRDU1RDgyQ0JBNTM2N0Y1MDdCNEEwOEUzMkUxNkEiLCJ4NXQiOiJrWVEyTnpYOVZkZ3N1bE5uOVFlMG9JNHk0V28iLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FscGhhLnVpcGF0aC5jb20vaWRlbnRpdHlfIiwibmJmIjoxNzAyMjkxOTcwLCJpYXQiOjE3MDIyOTIyNzAsImV4cCI6MTcwMjI5NTg3MCwiYXVkIjoiVWlQYXRoLkRvY3VtZW50VW5kZXJzdGFuZGluZyIsInNjb3BlIjpbIkR1LkNsYXNzaWZpY2F0aW9uLkFwaSIsIkR1LkRpZ2l0aXphdGlvbi5BcGkiLCJEdS5FeHRyYWN0aW9uLkFwaSIsIkR1LlZhbGlkYXRpb24uQXBpIl0sInN1Yl90eXBlIjoic2VydmljZS5leHRlcm5hbCIsInBydF9pZCI6IjQwOTExYTg1LTJiOWQtNDRlYS04NjU1LWFiZjg2OWRlODU4OCIsImNsaWVudF9pZCI6IjhiMGI3MzE1LTUyZWItNDNkZS04NmFhLTAxY2JkMjNmYTY4ZCIsImp0aSI6IkJBRjlCMTczRDcyNkZENjc5MUJGN0NEQjZFNjcyOTdBIn0.DLF7AK_Q2xwnR0VJxagXLNM6kuxjDt0F6d_UEV3AmEhr_Gi8Ykn4UXVfa-YbnnZvx5mLcZdT9kAZIPVi3FvE7R6N_60FS7j72TMjhaBtKVzt7NBxMjdXmuEqoom9wyRhX5IXEdWxhg5GGseL_m7fbLcBJYrHIvmZCIcTVNLMd73E5TzJwaW3TpQ_cZOBtvjhOZ-lIZus_R2hPez3v5E_d2BsmV9kbIf-DnhQm5LfUvD2JYytSiTiiWQVDE4lVDqQri88feUwSMOKp7e1Z_Kg9i7mf7SHjL9uH0tQWczTOP0LDHHN0uOsJsVhmlmMREyMjnjF0X8vA2PVda3uyjUJqg' \
-H 'Content-Type: application/json' \
-d '{
"documentId": "fa83da2a-1498-ee11-8925-000d3a67a01e",
"prompts": [
{
"name": "Invoice",
"description": "A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms."
},
{
"name": "Receipt",
"description": "A written acknowledgment of having received a specified amount of money, goods, or services."
}
]
}'
Important:
This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.
{
"classificationResults": [
{
"DocumentTypeId": "Invoice",
"DocumentId": "fa83da2a-1498-ee11-8925-000d3a67a01e",
"Confidence": 0.9,
"OcrConfidence": -1,
"Reference": {
"TextStartIndex": 0,
"TextLength": 0,
"Tokens": []
},
"DocumentBounds": {
"StartPage": 0,
"PageCount": 1,
"TextStartIndex": 0,
"TextLength": 864
},
"ClassifierName": "Generative Classifier"
}
]
}
{
"classificationResults": [
{
"DocumentTypeId": "Invoice",
"DocumentId": "fa83da2a-1498-ee11-8925-000d3a67a01e",
"Confidence": 0.9,
"OcrConfidence": -1,
"Reference": {
"TextStartIndex": 0,
"TextLength": 0,
"Tokens": []
},
"DocumentBounds": {
"StartPage": 0,
"PageCount": 1,
"TextStartIndex": 0,
"TextLength": 864
},
"ClassifierName": "Generative Classifier"
}
]
}