kodexa 7.0.1a8003164156__py3-none-any.whl → 7.0.1a9194120328__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
kodexa/model/objects.py CHANGED
@@ -218,7 +218,7 @@ class Organization(BaseModel):
218
218
  arbitrary_types_allowed=True,
219
219
  protected_namespaces=("model_config",),
220
220
  )
221
- id: Optional[str] = Field(None, description="The ID of the object")
221
+ id: Optional[str] = Field(None)
222
222
  uuid: Optional[str] = None
223
223
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
224
224
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -240,7 +240,7 @@ class Team(BaseModel):
240
240
  arbitrary_types_allowed=True,
241
241
  protected_namespaces=("model_config",),
242
242
  )
243
- id: Optional[str] = Field(None, description="The ID of the object")
243
+ id: Optional[str] = Field(None)
244
244
  uuid: Optional[str] = None
245
245
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
246
246
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -593,6 +593,7 @@ class PipelineStepMetadata(BaseModel):
593
593
  step_type: Optional[StepType] = Field(
594
594
  None, alias="stepType", description="The type of step (ACTION or MODEL)"
595
595
  )
596
+ conditional: Optional[str] = Field(None, description="The conditional expression for the step")
596
597
 
597
598
 
598
599
  class PossibleValue(BaseModel):
@@ -673,6 +674,11 @@ class StorePurpose(Enum):
673
674
  training = "TRAINING"
674
675
 
675
676
 
677
+ class ProjectStoreFile(BaseModel):
678
+ url: Optional[str] = None
679
+ metadata: Optional[Dict[str, str]] = None
680
+
681
+
676
682
  class ProjectStore(BaseModel):
677
683
  """
678
684
 
@@ -707,10 +713,12 @@ class ProjectStore(BaseModel):
707
713
  None, description="Allow data editing", alias="allowDataEditing"
708
714
  )
709
715
 
716
+ files: Optional[List[ProjectStoreFile]] = Field(None, description="Files to load in the store")
717
+
710
718
 
711
719
  class TaxonomyType(Enum):
712
720
  """
713
-
721
+ The type of taxonomy
714
722
  """
715
723
 
716
724
  content = "CONTENT"
@@ -821,12 +829,12 @@ class SlugBasedMetadata1(BaseModel):
821
829
  description="The slug of the organization that owns this metadata object",
822
830
  )
823
831
  slug: str = Field(
824
- ...,
832
+ None,
825
833
  description="The slug used when referencing this metadata object",
826
834
  pattern=r"^[a-zA-Z0-9\-_]{0,255}$",
827
835
  )
828
- type: str = Field(..., description="The type of metadata object")
829
- name: str = Field(..., description="The name of the object")
836
+ type: str = Field(None, description="The type of metadata object")
837
+ name: str = Field(None, description="The name of the object")
830
838
  description: Optional[str] = Field(
831
839
  None, description="The description of the object"
832
840
  )
@@ -948,6 +956,8 @@ class ValuePath(Enum):
948
956
  :cvar metadata: Represents metadata.
949
957
  :cvar expression: Represents an expression.
950
958
  :cvar script: Represents a script.
959
+ :cvar derived: Represents derived data.
960
+ :cvar formula: Represents a formula.
951
961
  """
952
962
 
953
963
  value_or_all_content = "VALUE_OR_ALL_CONTENT"
@@ -957,6 +967,8 @@ class ValuePath(Enum):
957
967
  metadata = "METADATA"
958
968
  expression = "EXPRESSION"
959
969
  script = "SCRIPT"
970
+ derived = "DERIVED"
971
+ formula = "FORMULA"
960
972
 
961
973
 
962
974
  class MetadataValue(Enum):
@@ -971,6 +983,9 @@ class MetadataValue(Enum):
971
983
  filename = "FILENAME"
972
984
  transaction_uuid = "TRANSACTION_UUID"
973
985
  created_datetime = "CREATED_DATETIME"
986
+ document_labels = "DOCUMENT_LABELS"
987
+ owner_name = "OWNER_NAME"
988
+ document_status = "DOCUMENT_STATUS"
974
989
 
975
990
 
976
991
  class TaxonType(Enum):
@@ -1003,6 +1018,7 @@ class TaxonType(Enum):
1003
1018
  email_address = "EMAIL_ADDRESS"
1004
1019
  phone_number = "PHONE_NUMBER"
