Skip to content

docs: bounding boxes&confidence score #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
superojla merged 1 commit into from
Sep 28, 2026
Merged

docs: bounding boxes&confidence score #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 23 additions & 19 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "21e370b9bd"
"x-box-commit-hash": "cae48740aa"
},
"servers": [
{
Expand Down Expand Up @@ -18423,6 +18423,16 @@
}
}
},
"403": {
"description": "Returns an error if the user does not have the required permissions\nto create a retention policy.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"409": {
"description": "Returns an error if a retention policy with the given name already exists.",
"content": {
Expand Down Expand Up @@ -27731,12 +27741,12 @@
]
},
"include_confidence_score": {
"description": "A flag to indicate whether confidence scores for every extracted field should be returned.",
"description": "A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability.",
"type": "boolean",
"example": true
},
"include_reference": {
"description": "A flag to indicate whether references for every extracted field should be returned.",
"description": "A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found.",
"type": "boolean",
"example": true
},
Expand Down Expand Up @@ -29991,17 +30001,17 @@
"x-box-tag": "collaboration_allowlist_exempt_targets"
},
"CollaborationItem": {
"description": "A collaboration item.",
"description": "A mini representation of the file, folder, or web link that a\ncollaboration is granted on.",
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/File"
"$ref": "#/components/schemas/File--Mini"
},
{
"$ref": "#/components/schemas/Folder"
"$ref": "#/components/schemas/Folder--Mini"
},
{
"$ref": "#/components/schemas/WebLink"
"$ref": "#/components/schemas/WebLink--Mini"
}
],
"title": "Collaboration item"
Expand Down Expand Up @@ -31418,11 +31428,9 @@
},
{
"description": "The shared link for this file. This value will be\n`null` if no shared link has been created for this\nfile."
},
{
"nullable": true
}
]
],
"nullable": true
},
"parent": {
"allOf": [
Expand Down Expand Up @@ -32023,11 +32031,9 @@
},
{
"description": "Details about the classification applied to this file."
},
{
"nullable": true
}
]
],
"nullable": true
},
"uploader_display_name": {
"allOf": [
Expand Down Expand Up @@ -43751,11 +43757,9 @@
},
{
"description": "The shared link object for this item. Will be\n`null` if no shared link has been created."
},
{
"nullable": true
}
]
],
"nullable": true
},
"item_status": {
"description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "21e370b9bd"
"x-box-commit-hash": "cae48740aa"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2026.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2026.0",
"x-box-commit-hash": "21e370b9bd"
"x-box-commit-hash": "cae48740aa"
},
"servers": [
{
Expand Down
42 changes: 23 additions & 19 deletions openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "21e370b9bd"
"x-box-commit-hash": "cae48740aa"
},
"servers": [
{
Expand Down Expand Up @@ -18423,6 +18423,16 @@
}
}
},
"403": {
"description": "Returns an error if the user does not have the required permissions\nto create a retention policy.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"409": {
"description": "Returns an error if a retention policy with the given name already exists.",
"content": {
Expand Down Expand Up @@ -27731,12 +27741,12 @@
]
},
"include_confidence_score": {
"description": "A flag to indicate whether confidence scores for every extracted field should be returned.",
"description": "A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability.",
"type": "boolean",
"example": true
},
"include_reference": {
"description": "A flag to indicate whether references for every extracted field should be returned.",
"description": "A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found.",
"type": "boolean",
"example": true
},
Expand Down Expand Up @@ -29991,17 +30001,17 @@
"x-box-tag": "collaboration_allowlist_exempt_targets"
},
"CollaborationItem": {
"description": "A collaboration item.",
"description": "A mini representation of the file, folder, or web link that a\ncollaboration is granted on.",
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/File"
"$ref": "#/components/schemas/File--Mini"
},
{
"$ref": "#/components/schemas/Folder"
"$ref": "#/components/schemas/Folder--Mini"
},
{
"$ref": "#/components/schemas/WebLink"
"$ref": "#/components/schemas/WebLink--Mini"
}
],
"title": "Collaboration item"
Expand Down Expand Up @@ -31418,11 +31428,9 @@
},
{
"description": "The shared link for this file. This value will be\n`null` if no shared link has been created for this\nfile."
},
{
"nullable": true
}
]
],
"nullable": true
},
"parent": {
"allOf": [
Expand Down Expand Up @@ -32023,11 +32031,9 @@
},
{
"description": "Details about the classification applied to this file."
},
{
"nullable": true
}
]
],
"nullable": true
},
"uploader_display_name": {
"allOf": [
Expand Down Expand Up @@ -43751,11 +43757,9 @@
},
{
"description": "The shared link object for this item. Will be\n`null` if no shared link has been created."
},
{
"nullable": true
}
]
],
"nullable": true
},
"item_status": {
"description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.",
Expand Down
Loading