API Reference
Schema
Platform
- Evals
- POSTCreate
- DELDelete
- GETGet
- GETList
- PATCHUpdate
- Documents
- Iterations
- POST
- Processors
- Secrets
Evals
List
List evaluations with pagination support.
GET
/
v1
/
evals
Copy
curl --request GET \
--url https://api.uiform.com/v1/evals
Copy
{
"data": [
{
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"documents": [
{
"mime_data": {
"filename": "file.pdf",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..."
},
"annotation": {},
"annotation_metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
],
"api_cost": {
"value": 123,
"currency": "<string>"
}
},
"id": "<string>"
}
],
"iterations": [
{
"id": "<string>",
"inference_settings": {
"model": "<string>",
"temperature": 123,
"modality": "text",
"reasoning_effort": "low",
"image_resolution_dpi": 123,
"browser_canvas": "A3",
"n_consensus": 123
},
"json_schema": {},
"predictions": [
{
"prediction": {},
"metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
],
"api_cost": {
"value": 123,
"currency": "<string>"
}
}
}
],
"metric_results": {
"item_metrics": [
{
"id": "<string>",
"name": "<string>",
"similarity": 123,
"similarities": {},
"flat_similarities": {},
"aligned_similarity": 123,
"aligned_similarities": {},
"aligned_flat_similarities": {}
}
],
"mean_similarity": 123,
"aligned_mean_similarity": 123,
"metric_type": "levenshtein"
},
"schema_data_id": "<string>",
"schema_id": "<string>"
}
],
"json_schema": {},
"project_id": "default_spreadsheets",
"default_inference_settings": {
"model": "<string>",
"temperature": 123,
"modality": "text",
"reasoning_effort": "low",
"image_resolution_dpi": 123,
"browser_canvas": "A3",
"n_consensus": 123
},
"schema_data_id": "<string>",
"schema_id": "<string>"
}
],
"list_metadata": {
"before": "<string>",
"after": "<string>"
}
}
Authorizations
Query Parameters
Available options:
asc
, desc
Response
200
application/json
Successful Response
The response is of type object
.
Copy
curl --request GET \
--url https://api.uiform.com/v1/evals
Copy
{
"data": [
{
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"documents": [
{
"mime_data": {
"filename": "file.pdf",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..."
},
"annotation": {},
"annotation_metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
],
"api_cost": {
"value": 123,
"currency": "<string>"
}
},
"id": "<string>"
}
],
"iterations": [
{
"id": "<string>",
"inference_settings": {
"model": "<string>",
"temperature": 123,
"modality": "text",
"reasoning_effort": "low",
"image_resolution_dpi": 123,
"browser_canvas": "A3",
"n_consensus": 123
},
"json_schema": {},
"predictions": [
{
"prediction": {},
"metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
],
"api_cost": {
"value": 123,
"currency": "<string>"
}
}
}
],
"metric_results": {
"item_metrics": [
{
"id": "<string>",
"name": "<string>",
"similarity": 123,
"similarities": {},
"flat_similarities": {},
"aligned_similarity": 123,
"aligned_similarities": {},
"aligned_flat_similarities": {}
}
],
"mean_similarity": 123,
"aligned_mean_similarity": 123,
"metric_type": "levenshtein"
},
"schema_data_id": "<string>",
"schema_id": "<string>"
}
],
"json_schema": {},
"project_id": "default_spreadsheets",
"default_inference_settings": {
"model": "<string>",
"temperature": 123,
"modality": "text",
"reasoning_effort": "low",
"image_resolution_dpi": 123,
"browser_canvas": "A3",
"n_consensus": 123
},
"schema_data_id": "<string>",
"schema_id": "<string>"
}
],
"list_metadata": {
"before": "<string>",
"after": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.