1005
1020
  selection = "SELECTION"
1021
+ section = "SECTION"
1006
1022
 
1007
1023
 
1008
1024
  class TaxonomyType1(Enum):
@@ -1099,7 +1115,7 @@ class AttributeStatus(BaseModel):
1099
1115
  arbitrary_types_allowed=True,
1100
1116
  protected_namespaces=("model_config",),
1101
1117
  )
1102
- id: Optional[str] = Field(None, description="The ID of the object")
1118
+ id: Optional[str] = Field(None)
1103
1119
  uuid: Optional[str] = None
1104
1120
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
1105
1121
  updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
@@ -1186,7 +1202,7 @@ class DocumentStatus(BaseModel):
1186
1202
  arbitrary_types_allowed=True,
1187
1203
  protected_namespaces=("model_config",),
1188
1204
  )
1189
- id: Optional[str] = Field(None, description="The ID of the object")
1205
+ id: Optional[str] = Field(None)
1190
1206
  uuid: Optional[str] = None
1191
1207
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1192
1208
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1221,7 +1237,7 @@ class DocumentTransition(BaseModel):
1221
1237
  Provides the definition of a transition for a document, where a change was applied by an assistant, user or external process
1222
1238
  """
1223
1239
 
1224
- id: Optional[str] = Field(None, description="The ID of the object")
1240
+ id: Optional[str] = Field(None)
1225
1241
  uuid: Optional[str] = None
1226
1242
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1227
1243
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1401,7 +1417,7 @@ class Label(BaseModel):
1401
1417
  The labels from the latest content object in the family
1402
1418
  """
1403
1419
 
1404
- id: Optional[str] = Field(None, description="The ID of the object")
1420
+ id: Optional[str] = Field(None)
1405
1421
  uuid: Optional[str] = None
1406
1422
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1407
1423
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1425,7 +1441,7 @@ class ProjectTag(BaseModel):
1425
1441
  A project tag
1426
1442
  """
1427
1443
 
1428
- id: Optional[str] = Field(None, description="The ID of the object")
1444
+ id: Optional[str] = Field(None)
1429
1445
  name: str
1430
1446
  color: Optional[str] = None
1431
1447
 
@@ -1503,7 +1519,7 @@ class Session(BaseModel):
1503
1519
  arbitrary_types_allowed=True,
1504
1520
  protected_namespaces=("model_config",),
1505
1521
  )
1506
- id: Optional[str] = Field(None, description="The ID of the object")
1522
+ id: Optional[str] = Field(None)
1507
1523
  uuid: Optional[str] = None
1508
1524
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1509
1525
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1562,7 +1578,7 @@ class ValidationError(BaseModel):
1562
1578
  arbitrary_types_allowed=True,
1563
1579
  protected_namespaces=("model_config",),
1564
1580
  )
1565
- id: Optional[str] = Field(None, description="The ID of the object")
1581
+ id: Optional[str] = Field(None)
1566
1582
  uuid: Optional[str] = None
1567
1583
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
1568
1584
  updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
@@ -1656,7 +1672,7 @@ class DataException(BaseModel):
1656
1672
  A data exception
1657
1673
  """
1658
1674
 
1659
- id: Optional[str] = Field(None, description="The ID of the object")
1675
+ id: Optional[str] = Field(None)
1660
1676
  uuid: Optional[str] = None
1661
1677
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1662
1678
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1755,6 +1771,7 @@ class DeploymentOptions(BaseModel):
1755
1771
  cpu: Optional[str] = None
1756
1772
  pod_match_labels: Optional[List[MatchLabel]] = Field(None, alias="podMatchLabels")
1757
1773
  child_process: Optional[bool] = Field(None, alias="childProcess")
1774
+ layers: Optional[List[str]] = None
1758
1775
 
1759
1776
 
1760
1777
  class SourceType(Enum):
@@ -1805,7 +1822,7 @@ class PlatformConfiguration(BaseModel):
1805
1822
  arbitrary_types_allowed=True,
1806
1823
  protected_namespaces=("model_config",),
1807
1824
  )
1808
- id: Optional[str] = Field(None, description="The ID of the object")
1825
+ id: Optional[str] = Field(None)
1809
1826
  uuid: Optional[str] = None
1810
1827
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1811
1828
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1857,7 +1874,7 @@ class ModelTraining(BaseModel):
1857
1874
  arbitrary_types_allowed=True,
