From e97082c882b703e2d8f4e5ae9361cefbbcb5a437 Mon Sep 17 00:00:00 2001 From: box-apimgmt Date: Tue, 2 Dec 2025 01:18:45 -0800 Subject: [PATCH] docs: modify can_view_path description and add confidence scores for structured extract --- openapi.json | 16 +++++++++++++--- openapi/openapi-v2025.0.json | 2 +- openapi/openapi.json | 16 +++++++++++++--- 3 files changed, 27 insertions(+), 7 deletions(-) diff --git a/openapi.json b/openapi.json index 7dc1408d..93b37a77 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "57f6be0109" + "x-box-commit-hash": "0ff2cd637c" }, "servers": [ { @@ -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 owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\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.", "type": "boolean", "example": true } @@ -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 owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\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.", "type": "boolean", "example": true }, @@ -25895,6 +25895,11 @@ "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": [ { @@ -25943,6 +25948,11 @@ "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" } diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index b2a972ab..fc750c6f 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "57f6be0109" + "x-box-commit-hash": "0ff2cd637c" }, "servers": [ { diff --git a/openapi/openapi.json b/openapi/openapi.json index 7dc1408d..93b37a77 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "57f6be0109" + "x-box-commit-hash": "0ff2cd637c" }, "servers": [ { @@ -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 owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\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.", "type": "boolean", "example": true } @@ -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 owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\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.", "type": "boolean", "example": true }, @@ -25895,6 +25895,11 @@ "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": [ { @@ -25943,6 +25948,11 @@ "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" }