Create Evaluation
curl --request POST \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"document_ids": [
"<string>"
],
"extraction_request": {
"document_id": "<string>",
"llm_model_prefix": "gemini-3.7-flash",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"sources": [
{
"type": "description"
}
],
"instruction": "<string>",
"provide_location": false,
"fields": [
{
"name": "<string>",
"id": "<string>",
"instruction": "<string>",
"barcode": false,
"extract_all_urls": false,
"integer_decimal_handling": "error",
"table_search": {
"dataset_id": "<string>",
"input_columns": [
"<string>"
],
"output_columns": [
{
"name": "<string>",
"id_column": "<string>"
}
]
}
}
],
"example_documents": [
"<string>"
],
"registries": [
{
"name": "<string>",
"library_id": "<string>",
"document_class_id": "<string>",
"field_mappings": [
{
"extracted_field": "<string>",
"registry_field": "<string>",
"key_field": false,
"optional_key": false,
"similarity_threshold": 1
}
],
"match_mode": "ALL"
}
]
}
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations"
payload = {
"name": "<string>",
"document_ids": ["<string>"],
"extraction_request": {
"document_id": "<string>",
"llm_model_prefix": "gemini-3.7-flash",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"sources": [{ "type": "description" }],
"instruction": "<string>",
"provide_location": False,
"fields": [
{
"name": "<string>",
"id": "<string>",
"instruction": "<string>",
"barcode": False,
"extract_all_urls": False,
"integer_decimal_handling": "error",
"table_search": {
"dataset_id": "<string>",
"input_columns": ["<string>"],
"output_columns": [
{
"name": "<string>",
"id_column": "<string>"
}
]
}
}
],
"example_documents": ["<string>"],
"registries": [
{
"name": "<string>",
"library_id": "<string>",
"document_class_id": "<string>",
"field_mappings": [
{
"extracted_field": "<string>",
"registry_field": "<string>",
"key_field": False,
"optional_key": False,
"similarity_threshold": 1
}
],
"match_mode": "ALL"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
document_ids: ['<string>'],
extraction_request: {
document_id: '<string>',
llm_model_prefix: 'gemini-3.7-flash',
attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
sources: [{type: 'description'}],
instruction: '<string>',
provide_location: false,
fields: [
{
name: '<string>',
id: '<string>',
instruction: '<string>',
barcode: false,
extract_all_urls: false,
integer_decimal_handling: 'error',
table_search: {
dataset_id: '<string>',
input_columns: ['<string>'],
output_columns: [{name: '<string>', id_column: '<string>'}]
}
}
],
example_documents: ['<string>'],
registries: [
{
name: '<string>',
library_id: '<string>',
document_class_id: '<string>',
field_mappings: [
{
extracted_field: '<string>',
registry_field: '<string>',
key_field: false,
optional_key: false,
similarity_threshold: 1
}
],
match_mode: 'ALL'
}
]
}
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'document_ids' => [
'<string>'
],
'extraction_request' => [
'document_id' => '<string>',
'llm_model_prefix' => 'gemini-3.7-flash',
'attachment_filters' => [
[
'name' => '<string>',
'id' => '<string>',
'mime_type' => '<string>'
]
],
'sources' => [
[
'type' => 'description'
]
],
'instruction' => '<string>',
'provide_location' => false,
'fields' => [
[
'name' => '<string>',
'id' => '<string>',
'instruction' => '<string>',
'barcode' => false,
'extract_all_urls' => false,
'integer_decimal_handling' => 'error',
'table_search' => [
'dataset_id' => '<string>',
'input_columns' => [
'<string>'
],
'output_columns' => [
[
'name' => '<string>',
'id_column' => '<string>'
]
]
]
]
],
'example_documents' => [
'<string>'
],
'registries' => [
[
'name' => '<string>',
'library_id' => '<string>',
'document_class_id' => '<string>',
'field_mappings' => [
[
'extracted_field' => '<string>',
'registry_field' => '<string>',
'key_field' => false,
'optional_key' => false,
'similarity_threshold' => 1
]
],
'match_mode' => 'ALL'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"library_id": "<string>",
"name": "<string>",
"created_by": "<string>",
"document_ids": [
"<string>"
],
"status": "<string>",
"total_documents": 123,
"processed_documents": 123,
"failed_documents": 123,
"created_at": "<string>",
"expire_at": "<string>",
"llm_model": "<string>",
"overall_accuracy": 123,
"field_accuracies": {},
"fully_correct_document_ratio": 123,
"total_cost": 123,
"average_cost_per_document": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}metadata_evaluation
Create Evaluation
Create a new metadata extraction evaluation. Starts async processing immediately.
POST
/
assistant
/
api
/
v1
/
tenants
/
{tenant}
/
libraries
/
{library_id}
/
evaluations
Create Evaluation
curl --request POST \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"document_ids": [
"<string>"
],
"extraction_request": {
"document_id": "<string>",
"llm_model_prefix": "gemini-3.7-flash",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"sources": [
{
"type": "description"
}
],
"instruction": "<string>",
"provide_location": false,
"fields": [
{
"name": "<string>",
"id": "<string>",
"instruction": "<string>",
"barcode": false,
"extract_all_urls": false,
"integer_decimal_handling": "error",
"table_search": {
"dataset_id": "<string>",
"input_columns": [
"<string>"
],
"output_columns": [
{
"name": "<string>",
"id_column": "<string>"
}
]
}
}
],
"example_documents": [
"<string>"
],
"registries": [
{
"name": "<string>",
"library_id": "<string>",
"document_class_id": "<string>",
"field_mappings": [
{
"extracted_field": "<string>",
"registry_field": "<string>",
"key_field": false,
"optional_key": false,
"similarity_threshold": 1
}
],
"match_mode": "ALL"
}
]
}
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations"
payload = {
"name": "<string>",
"document_ids": ["<string>"],
"extraction_request": {
"document_id": "<string>",
"llm_model_prefix": "gemini-3.7-flash",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"sources": [{ "type": "description" }],
"instruction": "<string>",
"provide_location": False,
"fields": [
{
"name": "<string>",
"id": "<string>",
"instruction": "<string>",
"barcode": False,
"extract_all_urls": False,
"integer_decimal_handling": "error",
"table_search": {
"dataset_id": "<string>",
"input_columns": ["<string>"],
"output_columns": [
{
"name": "<string>",
"id_column": "<string>"
}
]
}
}
],
"example_documents": ["<string>"],
"registries": [
{
"name": "<string>",
"library_id": "<string>",
"document_class_id": "<string>",
"field_mappings": [
{
"extracted_field": "<string>",
"registry_field": "<string>",
"key_field": False,
"optional_key": False,
"similarity_threshold": 1
}
],
"match_mode": "ALL"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
document_ids: ['<string>'],
extraction_request: {
document_id: '<string>',
llm_model_prefix: 'gemini-3.7-flash',
attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
sources: [{type: 'description'}],
instruction: '<string>',
provide_location: false,
fields: [
{
name: '<string>',
id: '<string>',
instruction: '<string>',
barcode: false,
extract_all_urls: false,
integer_decimal_handling: 'error',
table_search: {
dataset_id: '<string>',
input_columns: ['<string>'],
output_columns: [{name: '<string>', id_column: '<string>'}]
}
}
],
example_documents: ['<string>'],
registries: [
{
name: '<string>',
library_id: '<string>',
document_class_id: '<string>',
field_mappings: [
{
extracted_field: '<string>',
registry_field: '<string>',
key_field: false,
optional_key: false,
similarity_threshold: 1
}
],
match_mode: 'ALL'
}
]
}
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'document_ids' => [
'<string>'
],
'extraction_request' => [
'document_id' => '<string>',
'llm_model_prefix' => 'gemini-3.7-flash',
'attachment_filters' => [
[
'name' => '<string>',
'id' => '<string>',
'mime_type' => '<string>'
]
],
'sources' => [
[
'type' => 'description'
]
],
'instruction' => '<string>',
'provide_location' => false,
'fields' => [
[
'name' => '<string>',
'id' => '<string>',
'instruction' => '<string>',
'barcode' => false,
'extract_all_urls' => false,
'integer_decimal_handling' => 'error',
'table_search' => [
'dataset_id' => '<string>',
'input_columns' => [
'<string>'
],
'output_columns' => [
[
'name' => '<string>',
'id_column' => '<string>'
]
]
]
]
],
'example_documents' => [
'<string>'
],
'registries' => [
[
'name' => '<string>',
'library_id' => '<string>',
'document_class_id' => '<string>',
'field_mappings' => [
[
'extracted_field' => '<string>',
'registry_field' => '<string>',
'key_field' => false,
'optional_key' => false,
'similarity_threshold' => 1
]
],
'match_mode' => 'ALL'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/libraries/{library_id}/evaluations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"document_ids\": [\n \"<string>\"\n ],\n \"extraction_request\": {\n \"document_id\": \"<string>\",\n \"llm_model_prefix\": \"gemini-3.7-flash\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"sources\": [\n {\n \"type\": \"description\"\n }\n ],\n \"instruction\": \"<string>\",\n \"provide_location\": false,\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"instruction\": \"<string>\",\n \"barcode\": false,\n \"extract_all_urls\": false,\n \"integer_decimal_handling\": \"error\",\n \"table_search\": {\n \"dataset_id\": \"<string>\",\n \"input_columns\": [\n \"<string>\"\n ],\n \"output_columns\": [\n {\n \"name\": \"<string>\",\n \"id_column\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"example_documents\": [\n \"<string>\"\n ],\n \"registries\": [\n {\n \"name\": \"<string>\",\n \"library_id\": \"<string>\",\n \"document_class_id\": \"<string>\",\n \"field_mappings\": [\n {\n \"extracted_field\": \"<string>\",\n \"registry_field\": \"<string>\",\n \"key_field\": false,\n \"optional_key\": false,\n \"similarity_threshold\": 1\n }\n ],\n \"match_mode\": \"ALL\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"library_id": "<string>",
"name": "<string>",
"created_by": "<string>",
"document_ids": [
"<string>"
],
"status": "<string>",
"total_documents": 123,
"processed_documents": 123,
"failed_documents": 123,
"created_at": "<string>",
"expire_at": "<string>",
"llm_model": "<string>",
"overall_accuracy": 123,
"field_accuracies": {},
"fully_correct_document_ratio": 123,
"total_cost": 123,
"average_cost_per_document": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the library
The domain of the customer
Example:
"example.com"
Body
application/json
Human-readable label for this evaluation run
IDs of the AODocs documents to evaluate against their current field values
The full extraction request configuration to use (fields, registries, example_documents, feature_config). The document_id field is ignored here and overridden per-document during evaluation.
Show child attributes
Show child attributes
Response
Successful Response
PENDING | RUNNING | DONE | FAILED | CANCELLED
ISO 8601 timestamp
ISO 8601 timestamp — entity is auto-deleted after this date
Average correctness across all document+field pairs (0.0–1.0). Populated when status=DONE.
Per-field accuracy keyed by field ID. Populated when status=DONE.
Show child attributes
Show child attributes
Fraction of documents where every evaluated field was correct (0.0–1.0). Populated when status=DONE.
Total LLM cost in USD across all evaluated documents. Populated when status=DONE.
Average LLM cost in USD per document. Populated when status=DONE.