1858
1875
  protected_namespaces=("model_config",),
1859
1876
  )
1860
- id: Optional[str] = Field(None, description="The ID of the object")
1877
+ id: Optional[str] = Field(None)
1861
1878
  uuid: Optional[str] = None
1862
1879
  name: Optional[str] = None
1863
1880
  state: Optional[str] = None
@@ -1950,7 +1967,7 @@ class ExecutionLogEntry(BaseModel):
1950
1967
  arbitrary_types_allowed=True,
1951
1968
  protected_namespaces=("model_config",),
1952
1969
  )
1953
- id: Optional[str] = Field(None, description="The ID of the object")
1970
+ id: Optional[str] = Field(None)
1954
1971
  uuid: Optional[str] = None
1955
1972
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
1956
1973
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2167,9 +2184,6 @@ class BulkDelete(BaseModel):
2167
2184
 
2168
2185
 
2169
2186
  class User(BaseModel):
2170
- """
2171
-
2172
- """
2173
2187
  model_config = ConfigDict(
2174
2188
  populate_by_name=True,
2175
2189
  use_enum_values=True,
@@ -2180,14 +2194,14 @@ class User(BaseModel):
2180
2194
  A user within the Kodexa platform
2181
2195
  """
2182
2196
 
2183
- id: Optional[str] = Field(None, description="The ID of the object")
2197
+ id: Optional[str] = Field(None)
2184
2198
  uuid: Optional[str] = None
2185
2199
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
2186
2200
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
2187
2201
  updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
2188
- email: str
2189
- first_name: str = Field(..., alias="firstName")
2190
- last_name: str = Field(..., alias="lastName")
2202
+ email: Optional[str] = None
2203
+ first_name: Optional[str] = Field(None, alias="firstName")
2204
+ last_name: Optional[str] = Field(None, alias="lastName")
2191
2205
  activated: Optional[bool] = None
2192
2206
  platform_admin: Optional[bool] = Field(None, alias="platformAdmin")
2193
2207
  password_reset_date: Optional[StandardDateTime] = Field(
@@ -2331,6 +2345,9 @@ class ExtensionPackProvided(BaseModel):
2331
2345
  change_sequence: Optional[int] = Field(
2332
2346
  None, alias="changeSequence", description="The change sequence"
2333
2347
  )
2348
+ delete_protection: Optional[bool] = Field(
2349
+ None, description="Delete protection", alias="deleteProtection"
2350
+ )
2334
2351
 
2335
2352
 
2336
2353
  class Option(BaseModel):
@@ -2468,6 +2485,28 @@ class ProjectAssistant(BaseModel):
2468
2485
  logging_enabled: Optional[bool] = Field(None, alias="loggingEnabled")
2469
2486
  show_in_training: Optional[bool] = Field(None, alias="showInTraining")
2470
2487
  priority_hint: Optional[int] = Field(None, alias="priorityHint")
2488
+ chat_enabled: Optional[bool] = Field(None, alias="chatEnabled")
2489
+ assistant_role: Optional[str] = Field(None, alias="assistantRole")
2490
+
2491
+
2492
+ class TaxonConditionalFormat(BaseModel):
2493
+ model_config = ConfigDict(
2494
+ populate_by_name=True,
2495
+ use_enum_values=True,
2496
+ arbitrary_types_allowed=True,
2497
+ protected_namespaces=("model_config",),
2498
+ )
2499
+
2500
+ type: Optional[str] = None
2501
+ condition: Optional[str] = None
2502
+ properties: Optional[Dict[str, Any]] = Field(default_factory=dict)
2503
+
2504
+
2505
+ class TaxonCardinality(Enum):
2506
+ once_per_document = "ONCE_PER_DOCUMENT"
2507
+ multiple_per_document = "MULTIPLE_PER_DOCUMENT"
2508
+ once_per_segment = "ONCE_PER_SEGMENT"
2509
+ multiple_per_segment = "MULTIPLE_PER_SEGMENT"
2471
2510
 
2472
2511
 
2473
2512
  class Taxon(BaseModel):
@@ -2622,6 +2661,10 @@ class Taxon(BaseModel):
2622
2661
  description="A list of synonyms of the taxon values, used to understand the taxon",
2623
2662
  )
2624
2663
 
2664
+ cardinality: Optional[TaxonCardinality] = None
2665
+
2666
+ conditional_formats: Optional[List[TaxonConditionalFormat]] = Field(None, alias="conditionalFormats")
2667
+
2625
2668
  def update_path(self, parent_path=None):
2626
2669
  if parent_path is None:
2627
2670
  parent_path = ""
@@ -2641,7 +2684,7 @@ class ContentObject(BaseModel):
2641
2684
  arbitrary_types_allowed=True,
2642
2685
  protected_namespaces=("model_config",),
2643
2686
  )
2644
- id: Optional[str] = Field(None, description="The ID of the object")
2687
+ id: Optional[str] = Field(None)
2645
2688
  uuid: Optional[str] = None
2646
2689
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
2647
2690
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2675,12 +2718,12 @@ class DocumentAssignment(BaseModel):
2675
2718
  A list of the assignments to users for this document
2676
2719
  """
2677
2720
 
2678
- id: Optional[str] = Field(None, description="The ID of the object")
2721
+ id: Optional[str] = Field(None)
2679
2722
  uuid: Optional[str] = None
2680
2723
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
2681
2724
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
2682
2725
  updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
2683
- user: User
2726
+ user: Optional[User] = None
2684
2727
 
2685
2728
 
2686
2729
  class ExceptionDetails(BaseModel):
@@ -2735,9 +2778,11 @@ class ExecutionStep(BaseModel):
2735
2778
  content_objects: Optional[List[ContentObject]] = Field(None, alias="contentObjects")
2736
2779
  input_id: Optional[str] = Field(None, alias="inputId")
2737
2780
  output_id: Optional[str] = Field(None, alias="outputId")
2781
+ output_ids: Optional[List[str]] = Field(None, alias="outputIds")
2738
2782
  ref: Optional[str] = None
2739
2783
  extension_pack_ref: Optional[str] = Field(None, alias="extensionPackRef")
2740
2784
  step_type: Optional[StepType1] = Field(None, alias="stepType")
2785
+ conditional: Optional[str] = None
2741
2786
 
2742
2787
 
2743
2788
  class ProjectStatus(BaseModel):
@@ -2750,7 +2795,7 @@ class ProjectStatus(BaseModel):
2750
2795
  arbitrary_types_allowed=True,
2751
2796
  protected_namespaces=("model_config",),
2752
2797
  )
