Skip to content

docs: Remove confidence_score and include_confidence_score from AI extract #567

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
antusus merged 1 commit into from
Dec 10, 2025
Merged

docs: Remove confidence_score and include_confidence_score from AI extract #567

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
32 changes: 16 additions & 16 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "0ff2cd637c"
"x-box-commit-hash": "989ee7d3a1"
},
"servers": [
{
Expand Down Expand Up @@ -9963,7 +9963,7 @@
"example": "2019-08-29T23:59:00-07:00"
},
"can_view_path": {
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.",
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.\n\nWhen you delete a folder with `can_view_path=true`, collaborators may still see the parent path. \nFor instructions on how to remove this, see \n[Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).",
"type": "boolean",
"example": true
}
Expand Down Expand Up @@ -10246,7 +10246,7 @@
"example": true
},
"can_view_path": {
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.",
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.\n\nWhen you delete a folder with `can_view_path=true`, collaborators may still see the parent path. \nFor instructions on how to remove this, see \n[Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).",
"type": "boolean",
"example": true
},
Expand Down Expand Up @@ -15257,7 +15257,7 @@
"put": {
"operationId": "put_users_id_folders_0",
"summary": "Transfer owned folders",
"description": "Move all of the items (files, folders and workflows) owned by a user into\nanother user's account\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative\npermissions.\n\nAll existing shared links and folder-level collaborations are transferred\nduring the operation. Please note that while collaborations at the individual\nfile-level are transferred during the operation, the collaborations are\ndeleted when the original user is deleted.\n\nIf the user has a large number of items across all folders, the call will\nbe run asynchronously. If the operation is not completed within 10 minutes,\nthe user will receive a 200 OK response, and the operation will continue running.\n\nIf the destination path has a metadata cascade policy attached to any of\nthe parent folders, a metadata cascade operation will be kicked off\nasynchronously.\n\nThere is currently no way to check for when this operation is finished.\n\nThe destination folder's name will be in the format `{User}'s Files and\nFolders`, where `{User}` is the display name of the user.\n\nTo make this API call your application will need to have the \"Read and write\nall files and folders stored in Box\" scope enabled.\n\nPlease make sure the destination user has access to `Relay` or `Relay Lite`,\nand has access to the files and folders involved in the workflows being\ntransferred.\n\nAdmins will receive an email when the operation is completed.",
"description": "Move all of the items (files, folders and workflows) owned by a user into\nanother user's account.\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative\npermissions.\n\nAll existing shared links and folder-level collaborations are transferred\nduring the operation. Please note that while collaborations at the individual\nfile-level are transferred during the operation, the collaborations are\ndeleted when the original user is deleted.\n\nIf the user has a large number of items across all folders, the call will\nbe run asynchronously. If the operation is not completed within 10 minutes,\nthe user will receive a 200 OK response, and the operation will continue running.\n\nIf the destination path has a metadata cascade policy attached to any of\nthe parent folders, a metadata cascade operation will be kicked off\nasynchronously.\n\nThere is currently no way to check for when this operation is finished.\n\nThe destination folder's name will be in the format `{User}'s Files and\nFolders`, where `{User}` is the display name of the user.\n\nTo make this API call your application will need to have the \"Read and write\nall files and folders stored in Box\" scope enabled.\n\nPlease make sure the destination user has access to `Relay` or `Relay Lite`,\nand has access to the files and folders involved in the workflows being\ntransferred.\n\nAdmins will receive an email when the operation is completed.",
"parameters": [
{
"name": "user_id",
Expand Down Expand Up @@ -15338,7 +15338,7 @@
}
},
"403": {
"description": "Returns an error when folder ownership cannot be\ntransferred to another user.\n\n* `forbidden_by_policy`: Returned if ownership transfer\n is forbidden due to information barrier restrictions.",
"description": "Returns an error when folder ownership cannot be\ntransferred to another user.\n\n* `forbidden_by_policy`: Returned if ownership transfer\n is forbidden due to information barrier restrictions.\n* `Cannot transfer files from/to higher privileged accounts`: You can only transfer content to or from managed users or your own account,\n not other co-admins or admins. Admins can transfer content between any users, including co-admins and managed users.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -20356,8 +20356,18 @@
}
}
},
"400": {
"description": "Returns an error if the enterprise is missing from the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"404": {
"description": "Returns an error if the enterprise was not found.",
"description": "Returns an error when an incorrect or null enterprise is present in the request body.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -25895,11 +25905,6 @@
"minItems": 1,
"uniqueItems": true
},
"include_confidence_score": {
"description": "A flag to indicate whether confidence scores for every extracted field should be returned.",
"type": "boolean",
"example": true
},
"ai_agent": {
"allOf": [
{
Expand Down Expand Up @@ -25948,11 +25953,6 @@
"type": "string",
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
"ai_agent_info": {
"$ref": "#/components/schemas/AiAgentInfo"
}
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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "0ff2cd637c"
"x-box-commit-hash": "989ee7d3a1"
},
"servers": [
{
Expand Down
32 changes: 16 additions & 16 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "0ff2cd637c"
"x-box-commit-hash": "989ee7d3a1"
},
"servers": [
{
Expand Down Expand Up @@ -9963,7 +9963,7 @@
"example": "2019-08-29T23:59:00-07:00"
},
"can_view_path": {
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.",
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.\n\nWhen you delete a folder with `can_view_path=true`, collaborators may still see the parent path. \nFor instructions on how to remove this, see \n[Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).",
"type": "boolean",
"example": true
}
Expand Down Expand Up @@ -10246,7 +10246,7 @@
"example": true
},
"can_view_path": {
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.",
"description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly an owner or co-owners can invite collaborators with a `can_view_path` of\n`true`. Only an owner can update `can_view_path` on existing collaborations.\n\n`can_view_path` can only be used for folder collaborations.\n\nWhen you delete a folder with `can_view_path=true`, collaborators may still see the parent path. \nFor instructions on how to remove this, see \n[Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).",
"type": "boolean",
"example": true
},
Expand Down Expand Up @@ -15257,7 +15257,7 @@
"put": {
"operationId": "put_users_id_folders_0",
"summary": "Transfer owned folders",
"description": "Move all of the items (files, folders and workflows) owned by a user into\nanother user's account\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative\npermissions.\n\nAll existing shared links and folder-level collaborations are transferred\nduring the operation. Please note that while collaborations at the individual\nfile-level are transferred during the operation, the collaborations are\ndeleted when the original user is deleted.\n\nIf the user has a large number of items across all folders, the call will\nbe run asynchronously. If the operation is not completed within 10 minutes,\nthe user will receive a 200 OK response, and the operation will continue running.\n\nIf the destination path has a metadata cascade policy attached to any of\nthe parent folders, a metadata cascade operation will be kicked off\nasynchronously.\n\nThere is currently no way to check for when this operation is finished.\n\nThe destination folder's name will be in the format `{User}'s Files and\nFolders`, where `{User}` is the display name of the user.\n\nTo make this API call your application will need to have the \"Read and write\nall files and folders stored in Box\" scope enabled.\n\nPlease make sure the destination user has access to `Relay` or `Relay Lite`,\nand has access to the files and folders involved in the workflows being\ntransferred.\n\nAdmins will receive an email when the operation is completed.",
"description": "Move all of the items (files, folders and workflows) owned by a user into\nanother user's account.\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative\npermissions.\n\nAll existing shared links and folder-level collaborations are transferred\nduring the operation. Please note that while collaborations at the individual\nfile-level are transferred during the operation, the collaborations are\ndeleted when the original user is deleted.\n\nIf the user has a large number of items across all folders, the call will\nbe run asynchronously. If the operation is not completed within 10 minutes,\nthe user will receive a 200 OK response, and the operation will continue running.\n\nIf the destination path has a metadata cascade policy attached to any of\nthe parent folders, a metadata cascade operation will be kicked off\nasynchronously.\n\nThere is currently no way to check for when this operation is finished.\n\nThe destination folder's name will be in the format `{User}'s Files and\nFolders`, where `{User}` is the display name of the user.\n\nTo make this API call your application will need to have the \"Read and write\nall files and folders stored in Box\" scope enabled.\n\nPlease make sure the destination user has access to `Relay` or `Relay Lite`,\nand has access to the files and folders involved in the workflows being\ntransferred.\n\nAdmins will receive an email when the operation is completed.",
"parameters": [
{
"name": "user_id",
Expand Down Expand Up @@ -15338,7 +15338,7 @@
}
},
"403": {
"description": "Returns an error when folder ownership cannot be\ntransferred to another user.\n\n* `forbidden_by_policy`: Returned if ownership transfer\n is forbidden due to information barrier restrictions.",
"description": "Returns an error when folder ownership cannot be\ntransferred to another user.\n\n* `forbidden_by_policy`: Returned if ownership transfer\n is forbidden due to information barrier restrictions.\n* `Cannot transfer files from/to higher privileged accounts`: You can only transfer content to or from managed users or your own account,\n not other co-admins or admins. Admins can transfer content between any users, including co-admins and managed users.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -20356,8 +20356,18 @@
}
}
},
"400": {
"description": "Returns an error if the enterprise is missing from the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"404": {
"description": "Returns an error if the enterprise was not found.",
"description": "Returns an error when an incorrect or null enterprise is present in the request body.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -25895,11 +25905,6 @@
"minItems": 1,
"uniqueItems": true
},
"include_confidence_score": {
"description": "A flag to indicate whether confidence scores for every extracted field should be returned.",
"type": "boolean",
"example": true
},
"ai_agent": {
"allOf": [
{
Expand Down Expand Up @@ -25948,11 +25953,6 @@
"type": "string",
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
"ai_agent_info": {
"$ref": "#/components/schemas/AiAgentInfo"
}
Expand Down