unique_toolkit 0.0.1__tar.gz → 0.5.0__tar.gz

unique_toolkit-0.5.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2024-07-23
+### Added
+- Added `unique_toolkit.app` module with the following components:
+  - `init_logging.py` for initializing the logger.
+  - `init_sdk.py` for initializing the SDK with environment variables.
+  - `schemas.py` containing the Event schema.
+  - `verification.py` for verifying the endpoint secret and constructing the event.
+
+- Added `unique_toolkit.chat` module with the following components:
+  - `state.py` containing the `ChatState` class.
+  - `service.py` containing the `ChatService` class for managing chat interactions.
+  - `schemas.py` containing relevant schemas such as `ChatMessage`.
+  - `utils.py` with utility functions for chat interactions.
+
+- Added `unique_toolkit.content` module with the following components:
+  - `service.py` containing the `ContentService` class for interacting with content.
+  - `schemas.py` containing relevant schemas such as `Content` and `ContentChunk`.
+  - `utils.py` with utility functions for manipulating content objects.
+
+- Added `unique_toolkit.embedding` module with the following components:
+  - `service.py` containing the `EmbeddingService` class for working with embeddings.
+  - `schemas.py` containing relevant schemas such as `Embeddings`.
+
+- Added `unique_toolkit.language_model` module with the following components:
+  - `infos.py` containing information on language models deployed on the Unique platform.
+  - `service.py` containing the `LanguageModelService` class for interacting with language models.
+  - `schemas.py` containing relevant schemas such as `LanguageModelResponse`.
+  - `utils.py` with utility functions for parsing language model output.
+
+## [0.0.2] - 2024-07-10
+- Initial release of `unique_toolkit`.

