kodexa 6.3.37337260243__py3-none-any.whl → 7.0.1a7664024353__py3-none-any.whl

kodexa/model/objects.py

@@ -9,6 +9,13 @@ from kodexa.model.base import StandardDateTime
 
 
 class ExceptionResponse(BaseModel):
+    """
+    This class represents the response structure for exceptions in the application.
+
+    Attributes:
+        date_time (Optional[StandardDateTime]): The date and time when the exception occurred.
+        message (Optional[str]): The error message.
+        incident_id (Optional[str]): The ID of the incident associated with the"""
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -28,6 +35,9 @@ class ExceptionResponse(BaseModel):
 
 
 class StatusType(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -40,6 +50,9 @@ class StatusType(BaseModel):
 
 
 class StackTraceItem(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -57,6 +70,14 @@ class StackTraceItem(BaseModel):
 
 
 class StackTraceItem1(BaseModel):
+    """
+
+    :class:`StackTraceItem1` represents a stack trace item.
+
+    Attributes:
+        model_config (ConfigDict): Configuration dictionary for the model.
+        class_loader_name (str, optional): The name of the class loader used.
+        module_name (str, optional): The name of the module"""
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -74,6 +95,9 @@ class StackTraceItem1(BaseModel):
 
 
 class Cause(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -86,6 +110,9 @@ class Cause(BaseModel):
 
 
 class StackTraceItem2(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -103,6 +130,9 @@ class StackTraceItem2(BaseModel):
 
 
 class SuppressedItem(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -116,6 +146,9 @@ class SuppressedItem(BaseModel):
 
 
 class ThrowableProblem(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -136,6 +169,9 @@ class ThrowableProblem(BaseModel):
 
 
 class FavoriteLink(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -146,6 +182,9 @@ class FavoriteLink(BaseModel):
 
 
 class UserStorage(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -156,6 +195,9 @@ class UserStorage(BaseModel):
 
 
 class CompletePasswordReset(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -167,6 +209,9 @@ class CompletePasswordReset(BaseModel):
 
 
 class Organization(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -186,6 +231,9 @@ class Organization(BaseModel):
 
 
 class Team(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -203,6 +251,9 @@ class Team(BaseModel):
 
 
 class AssistantImplementation(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -218,6 +269,9 @@ class AssistantImplementation(BaseModel):
 
 
 class AssistantTaxonomy(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -232,6 +286,9 @@ class AssistantTaxonomy(BaseModel):
 
 
 class Avatar(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -243,6 +300,9 @@ class Avatar(BaseModel):
 
 
 class Card(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -256,6 +316,9 @@ class Card(BaseModel):
 
 
 class ColumnState(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -272,6 +335,9 @@ class ColumnState(BaseModel):
 
 
 class ContainerResources(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -283,6 +349,9 @@ class ContainerResources(BaseModel):
 
 
 class ContentMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -297,6 +366,9 @@ class ContentMetadata(BaseModel):
 
 
 class DashboardWidget(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -311,6 +383,9 @@ class DashboardWidget(BaseModel):
 
 
 class DataFormSource(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -324,6 +399,9 @@ class DataFormSource(BaseModel):
 
 
 class DataFormView(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -341,6 +419,15 @@ class DataFormView(BaseModel):
 
 
 class DeploymentType(Enum):
+    """
+    Represents the types of deployment options available.
+
+    Attributes:
+        kubernetes (str): Represents a Kubernetes deployment.
+        aws_lambda (str): Represents an AWS Lambda deployment.
+        azure_cloud_function (str): Represents an Azure Cloud Function deployment.
+        none (str): Represents no deployment type.
+    """
     kubernetes = "KUBERNETES"
     aws_lambda = "AWS_LAMBDA"
     azure_cloud_function = "AZURE_CLOUD_FUNCTION"
@@ -348,6 +435,9 @@ class DeploymentType(Enum):
 
 
 class DocumentColumn(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -361,6 +451,9 @@ class DocumentColumn(BaseModel):
 
 
 class DocumentMetadataProperty(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -373,6 +466,9 @@ class DocumentMetadataProperty(BaseModel):
 
 
 class Status(Enum):
+    """
+
+    """
     pending = "PENDING"
     building = "BUILDING"
     built = "BUILT"
@@ -385,6 +481,9 @@ class Status(Enum):
 
 
 class ExtensionPackSource(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -395,6 +494,9 @@ class ExtensionPackSource(BaseModel):
 
 
 class MatchLabel(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -406,6 +508,9 @@ class MatchLabel(BaseModel):
 
 
 class MetadataTag(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -422,7 +527,7 @@ class MetadataTag(BaseModel):
 
 class State(Enum):
     """
-    The state of the model in this store
+
     """
 
     pending = "PENDING"
@@ -437,7 +542,7 @@ class State(Enum):
 
 class DeploymentType1(Enum):
     """
-    The deployment to use, local means that the model runtime can be re-used across models, while container means that the model store must be deployed with the model runtime
+
     """
 
     local = "LOCAL"
@@ -445,6 +550,9 @@ class DeploymentType1(Enum):
 
 
 class OverlayCondition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -456,7 +564,7 @@ class OverlayCondition(BaseModel):
 
 class StepType(Enum):
     """
-    The type of step (ACTION or MODEL)
+
     """
 
     action = "ACTION"
@@ -464,6 +572,9 @@ class StepType(Enum):
 
 
 class PipelineStepMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -485,6 +596,9 @@ class PipelineStepMetadata(BaseModel):
 
 
 class PossibleValue(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -496,7 +610,32 @@ class PossibleValue(BaseModel):
     description: Optional[str] = None
 
 
+class ProjectGuidance(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    """
+    The guidance that will be created with the project template
+    """
+
+    slug: Optional[str] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    template_ref: Optional[str] = Field(None, alias="templateRef")
+    ref: Optional[str] = None
+    guidance: Optional[List[Guidance]] = Field(None, alias="guidance")
+
+
 class ProjectDashboard(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -517,6 +656,9 @@ class ProjectDashboard(BaseModel):
 
 
 class StoreType(Enum):
+    """
+
+    """
     document = "DOCUMENT"
     table = "TABLE"
     dictionary = "DICTIONARY"
@@ -524,11 +666,17 @@ class StoreType(Enum):
 
 
 class StorePurpose(Enum):
+    """
+
+    """
     operational = "OPERATIONAL"
     training = "TRAINING"
 
 
 class ProjectStore(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -562,7 +710,7 @@ class ProjectStore(BaseModel):
 
 class TaxonomyType(Enum):
     """
-    The type of taxonomy
+
     """
 
     content = "CONTENT"
@@ -573,7 +721,7 @@ class TaxonomyType(Enum):
 
 class Category(Enum):
     """
-    The category of project template
+
     """
 
     task = "TASK"
@@ -584,11 +732,17 @@ class Category(Enum):
 
 
 class Purpose(Enum):
+    """
+
+    """
     suggestion = "SUGGESTION"
     source = "SOURCE"
 
 
 class RelatedTaxon(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -605,6 +759,9 @@ class RelatedTaxon(BaseModel):
 
 
 class ScheduleDefinition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -622,6 +779,9 @@ class ScheduleDefinition(BaseModel):
 
 
 class SelectionOption(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -638,6 +798,9 @@ class SelectionOption(BaseModel):
 
 
 class SlugBasedMetadata1(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -705,6 +868,9 @@ class SlugBasedMetadata1(BaseModel):
 
 
 class StepImplementation(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -715,27 +881,10 @@ class StepImplementation(BaseModel):
     class_: Optional[str] = Field(None, alias="class")
 
 
-class StoreType1(Enum):
-    """
-    The type of object the store will contain
+class StoreViewOptions(BaseModel):
     """
 
-    document = "DOCUMENT"
-    table = "TABLE"
-    dictionary = "DICTIONARY"
-    model = "MODEL"
-
-
-class StorePurpose1(Enum):
-    """
-    The purpose of the store (used by UI and assistants to understand how to interact with the store events)
     """
-
-    operational = "OPERATIONAL"
-    training = "TRAINING"
-
-
-class StoreViewOptions(BaseModel):
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -764,6 +913,16 @@ class StoreViewOptions(BaseModel):
 
 
 class OptionTab(BaseModel):
+    """
+
+    Class OptionTab
+
+    This class represents an option tab that can be used in a UI for configuring models.
+
+    Attributes:
+    - `model_config` (ConfigDict): A dictionary that stores the model configuration.
+    - `name` (Optional[str]): The name of the option tab.
+    - `description` (Optional[str]): The description of the option"""
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -780,7 +939,15 @@ class OptionTab(BaseModel):
 
 class ValuePath(Enum):
     """
-    Where to get the value for this taxon when extracting
+    Enum class representing different types of value paths.
+
+    :cvar value_or_all_content: Represents a value or all content.
+    :cvar value_only: Represents a value only.
+    :cvar all_content: Represents all content.
+    :cvar data_path: Represents a data path.
+    :cvar metadata: Represents metadata.
+    :cvar expression: Represents an expression.
+    :cvar script: Represents a script.
     """
 
     value_or_all_content = "VALUE_OR_ALL_CONTENT"
@@ -793,8 +960,12 @@ class ValuePath(Enum):
 
 
 class MetadataValue(Enum):
-    """
-    If the type is metadata this will be the metadata option
+    """Enumeration representing different metadata values.
+
+    Attributes:
+        filename (str): The filename metadata value.
+        transaction_uuid (str): The transaction UUID metadata value.
+        created_datetime (str): The created datetime metadata value.
     """
 
     filename = "FILENAME"
@@ -804,8 +975,21 @@ class MetadataValue(Enum):
 
 class TaxonType(Enum):
     """
-    Expected data type to coalesce to (defaults to STRING)
-    """
+    An enumeration representing different types of taxonomic data.
+
+    The TaxonType class defines constants for various taxonomic data types, including strings, dates, numbers,
+    and more.
+
+    Usage:
+        Use the TaxonType enumeration to represent the type of taxonomic data in your code.
+
+    Example:
+        ::
+
+            taxon_type = TaxonType.string
+            if taxon_type == TaxonType.date:
+                print("This is a date type")
+            elif taxon"""
 
     string = "STRING"
     date = "DATE"
@@ -823,7 +1007,13 @@ class TaxonType(Enum):
 
 class TaxonomyType1(Enum):
     """
-    The type of taxonomy
+    Represents the taxonomy types for classification.
+
+    The possible values are:
+    - content: Represents the content taxonomy type.
+    - classification: Represents the classification taxonomy type.
+    - processing: Represents the processing taxonomy type.
+    - model: Represents the model taxonomy type.
     """
 
     content = "CONTENT"
@@ -833,6 +1023,9 @@ class TaxonomyType1(Enum):
 
 
 class ViewPreset(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -850,6 +1043,9 @@ class ViewPreset(BaseModel):
 
 
 class ReprocessRequest(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -862,6 +1058,9 @@ class ReprocessRequest(BaseModel):
 
 
 class AssistantSchedule(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -876,11 +1075,24 @@ class AssistantSchedule(BaseModel):
 
 
 class StatusType1(Enum):
+    """
+    Enumeration class representing the status types.
+
+    Each status type has a string value associated with it.
+
+    :ivar unresolved: The unresolved status type.
+    :vartype unresolved: StatusType1
+    :ivar resolved: The resolved status type.
+    :vartype resolved: StatusType1
+    """
     unresolved = "UNRESOLVED"
     resolved = "RESOLVED"
 
 
 class AttributeStatus(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -898,9 +1110,7 @@ class AttributeStatus(BaseModel):
 
 
 class ContentType(Enum):
-    """
-    The type of content
-    """
+    """A class representing the content type of a document or native file."""
 
     document = "DOCUMENT"
     native = "NATIVE"
@@ -908,8 +1118,23 @@ class ContentType(Enum):
 
 class ActorType(Enum):
     """
-    The type of actor
-    """
+    The ActorType class is an enumeration that represents different types of actors in a system.
+
+    Usage:
+        Use the ActorType enum to specify the type of an actor in your system.
+
+    Attributes:
+        - user: Represents a user actor.
+        - assistant: Represents an assistant actor.
+        - access_token: Represents an access token actor.
+        - api: Represents an API actor.
+
+    Example:
+        actor = ActorType.user
+        print(actor)  # Output: ActorType.user
+
+    Notes:
+        - The values of the ActorType enum are"""
 
     user = "USER"
     assistant = "ASSISTANT"
@@ -918,6 +1143,9 @@ class ActorType(Enum):
 
 
 class DocumentActor(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -939,11 +1167,19 @@ class DocumentActor(BaseModel):
 
 
 class StatusType2(Enum):
+    """Module containing the `StatusType2` class.
+
+    This class represents the status types for a particular issue or task.
+
+    """
     unresolved = "UNRESOLVED"
     resolved = "RESOLVED"
 
 
 class DocumentStatus(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -963,13 +1199,18 @@ class DocumentStatus(BaseModel):
 
 class TransitionType(Enum):
     """
-    The type of transition
+    Defines the different types of transitions.
+
+    :cvar derived: The transition is derived from previous data.
     """
 
     derived = "DERIVED"
 
 
 class DocumentTransition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1005,6 +1246,25 @@ class DocumentTransition(BaseModel):
 
 
 class Status1(Enum):
+    """
+
+    The Status1 Enumeration Class
+    ------------------------
+
+    This class represents a set of possible statuses.
+
+    Attributes:
+        pending (str): The pending status.
+        running (str): The running status.
+        succeeded (str): The succeeded status.
+        failed (str): The failed status.
+        requested (str): The requested status.
+        skipped (str): The skipped status.
+        cancelling (str): The cancelling status.
+        cancelled (str): The cancelled status.
+        pending_reprocessing (str): The pending reprocessing status.
+
+    """
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1017,6 +1277,20 @@ class Status1(Enum):
 
 
 class Status2(Enum):
+    """
+
+    :class:`Status2` Enum
+
+    Enumeration class representing the status of a task. The possible values are:
+
+    - `pending`: The task is pending and has not started yet.
+    - `running`: The task is currently running.
+    - `succeeded`: The task has successfully completed.
+    - `failed`: The task has failed to complete.
+    - `requested`: The task has been requested to start but has not yet started.
+    - `skipped`: The task has been skipped.
+    - `cancelling`: The task is currently being cancelled.
+    """
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1029,6 +1303,9 @@ class Status2(Enum):
 
 
 class Status3(Enum):
+    """
+
+    """
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1041,17 +1318,47 @@ class Status3(Enum):
 
 
 class StepType1(Enum):
+    """
+    Enumerates the possible step types for a specific class.
+
+    :class: StepType1
+
+    Attributes:
+        action (str): Constant representing an action step type.
+        model (str): Constant representing a model step type.
+    """
     action = "ACTION"
     model = "MODEL"
 
 
 class Type(Enum):
+    """
+    A class representing different types.
+
+    Attributes:
+        document_store (str): Represents the type for document store.
+        taxonomy_store (str): Represents the type for taxonomy store.
+        data_store (str): Represents the type for data store.
+
+    Examples:
+        The `document_store` attribute can be accessed as follows:
+
+        >>> Type.document_store
+        <Type.document_store: 'DOCUMENT_STORE'>
+
+        The `taxonomy_store` attribute can be accessed as follows:
+
+        >>> Type.taxonomy_store
+        <Type.taxonomy_store"""
     document_store = "DOCUMENT_STORE"
     taxonomy_store = "TAXONOMY_STORE"
     data_store = "DATA_STORE"
 
 
 class ExecutionTarget(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1068,6 +1375,9 @@ class ExecutionTarget(BaseModel):
 
 
 class ExecutionTargets(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1078,6 +1388,9 @@ class ExecutionTargets(BaseModel):
 
 
 class Label(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1099,6 +1412,9 @@ class Label(BaseModel):
 
 
 class ProjectTag(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1115,6 +1431,9 @@ class ProjectTag(BaseModel):
 
 
 class PathExtractedData(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1130,6 +1449,9 @@ class PathExtractedData(BaseModel):
 
 
 class ProjectMemory(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1140,6 +1462,9 @@ class ProjectMemory(BaseModel):
 
 
 class ProjectMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1150,11 +1475,28 @@ class ProjectMetadata(BaseModel):
 
 
 class State1(Enum):
+    """
+    .. py:class:: State1(Enum)
+
+       Enumeration class representing different states.
+
+       The ``State1`` class is an enumeration that represents different states. It is implemented as an enum in Python.
+       The available states are "open" and "closed".
+
+       The states are defined with corresponding string values, allowing for easy comparison and assignment.
+
+       :cvar open: Represents the "OPEN" state.
+       :vartype open: str
+       :cvar closed: Represents the "CLOSED" state.
+       :v"""
     open = "OPEN"
     closed = "CLOSED"
 
 
 class Session(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1171,6 +1513,17 @@ class Session(BaseModel):
 
 
 class Status4(Enum):
+    """
+
+    :class:`Status4` is an enumeration class that represents different status values.
+
+    Attributes:
+        * :attr:`Status4.pending`: Represents the "PENDING" status.
+        * :attr:`Status4.running`: Represents the "RUNNING" status.
+        * :attr:`Status4.succeeded`: Represents the "SUCCEEDED" status.
+        * :attr:`Status4.failed`: Represents the "FAILED" status.
+        * :attr:`Status4.requested`: Represents the "REQUESTED" status.
+        * :"""
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1183,6 +1536,9 @@ class Status4(Enum):
 
 
 class StatusDetails(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1197,6 +1553,9 @@ class StatusDetails(BaseModel):
 
 
 class ValidationError(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1213,6 +1572,9 @@ class ValidationError(BaseModel):
 
 
 class ValidationResults(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1223,6 +1585,9 @@ class ValidationResults(BaseModel):
 
 
 class BulkCopy(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1235,6 +1600,9 @@ class BulkCopy(BaseModel):
 
 
 class FamilyRename(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1245,6 +1613,9 @@ class FamilyRename(BaseModel):
 
 
 class ContentFeature(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1258,6 +1629,9 @@ class ContentFeature(BaseModel):
 
 
 class NodeFeatures(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1269,6 +1643,9 @@ class NodeFeatures(BaseModel):
 
 
 class DataException(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1296,6 +1673,9 @@ class DataException(BaseModel):
 
 
 class DataLineage(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1309,6 +1689,9 @@ class DataLineage(BaseModel):
 
 
 class WorkflowDefinition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1320,6 +1703,9 @@ class WorkflowDefinition(BaseModel):
 
 
 class ProjectResourcesUpdate(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1333,12 +1719,18 @@ class ProjectResourcesUpdate(BaseModel):
 
 
 class Role1(Enum):
+    """
+
+    """
     owner = "OWNER"
     read = "READ"
     write = "WRITE"
 
 
 class DeploymentType2(Enum):
+    """
+
+    """
     kubernetes = "KUBERNETES"
     aws_lambda = "AWS_LAMBDA"
     azure_cloud_function = "AZURE_CLOUD_FUNCTION"
@@ -1346,6 +1738,9 @@ class DeploymentType2(Enum):
 
 
 class DeploymentOptions(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1362,13 +1757,19 @@ class DeploymentOptions(BaseModel):
     child_process: Optional[bool] = Field(None, alias="childProcess")
 
 
-class SourceType(Enum):
+class SourceType(Enum):
+    """
+
+    """
     data_object = "DATA_OBJECT"
     data_attribute = "DATA_ATTRIBUTE"
     fixed = "FIXED"
 
 
 class DataFormSourceParameter(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1380,6 +1781,9 @@ class DataFormSourceParameter(BaseModel):
 
 
 class DataFormProviderExchange(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1392,6 +1796,9 @@ class DataFormProviderExchange(BaseModel):
 
 
 class PlatformConfiguration(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1426,6 +1833,9 @@ class PlatformConfiguration(BaseModel):
 
 
 class UserActivation(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1438,6 +1848,9 @@ class UserActivation(BaseModel):
 
 
 class ModelTraining(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1466,6 +1879,9 @@ class ModelTraining(BaseModel):
 
 
 class Status5(Enum):
+    """
+
+    """
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1478,6 +1894,9 @@ class Status5(Enum):
 
 
 class BaseEvent1(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1488,11 +1907,17 @@ class BaseEvent1(BaseModel):
 
 
 class ObjectEventType(Enum):
+    """
+
+    """
     new_object = "NEW_OBJECT"
     derived_object = "DERIVED_OBJECT"
 
 
 class ExecutionEventType(Enum):
+    """
+
+    """
     start_execution = "START_EXECUTION"
     step_update = "STEP_UPDATE"
     assistant_event = "ASSISTANT_EVENT"
@@ -1501,6 +1926,9 @@ class ExecutionEventType(Enum):
 
 
 class Status6(Enum):
+    """
+
+    """
     pending = "PENDING"
     running = "RUNNING"
     succeeded = "SUCCEEDED"
@@ -1513,6 +1941,9 @@ class Status6(Enum):
 
 
 class ExecutionLogEntry(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1529,6 +1960,9 @@ class ExecutionLogEntry(BaseModel):
 
 
 class LoginRequest(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1540,6 +1974,9 @@ class LoginRequest(BaseModel):
 
 
 class RegisterUser(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1552,6 +1989,9 @@ class RegisterUser(BaseModel):
 
 
 class PasswordReset(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1562,6 +2002,9 @@ class PasswordReset(BaseModel):
 
 
 class PasswordChange(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1573,6 +2016,9 @@ class PasswordChange(BaseModel):
 
 
 class PlatformOverview(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1617,6 +2063,9 @@ class PlatformOverview(BaseModel):
 
 
 class QueryContext(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1635,6 +2084,9 @@ class QueryContext(BaseModel):
 
 
 class SortObject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1647,6 +2099,9 @@ class SortObject(BaseModel):
 
 
 class SearchEntity(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1665,12 +2120,18 @@ class SearchEntity(BaseModel):
 
 
 class EventType(Enum):
+    """
+
+    """
     created = "CREATED"
     deleted = "DELETED"
     updated = "UPDATED"
 
 
 class DataAttributeValues(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1692,6 +2153,9 @@ class DataAttributeValues(BaseModel):
 
 
 class BulkDelete(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1703,6 +2167,9 @@ class BulkDelete(BaseModel):
 
 
 class User(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1733,6 +2200,9 @@ class User(BaseModel):
 
 
 class DeploymentMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1761,10 +2231,16 @@ class DeploymentMetadata(BaseModel):
 
 
 class DockerSource(ExtensionPackSource):
+    """
+
+    """
     location: Optional[str] = None
 
 
 class DocumentMetadataDefaults(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1777,6 +2253,9 @@ class DocumentMetadataDefaults(BaseModel):
 
 
 class ExtensionPackProvided(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1852,6 +2331,9 @@ class ExtensionPackProvided(BaseModel):
 
 
 class Option(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1885,6 +2367,9 @@ class Option(BaseModel):
 
 
 class Overlay(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1901,6 +2386,9 @@ class Overlay(BaseModel):
 
 
 class PipelineImplementationMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1918,12 +2406,7 @@ class PipelineImplementationMetadata(BaseModel):
 
 class ConnectionType(Enum):
     """
-    The type of assistant subscription, ie.
-        STORE,
-        DOCUMENT_FAMILY,
-        DATA_OBJECT,
-        WORKSPACE,
-        CHANNEL,
+
     """
     STORE = "STORE"
     DOCUMENT_FAMILY = "DOCUMENT_FAMILY"
@@ -1933,6 +2416,9 @@ class ConnectionType(Enum):
 
 
 class ProjectAssistantConnection(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1953,6 +2439,9 @@ class ProjectAssistantConnection(BaseModel):
 
 
 class ProjectAssistant(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -1979,6 +2468,9 @@ class ProjectAssistant(BaseModel):
 
 
 class Taxon(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2112,17 +2604,12 @@ class Taxon(BaseModel):
         alias="postExpression",
         description="An expression that is applied post extraction of the data",
     )
-    default_attribute_status_id: Optional[str] = Field(
-        None,
-        alias="defaultAttributeStatusId",
-        description="Default attribute status ID",
-    )
     semantic_definition: Optional[str] = Field(
         None,
         alias="semanticDefinition",
         description="The semantic definition of the taxon",
     )
-    examples: Optional[List[str]] = Field(
+    examples: Optional[List[GuidanceTagResult]] = Field(
         None,
         description="A list of examples of the taxon values, used to understand the taxon",
     )
@@ -2132,8 +2619,19 @@ class Taxon(BaseModel):
         description="A list of synonyms of the taxon values, used to understand the taxon",
     )
 
+    def update_path(self, parent_path=None):
+        if parent_path is None:
+            parent_path = ""
+        self.path = parent_path + self.name
+        if self.children is not None:
+            for child in self.children:
+                child.update_path(self.path + "/")
+
 
 class ContentObject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2161,6 +2659,9 @@ class ContentObject(BaseModel):
 
 
 class DocumentAssignment(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2180,6 +2681,9 @@ class DocumentAssignment(BaseModel):
 
 
 class ExceptionDetails(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2204,6 +2708,9 @@ class ExceptionDetails(BaseModel):
 
 
 class ExecutionStep(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2231,6 +2738,9 @@ class ExecutionStep(BaseModel):
 
 
 class ProjectStatus(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2249,6 +2759,9 @@ class ProjectStatus(BaseModel):
 
 
 class Project(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2290,20 +2803,10 @@ class Project(BaseModel):
     owner: Optional[User] = None
 
 
-class TaxonLink(BaseModel):
-    model_config = ConfigDict(
-        populate_by_name=True,
-        use_enum_values=True,
-        arbitrary_types_allowed=True,
-        protected_namespaces=("model_config",),
-    )
-    node_uuids: Optional[List[str]] = Field(None, alias="nodeUuids")
-    content_object: Optional[ContentObject] = Field(None, alias="contentObject")
-    path: Optional[str] = None
-    owner_uri: Optional[str] = Field(None, alias="ownerUri")
-
-
 class FeatureSet(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2315,6 +2818,9 @@ class FeatureSet(BaseModel):
 
 
 class DocumentViewState(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2330,6 +2836,9 @@ class DocumentViewState(BaseModel):
 
 
 class DataFormState(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2346,6 +2855,9 @@ class DataFormState(BaseModel):
 
 
 class WorkspaceStorage(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2364,6 +2876,9 @@ class WorkspaceStorage(BaseModel):
 
 
 class Workspace(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2378,13 +2893,15 @@ class Workspace(BaseModel):
     project: Optional[Project] = None
     name: Optional[str] = None
     description: Optional[str] = None
-    channel: Optional[Channel] = None
     workspace_storage: Optional[WorkspaceStorage] = Field(
         None, alias="workspaceStorage"
     )
 
 
 class ProjectWorkspace(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2399,6 +2916,9 @@ class ProjectWorkspace(BaseModel):
 
 
 class Channel(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2411,9 +2931,13 @@ class Channel(BaseModel):
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
     updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
     workspace: Optional[Workspace] = None
+    name: Optional[str] = None
 
 
 class MessageBlock(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2424,10 +2948,13 @@ class MessageBlock(BaseModel):
     type: Optional[str] = None
     properties: Optional[Dict[str, Any]] = None
     channel: Optional[Channel] = None
-    children: Optional[List[MessageBlock]] = Field(None, alias="messageBlock")
+    children: Optional[List[MessageBlock]] = Field(None, alias="children")
 
 
 class MessageFeedbackResponse(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2442,6 +2969,9 @@ class MessageFeedbackResponse(BaseModel):
 
 
 class MessageFeedbackOption(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2460,6 +2990,9 @@ class MessageFeedbackOption(BaseModel):
 
 
 class MessageFeedback(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2470,6 +3003,9 @@ class MessageFeedback(BaseModel):
 
 
 class Message(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2491,7 +3027,11 @@ class Message(BaseModel):
     context: Optional[MessageContext] = None
     force_to_sender: Optional[bool] = Field(False, alias="forceToSender")
 
+
 class DataAttribute(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2528,7 +3068,11 @@ class DataAttribute(BaseModel):
     data_obj_id: Optional[str] = Field(None, alias="dataObjId")
     label: Optional[str] = None
 
+
 class Role(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2550,6 +3094,9 @@ class Role(BaseModel):
 
 
 class Membership(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2567,6 +3114,9 @@ class Membership(BaseModel):
 
 
 class DataFormSourceMethod(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2578,6 +3128,9 @@ class DataFormSourceMethod(BaseModel):
 
 
 class PageableObject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2592,6 +3145,9 @@ class PageableObject(BaseModel):
 
 
 class PageTeam(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2611,6 +3167,9 @@ class PageTeam(BaseModel):
 
 
 class PageModelTraining(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2630,6 +3189,9 @@ class PageModelTraining(BaseModel):
 
 
 class PageDataAttribute(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2649,6 +3211,9 @@ class PageDataAttribute(BaseModel):
 
 
 class PageSession(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2668,6 +3233,9 @@ class PageSession(BaseModel):
 
 
 class PageRole(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2687,6 +3255,9 @@ class PageRole(BaseModel):
 
 
 class PageProject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2706,6 +3277,9 @@ class PageProject(BaseModel):
 
 
 class PageAssistant(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2725,6 +3299,9 @@ class PageAssistant(BaseModel):
 
 
 class PageWorkspace(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2744,6 +3321,9 @@ class PageWorkspace(BaseModel):
 
 
 class PageMessage(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2763,6 +3343,9 @@ class PageMessage(BaseModel):
 
 
 class PageChannel(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2782,6 +3365,9 @@ class PageChannel(BaseModel):
 
 
 class PageOrganization(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2801,6 +3387,9 @@ class PageOrganization(BaseModel):
 
 
 class PageMembership(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2820,6 +3409,9 @@ class PageMembership(BaseModel):
 
 
 class PageExecutionLogEntry(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2839,6 +3431,9 @@ class PageExecutionLogEntry(BaseModel):
 
 
 class CustomEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2884,6 +3479,9 @@ class CustomEvent(BaseModel):
 
 
 class ObjectMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2894,6 +3492,9 @@ class ObjectMetadata(BaseModel):
 
 
 class ProjectTaxonomy(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2919,6 +3520,9 @@ class ProjectTaxonomy(BaseModel):
 
 
 class ContentException(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2935,9 +3539,9 @@ class ContentException(BaseModel):
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
     updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
     tag: Optional[str] = None
-    message: str
-    exception_type: str = Field(..., alias="exceptionType")
-    severity: str
+    message: Optional[str] = None
+    exception_type: Optional[str] = Field(None, alias="exceptionType")
+    severity: Optional[str] = None
     exception_details: Optional[str] = Field(None, alias="exceptionDetails")
     group_uuid: Optional[str] = Field(None, alias="groupUuid")
     tag_uuid: Optional[str] = Field(None, alias="tagUuid")
@@ -2945,6 +3549,9 @@ class ContentException(BaseModel):
 
 
 class ExecutionPipeline(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2959,6 +3566,9 @@ class ExecutionPipeline(BaseModel):
 
 
 class DataFormSourceDefinition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2971,6 +3581,9 @@ class DataFormSourceDefinition(BaseModel):
 
 
 class PageUser(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2990,6 +3603,9 @@ class PageUser(BaseModel):
 
 
 class Execution(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3022,6 +3638,9 @@ class Execution(BaseModel):
 
 
 class ExecutionSnapshot(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3054,6 +3673,9 @@ class ExecutionSnapshot(BaseModel):
 
 
 class PageExecution(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3073,6 +3695,9 @@ class PageExecution(BaseModel):
 
 
 class ContentMetadata1(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3083,6 +3708,9 @@ class ContentMetadata1(BaseModel):
 
 
 class SlugBasedMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3093,6 +3721,9 @@ class SlugBasedMetadata(BaseModel):
 
 
 class LabelStatistics(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3125,6 +3756,9 @@ class LabelStatistics(BaseModel):
 
 
 class DocumentFamily(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3203,7 +3837,11 @@ class DocumentFamily(BaseModel):
         description="The statistics about the labels in the document family",
     )
 
+
 class DocumentFamilyStatistics(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3221,6 +3859,9 @@ class DocumentFamilyStatistics(BaseModel):
 
 
 class ExecutionAssistant(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3251,6 +3892,9 @@ class ExecutionAssistant(BaseModel):
 
 
 class ExecutionOverview(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3262,6 +3906,9 @@ class ExecutionOverview(BaseModel):
 
 
 class DataObject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3291,6 +3938,9 @@ class DataObject(BaseModel):
 
 
 class Assistant(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3325,6 +3975,9 @@ class Assistant(BaseModel):
 
 
 class AssistantExecution(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3357,6 +4010,9 @@ class AssistantExecution(BaseModel):
 
 
 class AssistantExecutionResponse(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3368,6 +4024,9 @@ class AssistantExecutionResponse(BaseModel):
 
 
 class AssistantResponsePipeline(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3395,10 +4054,16 @@ class BaseEvent(
         ]
     ]
 ):
+    """
+
+    """
     pass
 
 
 class MessageContext(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3407,16 +4072,20 @@ class MessageContext(BaseModel):
     )
 
     active_features: Optional[FeatureSet] = Field(None, alias="activeFeatures")
+    active_data: Optional[List[dict[str, Any]]] = Field(None, alias="activeData")
     content_object_id: Optional[str] = Field(None, alias="contentObjectId")
     store_ref: Optional[str] = Field(None, alias="storeRef")
     document_family_id: Optional[str] = Field(None, alias="documentFamilyId")
     selected_node_uuids: Optional[List[str]] = Field(None, alias="selectedNodeUuids")
     page: Optional[int] = None
     message_template: Optional[MessageTemplate] = Field(None, alias="messageTemplate")
-    message_feedback_response: Optional[MessageFeedbackResponse] = Field(None, alias="messageFeedbackResponse")
+    message_feedback_response: Optional[MessageFeedbackResponse] = Field(None, alias="feedbackOption")
 
 
 class MessageEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3427,6 +4096,9 @@ class MessageEvent(BaseModel):
 
 
 class ChannelEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3439,6 +4111,9 @@ class ChannelEvent(BaseModel):
 
 
 class ExecutionEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3471,6 +4146,9 @@ class ExecutionEvent(BaseModel):
 
 
 class PageTaxonomy(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3489,7 +4167,127 @@ class PageTaxonomy(BaseModel):
     empty: Optional[bool] = None
 
 
+class GuidanceTagResult(BaseModel):
+    """
+
+    """
+    value: Optional[str] = None
+    line_uuid: Optional[str] = Field(None, alias="lineUuid")
+
+
+class UserSelection(BaseModel):
+
+    text: Optional[str] = None
+    line_uuid: Optional[str] = Field(None, alias="lineUuid")
+
+
+class Guidance(BaseModel):
+    """
+
+    """
+    guidance_type: Optional[str] = Field(None, alias="guidanceType")
+    taxonomy_ref: Optional[str] = Field(None, alias="taxonomyRef")
+    document_name: Optional[str] = Field(None, alias="documentName")
+    document_type: Optional[str] = Field(None, alias="documentType")
+    sample_text: Optional[str] = Field(None, alias="sampleText")
+    sample_result: Optional[Dict[str, List[GuidanceTagResult]]] = Field(None, alias="sampleResult")
+    active: Optional[bool] = None
+    applicable_tags: Optional[List[str]] = Field(None, alias="applicableTags")
+    priority: Optional[int] = 1
+    user_instructions: Optional[str] = Field(None, alias="userInstructions")
+    user_instructions_properties: Optional[Dict[str, Any]] = Field(None, alias="userInstructionsProperties")
+    
+    # users selected text, text and line_uuid
+    user_selection: Optional[List[UserSelection]] = Field(None, alias="userSelection")
+
+    compiled_guidance: Optional[Dict[str, Any]] = Field(None, alias="compiledGuidance")
+
+
+class GuidanceSet(ExtensionPackProvided):
+    """
+
+    """
+    guidance: List[Guidance] = Field(None, description="The guidance in the set")
+
+
+class PageGuidanceSet(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[GuidanceSet]] = None
+    number: Optional[int] = None
+
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
+class TemplateType(Enum):
+    """
+
+    """
+    fstring = "FSTRING"
+    mustache = "MUSTACHE"
+
+
+class Prompt(ExtensionPackProvided):
+    """
+
+    """
+    prompt_template: Optional[str] = Field(
+        None, description="The prompt template", alias="promptTemplate"
+    )
+    options: Optional[List[Option]] = Field(
+        None, description="Options for the prompt"
+    )
+    template_type: Optional[TemplateType] = Field(None, alias="templateType")
+
+    def render(self, properties):
+        if self.template_type == "FSTRING":
+            return self.prompt_template.format(**properties)
+        elif self.template_type == "MUSTACHE":
+            import chevron
+            return chevron.render(self.prompt_template, properties)
+        else:
+            raise Exception(f"Unknown template type {self.template_type}")
+
+
+class PagePrompt(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[Prompt]] = None
+    number: Optional[int] = None
+
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
 class PageStore(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3509,6 +4307,9 @@ class PageStore(BaseModel):
 
 
 class PageDocumentFamily(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3528,6 +4329,9 @@ class PageDocumentFamily(BaseModel):
 
 
 class SearchContent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3575,6 +4379,9 @@ class SearchContent(BaseModel):
 
 
 class StoreMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3610,6 +4417,9 @@ class StoreMetadata(BaseModel):
 
 
 class PlatformEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3636,6 +4446,9 @@ class PlatformEvent(BaseModel):
 
 
 class PageDataObject(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3655,6 +4468,9 @@ class PageDataObject(BaseModel):
 
 
 class AuditEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3681,6 +4497,9 @@ class AuditEvent(BaseModel):
 
 
 class PageAuditEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3700,6 +4519,9 @@ class PageAuditEvent(BaseModel):
 
 
 class PageRuleSet(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3719,6 +4541,9 @@ class PageRuleSet(BaseModel):
 
 
 class PageProjectTemplate(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3738,6 +4563,9 @@ class PageProjectTemplate(BaseModel):
 
 
 class PagePipeline(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3757,6 +4585,9 @@ class PagePipeline(BaseModel):
 
 
 class PageModelRuntime(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3776,6 +4607,9 @@ class PageModelRuntime(BaseModel):
 
 
 class PageSlugBasedMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3812,6 +4646,9 @@ class PageSlugBasedMetadata(BaseModel):
 
 
 class PageExtensionPack(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3831,6 +4668,9 @@ class PageExtensionPack(BaseModel):
 
 
 class PagePlatformEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3850,6 +4690,9 @@ class PagePlatformEvent(BaseModel):
 
 
 class PageDataException(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3869,6 +4712,9 @@ class PageDataException(BaseModel):
 
 
 class PageDataForm(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3888,6 +4734,9 @@ class PageDataForm(BaseModel):
 
 
 class PageDashboard(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3907,6 +4756,9 @@ class PageDashboard(BaseModel):
 
 
 class PageCredentialDefinition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3926,6 +4778,9 @@ class PageCredentialDefinition(BaseModel):
 
 
 class PageAssistantDefinition(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3945,6 +4800,9 @@ class PageAssistantDefinition(BaseModel):
 
 
 class PageAction(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3964,6 +4822,9 @@ class PageAction(BaseModel):
 
 
 class DocumentContentMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3978,8 +4839,9 @@ class DocumentContentMetadata(BaseModel):
 
 class MessageTemplate(BaseModel):
     """
-    A template for a message on a channel
+
     """
+    name: Optional[str] = None
     label: Optional[str] = None
     description: Optional[str] = None
     content: Optional[str] = None
@@ -3992,6 +4854,9 @@ class MessageTemplate(BaseModel):
 
 
 class ModelContentMetadata(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4091,7 +4956,7 @@ class ModelContentMetadata(BaseModel):
 
 class Action(ExtensionPackProvided):
     """
-    The definition of an available action
+
     """
 
     step: Optional[StepImplementation] = None
@@ -4099,6 +4964,9 @@ class Action(ExtensionPackProvided):
 
 
 class AssistantDefinition(ExtensionPackProvided):
+    """
+
+    """
     template: Optional[bool] = None
     schedulable: Optional[bool] = Field(
         None, description="The assistant can be scheduled"
@@ -4148,7 +5016,7 @@ class AssistantDefinition(ExtensionPackProvided):
 
 class CredentialDefinition(ExtensionPackProvided):
     """
-    Defines a type of credential that can be created as part of a project
+
     """
 
     credential_type: Optional[str] = Field(None, alias="credentialType")
@@ -4158,12 +5026,18 @@ class CredentialDefinition(ExtensionPackProvided):
 
 
 class Dashboard(ExtensionPackProvided):
+    """
+
+    """
     widgets: Optional[List[DashboardWidget]] = None
     single_widget: Optional[DashboardWidget] = Field(None, alias="singleWidget")
     entry_points: Optional[List[str]] = Field(None, alias="entryPoints")
 
 
 class DataForm(ExtensionPackProvided):
+    """
+
+    """
     entrypoints: Optional[List[str]] = None
     entrypoint: Optional[str] = None
     cards: Optional[List[Card]] = None
@@ -4171,6 +5045,9 @@ class DataForm(ExtensionPackProvided):
 
 
 class ProjectDataForm(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4188,7 +5065,7 @@ class ProjectDataForm(BaseModel):
 
 class ExtensionPack(ExtensionPackProvided):
     """
-    Extension packs provide new components to the platform
+
     """
     name: Optional[str] = None
     description: Optional[str] = None
@@ -4204,7 +5081,7 @@ class ExtensionPack(ExtensionPackProvided):
 
 class ModelRuntime(ExtensionPackProvided):
     """
-    The definition of an available model runtime
+
     """
 
     inference_action: Optional[str] = Field(
@@ -4238,12 +5115,15 @@ class ModelRuntime(ExtensionPackProvided):
 
 
 class Pipeline(ExtensionPackProvided):
+    """
+
+    """
     metadata: Optional[PipelineImplementationMetadata] = None
 
 
 class ProjectTemplate(ExtensionPackProvided):
     """
-    A template for new project
+
     """
 
     stores: Optional[List[ProjectStore]] = Field(
@@ -4265,6 +5145,10 @@ class ProjectTemplate(ExtensionPackProvided):
         None,
         description="The workspaces that will be created with the project template",
     )
+    guidance: Optional[List[ProjectGuidance]] = Field(
+        None,
+        description="The guidance that will be created with the project template",
+    )
     data_forms: Optional[List[ProjectDataForm]] = Field(
         None,
         alias="dataForms",
@@ -4295,17 +5179,17 @@ class ProjectTemplate(ExtensionPackProvided):
 
 class Store(ExtensionPackProvided):
     """
-    Provides the definition and metadata for a store
+
     """
 
     metadata: Optional[ContentMetadata1] = None
-    store_type: Optional[StoreType1] = Field(
+    store_type: Optional[StoreType] = Field(
         None, alias="storeType", description="The type of object the store will contain"
     )
     searchable: Optional[bool] = Field(
         None, description="Is the store indexed, and thus searchable"
     )
-    store_purpose: Optional[StorePurpose1] = Field(
+    store_purpose: Optional[StorePurpose] = Field(
         None,
         alias="storePurpose",
         description="The purpose of the store (used by UI and assistants to understand how to interact with the store events)",
@@ -4336,7 +5220,7 @@ class Store(ExtensionPackProvided):
 
 class Taxonomy(ExtensionPackProvided):
     """
-    Provides the taxonomy hierarchy that is used for content and document classification and labeling
+
     """
 
     type: Optional[str] = Field(None, description="The metadata object type")
@@ -4359,10 +5243,31 @@ class Taxonomy(ExtensionPackProvided):
         description="The total number of taxons in the taxonomy",
     )
 
+    def update_paths(self):
+        for taxon in self.taxons:
+            taxon.update_path()
+
+    def build_guidance_tags(self, taxons=None, guidance_tags=None):
+        if taxons is None:
+            taxons = self.taxons
+        if guidance_tags is None:
+            guidance_tags = {}
+        for taxon in taxons:
+            new_tags = []
+            if taxon.examples is not None:
+                for example in taxon.examples:
+                    new_tags.append(example)
+                guidance_tags[taxon.path] = new_tags
+
+            if taxon.children is not None and len(taxon.children) > 0:
+                guidance_tags = self.build_guidance_tags(taxon.children, guidance_tags)
+
+        return guidance_tags
+
 
 class RuleSet(ExtensionPackProvided):
     """
-    Defines a ruleset that can be applied to data objects and attributes
+
     """
 
     ref: Optional[str] = Field(None, description="The reference to the metadata object")
@@ -4428,6 +5333,9 @@ class RuleSet(ExtensionPackProvided):
 
 
 class AssistantEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4442,6 +5350,9 @@ class AssistantEvent(BaseModel):
 
 
 class ContentEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4455,6 +5366,9 @@ class ContentEvent(BaseModel):
 
 
 class DataObjectEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4466,6 +5380,9 @@ class DataObjectEvent(BaseModel):
 
 
 class DocumentFamilyEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4477,6 +5394,9 @@ class DocumentFamilyEvent(BaseModel):
 
 
 class WorkspaceEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -4489,6 +5409,9 @@ class WorkspaceEvent(BaseModel):
 
 
 class ScheduledEvent(BaseModel):
+    """
+
+    """
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,