-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathclient.py
More file actions
472 lines (392 loc) · 15 KB
/
client.py
File metadata and controls
472 lines (392 loc) · 15 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
from dataclasses import dataclass
from typing import Any, Dict, List, Literal, Optional, Tuple
import chevron
from ldclient import Context
from ldclient.client import LDClient
from ldai.tracker import LDAIConfigTracker
@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:
"""
Configuration related to the model.
"""
def __init__(self, name: str, parameters: Optional[Dict[str, Any]] = None, custom: Optional[Dict[str, Any]] = None):
"""
:param name: The name of the model.
:param parameters: Additional model-specific parameters.
:param custom: Additional customer provided data.
"""
self._name = name
self._parameters = parameters
self._custom = custom
@property
def name(self) -> str:
"""
The name of the model.
"""
return self._name
def get_parameter(self, key: str) -> Any:
"""
Retrieve model-specific parameters.
Accessing a named, typed attribute (e.g. name) will result in the call
being delegated to the appropriate property.
"""
if key == 'name':
return self.name
if self._parameters is None:
return None
return self._parameters.get(key)
def get_custom(self, key: str) -> Any:
"""
Retrieve customer provided data.
"""
if self._custom is None:
return None
return self._custom.get(key)
def to_dict(self) -> dict:
"""
Render the given model config as a dictionary object.
"""
return {
'name': self._name,
'parameters': self._parameters,
'custom': self._custom,
}
class ProviderConfig:
"""
Configuration related to the provider.
"""
def __init__(self, name: str):
self._name = name
@property
def name(self) -> str:
"""
The name of the provider.
"""
return self._name
def to_dict(self) -> dict:
"""
Render the given provider config as a dictionary object.
"""
return {
'name': self._name,
}
@dataclass(frozen=True)
class AIConfig:
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 LDAIAgent:
"""
Represents an AI agent configuration with instructions and model settings.
An agent is similar to an AIConfig but focuses on instructions rather than messages,
making it suitable for AI assistant/agent use cases.
"""
enabled: Optional[bool] = None
model: Optional[ModelConfig] = None
provider: Optional[ProviderConfig] = None
instructions: Optional[str] = None
tracker: Optional[LDAIConfigTracker] = None
def to_dict(self) -> Dict[str, Any]:
"""
Render the given agent as a dictionary object.
"""
result: Dict[str, Any] = {
'_ldMeta': {
'enabled': self.enabled or False,
},
'model': self.model.to_dict() if self.model else None,
'provider': self.provider.to_dict() if self.provider else None,
}
if self.instructions is not None:
result['instructions'] = self.instructions
return result
@dataclass(frozen=True)
class LDAIAgentDefaults:
"""
Default values for AI agent configurations.
Similar to LDAIAgent but without tracker and with optional enabled field,
used as fallback values when agent configurations are not available.
"""
enabled: Optional[bool] = None
model: Optional[ModelConfig] = None
provider: Optional[ProviderConfig] = None
instructions: Optional[str] = None
def to_dict(self) -> Dict[str, Any]:
"""
Render the given agent defaults as a dictionary object.
"""
result: Dict[str, Any] = {
'_ldMeta': {
'enabled': self.enabled or False,
},
'model': self.model.to_dict() if self.model else None,
'provider': self.provider.to_dict() if self.provider else None,
}
if self.instructions is not None:
result['instructions'] = self.instructions
return result
@dataclass
class LDAIAgentConfig:
"""
Configuration for individual agent in batch requests.
Combines agent key with its specific default configuration and variables.
"""
key: str
default_value: Optional[LDAIAgentDefaults] = None
variables: Optional[Dict[str, Any]] = None
def __post_init__(self):
"""Set default value if not provided."""
if self.default_value is None:
self.default_value = LDAIAgentDefaults(enabled=False)
# Type alias for multiple agents
LDAIAgents = Dict[str, LDAIAgent]
class LDAIClient:
"""The LaunchDarkly AI SDK client object."""
def __init__(self, client: LDClient):
self._client = client
def config(
self,
key: str,
context: Context,
default_value: AIConfig,
variables: Optional[Dict[str, Any]] = None,
) -> Tuple[AIConfig, LDAIConfigTracker]:
"""
Get the value of a model configuration.
:param key: The key of the model configuration.
:param context: The context to evaluate the model configuration in.
:param default_value: The default value of the model configuration.
:param variables: Additional variables for the model configuration.
:return: The value of the model configuration along with a tracker used for gathering metrics.
"""
model, provider, messages, instructions, tracker, enabled = self.__evaluate(key, context, default_value.to_dict(), variables)
config = AIConfig(
enabled=bool(enabled),
model=model,
messages=messages,
provider=provider,
)
return config, tracker
def agent(
self,
key: str,
context: Context,
default_value: Optional[LDAIAgentDefaults] = None,
variables: Optional[Dict[str, Any]] = None,
) -> LDAIAgent:
"""
Retrieve a single AI Config agent.
This method retrieves a single agent configuration with instructions
dynamically interpolated using the provided variables and context data.
Example::
# With explicit default configuration
agent = client.agent(
'research_agent',
context,
LDAIAgentDefaults(
enabled=True,
model=ModelConfig('gpt-4'),
instructions="You are a research assistant specializing in {{topic}}."
),
{'topic': 'climate change'}
)
# Or with optional default (defaults to {enabled: False})
agent = client.agent('research_agent', context, variables={'topic': 'climate change'})
if agent.enabled:
research_result = agent.instructions # Interpolated instructions
agent.tracker.track_success()
:param key: The agent configuration key to retrieve.
:param context: The context to evaluate the agent configuration in.
:param default_value: Default agent configuration values to use as fallback.
:param variables: Additional variables for template interpolation in instructions.
:return: Configured LDAIAgent instance.
"""
# Set default value if not provided
if default_value is None:
default_value = LDAIAgentDefaults(enabled=False)
# Track single agent usage
self._client.track(
"$ld:ai:agent:function:single",
context,
key,
1
)
return self.__evaluate_agent(key, context, default_value, variables)
def agents(
self,
agent_configs: List[LDAIAgentConfig],
context: Context,
) -> LDAIAgents:
"""
Retrieve multiple AI agent configurations.
This method allows you to retrieve multiple agent configurations in a single call,
with each agent having its own default configuration and variables for instruction
interpolation.
Example::
agents = client.agents([
LDAIAgentConfig(
key='research_agent',
default_value=LDAIAgentDefaults(
enabled=True,
instructions='You are a research assistant.'
),
variables={'topic': 'climate change'}
),
LDAIAgentConfig(
key='writing_agent',
default_value=LDAIAgentDefaults(
enabled=True,
instructions='You are a writing assistant.'
),
variables={'style': 'academic'}
)
], context)
research_result = agents["research_agent"].instructions
agents["research_agent"].tracker.track_success()
:param agent_configs: List of agent configurations to retrieve.
:param context: The context to evaluate the agent configurations in.
:return: Dictionary mapping agent keys to their LDAIAgent configurations.
"""
# Track multiple agents usage
agent_count = len(agent_configs)
self._client.track(
"$ld:ai:agent:function:multiple",
context,
agent_count,
agent_count
)
result: LDAIAgents = {}
for config in agent_configs:
# Ensure default_value is set (should be handled by __post_init__, but satisfy type checker)
default_value = config.default_value or LDAIAgentDefaults(enabled=False)
agent = self.__evaluate_agent(
config.key,
context,
default_value,
config.variables
)
result[config.key] = agent
return result
def __evaluate(
self,
key: str,
context: Context,
default_dict: Dict[str, Any],
variables: Optional[Dict[str, Any]] = None,
) -> Tuple[Optional[ModelConfig], Optional[ProviderConfig], Optional[List[LDMessage]], Optional[str], LDAIConfigTracker, bool]:
"""
Internal method to evaluate a configuration and extract components.
:param key: The configuration key.
:param context: The evaluation context.
:param default_dict: Default configuration as dictionary.
:param variables: Variables for interpolation.
:return: Tuple of (model, provider, messages, instructions, tracker, enabled).
"""
variation = self._client.variation(key, context, default_dict)
all_variables = {}
if variables:
all_variables.update(variables)
all_variables['ldctx'] = context.to_dict()
# Extract messages
messages = None
if 'messages' in variation and isinstance(variation['messages'], list) and all(
isinstance(entry, dict) for entry in variation['messages']
):
messages = [
LDMessage(
role=entry['role'],
content=self.__interpolate_template(
entry['content'], all_variables
),
)
for entry in variation['messages']
]
# Extract instructions
instructions = None
if 'instructions' in variation and isinstance(variation['instructions'], str):
instructions = self.__interpolate_template(variation['instructions'], all_variables)
# Extract provider config
provider_config = None
if 'provider' in variation and isinstance(variation['provider'], dict):
provider = variation['provider']
provider_config = ProviderConfig(provider.get('name', ''))
# Extract model config
model = None
if 'model' in variation and isinstance(variation['model'], dict):
parameters = variation['model'].get('parameters', None)
custom = variation['model'].get('custom', None)
model = ModelConfig(
name=variation['model']['name'],
parameters=parameters,
custom=custom
)
# Create tracker
tracker = LDAIConfigTracker(
self._client,
variation.get('_ldMeta', {}).get('variationKey', ''),
key,
int(variation.get('_ldMeta', {}).get('version', 1)),
context,
)
enabled = variation.get('_ldMeta', {}).get('enabled', False)
return model, provider_config, messages, instructions, tracker, enabled
def __evaluate_agent(
self,
key: str,
context: Context,
default_value: LDAIAgentDefaults,
variables: Optional[Dict[str, Any]] = None,
) -> LDAIAgent:
"""
Internal method to evaluate an agent configuration.
:param key: The agent configuration key.
:param context: The evaluation context.
:param default_value: Default agent values.
:param variables: Variables for interpolation.
:return: Configured LDAIAgent instance.
"""
model, provider, messages, instructions, tracker, enabled = self.__evaluate(
key, context, default_value.to_dict(), variables
)
# For agents, prioritize instructions over messages
final_instructions = instructions if instructions is not None else default_value.instructions
return LDAIAgent(
enabled=bool(enabled) if enabled is not None else default_value.enabled,
model=model or default_value.model,
provider=provider or default_value.provider,
instructions=final_instructions,
tracker=tracker,
)
def __interpolate_template(self, template: str, variables: Dict[str, Any]) -> str:
"""
Interpolate the template with the given variables using Mustache format.
:param template: The template string.
:param variables: The variables to interpolate into the template.
:return: The interpolated string.
"""
return chevron.render(template, variables)