LaunchDarkly AI SDK OpenAI Provider
Project description
LaunchDarkly AI SDK OpenAI Provider
[!CAUTION] This package is in pre-release and not subject to backwards compatibility guarantees. The API may change based on feedback.
Pin to a specific minor version and review the changelog before upgrading.
This package provides an OpenAI integration for the LaunchDarkly AI SDK.
Installation
pip install launchdarkly-server-sdk-ai-openai
Quick Start
import asyncio
from ldclient import LDClient, Config, Context
from ldai import init
from ldai.models import AICompletionConfigDefault, ModelConfig, ProviderConfig
# Initialize LaunchDarkly client
ld_client = LDClient(Config("your-sdk-key"))
ai_client = init(ld_client)
context = Context.builder("user-123").build()
async def main():
# Create a ManagedModel backed by the OpenAI provider
model = await ai_client.create_model(
"ai-config-key",
context,
AICompletionConfigDefault(
enabled=True,
model=ModelConfig("gpt-4"),
provider=ProviderConfig("openai"),
),
)
if model:
result = await model.run("Hello, how are you?")
print(result.content)
asyncio.run(main())
Usage
Using create_model (recommended)
The recommended entry point is LDAIClient.create_model, which evaluates a
LaunchDarkly AI config flag, selects the OpenAI runner automatically, and
returns a ManagedModel that wraps the runner:
model = await ai_client.create_model("ai-config-key", context)
if model:
result = await model.run("What is feature flagging?")
print(result.content)
Using the runner directly
If you need to construct a runner manually (e.g. for testing), you can use
OpenAIRunnerFactory from the ldai_openai package:
from ldai_openai import OpenAIRunnerFactory
factory = OpenAIRunnerFactory() # uses OPENAI_API_KEY from environment
runner = factory.create_model(ai_config)
result = await runner.run("Hello!")
print(result.content)
Structured Output
Pass a JSON schema dict as output_type to request structured output:
response_structure = {
"type": "object",
"properties": {
"sentiment": {"type": "string", "enum": ["positive", "negative", "neutral"]},
"confidence": {"type": "number"},
},
"required": ["sentiment", "confidence"],
}
result = await runner.run(messages, output_type=response_structure)
print(result.parsed) # {"sentiment": "positive", "confidence": 0.95}
Tracking Metrics
ManagedModel.run() automatically tracks metrics via the associated
LDAIConfigTracker. For manual tracking, use the tracker directly:
model = await ai_client.create_model("ai-config-key", context)
if model:
result = await model.run("Explain feature flags.")
# Metrics are tracked automatically; access them via result.metrics
print(result.metrics.usage)
Static Utility Methods
The ldai_openai helper module provides several utility functions:
Converting Messages
from ldai.models import LDMessage
from ldai_openai import convert_messages_to_openai
messages = [
LDMessage(role="system", content="You are helpful."),
LDMessage(role="user", content="Hello!"),
]
openai_messages = convert_messages_to_openai(messages)
Extracting Metrics
from ldai_openai import get_ai_metrics_from_response
# After getting a response from OpenAI
metrics = get_ai_metrics_from_response(response)
print(f"Success: {metrics.success}")
print(f"Tokens used: {metrics.usage.total if metrics.usage else 'N/A'}")
Documentation
For full documentation, please refer to the LaunchDarkly AI SDK documentation.
Contributing
See CONTRIBUTING.md in the repository root.
License
Apache-2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file launchdarkly_server_sdk_ai_openai-0.5.0.tar.gz.
File metadata
- Download URL: launchdarkly_server_sdk_ai_openai-0.5.0.tar.gz
- Upload date:
- Size: 21.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36113e8cb80150b333f1d11debef5a40b8c714f1a8c4b7c7e812f9af6cc95928
|
|
| MD5 |
e28a1ff09718dcf4ee29ea5412976a08
|
|
| BLAKE2b-256 |
dc75699f1eeae2dbd46b9c32442ace3a5e7bb72519f32edcae0d979adfc8d966
|
File details
Details for the file launchdarkly_server_sdk_ai_openai-0.5.0-py3-none-any.whl.
File metadata
- Download URL: launchdarkly_server_sdk_ai_openai-0.5.0-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28d51e0a263383fb7961f60026f6b4b28e679797ffe5539488a676685cd0c0db
|
|
| MD5 |
84c8c74a1fcaa54a6af2cba0c201684e
|
|
| BLAKE2b-256 |
34d4b365884de6f4080aceb914fe12b8547c1f721b10209fcde6a17b5cbcc987
|