feat(boxsdkgen): Add new parameters to ai extract structured method (box/box-openapi#604) (#1479)

Co-authored-by: box-sdk-build <box-sdk-build@box.com>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "a87c352", "specHash": "ded99bf", "version": "4.11.0" }
+{ "engineHash": "a87c352", "specHash": "0ac3d31", "version": "4.11.0" }

box_sdk_gen/managers/ai.py

@@ -14,6 +14,10 @@
 
 from box_sdk_gen.serialization.json import deserialize
 
+from box_sdk_gen.schemas.ai_extract_sub_field import AiExtractSubField
+
+from box_sdk_gen.schemas.ai_options_rules import AiOptionsRules
+
 from box_sdk_gen.schemas.ai_item_ask import AiItemAsk
 
 from box_sdk_gen.schemas.ai_dialogue_history import AiDialogueHistory
@@ -40,6 +44,12 @@
 
 from box_sdk_gen.schemas.ai_extract_structured_agent import AiExtractStructuredAgent
 
+from box_sdk_gen.schemas.ai_taxonomy_reference import AiTaxonomyReference
+
+from box_sdk_gen.schemas.ai_taxonomy_file_reference import AiTaxonomyFileReference
+
+from box_sdk_gen.schemas.ai_taxonomy_source import AiTaxonomySource
+
 from box_sdk_gen.schemas.ai_response_full import AiResponseFull
 
 from box_sdk_gen.schemas.client_error import ClientError
@@ -185,6 +195,10 @@ def __init__(
         prompt: Optional[str] = None,
         type: Optional[str] = None,
         options: Optional[List[CreateAiExtractStructuredFieldsOptionsField]] = None,
+        fields: Optional[List[AiExtractSubField]] = None,
+        taxonomy_key: Optional[str] = None,
+        namespace: Optional[str] = None,
+        options_rules: Optional[AiOptionsRules] = None,
         **kwargs
     ):
         """
@@ -196,10 +210,16 @@ def __init__(
         :type display_name: Optional[str], optional
         :param prompt: The context about the key that may include how to find and format it., defaults to None
         :type prompt: Optional[str], optional
-        :param type: The type of the field. It can include but is not limited to `string`, `float`, `date`, `enum`, and `multiSelect`., defaults to None
+        :param type: The type of the field. It can include but is not limited to `string`, `float`, `date`, `enum`, `multiSelect`,`taxonomy`, `struct`, and `table`., defaults to None
         :type type: Optional[str], optional
         :param options: A list of options for this field. This is most often used in combination with the `enum` and `multiSelect` field types., defaults to None
         :type options: Optional[List[CreateAiExtractStructuredFieldsOptionsField]], optional
+        :param fields: The nested fields for this field. Used with `struct` and `table` field types to define the nested structure., defaults to None
+        :type fields: Optional[List[AiExtractSubField]], optional
+        :param taxonomy_key: The identifier for a taxonomy, which corresponds to the `key` of the taxonomy source. Required if using `taxonomy` type field., defaults to None
+        :type taxonomy_key: Optional[str], optional
+        :param namespace: The namespace of the taxonomy source. Required if using `taxonomy` type field from an existing taxonomy., defaults to None
+        :type namespace: Optional[str], optional
         """
         super().__init__(**kwargs)
         self.key = key