2753
- id: Optional[str] = Field(None, description="The ID of the object")
2798
+ id: Optional[str] = Field(None)
2754
2799
  uuid: Optional[str] = None
2755
2800
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
2756
2801
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2761,17 +2806,26 @@ class ProjectStatus(BaseModel):
2761
2806
  icon: Optional[str] = None
2762
2807
 
2763
2808
 
2764
- class Project(BaseModel):
2765
- """
2809
+ class ProjectOptions(BaseModel):
2810
+ model_config = ConfigDict(
2811
+ populate_by_name=True,
2812
+ use_enum_values=True,
2813
+ arbitrary_types_allowed=True,
2814
+ protected_namespaces=("model_config",),
2815
+ )
2766
2816
 
2767
- """
2817
+ options: List[Option] = Field(None, description="The options for the project")
2818
+ properties: Dict[str, Any] = Field(None, description="The properties for the project")
2819
+
2820
+
2821
+ class Project(BaseModel):
2768
2822
  model_config = ConfigDict(
2769
2823
  populate_by_name=True,
2770
2824
  use_enum_values=True,
2771
2825
  arbitrary_types_allowed=True,
2772
2826
  protected_namespaces=("model_config",),
2773
2827
  )
2774
- id: Optional[str] = Field(None, description="The ID of the object")
2828
+ id: Optional[str] = Field(None)
2775
2829
  uuid: Optional[str] = None
2776
2830
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
2777
2831
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2804,6 +2858,7 @@ class Project(BaseModel):
2804
2858
  )
2805
2859
  status: Optional[ProjectStatus] = None
2806
2860
  owner: Optional[User] = None
2861
+ options: Optional[ProjectOptions] = Field(None, alias="options")
2807
2862
 
2808
2863
 
2809
2864
  class FeatureSet(BaseModel):
@@ -2876,6 +2931,7 @@ class WorkspaceStorage(BaseModel):
2876
2931
  current_view_id: Optional[str] = Field(None, alias="currentViewId")
