fix: Distinguish AIConfig from DefaultAIConfig

Consumers of this SDK are responsible for providing some default value
to the `config` method. If that type is of `AIConfig`, customers have
the option of providing a tracker instance that will never be useful.

To help discourage this, we are making two separate types -- one to
represent the default ai config, and one to represent the actual
selected config.

Author: keelerm84

ldai/client.py

@@ -2,19 +2,26 @@
 from typing import Any, Dict, List, Literal, Optional
 
 import chevron
-from dataclasses_json import dataclass_json
 from ldclient import Context
 from ldclient.client import LDClient
 
 from ldai.tracker import LDAIConfigTracker
 
 
-@dataclass_json
 @dataclass
 class LDMessage:
     role: Literal['system', 'user', 'assistant']
     content: str
 
+    def to_dict(self) -> dict:
+        """
+        Render the given message as a dictionary object.
+        """
+        return {
+            'role': self.role,
+            'content': self.content,
+        }
+
 
 class ModelConfig:
     """
@@ -62,6 +69,16 @@ def get_custom(self, key: str) -> Any:
 
         return self._custom.get(key)
 
+    def to_dict(self) -> dict:
+        """
+        Render the given model config as a dictionary object.
+        """
+        return {
+            'id': self._id,
+            'parameters': self._parameters,
+            'custom': self._custom,
+        }
+
 
 class ProviderConfig:
     """
@@ -78,14 +95,46 @@ def id(self) -> str:
         """
         return self._id
 
+    def to_dict(self) -> dict:
+        """
+        Render the given provider config as a dictionary object.
+        """
+        return {
+            'id': self._id,
+        }
+
+
+@dataclass(frozen=True)
+class DefaultAIConfig:
+    """
+    The default values when evaluating an AI configuration.
+    """
+    enabled: Optional[bool] = None
+    model: Optional[ModelConfig] = None
+    messages: Optional[List[LDMessage]] = None
+    provider: Optional[ProviderConfig] = None
+
+    def to_dict(self) -> dict:
+        """
+        Render the given default values as an AIConfig-compatible dictionary object.
+        """
+        return {
+            '_ldMeta': {
+                'enabled': self.enabled or False,
+            },
+            'model': self.model.to_dict() if self.model else None,
+            'messages': [message.to_dict() for message in self.messages] if self.messages else None,
+            'provider': self.provider.to_dict() if self.provider else None,
+        }
+
 
+@dataclass(frozen=True)
 class AIConfig:
-    def __init__(self, tracker: LDAIConfigTracker, enabled: bool, model: Optional[ModelConfig], messages: Optional[List[LDMessage]], provider: Optional[ProviderConfig] = None):
-        self.tracker = tracker
-        self.enabled = enabled
-        self.model = model
-        self.messages = messages
-        self.provider = provider
+    tracker: LDAIConfigTracker
+    enabled: bool
+    model: Optional[ModelConfig] = None
+    messages: Optional[List[LDMessage]] = None
+    provider: Optional[ProviderConfig] = None
 
 
 class LDAIClient:
@@ -98,7 +147,7 @@ def config(
         self,
         key: str,
         context: Context,
-        default_value: AIConfig,
+        default_value: DefaultAIConfig,
         variables: Optional[Dict[str, Any]] = None,
     ) -> AIConfig:
         """
