-
Notifications
You must be signed in to change notification settings - Fork 30
chore: Add example for TrackChat from the AI SDK #937
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jsonbailey
wants to merge
6
commits into
main
Choose a base branch
from
jb/sdk-1454/ai-langchain-example
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b1ebb34
chore: Add example for LangChain provider integration
jsonbailey f227b28
Add chat to root package
jsonbailey 64bdd6c
update example and remove test code
jsonbailey ef43c50
update name of AI SDK example to be non provider specific
jsonbailey 7e3422d
remove debug logger from example
jsonbailey 5dc4ae9
remove unused imports
jsonbailey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Tracked Chat Example | ||
|
||
This example demonstrates how to use the LaunchDarkly AI SDK chat functionality with multiple providers for tracked chat interactions. | ||
|
||
## Prerequisites | ||
|
||
1. A LaunchDarkly account and SDK key | ||
1. An OpenAI API key (for the AI provider) | ||
1. Node.js 16 or later | ||
|
||
## Setup | ||
|
||
1. Install dependencies: | ||
```bash | ||
yarn install | ||
``` | ||
|
||
1. Set up environment variables: | ||
```bash | ||
cp .env.example .env | ||
``` | ||
|
||
Edit `.env` and add your keys: | ||
``` | ||
LAUNCHDARKLY_SDK_KEY=your-sdk-key-here | ||
OPENAI_API_KEY=your-openai-api-key-here | ||
LAUNCHDARKLY_AI_CONFIG_KEY=sample-ai-chat-config | ||
``` | ||
|
||
1. Create an AI Config in LaunchDarkly with the key `sample-ai-config`: | ||
```json | ||
{ | ||
"_ldMeta": { | ||
"variationKey": "1234", | ||
"enabled": true, | ||
"version": 1 | ||
}, | ||
"messages": [ | ||
{ | ||
"content": "You are a helpful assistant for {{customerName}}. You should be friendly and informative.", | ||
"role": "system" | ||
} | ||
], | ||
"model": { | ||
"name": "gpt-3.5-turbo", | ||
"parameters": { | ||
"temperature": 0.7, | ||
"maxTokens": 1000 | ||
} | ||
}, | ||
"provider": { | ||
"name": "langchain" | ||
} | ||
} | ||
``` | ||
|
||
## Running the Example | ||
|
||
```bash | ||
yarn start | ||
``` | ||
|
||
This will: | ||
1. Initialize the LaunchDarkly client | ||
1. Create a chat configuration using the AI Config | ||
1. Send a message to the AI and display the response | ||
1. Continue the conversation with a follow-up question | ||
1. Automatically track interaction metrics (duration, tokens, success/error) | ||
|
||
## Features Demonstrated | ||
|
||
- **AI Config Integration**: Using LaunchDarkly to configure AI models and prompts | ||
- **Variable Interpolation**: Using Mustache templates with runtime variables | ||
- **Chat Conversations**: Multi-turn conversations with message history | ||
- **Provider Integration**: Using multiple AI providers through the LaunchDarkly AI SDK | ||
- **Metrics Tracking**: Automatic tracking of token usage and performance |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"name": "tracked-chat-example", | ||
"version": "1.0.0", | ||
"description": "Example demonstrating LaunchDarkly AI SDK chat functionality with multiple providers", | ||
"type": "module", | ||
"scripts": { | ||
"build": "tsc", | ||
"start": "yarn build && node ./dist/index.js" | ||
}, | ||
"dependencies": { | ||
"@ai-sdk/google": "^2.0.20", | ||
"@langchain/core": "^0.3.78", | ||
"@langchain/google-genai": "^0.2.18", | ||
"@launchdarkly/node-server-sdk": "^9.0.0", | ||
"@launchdarkly/server-sdk-ai": "0.11.4", | ||
"@launchdarkly/server-sdk-ai-langchain": "0.0.0", | ||
"@launchdarkly/server-sdk-ai-vercel": "0.0.0", | ||
"dotenv": "^16.0.0", | ||
"langchain": "^0.1.0" | ||
}, | ||
"devDependencies": { | ||
"@types/node": "^20.0.0", | ||
"tsx": "^4.0.0", | ||
"typescript": "^5.0.0" | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
/* eslint-disable no-console */ | ||
import { | ||
init, | ||
type LDContext, | ||
} from '@launchdarkly/node-server-sdk'; | ||
import { initAi } from '@launchdarkly/server-sdk-ai'; | ||
|
||
// Environment variables | ||
const sdkKey = process.env.LAUNCHDARKLY_SDK_KEY; | ||
const aiConfigKey = process.env.LAUNCHDARKLY_AI_CONFIG_KEY || 'sample-ai-config'; | ||
|
||
// Validate required environment variables | ||
if (!sdkKey) { | ||
console.error('*** Please set the LAUNCHDARKLY_SDK_KEY env first'); | ||
process.exit(1); | ||
} | ||
|
||
// Initialize LaunchDarkly client | ||
const ldClient = init(sdkKey); | ||
|
||
// Set up the context properties. This context should appear on your LaunchDarkly contexts dashboard | ||
// soon after you run the demo. | ||
const context: LDContext = { | ||
kind: 'user', | ||
key: 'example-user-key', | ||
name: 'Sandy', | ||
}; | ||
|
||
async function main(): Promise<void> { | ||
try { | ||
await ldClient.waitForInitialization({ timeout: 10 }); | ||
console.log('*** SDK successfully initialized'); | ||
} catch (error) { | ||
console.log(`*** SDK failed to initialize: ${error}`); | ||
process.exit(1); | ||
} | ||
|
||
const aiClient = initAi(ldClient); | ||
const defaultValue = { | ||
enabled: true, | ||
model: { name: 'gpt-3.5-turbo' }, | ||
messages: [{ role: 'system' as const, content: 'You are a helpful assistant.' }], | ||
provider: { name: 'openai' }, | ||
}; | ||
|
||
// You provide a disabled default value | ||
// const defaultValue = { | ||
// enabled: false, | ||
// }; | ||
|
||
// Get AI chat configuration from LaunchDarkly | ||
const chat = await aiClient.initChat(aiConfigKey, context, defaultValue, { | ||
myVariable: 'My User Defined Variable', | ||
}); | ||
|
||
if (!chat) { | ||
console.log('*** AI chat configuration is not enabled'); | ||
process.exit(0); | ||
} | ||
|
||
// Example of using the chat functionality | ||
console.log('\n*** Starting chat conversation:'); | ||
try { | ||
const userInput = 'Hello! Can you help me understand what LaunchDarkly is?'; | ||
console.log('User Input:', userInput); | ||
|
||
const response = await chat.invoke(userInput); | ||
|
||
console.log('AI Response:', response.message.content); | ||
|
||
console.log('Success.'); | ||
} catch (err) { | ||
console.error('Error:', err); | ||
} | ||
} | ||
|
||
main(); |
18 changes: 18 additions & 0 deletions
18
packages/sdk/server-ai/examples/tracked-chat/tsconfig.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{ | ||
"compilerOptions": { | ||
"target": "ES2022", | ||
"module": "ESNext", | ||
"moduleResolution": "node", | ||
"esModuleInterop": true, | ||
"allowSyntheticDefaultImports": true, | ||
"strict": true, | ||
"skipLibCheck": true, | ||
"forceConsistentCasingInFileNames": true, | ||
"outDir": "./dist", | ||
"rootDir": "./src", | ||
"declaration": true, | ||
"sourceMap": true | ||
}, | ||
"include": ["src/**/*"], | ||
"exclude": ["node_modules", "dist"] | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Template Interpolation Variable Name Mismatch
The
initChat
call providesmyVariable
for template interpolation, but the AI Config template expectscustomerName
. This variable name mismatch prevents the template placeholder from being replaced.