{unique_toolkit-0.0.1 → unique_toolkit-0.5.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Unique-AG
+Copyright (c) 2024 Unique-AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

unique_toolkit-0.5.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.1
+Name: unique_toolkit
+Version: 0.5.0
+Summary: 
+License: MIT
+Author: Martin Fadler
+Author-email: martin.fadler@unique.ch
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: numpy (>=2.0.1,<3.0.0)
+Requires-Dist: pydantic (>=2.8.2,<3.0.0)
+Requires-Dist: pyhumps (>=3.8.0,<4.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: regex (>=2024.5.15,<2025.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
+Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
+Requires-Dist: unique-sdk (>=0.8.10,<0.9.0)
+Description-Content-Type: text/markdown
+
+# Unique Toolkit
+
+This package provides highlevel abstractions and methods on top of `unique_sdk` to ease application development for the Unique Platform. 
+
+The Toolkit is structured along the following domains:
+- `unique_toolkit.chat`
+- `unique_toolkit.content`
+- `unique_toolkit.embedding`
+- `unique_toolkit.language_model`
+
+Each domain comprises a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas 
+(in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional
+functionality to interact with the domain entities (all domains except Embedding) and other domain specific functionalities which are explained in the respective domain documentation.
+
+In addition, the `app` module provides functions to initialize and secure apps and perform parallel reuqests (only with async app like Flask) that will interact with the Unique platform. 
+
+## Changelog
+
+See the [CHANGELOG.md](https://github.com/Unique-AG/ai/blob/main/unique_toolkit/CHANGELOG.md) file for details on changes and version history.
+
+# Domains
+
+## App
+
+The `unique_toolkit.app` module encompasses functions for initializing and securing apps that will interact with the Unique platform.
+
+- `init_logging.py` can be used to initalize the logger either with unique dictConfig or an any other dictConfig.
+- `init_sdk.py` can be used to initialize the sdk using the correct env variables and retrieving the endpoint secret.
+- `schemas.py` contains the Event schema which can be used to parse and validate the unique.chat.external-module.chosen event.
+- `verification.py` can be used to verify the endpoint secret and construct the event.
+
+## Chat
+
+The `unique_toolkit.chat` module encompasses all chat related functionality.
+
+- `state.py` comprises the ChatState which is used to store the current state of the chat interaction and the user information.
+- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, used in the ChatService.
+- `utils.py` comprises utility functions to use and convert ChatMessage objects in assistants, e.g., convert_chat_history_to_injectable_string converts the chat history to a string that can be injected into a prompt. 
+
+## Content
+
+The `unique_toolkit.content` module encompasses all content related functionality. Content can be any type of textual data that is stored in the Knowledgebase on the Unique platform. During the ingestion of the content, the content is parsed, split in chunks, indexed, and stored in the database.
+
+- `service.py` comprises the ContentService and provides an interface to interact with the content, e.g., search content, search content chunks, upload and download content.
+- `schemas.py` comprises all relevant schemas, e.g., Content and ContentChunk, used in the ContentService.
+- `utils.py` comprise utility functions to manipulate Content and ContentChunk objects, e.g., sort_content_chunks and merge_content_chunks.
+
+## Embedding
+
+The `unique_toolkit.embedding` module encompasses all embedding related functionality. Embeddings are used to represent textual data in a high-dimensional space. The embeddings can be used to calculate the similarity between two texts, for instance.
+
+- `service.py` encompasses the EmbeddingService and provides an interface to interact with the embeddings, e.g., embed text and calculate the similarity between two texts.
+- `schemas.py` comprises all relevant schemas, e.g., Embeddings, used in the EmbeddingService.
+
+## Language Model
+
+The `unique_toolkit.language_model` module encompasses all language model related functionality and information on the different language models deployed through the 
+Unique platform.
+
+- `infos.py` comprises the information on all language models deployed through the Unique platform. We recommend to use the LanguageModel class, initialized with the LanguageModelName, e.g., LanguageModel(LanguageModelName.AZURE_GPT_35_TURBO_16K) to get the information on the specific language model like the name, version, token limits or retirement date.
+- `service.py` comprises the LanguageModelService and provides an interface to interact with the language models, e.g., complete or stream_complete. 
+- `schemas.py` comprises all relevant schemas, e.g., LanguageModelResponse, used in the LanguageModelService.
+- `utils.py` comprises utility functions to parse the output of the language model, e.g., convert_string_to_json finds and parses the last json object in a string.
+
+# Development instructions
+
+1. Install poetry on your system (through `brew` or `pipx`).
+
+2. Install `pyenv` and install python 3.11. `pyenv` is recommended as otherwise poetry uses the python version used to install itself and not the user preferred python version.
+
+3. If you then run `python --version` in your terminal, you should be able to see python version as specified in `.python-version`.
+
+4. Then finally run `poetry install` to install the package and all dependencies.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2024-07-23
+### Added
+- Added `unique_toolkit.app` module with the following components:
+  - `init_logging.py` for initializing the logger.
+  - `init_sdk.py` for initializing the SDK with environment variables.
+  - `schemas.py` containing the Event schema.
+  - `verification.py` for verifying the endpoint secret and constructing the event.
+
+- Added `unique_toolkit.chat` module with the following components:
+  - `state.py` containing the `ChatState` class.
+  - `service.py` containing the `ChatService` class for managing chat interactions.
+  - `schemas.py` containing relevant schemas such as `ChatMessage`.
+  - `utils.py` with utility functions for chat interactions.
+
+- Added `unique_toolkit.content` module with the following components:
+  - `service.py` containing the `ContentService` class for interacting with content.
+  - `schemas.py` containing relevant schemas such as `Content` and `ContentChunk`.
+  - `utils.py` with utility functions for manipulating content objects.
+
+- Added `unique_toolkit.embedding` module with the following components:
+  - `service.py` containing the `EmbeddingService` class for working with embeddings.
+  - `schemas.py` containing relevant schemas such as `Embeddings`.
+
+- Added `unique_toolkit.language_model` module with the following components:
+  - `infos.py` containing information on language models deployed on the Unique platform.
+  - `service.py` containing the `LanguageModelService` class for interacting with language models.
+  - `schemas.py` containing relevant schemas such as `LanguageModelResponse`.
+  - `utils.py` with utility functions for parsing language model output.
+
+## [0.0.2] - 2024-07-10
+- Initial release of `unique_toolkit`.

unique_toolkit-0.5.0/README.md

@@ -0,0 +1,74 @@
+# Unique Toolkit
+
+This package provides highlevel abstractions and methods on top of `unique_sdk` to ease application development for the Unique Platform. 
+
+The Toolkit is structured along the following domains:
+- `unique_toolkit.chat`
+- `unique_toolkit.content`
+- `unique_toolkit.embedding`
+- `unique_toolkit.language_model`
+
+Each domain comprises a service class (in `service.py`) which encapsulates the basic functionalities to interact with the domain entities, the schemas 
+(in `schemas.py`) used in the service and required for interacting with the service functions, utility functions (in `utils.py`) which give additional
+functionality to interact with the domain entities (all domains except Embedding) and other domain specific functionalities which are explained in the respective domain documentation.
+
+In addition, the `app` module provides functions to initialize and secure apps and perform parallel reuqests (only with async app like Flask) that will interact with the Unique platform. 
+
+## Changelog
+
+See the [CHANGELOG.md](https://github.com/Unique-AG/ai/blob/main/unique_toolkit/CHANGELOG.md) file for details on changes and version history.
+
+# Domains
+
+## App
+
+The `unique_toolkit.app` module encompasses functions for initializing and securing apps that will interact with the Unique platform.
+
+- `init_logging.py` can be used to initalize the logger either with unique dictConfig or an any other dictConfig.
+- `init_sdk.py` can be used to initialize the sdk using the correct env variables and retrieving the endpoint secret.
+- `schemas.py` contains the Event schema which can be used to parse and validate the unique.chat.external-module.chosen event.
+- `verification.py` can be used to verify the endpoint secret and construct the event.
+
+## Chat
+
+The `unique_toolkit.chat` module encompasses all chat related functionality.
+
+- `state.py` comprises the ChatState which is used to store the current state of the chat interaction and the user information.
+- `service.py` comprises the ChatService and provides an interface to manage and load the chat history and interact with the chat ui, e.g., creating a new assistant message.
+- `schemas.py` comprises all relevant schemas, e.g., ChatMessage, used in the ChatService.
+- `utils.py` comprises utility functions to use and convert ChatMessage objects in assistants, e.g., convert_chat_history_to_injectable_string converts the chat history to a string that can be injected into a prompt. 
+
+## Content
+
+The `unique_toolkit.content` module encompasses all content related functionality. Content can be any type of textual data that is stored in the Knowledgebase on the Unique platform. During the ingestion of the content, the content is parsed, split in chunks, indexed, and stored in the database.
+
+- `service.py` comprises the ContentService and provides an interface to interact with the content, e.g., search content, search content chunks, upload and download content.
+- `schemas.py` comprises all relevant schemas, e.g., Content and ContentChunk, used in the ContentService.
+- `utils.py` comprise utility functions to manipulate Content and ContentChunk objects, e.g., sort_content_chunks and merge_content_chunks.
+
+## Embedding
+
+The `unique_toolkit.embedding` module encompasses all embedding related functionality. Embeddings are used to represent textual data in a high-dimensional space. The embeddings can be used to calculate the similarity between two texts, for instance.
+
+- `service.py` encompasses the EmbeddingService and provides an interface to interact with the embeddings, e.g., embed text and calculate the similarity between two texts.
+- `schemas.py` comprises all relevant schemas, e.g., Embeddings, used in the EmbeddingService.
+
+## Language Model
+
+The `unique_toolkit.language_model` module encompasses all language model related functionality and information on the different language models deployed through the 
+Unique platform.
+
+- `infos.py` comprises the information on all language models deployed through the Unique platform. We recommend to use the LanguageModel class, initialized with the LanguageModelName, e.g., LanguageModel(LanguageModelName.AZURE_GPT_35_TURBO_16K) to get the information on the specific language model like the name, version, token limits or retirement date.
+- `service.py` comprises the LanguageModelService and provides an interface to interact with the language models, e.g., complete or stream_complete. 
+- `schemas.py` comprises all relevant schemas, e.g., LanguageModelResponse, used in the LanguageModelService.
+- `utils.py` comprises utility functions to parse the output of the language model, e.g., convert_string_to_json finds and parses the last json object in a string.
+
+# Development instructions
+
+1. Install poetry on your system (through `brew` or `pipx`).
+
+2. Install `pyenv` and install python 3.11. `pyenv` is recommended as otherwise poetry uses the python version used to install itself and not the user preferred python version.
+
+3. If you then run `python --version` in your terminal, you should be able to see python version as specified in `.python-version`.
+
+4. Then finally run `poetry install` to install the package and all dependencies.

unique_toolkit-0.5.0/pyproject.toml

@@ -0,0 +1,44 @@
+[tool.poetry]
+name = "unique_toolkit"
+version = "0.5.0"
+description = ""
+authors = [
+    "Martin Fadler <martin.fadler@unique.ch>",
+    "Sadique Sheik <sadique@unique.ch>",
+    "Fabian Schläpfer <fabian@unique.ch>",
+    "Pascal Hauri <pascal@unique.ch>",
+]
+readme = ["README.md", "CHANGELOG.md"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+typing-extensions = "^4.9.0"
+pydantic = "^2.8.2"
+pyhumps = "^3.8.0"
+unique-sdk = "^0.8.10"
+numpy = "^2.0.1"
+python-dotenv = "^1.0.1"
+requests = "^2.32.3"
+regex = "^2024.5.15"
+tiktoken = "^0.7.0"
+
+
+[tool.poetry.group.dev.dependencies]
+ruff = "0.5.0"
+pytest = "^7.4.3"
+tox = "^4.11.4"
+pyright = "^1.1.341"
+pytest-cov = "^4.1.0"
+pre-commit = "^3.7.1"
+pytest-asyncio = "^0.23.8"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+target-version = "py311"
+
+[tool.ruff.lint]
+extend-select = ["I"]

unique_toolkit-0.0.1/unique_toolkit/observability/log_config.py → unique_toolkit-0.5.0/unique_toolkit/app/init_logging.py

@@ -7,7 +7,7 @@ class UTCFormatter(Formatter):
     converter = gmtime
 
 
-log_config = {
+unique_log_config = {
     "version": 1,
     "root": {"level": "DEBUG", "handlers": ["console"]},
     "handlers": {
@@ -15,17 +15,17 @@ log_config = {
             "class": "logging.StreamHandler",
             "level": "DEBUG",
             "formatter": "utc",
-        },
-        "formatters": {
-            "utc": {
-                "()": UTCFormatter,
-                "format": "%(asctime)s: %(message)s",
-                "datefmt": "%Y-%m-%d %H:%M:%S",
-            },
+        }
+    },
+    "formatters": {
+        "utc": {
+            "()": UTCFormatter,
+            "format": "%(asctime)s: %(message)s",
+            "datefmt": "%Y-%m-%d %H:%M:%S",
         },
     },
 }
 
 
-def load_logging_config():
-    return dictConfig(log_config)
+def init_logging(config: dict = unique_log_config):
+    return dictConfig(config)

unique_toolkit-0.5.0/unique_toolkit/app/init_sdk.py

@@ -0,0 +1,41 @@
+import os
+
+import unique_sdk
+
+
+def get_env(var_name, default=None, strict=False):
+    """Get the environment variable.
+
+    Args:
+        var_name (str): Name of the environment variable.
+        default (str, optional): Default value. Defaults to None.
+        strict (bool, optional): This method raises a ValueError, if strict, and no value is found in the environment. Defaults to False.
+
+    Raises:
+        ValueError: _description_
+
+    Returns:
+        _type_: _description_
+    """
+    val = os.environ.get(var_name)
+    if not val:
+        if strict:
+            raise ValueError(f"{var_name} is not set")
+    return val or default
+
+
+def init_sdk(strict_all_vars=False):
+    """Initialize the SDK.
+
+    Args:
+        strict_all_vars (bool, optional): This method raises a ValueError if strict and no value is found in the environment. Defaults to False.
+    """
+    unique_sdk.api_key = get_env("API_KEY", default="dummy", strict=strict_all_vars)
+    unique_sdk.app_id = get_env("APP_ID", default="dummy", strict=strict_all_vars)
+    unique_sdk.api_base = get_env("API_BASE", default=None, strict=strict_all_vars)
+
+
+def get_endpoint_secret():
+    """Fetch endpoint secret from the environment."""
+    endpoint_secret = os.getenv("ENDPOINT_SECRET")
+    return endpoint_secret

{unique_toolkit-0.0.1/unique_toolkit → unique_toolkit-0.5.0/unique_toolkit/app}/performance/async_executor.py

@@ -1,19 +1,46 @@
 import asyncio
+import contextlib
+import logging
 import threading
 import time
 from concurrent.futures import ThreadPoolExecutor
 from math import ceil
-from typing import Awaitable, Sequence, TypeVar, Union
-
-from quart import Quart
+from typing import (
+    AsyncContextManager,
+    Awaitable,
+    Callable,
+    Optional,
+    Sequence,
+    TypeVar,
+    Union,
+)
 
 T = TypeVar("T")
 Result = Union[T, BaseException]
 
 
 class AsyncExecutor:
-    def __init__(self, app_instance: Quart) -> None:
-        self.app = app_instance
+    """
+    A class for executing asynchronous tasks concurrently, with optional threading support.
+
+    This class provides methods to run multiple asynchronous tasks in parallel, with
+    the ability to limit the number of concurrent tasks and distribute work across
+    multiple threads if needed.
+
+    Attributes:
+        logger (logging.Logger): Logger instance for recording execution information.
+        context_manager (Callable[[], AsyncContextManager]): A factory function that returns
+            an async context manager to be used for each task execution, e.g., quart.current_app.app_context().
+
+    """
+
+    def __init__(
+        self,
+        logger: Optional[logging.Logger] = None,
+        context_manager: Optional[Callable[[], AsyncContextManager]] = None,
+    ) -> None:
+        self.logger = logger or logging.getLogger(__name__)
+        self.context_manager = context_manager or (lambda: contextlib.nullcontext())
 
     async def run_async_tasks(
         self,
@@ -21,7 +48,7 @@ class AsyncExecutor:
         max_tasks: int,
     ) -> list[Result]:
         """
-        Executes the given async tasks within one thread non-blocking and returns the results.
+        Executes the a set of given async tasks and returns the results.
 
         Args:
         tasks (list[Awaitable[T]]): list of async callables to execute in parallel.
@@ -35,23 +62,23 @@ class AsyncExecutor:
             thread = threading.current_thread()
             start_time = time.time()
 
-            self.app.logger.info(
+            self.logger.info(
                 f"Thread {thread.name} (ID: {thread.ident}) starting task {task_id}"
             )
 
             try:
-                async with self.app.app_context():
+                async with self.context_manager():
                     result = await task
                 return result
             except Exception as e:
-                self.app.logger.error(
+                self.logger.error(
                     f"Thread {thread.name} (ID: {thread.ident}) - Task {task_id} failed with error: {e}"
                 )
                 return e
             finally:
                 end_time = time.time()
                 duration = end_time - start_time
-                self.app.logger.debug(
+                self.logger.debug(
                     f"Thread {thread.name} (ID: {thread.ident}) - Task {task_id} finished in {duration:.2f} seconds"
                 )
 
@@ -78,7 +105,7 @@ class AsyncExecutor:
         max_tasks: int,
     ) -> list[Result[T]]:
         """
-        Executes the given async tasks in parallel threads and returns the results.
+        Executes the given async tasks in multiple threads and returns the results.
 
         Args:
         tasks (list[Awaitable[T]]): list of async callables to execute in parallel.
@@ -92,14 +119,14 @@ class AsyncExecutor:
         async def run_in_thread(task_chunk: list[Awaitable[T]]) -> list[Result]:
             loop = asyncio.new_event_loop()
             asyncio.set_event_loop(loop)
-            async with self.app.app_context():
+            async with self.context_manager():
                 return await self.run_async_tasks(task_chunk, max_tasks)
 
         def thread_worker(
             task_chunk: list[Awaitable[T]], chunk_id: int
         ) -> list[Result]:
             thread = threading.current_thread()
-            self.app.logger.info(
+            self.logger.info(
                 f"Thread {thread.name} (ID: {thread.ident}) starting chunk {chunk_id} with {len(task_chunk)} tasks"
             )
 
@@ -111,12 +138,12 @@ class AsyncExecutor:
                 results = loop.run_until_complete(run_in_thread(task_chunk))
                 end_time = time.time()
                 duration = end_time - start_time
-                self.app.logger.info(
+                self.logger.info(
                     f"Thread {thread.name} (ID: {thread.ident}) finished chunk {chunk_id} in {duration:.2f} seconds"
                 )
                 return results
             except Exception as e:
-                self.app.logger.error(
+                self.logger.error(
                     f"Thread {thread.name} (ID: {thread.ident}) encountered an error in chunk {chunk_id}: {str(e)}"
                 )
                 raise
@@ -133,7 +160,7 @@ class AsyncExecutor:
             for i in range(0, len(tasks), tasks_per_thread)
         ]
 
-        self.app.logger.info(
+        self.logger.info(
             f"Splitting {len(tasks)} tasks into {len(task_chunks)} chunks across {max_threads} threads"
         )
 
@@ -152,7 +179,7 @@ class AsyncExecutor:
         results: list[Result] = [item for sublist in future_results for item in sublist]
         end_time = time.time()
         duration = end_time - start_time
-        self.app.logger.info(
+        self.logger.info(
             f"All threads completed. Total results: {len(results)}. Duration: {duration:.2f} seconds"
         )
 

unique_toolkit-0.5.0/unique_toolkit/app/performance/async_wrapper.py

@@ -0,0 +1,28 @@
+import asyncio
+import warnings
+from functools import wraps
+from typing import Any, Callable, Coroutine, TypeVar
+
+T = TypeVar("T")
+
+
+def to_async(func: Callable[..., T]) -> Callable[..., Coroutine[Any, Any, T]]:
+    @wraps(func)
+    async def wrapper(*args, **kwargs) -> T:
+        return await asyncio.to_thread(func, *args, **kwargs)
+
+    return wrapper
+
+
+def async_warning(func):
+    @wraps(func)
+    async def wrapper(*args, **kwargs):
+        warnings.warn(
+            f"The function '{func.__name__}' is not purely async. It uses a thread pool executor underneath, "
+            "which may impact performance for CPU-bound operations.",
+            RuntimeWarning,
+            stacklevel=2,
+        )
+        return await func(*args, **kwargs)
+
+    return wrapper

unique_toolkit-0.0.1/unique_toolkit/event/schema.py → unique_toolkit-0.5.0/unique_toolkit/app/schemas.py

@@ -1,13 +1,20 @@
+from enum import StrEnum
 from typing import Any
 
 from humps import camelize
 from pydantic import BaseModel, ConfigDict
 
 # set config to convert camelCase to snake_case
-model_config = ConfigDict(alias_generator=camelize, populate_by_name=True)
+model_config = ConfigDict(
+    alias_generator=camelize, populate_by_name=True, arbitrary_types_allowed=True
+)
 
 
-class UserMessage(BaseModel):
+class EventName(StrEnum):
+    EXTERNAL_MODULE_CHOSEN = "unique.chat.external-module.chosen"
+
+
+class EventUserMessage(BaseModel):
     model_config = model_config
 
     id: str
@@ -15,23 +22,23 @@ class UserMessage(BaseModel):
     created_at: str
 
 
-class AssistantMessage(BaseModel):
+class EventAssistantMessage(BaseModel):
     model_config = model_config
 
     id: str
     created_at: str
 
 
-class Payload(BaseModel):
+class EventPayload(BaseModel):
     model_config = model_config
 
-    name: str
+    name: EventName
     description: str
     configuration: dict[str, Any]
     chat_id: str
     assistant_id: str
-    user_message: UserMessage
-    assistant_message: AssistantMessage
+    user_message: EventUserMessage
+    assistant_message: EventAssistantMessage
     text: str | None = None
 
 
@@ -39,9 +46,9 @@ class Event(BaseModel):
     model_config = model_config
 
     id: str
-    version: str
     event: str
-    created_at: int
     user_id: str
     company_id: str
-    payload: Payload
+    payload: EventPayload
+    created_at: int | None = None
+    version: str | None = None