Readme improvements. Example improvements.

Author: kinyoklion

packages/sdk/server-ai/README.md

@@ -2,4 +2,62 @@
 
 This package provides the LaunchDarkly AI SDK for Node.js.
 
-## Installation
+## LaunchDarkly overview
+
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
+
+## Quick Setup
+
+This assumes that you have already installed the LaunchDarkly Node.js SDK, or a compatible edge
+SDK.
+
+1. Install this package with `npm` or `yarn`:
+
+```shell
+npm install @launchdarkly/server-sdk-ai --save
+```
+
+2. Create an AI SDK instance:
+
+```typescript
+// The ldClient instance should be created based on the instructions in the relevant SDK.
+const aiClient = initAi(ldClient);
+```
+
+3. Evaluate a model configuration:
+```
+  const config = await aiClient.modelConfig(
+    aiConfigKey!,
+    context,
+    { enabled: false },
+    { myVariable: 'My User Defined Variable' },
+  );
+```
+
+For an example of how to use the config please refer to the examples folder.
+
+## Contributing
+
+We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan).
+  - Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
+
+[node-otel-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml/badge.svg
+[node-otel-ci]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml
+[node-otel-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-server-sdk-otel.svg?style=flat-square
+[node-otel-npm-link]: https://www.npmjs.com/package/@launchdarkly/node-server-sdk-otel

packages/sdk/server-ai/examples/bedrock/src/index.ts

@@ -2,7 +2,7 @@
 import { BedrockRuntimeClient, ConverseCommand, Message } from '@aws-sdk/client-bedrock-runtime';
 
 import { init } from '@launchdarkly/node-server-sdk';
-import { initAi, LDAIConfig } from '@launchdarkly/server-sdk-ai';
+import { initAi } from '@launchdarkly/server-sdk-ai';
 
 const sdkKey = process.env.LAUNCHDARKLY_SDK_KEY;
 const aiConfigKey = process.env.LAUNCHDARKLY_AI_CONFIG_KEY || 'sample-ai-config';
@@ -38,45 +38,41 @@ function mapPromptToConversation(
 }
 
 async function main() {
-  let tracker;
-  let configValue: LDAIConfig;
-
   try {
     await ldClient.waitForInitialization({ timeout: 10 });
     console.log('*** SDK successfully initialized');
-    const aiClient = initAi(ldClient);
-
-    configValue = await aiClient.modelConfig(
-      aiConfigKey!,
-      context,
-      {
-        model: {
-          modelId: 'my-default-model',
-        },
-        enabled: true,
-      },
-      {
-        myVariable: 'My User Defined Variable',
-      },
-    );
-    tracker = configValue.tracker;
   } catch (error) {
     console.log(`*** SDK failed to initialize: ${error}`);
     process.exit(1);
   }
 
-  if (tracker) {
-    const completion = tracker.trackBedrockConverse(
-      await awsClient.send(
-        new ConverseCommand({
-          modelId: configValue.config.model?.modelId ?? 'no-model',
-          messages: mapPromptToConversation(configValue.config.prompt ?? []),
-        }),
-      ),
-    );
-    console.log('AI Response:', completion.output?.message?.content?.[0]?.text ?? 'no-response');
-    console.log('Success.');
-  }
+  const aiClient = initAi(ldClient);
+
+  const aiConfig = await aiClient.modelConfig(
+    aiConfigKey!,
+    context,
+    {
+      model: {
+        modelId: 'my-default-model',
+      },
+      enabled: true,
+    },
+    {
+      myVariable: 'My User Defined Variable',
+    },
+  );
+  const { tracker } = aiConfig;
+
+  const completion = tracker.trackBedrockConverse(
+    await awsClient.send(
+      new ConverseCommand({
+        modelId: aiConfig.config.model?.modelId ?? 'no-model',
+        messages: mapPromptToConversation(aiConfig.config.prompt ?? []),
+      }),
+    ),
+  );
+  console.log('AI Response:', completion.output?.message?.content?.[0]?.text ?? 'no-response');
+  console.log('Success.');
 }
 
 main();

packages/sdk/server-ai/examples/openai/src/index.ts

@@ -39,33 +39,34 @@ async function main(): Promise<void> {
   try {
     await ldClient.waitForInitialization({ timeout: 10 });
     console.log('*** SDK successfully initialized');
-    const aiClient = initAi(ldClient);
-
-    const configValue = await aiClient.modelConfig(
-      aiConfigKey,
-      context,
-      {
-        model: {
-          modelId: 'gpt-4',
-        },
-      },
-      { myVariable: 'My User Defined Variable' },
-    );
-
-    const { tracker } = configValue;
-    const completion = await tracker.trackOpenAI(async () =>
-      client.chat.completions.create({
-        messages: configValue.config.prompt || [],
-        model: configValue.config.model?.modelId || 'gpt-4',
-      }),
-    );
-
-    console.log('AI Response:', completion.choices[0]?.message.content);
-    console.log('Success.');
   } catch (error) {
     console.log(`*** SDK failed to initialize: ${error}`);
     process.exit(1);
   }
+
+  const aiClient = initAi(ldClient);
+
+  const aiConfig = await aiClient.modelConfig(
+    aiConfigKey,
+    context,
+    {
+      model: {
+        modelId: 'gpt-4',
+      },
+    },
+    { myVariable: 'My User Defined Variable' },
+  );
+
+  const { tracker } = aiConfig;
+  const completion = await tracker.trackOpenAI(async () =>
+    client.chat.completions.create({
+      messages: aiConfig.config.prompt || [],
+      model: aiConfig.config.model?.modelId || 'gpt-4',
+    }),
+  );
+
+  console.log('AI Response:', completion.choices[0]?.message.content);
+  console.log('Success.');
 }
 
 main();