2877
2932
  default_sidebar: Optional[str] = Field(None, alias="defaultSidebar")
2878
2933
  overview: Optional[str] = None
2934
+ available_panels: Optional[Dict[str, bool]] = Field(None, alias="availablePanels")
2879
2935
 
2880
2936
 
2881
2937
  class Workspace(BaseModel):
@@ -3024,6 +3080,9 @@ class MessageFeedback(BaseModel):
3024
3080
  )
3025
3081
  options: Optional[List[MessageFeedbackOption]] = Field(None, alias="options")
3026
3082
 
3083
+ # Thumbs down is -1 and thumbs up is 1
3084
+ rating: Optional[int] = None
3085
+
3027
3086
 
3028
3087
  class Message(BaseModel):
3029
3088
  """
@@ -3048,7 +3107,6 @@ class Message(BaseModel):
3048
3107
  assistant: Optional[Assistant] = None
3049
3108
  user: Optional[User] = None
3050
3109
  context: Optional[MessageContext] = None
3051
- force_to_sender: Optional[bool] = Field(False, alias="forceToSender")
3052
3110
 
3053
3111
 
3054
3112
  class DataAttribute(BaseModel):
@@ -3061,7 +3119,7 @@ class DataAttribute(BaseModel):
3061
3119
  arbitrary_types_allowed=True,
3062
3120
  protected_namespaces=("model_config",),
3063
3121
  )
3064
- id: Optional[str] = Field(None, description="The ID of the object")
3122
+ id: Optional[str] = Field(None)
3065
3123
  uuid: Optional[str] = None
3066
3124
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3067
3125
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3106,7 +3164,7 @@ class Role(BaseModel):
3106
3164
  A role that can be used to manage rights
3107
3165
  """
3108
3166
 
3109
- id: Optional[str] = Field(None, description="The ID of the object")
3167
+ id: Optional[str] = Field(None)
3110
3168
  uuid: Optional[str] = None
3111
3169
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3112
3170
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3126,7 +3184,7 @@ class Membership(BaseModel):
3126
3184
  arbitrary_types_allowed=True,
3127
3185
  protected_namespaces=("model_config",),
3128
3186
  )
3129
- id: Optional[str] = Field(None, description="The ID of the object")
3187
+ id: Optional[str] = Field(None)
3130
3188
  uuid: Optional[str] = None
3131
3189
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3132
3190
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3556,7 +3614,7 @@ class ContentException(BaseModel):
3556
3614
  A list of the content exceptions from the content objects
3557
3615
  """
3558
3616
 
3559
- id: Optional[str] = Field(None, description="The ID of the object")
3617
+ id: Optional[str] = Field(None)
3560
3618
  uuid: Optional[str] = None
3561
3619
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3562
3620
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3635,7 +3693,7 @@ class Execution(BaseModel):
3635
3693
  arbitrary_types_allowed=True,
3636
3694
  protected_namespaces=("model_config",),
3637
3695
  )
3638
- id: Optional[str] = Field(None, description="The ID of the object")
3696
+ id: Optional[str] = Field(None)
3639
3697
  uuid: Optional[str] = None
3640
3698
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3641
3699
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3670,7 +3728,7 @@ class ExecutionSnapshot(BaseModel):
3670
3728
  arbitrary_types_allowed=True,
3671
3729
  protected_namespaces=("model_config",),
3672
3730
  )
3673
- id: Optional[str] = Field(None, description="The ID of the object")
3731
+ id: Optional[str] = Field(None)
3674
3732
  uuid: Optional[str] = None
3675
3733
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3676
3734
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3778,6 +3836,20 @@ class LabelStatistics(BaseModel):
3778
3836
  )
3779
3837
 
3780
3838
 
3839
+ class DocumentEmbedding(BaseModel):
3840
+ model_config = ConfigDict(
3841
+ populate_by_name=True,
3842
+ use_enum_values=True,
3843
+ arbitrary_types_allowed=True,
3844
+ protected_namespaces=("model_config",),
3845
+ )
3846
+ embedding: Optional[List[float]] = None
3847
+ document_family: Optional[DocumentFamily] = Field(None, alias="documentFamily")
3848
+ content_object: Optional[ContentObject] = Field(None, alias="contentObject")
3849
+ embedding_name: Optional[str] = Field(None, alias="embeddingName")
3850
+ node_uuid: Optional[str] = Field(None, alias="nodeUuid")
3851
+
3852
+
3781
3853
  class DocumentFamily(BaseModel):
3782
3854
  """