@@ -208,6 +228,10 @@ def __init__(
         self.prompt = prompt
         self.type = type
         self.options = options
+        self.fields = fields
+        self.taxonomy_key = taxonomy_key
+        self.namespace = namespace
+        self.options_rules = options_rules
 
 
 class AiManager:
@@ -428,6 +452,7 @@ def create_ai_extract_structured(
         ai_agent: Optional[AiExtractStructuredAgent] = None,
         include_confidence_score: Optional[bool] = None,
         include_reference: Optional[bool] = None,
+        taxonomy_sources: Optional[List[AiTaxonomySource]] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> AiExtractStructuredResponse:
         """
@@ -456,6 +481,9 @@ def create_ai_extract_structured(
                 :type include_confidence_score: Optional[bool], optional
                 :param include_reference: A flag to indicate whether references for every extracted field should be returned., defaults to None
                 :type include_reference: Optional[bool], optional
+                :param taxonomy_sources: The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy.
+        For your request to work, `fields` must also be provided. `taxonomy_sources` is not supported with `metadata_template`., defaults to None
+                :type taxonomy_sources: Optional[List[AiTaxonomySource]], 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
         """
@@ -468,6 +496,7 @@ def create_ai_extract_structured(
             'ai_agent': ai_agent,
             'include_confidence_score': include_confidence_score,
             'include_reference': include_reference,
+            'taxonomy_sources': taxonomy_sources,
         }
         headers_map: Dict[str, str] = prepare_params({**extra_headers})
         response: FetchResponse = self.network_session.network_client.fetch(

box_sdk_gen/managers/user_collaborations.py

@@ -350,19 +350,13 @@ def create_collaboration(
                 this endpoint is dependent on the group's ability to be invited.
 
 
-                If collaboration is in `pending` status, the following fields
+                If collaboration is in `pending` status, field `name` is redacted when:
 
 
-                are redacted:
+                - a collaboration was created using `user_id`,
 
 
-                - `login` and `name` are hidden if a collaboration was created
-
-
-                using `user_id`,
-
-
-                -  `name` is hidden if a collaboration was created using `login`.
+                - a collaboration was created using `login`.
 
                 :param item: The item to attach the comment to.
                 :type item: CreateCollaborationItem

box_sdk_gen/schemas/__init__.py

@@ -10,6 +10,10 @@
 
 from box_sdk_gen.schemas.ai_dialogue_history import *
 
+from box_sdk_gen.schemas.ai_extract_field_option import *
+
+from box_sdk_gen.schemas.ai_extract_sub_field import *
+
 from box_sdk_gen.schemas.ai_extract_structured_response import *
 
 from box_sdk_gen.schemas.ai_item_base import *
@@ -78,8 +82,6 @@
 
 from box_sdk_gen.schemas.ai_extract_structured_agent import *
 
-from box_sdk_gen.schemas.ai_extract_structured import *
-
 from box_sdk_gen.schemas.ai_agent_extract import *
 
 from box_sdk_gen.schemas.ai_extract_agent import *
@@ -94,6 +96,16 @@
 
 from box_sdk_gen.schemas.ai_agent import *
 
+from box_sdk_gen.schemas.ai_options_rules import *
+
+from box_sdk_gen.schemas.ai_taxonomy_file_reference import *
+
+from box_sdk_gen.schemas.ai_taxonomy_reference import *
+
+from box_sdk_gen.schemas.ai_taxonomy_source import *
+
+from box_sdk_gen.schemas.ai_extract_structured import *
+
 from box_sdk_gen.schemas.app_item import *
 
 from box_sdk_gen.schemas.classification import *

box_sdk_gen/schemas/ai_extract_field_option.py

@@ -0,0 +1,13 @@
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class AiExtractFieldOption(BaseObject):
+    def __init__(self, key: str, **kwargs):
+        """
+        :param key: A unique identifier for the option.
+        :type key: str
+        """
+        super().__init__(**kwargs)
+        self.key = key

box_sdk_gen/schemas/ai_extract_structured.py

@@ -12,10 +12,20 @@
 
 from box_sdk_gen.schemas.ai_agent_extract_structured import AiAgentExtractStructured
 
+from box_sdk_gen.schemas.ai_taxonomy_reference import AiTaxonomyReference
+
+from box_sdk_gen.schemas.ai_taxonomy_file_reference import AiTaxonomyFileReference
+
 from box_sdk_gen.schemas.ai_item_base import AiItemBase
 
+from box_sdk_gen.schemas.ai_extract_sub_field import AiExtractSubField
+
+from box_sdk_gen.schemas.ai_options_rules import AiOptionsRules
+
 from box_sdk_gen.schemas.ai_extract_structured_agent import AiExtractStructuredAgent
 
+from box_sdk_gen.schemas.ai_taxonomy_source import AiTaxonomySource
+
 from box_sdk_gen.box.errors import BoxSDKError
 
 
@@ -82,6 +92,10 @@ def __init__(
         prompt: Optional[str] = None,
         type: Optional[str] = None,
         options: Optional[List[AiExtractStructuredFieldsOptionsField]] = None,
+        fields: Optional[List[AiExtractSubField]] = None,
+        taxonomy_key: Optional[str] = None,
+        namespace: Optional[str] = None,
+        options_rules: Optional[AiOptionsRules] = None,
         **kwargs
     ):
         """
@@ -93,10 +107,16 @@ def __init__(
         :type display_name: Optional[str], optional
         :param prompt: The context about the key that may include how to find and format it., defaults to None
         :type prompt: Optional[str], optional
-        :param type: The type of the field. It can include but is not limited to `string`, `float`, `date`, `enum`, and `multiSelect`., defaults to None
+        :param type: The type of the field. It can include but is not limited to `string`, `float`, `date`, `enum`, `multiSelect`,`taxonomy`, `struct`, and `table`., defaults to None
         :type type: Optional[str], optional
         :param options: A list of options for this field. This is most often used in combination with the `enum` and `multiSelect` field types., defaults to None
         :type options: Optional[List[AiExtractStructuredFieldsOptionsField]], optional
+        :param fields: The nested fields for this field. Used with `struct` and `table` field types to define the nested structure., defaults to None
+        :type fields: Optional[List[AiExtractSubField]], optional
+        :param taxonomy_key: The identifier for a taxonomy, which corresponds to the `key` of the taxonomy source. Required if using `taxonomy` type field., defaults to None
+        :type taxonomy_key: Optional[str], optional
+        :param namespace: The namespace of the taxonomy source. Required if using `taxonomy` type field from an existing taxonomy., defaults to None
+        :type namespace: Optional[str], optional
         """
         super().__init__(**kwargs)
         self.key = key
@@ -105,6 +125,10 @@ def __init__(
         self.prompt = prompt
         self.type = type
         self.options = options
+        self.fields = fields
+        self.taxonomy_key = taxonomy_key
+        self.namespace = namespace
+        self.options_rules = options_rules
 
 
 class AiExtractStructured(BaseObject):
@@ -117,6 +141,7 @@ def __init__(
         ai_agent: Optional[AiExtractStructuredAgent] = None,
         include_confidence_score: Optional[bool] = None,
         include_reference: Optional[bool] = None,
+        taxonomy_sources: Optional[List[AiTaxonomySource]] = None,
         **kwargs
     ):
         """
@@ -132,6 +157,9 @@ def __init__(
                 :type include_confidence_score: Optional[bool], optional
                 :param include_reference: A flag to indicate whether references for every extracted field should be returned., defaults to None
                 :type include_reference: Optional[bool], optional
+                :param taxonomy_sources: The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy.
+        For your request to work, `fields` must also be provided. `taxonomy_sources` is not supported with `metadata_template`., defaults to None
+                :type taxonomy_sources: Optional[List[AiTaxonomySource]], optional
         """
         super().__init__(**kwargs)
         self.items = items
@@ -140,3 +168,4 @@ def __init__(
         self.ai_agent = ai_agent
         self.include_confidence_score = include_confidence_score
         self.include_reference = include_reference
+        self.taxonomy_sources = taxonomy_sources

box_sdk_gen/schemas/ai_extract_sub_field.py

@@ -0,0 +1,55 @@
+from typing import Optional
+
+from typing import List
+
+from typing import Dict
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.schemas.ai_extract_field_option import AiExtractFieldOption
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class AiExtractSubField(BaseObject):
+    _fields_to_json_mapping: Dict[str, str] = {
+        'display_name': 'displayName',
+        **BaseObject._fields_to_json_mapping,
+    }
+    _json_to_fields_mapping: Dict[str, str] = {
+        'displayName': 'display_name',
+        **BaseObject._json_to_fields_mapping,
+    }
+
+    def __init__(
+        self,
+        key: str,
+        *,
+        description: Optional[str] = None,
+        display_name: Optional[str] = None,
+        prompt: Optional[str] = None,
+        type: Optional[str] = None,
+        options: Optional[List[AiExtractFieldOption]] = None,
+        **kwargs
+    ):
+        """
+        :param key: A unique identifier for the nested field.
+        :type key: str
+        :param description: A description of the nested field., defaults to None
+        :type description: Optional[str], optional
+        :param display_name: The display name of the nested field., defaults to None
+        :type display_name: Optional[str], optional
+        :param prompt: Context about the nested field that may include how to find and how to format it., defaults to None
+        :type prompt: Optional[str], optional
+        :param type: The type of the nested field. Allowed types include `string`, `float`, `date`, `number`, `text`, `boolean`, `enum` and `multiSelect`., defaults to None
+        :type type: Optional[str], optional
+        :param options: A list of options for this nested field. Used with `enum` and `multiSelect` types., defaults to None
+        :type options: Optional[List[AiExtractFieldOption]], optional
+        """
+        super().__init__(**kwargs)
+        self.key = key
+        self.description = description
+        self.display_name = display_name
+        self.prompt = prompt
+        self.type = type
+        self.options = options

box_sdk_gen/schemas/ai_options_rules.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+from typing import List
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class AiOptionsRules(BaseObject):
+    def __init__(
+        self,
+        *,
+        multi_select: Optional[bool] = None,
+        selectable_levels: Optional[List[int]] = None,
+        **kwargs
+    ):
+        """
+                :param multi_select: Indicates whether the field is a multi-select field.
+        If true, the field can have multiple values., defaults to None
+                :type multi_select: Optional[bool], optional
+                :param selectable_levels: The selectable levels for the field.
+        This is used to limit the levels of the taxonomy that can be selected., defaults to None
+                :type selectable_levels: Optional[List[int]], optional
+        """
+        super().__init__(**kwargs)
+        self.multi_select = multi_select
+        self.selectable_levels = selectable_levels

box_sdk_gen/schemas/ai_taxonomy_file_reference.py

@@ -0,0 +1,36 @@
+from enum import Enum
+
+from typing import Optional
+
+from box_sdk_gen.internal.base_object import BaseObject
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+
+class AiTaxonomyFileReferenceTypeField(str, Enum):
+    FILE = 'file'
+
+
+class AiTaxonomyFileReference(BaseObject):
+    _discriminator = 'type', {'file'}
+
+    def __init__(
+        self,
+        *,
+        type: Optional[AiTaxonomyFileReferenceTypeField] = None,
+        taxonomy_key: Optional[str] = None,
+        id: Optional[str] = None,
+        **kwargs
+    ):
+        """
+        :param type: The type of the taxonomy source., defaults to None
+        :type type: Optional[AiTaxonomyFileReferenceTypeField], optional
+        :param taxonomy_key: The identifier for a taxonomy, which corresponds to the `taxonomy_key` of the taxonomy source., defaults to None
+        :type taxonomy_key: Optional[str], optional
+        :param id: The ID of the taxonomy source. Required if the type is `file` and unsupported if the type is `taxonomy`., defaults to None
+        :type id: Optional[str], optional
+        """
+        super().__init__(**kwargs)
+        self.type = type
+        self.taxonomy_key = taxonomy_key
+        self.id = id