@@ -110,7 +159,7 @@ def config(
         :param variables: Additional variables for the model configuration.
         :return: The value of the model configuration.
         """
-        variation = self.client.variation(key, context, default_value)
+        variation = self.client.variation(key, context, default_value.to_dict())
 
         all_variables = {}
         if variables:

ldai/testing/test_model_config.py

@@ -2,8 +2,7 @@
 from ldclient import Config, Context, LDClient
 from ldclient.integrations.test_data import TestData
 
-from ldai.client import AIConfig, LDAIClient, LDMessage, ModelConfig
-from ldai.tracker import LDAIConfigTracker
+from ldai.client import DefaultAIConfig, LDAIClient, LDMessage, ModelConfig
 
 
 @pytest.fixture
@@ -98,11 +97,6 @@ def client(td: TestData) -> LDClient:
     return LDClient(config=config)
 
 
-@pytest.fixture
-def tracker(client: LDClient) -> LDAIConfigTracker:
-    return LDAIConfigTracker(client, 'abcd', 'model-config', Context.create('user-key'))
-
-
 @pytest.fixture
 def ldai_client(client: LDClient) -> LDAIClient:
     return LDAIClient(client)
@@ -125,10 +119,31 @@ def test_model_config_handles_custom():
     assert model.get_custom('id') is None
 
 
-def test_model_config_interpolation(ldai_client: LDAIClient, tracker):
+def test_uses_default_on_invalid_flag(ldai_client: LDAIClient):
+    context = Context.create('user-key')
+    default_value = DefaultAIConfig(
+        enabled=True,
+        model=ModelConfig('fakeModel', parameters={'temperature': 0.5, 'maxTokens': 4096}),
+        messages=[LDMessage(role='system', content='Hello, {{name}}!')],
+    )
+    variables = {'name': 'World'}
+
+    config = ldai_client.config('missing-flag', context, default_value, variables)
+
+    assert config.messages is not None
+    assert len(config.messages) > 0
+    assert config.messages[0].content == 'Hello, World!'
+    assert config.enabled is True
+
+    assert config.model is not None
+    assert config.model.id == 'fakeModel'
+    assert config.model.get_parameter('temperature') == 0.5
+    assert config.model.get_parameter('maxTokens') == 4096
+
+
+def test_model_config_interpolation(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(
-        tracker=tracker,
+    default_value = DefaultAIConfig(
         enabled=True,
         model=ModelConfig('fakeModel'),
         messages=[LDMessage(role='system', content='Hello, {{name}}!')],
@@ -148,9 +163,9 @@ def test_model_config_interpolation(ldai_client: LDAIClient, tracker):
     assert config.model.get_parameter('maxTokens') == 4096
 
 
-def test_model_config_no_variables(ldai_client: LDAIClient, tracker):
+def test_model_config_no_variables(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(tracker=tracker, enabled=True, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=True, model=ModelConfig('fake-model'), messages=[])
 
     config = ldai_client.config('model-config', context, default_value, {})
 
@@ -165,9 +180,9 @@ def test_model_config_no_variables(ldai_client: LDAIClient, tracker):
     assert config.model.get_parameter('maxTokens') == 4096
 
 
-def test_provider_config_handling(ldai_client: LDAIClient, tracker):
+def test_provider_config_handling(ldai_client: LDAIClient):
     context = Context.builder('user-key').name("Sandy").build()
-    default_value = AIConfig(tracker=tracker, enabled=True, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=True, model=ModelConfig('fake-model'), messages=[])
     variables = {'name': 'World'}
 
     config = ldai_client.config('model-config', context, default_value, variables)
@@ -176,9 +191,9 @@ def test_provider_config_handling(ldai_client: LDAIClient, tracker):
     assert config.provider.id == 'fakeProvider'
 
 
-def test_context_interpolation(ldai_client: LDAIClient, tracker):
+def test_context_interpolation(ldai_client: LDAIClient):
     context = Context.builder('user-key').name("Sandy").build()
-    default_value = AIConfig(tracker=tracker, enabled=True, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=True, model=ModelConfig('fake-model'), messages=[])
     variables = {'name': 'World'}
 
     config = ldai_client.config(
@@ -197,9 +212,9 @@ def test_context_interpolation(ldai_client: LDAIClient, tracker):
     assert config.model.get_parameter('extra-attribute') == 'I can be anything I set my mind/type to'
 
 
-def test_model_config_multiple(ldai_client: LDAIClient, tracker):
+def test_model_config_multiple(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(tracker=tracker, enabled=True, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=True, model=ModelConfig('fake-model'), messages=[])
     variables = {'name': 'World', 'day': 'Monday'}
 
     config = ldai_client.config(
@@ -218,9 +233,9 @@ def test_model_config_multiple(ldai_client: LDAIClient, tracker):
     assert config.model.get_parameter('maxTokens') == 8192
 
 
-def test_model_config_disabled(ldai_client: LDAIClient, tracker):
+def test_model_config_disabled(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(tracker=tracker, enabled=False, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=False, model=ModelConfig('fake-model'), messages=[])
 
     config = ldai_client.config('off-config', context, default_value, {})
 
@@ -231,9 +246,9 @@ def test_model_config_disabled(ldai_client: LDAIClient, tracker):
     assert config.model.get_parameter('maxTokens') is None
 
 
-def test_model_initial_config_disabled(ldai_client: LDAIClient, tracker):
+def test_model_initial_config_disabled(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(tracker=tracker, enabled=False, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=False, model=ModelConfig('fake-model'), messages=[])
 
     config = ldai_client.config('initial-config-disabled', context, default_value, {})
 
@@ -243,9 +258,9 @@ def test_model_initial_config_disabled(ldai_client: LDAIClient, tracker):
     assert config.provider is None
 
 
-def test_model_initial_config_enabled(ldai_client: LDAIClient, tracker):
+def test_model_initial_config_enabled(ldai_client: LDAIClient):
     context = Context.create('user-key')
-    default_value = AIConfig(tracker=tracker, enabled=False, model=ModelConfig('fake-model'), messages=[])
+    default_value = DefaultAIConfig(enabled=False, model=ModelConfig('fake-model'), messages=[])
 
     config = ldai_client.config('initial-config-enabled', context, default_value, {})
 

pyproject.toml

@@ -30,7 +30,6 @@ exclude = [
 python = ">=3.8,<4"
 launchdarkly-server-sdk = ">=9.4.0"
 chevron = "=0.14.0"
-dataclasses-json = "^0.6.7"
 
 
 [tool.poetry.group.dev.dependencies]

release-please-config.json

@@ -3,7 +3,7 @@
     ".": {
       "release-type": "python",
       "versioning": "default",
-      "release-as": "0.3.0",
+      "bump-minor-pre-major": true,
       "include-v-in-tag": false,
       "extra-files": ["ldai/__init__.py", "PROVENANCE.md"],
       "include-component-in-tag": false