3783
3855
 
@@ -3792,7 +3864,7 @@ class DocumentFamily(BaseModel):
3792
3864
  A document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file
3793
3865
  """
3794
3866
 
3795
- id: Optional[str] = Field(None, description="The ID of the object")
3867
+ id: Optional[str] = Field(None)
3796
3868
  uuid: Optional[str] = None
3797
3869
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3798
3870
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3891,7 +3963,7 @@ class ExecutionAssistant(BaseModel):
3891
3963
  arbitrary_types_allowed=True,
3892
3964
  protected_namespaces=("model_config",),
3893
3965
  )
3894
- id: Optional[str] = Field(None, description="The ID of the object")
3966
+ id: Optional[str] = Field(None)
3895
3967
  uuid: Optional[str] = None
3896
3968
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3897
3969
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3938,7 +4010,7 @@ class DataObject(BaseModel):
3938
4010
  arbitrary_types_allowed=True,
3939
4011
  protected_namespaces=("model_config",),
3940
4012
  )
3941
- id: Optional[str] = Field(None, description="The ID of the object")
4013
+ id: Optional[str] = Field(None)
3942
4014
  uuid: Optional[str] = None
3943
4015
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3944
4016
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3970,7 +4042,7 @@ class Assistant(BaseModel):
3970
4042
  arbitrary_types_allowed=True,
3971
4043
  protected_namespaces=("model_config",),
3972
4044
  )
3973
- id: Optional[str] = Field(None, description="The ID of the object")
4045
+ id: Optional[str] = Field(None)
3974
4046
  uuid: Optional[str] = None
3975
4047
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
3976
4048
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3995,6 +4067,8 @@ class Assistant(BaseModel):
3995
4067
  show_in_training: Optional[bool] = Field(None, alias="showInTraining")
3996
4068
  color: Optional[str] = Field(None, description="The color to use for the assistant")
3997
4069
  priority_hint: Optional[int] = Field(None, alias="priorityHint")
4070
+ chat_enabled: Optional[bool] = Field(None, alias="chatEnabled")
4071
+ assistant_role: Optional[str] = Field(None, alias="assistantRole")
3998
4072
 
3999
4073
 
4000
4074
  class AssistantExecution(BaseModel):
@@ -4024,6 +4098,8 @@ class AssistantExecution(BaseModel):
4024
4098
  DataObjectEvent,
4025
4099
  DocumentFamilyEvent,
4026
4100
  ScheduledEvent,
4101
+ ChannelEvent,
4102
+ WorkspaceEvent,
4027
4103
  ]
4028
4104
  ] = None
4029
4105
  response: Optional[AssistantExecutionResponse] = None
@@ -4172,7 +4248,7 @@ class ExecutionEvent(BaseModel):
4172
4248
  arbitrary_types_allowed=True,
4173
4249
  protected_namespaces=("model_config",),
4174
4250
  )
4175
- id: Optional[str] = Field(None, description="The ID of the object")
4251
+ id: Optional[str] = Field(None)
4176
4252
  uuid: Optional[str] = None
4177
4253
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
4178
4254
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4234,26 +4310,32 @@ class UserSelection(BaseModel):
4234
4310
 
4235
4311
 
4236
4312
  class Guidance(BaseModel):
4237
- """
4238
-
4239
- """
4313
+ id: Optional[str] = Field(None, description="The ID of the guidance")
4314
+ name: Optional[str] = None
4240
4315
  guidance_type: Optional[str] = Field(None, alias="guidanceType")
4241
4316
  taxonomy_ref: Optional[str] = Field(None, alias="taxonomyRef")
4242
4317
  document_name: Optional[str] = Field(None, alias="documentName")
4243
4318
  document_type: Optional[str] = Field(None, alias="documentType")
4319
+ document_page: Optional[int] = Field(None, alias="documentPage")
4244
4320
  sample_text: Optional[str] = Field(None, alias="sampleText")
4245
4321
  sample_result: Optional[Dict[str, List[GuidanceTagResult]]] = Field(None, alias="sampleResult")
4322
+ section_markers: Optional[List[GuidanceTagResult]] = Field(None, alias="sectionMarkers")
4246
4323
  active: Optional[bool] = None
4247
4324
  applicable_tags: Optional[List[str]] = Field(None, alias="applicableTags")
4248
4325
  priority: Optional[int] = 1
4249
4326
  user_instructions: Optional[str] = Field(None, alias="userInstructions")
4250
4327
  user_instructions_properties: Optional[Dict[str, Any]] = Field(None, alias="userInstructionsProperties")
4328
+ created: Optional[StandardDateTime] = None
4329
+ updated: Optional[StandardDateTime] = None
4330
+ userId: Optional[str] = Field(None, alias="userId")
4251
4331
 
4252
4332
  # users selected text, text and line_uuid
4253
4333
  user_selection: Optional[List[UserSelection]] = Field(None, alias="userSelection")
4254
4334
 
4255
4335
  compiled_guidance: Optional[Dict[str, Any]] = Field(None, alias="compiledGuidance")
4256
4336
 
4337
+ guidance_options: Optional[List[Option]] = Field(None, alias="guidanceOptions")
4338
+
4257
4339
 
4258
4340
  class GuidanceSet(ExtensionPackProvided):
4259
4341
  """
