docs: modify can_view_path description and add confidence scores for structured extract (box/box-openapi#566) (#1224)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "49f3695", "specHash": "7e4908e", "version": "10.1.0" }
+{ "engineHash": "49f3695", "specHash": "5183b65", "version": "10.1.0" }

box_sdk_gen/managers/ai.py

@@ -425,6 +425,7 @@ def create_ai_extract_structured(
         *,
         metadata_template: Optional[CreateAiExtractStructuredMetadataTemplate] = None,
         fields: Optional[List[CreateAiExtractStructuredFields]] = None,
+        include_confidence_score: Optional[bool] = None,
         ai_agent: Optional[AiExtractStructuredAgent] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> AiExtractStructuredResponse:
@@ -450,6 +451,8 @@ def create_ai_extract_structured(
                 :param fields: The fields to be extracted from the provided items.
         For your request to work, you must provide either `metadata_template` or `fields`, but not both., defaults to None
                 :type fields: Optional[List[CreateAiExtractStructuredFields]], optional
+                :param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned., defaults to None
+                :type include_confidence_score: Optional[bool], optional
                 :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
                 :type extra_headers: Optional[Dict[str, Optional[str]]], optional
         """
@@ -459,6 +462,7 @@ def create_ai_extract_structured(
             'items': items,
             'metadata_template': metadata_template,
             'fields': fields,
+            'include_confidence_score': include_confidence_score,
             'ai_agent': ai_agent,
         }
         headers_map: Dict[str, str] = prepare_params({**extra_headers})

box_sdk_gen/managers/user_collaborations.py

@@ -241,8 +241,8 @@ def update_collaboration_by_id(
         invitee's **All Files** page. We recommend you limit the number of
         collaborations with `can_view_path` enabled to 1,000 per user.
 
-        Only owner or co-owners can invite collaborators with a `can_view_path` of
-        `true`.
+        Only an owner or co-owners can invite collaborators with a `can_view_path` of
+        `true`. Only an owner can update `can_view_path` on existing collaborations.
 
         `can_view_path` can only be used for folder collaborations., defaults to None
                 :type can_view_path: Optional[bool], optional
@@ -381,8 +381,8 @@ def create_collaboration(
         invitee's **All Files** page. We recommend you limit the number of
         collaborations with `can_view_path` enabled to 1,000 per user.
 
-        Only owner or co-owners can invite collaborators with a `can_view_path` of
-        `true`.
+        Only an owner or co-owners can invite collaborators with a `can_view_path` of
+        `true`. Only an owner can update `can_view_path` on existing collaborations.
 
         `can_view_path` can only be used for folder collaborations., defaults to None
                 :type can_view_path: Optional[bool], optional

box_sdk_gen/schemas/ai_extract_structured.py

@@ -114,6 +114,7 @@ def __init__(
         *,
         metadata_template: Optional[AiExtractStructuredMetadataTemplateField] = None,
         fields: Optional[List[AiExtractStructuredFieldsField]] = None,
+        include_confidence_score: Optional[bool] = None,
         ai_agent: Optional[AiExtractStructuredAgent] = None,
         **kwargs
     ):
@@ -126,9 +127,12 @@ def __init__(
                 :param fields: The fields to be extracted from the provided items.
         For your request to work, you must provide either `metadata_template` or `fields`, but not both., defaults to None
                 :type fields: Optional[List[AiExtractStructuredFieldsField]], optional
+                :param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned., defaults to None
+                :type include_confidence_score: Optional[bool], optional
         """
         super().__init__(**kwargs)
         self.items = items
         self.metadata_template = metadata_template
         self.fields = fields
+        self.include_confidence_score = include_confidence_score
         self.ai_agent = ai_agent

box_sdk_gen/schemas/ai_extract_structured_response.py

@@ -18,6 +18,7 @@ def __init__(
         created_at: DateTime,
         *,
         completion_reason: Optional[str] = None,
+        confidence_score: Optional[Dict] = None,
         ai_agent_info: Optional[AiAgentInfo] = None,
         **kwargs
     ):
@@ -26,9 +27,12 @@ def __init__(
         :type created_at: DateTime
         :param completion_reason: The reason the response finishes., defaults to None
         :type completion_reason: Optional[str], optional
+        :param confidence_score: The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted., defaults to None
+        :type confidence_score: Optional[Dict], optional
         """
         super().__init__(**kwargs)
         self.answer = answer
         self.created_at = created_at
         self.completion_reason = completion_reason
+        self.confidence_score = confidence_score
         self.ai_agent_info = ai_agent_info

docs/ai.md

@@ -258,6 +258,8 @@ client.ai.create_ai_extract_structured(
   - The metadata template containing the fields to extract. For your request to work, you must provide either `metadata_template` or `fields`, but not both.
 - fields `Optional[List[CreateAiExtractStructuredFields]]`
   - The fields to be extracted from the provided items. For your request to work, you must provide either `metadata_template` or `fields`, but not both.
+- include_confidence_score `Optional[bool]`
+  - A flag to indicate whether confidence scores for every extracted field should be returned.
 - ai_agent `Optional[AiExtractStructuredAgent]`
 - extra_headers `Optional[Dict[str, Optional[str]]]`
   - Extra headers that will be included in the HTTP request.

docs/user_collaborations.md

@@ -65,7 +65,7 @@ client.user_collaborations.update_collaboration_by_id(
 - expires_at `Optional[DateTime]`
   - Update the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error. Additionally, a collaboration can only be given an expiration if it was created after the **Automatically remove invited collaborator** setting was enabled.
 - can_view_path `Optional[bool]`
-  - Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a `can_view_path` of `true`. `can_view_path` can only be used for folder collaborations.
+  - Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only an owner or co-owners can invite collaborators with a `can_view_path` of `true`. Only an owner can update `can_view_path` on existing collaborations. `can_view_path` can only be used for folder collaborations.
 - extra_headers `Optional[Dict[str, Optional[str]]]`
   - Extra headers that will be included in the HTTP request.
 
@@ -152,7 +152,7 @@ client.user_collaborations.create_collaboration(
 - is_access_only `Optional[bool]`
   - If set to `true`, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the path to the root folder for the shared item.
 - can_view_path `Optional[bool]`
-  - Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a `can_view_path` of `true`. `can_view_path` can only be used for folder collaborations.
+  - Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only an owner or co-owners can invite collaborators with a `can_view_path` of `true`. Only an owner can update `can_view_path` on existing collaborations. `can_view_path` can only be used for folder collaborations.
 - expires_at `Optional[DateTime]`
   - Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.
 - fields `Optional[List[str]]`