@@ -4394,7 +4476,7 @@ class SearchContent(BaseModel):
4394
4476
  A document family is the representation of a single peice of external content (ie. a PDF) and all the related document representations of that file
4395
4477
  """
4396
4478
 
4397
- id: Optional[str] = Field(None, description="The ID of the object")
4479
+ id: Optional[str] = Field(None)
4398
4480
  uuid: Optional[str] = None
4399
4481
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
4400
4482
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4478,7 +4560,7 @@ class PlatformEvent(BaseModel):
4478
4560
  arbitrary_types_allowed=True,
4479
4561
  protected_namespaces=("model_config",),
4480
4562
  )
4481
- id: Optional[str] = Field(None, description="The ID of the object")
4563
+ id: Optional[str] = Field(None)
4482
4564
  uuid: Optional[str] = None
4483
4565
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
4484
4566
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4492,6 +4574,8 @@ class PlatformEvent(BaseModel):
4492
4574
  DataObjectEvent,
4493
4575
  DocumentFamilyEvent,
4494
4576
  ScheduledEvent,
4577
+ ChannelEvent,
4578
+ WorkspaceEvent
4495
4579
  ]
4496
4580
  ] = Field(None, alias="eventDetail")
4497
4581
  document_family: Optional[DocumentFamily] = Field(None, alias="documentFamily")
@@ -4533,7 +4617,7 @@ class AuditEvent(BaseModel):
4533
4617
  An audit event captures a data to a data structure or document
4534
4618
  """
4535
4619
 
4536
- id: Optional[str] = Field(None, description="The ID of the object")
4620
+ id: Optional[str] = Field(None)
4537
4621
  uuid: Optional[str] = None
4538
4622
  change_sequence: Optional[int] = Field(None, alias="changeSequence")
4539
4623
  created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4969,6 +5053,8 @@ class ModelContentMetadata(BaseModel):
4969
5053
  None, alias="trainingOptions", description="The training options for this model"
4970
5054
  )
4971
5055
 
5056
+ model_sidecars: Optional[List[str]] = Field(None, alias="modelSidecars")
5057
+
4972
5058
  message_templates: Optional[List[MessageTemplate]] = Field(
4973
5059
  None, alias="messageTemplates", description="The message templates"
4974
5060
  )
@@ -5174,10 +5260,6 @@ class Pipeline(ExtensionPackProvided):
5174
5260
 
5175
5261
 
5176
5262
  class ProjectTemplate(ExtensionPackProvided):
5177
- """
5178
-
5179
- """
5180
-
5181
5263
  stores: Optional[List[ProjectStore]] = Field(
5182
5264
  None, description="The stores that will be created with the project template"
5183
5265
  )
@@ -5224,9 +5306,10 @@ class ProjectTemplate(ExtensionPackProvided):
5224
5306
  alias="attributeStatuses",
5225
5307
  description="The attribute statuses that will be created with the project template",
5226
5308
  )
5227
- options: Optional[List[Option]] = Field(
5228
- None, description="Options for the project template"
5229
- )
5309
+
5310
+ options: Optional[ProjectOptions] = Field(None, alias="options")
5311
+
5312
+ tags: Optional[List[str]] = Field(None, alias="tags")
5230
5313
 
5231
5314
 
5232
5315
  class Store(ExtensionPackProvided):