@launchdarkly/server-sdk-ai 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDModelConfig | @launchdarkly/server-sdk-ai - v0.2.1</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDModelConfig | @launchdarkly/server-sdk-ai - v0.3.0</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.2.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.3.0</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -27,7 +27,7 @@
27
27
  <h4 class="tsd-before-signature">Indexable</h4>
28
28
  <div class="tsd-signature"><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></section><aside class="tsd-sources">
29
29
  <ul>
30
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L6">api/config/LDAIConfig.ts:6</a></li></ul></aside>
30
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L6">api/config/LDAIConfig.ts:6</a></li></ul></aside>
31
31
  <section class="tsd-panel-group tsd-index-group">
32
32
  <section class="tsd-panel tsd-index-panel">
33
33
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,7 +36,7 @@
36
36
  <section class="tsd-index-section">
37
37
  <h3 class="tsd-index-heading">Properties</h3>
38
38
  <div class="tsd-index-list"><a href="LDModelConfig.html#maxTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>max<wbr/>Tokens?</span></a>
39
- <a href="LDModelConfig.html#modelId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model<wbr/>Id?</span></a>
39
+ <a href="LDModelConfig.html#modelId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model<wbr/>Id</span></a>
40
40
  <a href="LDModelConfig.html#temperature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>temperature?</span></a>
41
41
  </div></section></div></details></section></section>
42
42
  <section class="tsd-panel-group tsd-member-group">
@@ -48,15 +48,15 @@
48
48
  </div>
49
49
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
50
50
  <ul>
51
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L21">api/config/LDAIConfig.ts:21</a></li></ul></aside></section>
51
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L21">api/config/LDAIConfig.ts:21</a></li></ul></aside></section>
52
52
  <section class="tsd-panel tsd-member"><a id="modelId" class="tsd-anchor"></a>
53
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>model<wbr/>Id</span><a href="#modelId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
54
- <div class="tsd-signature"><span class="tsd-kind-property">model<wbr/>Id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
53
+ <h3 class="tsd-anchor-link"><span>model<wbr/>Id</span><a href="#modelId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
54
+ <div class="tsd-signature"><span class="tsd-kind-property">model<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
55
55
  <div class="tsd-comment tsd-typography"><p>The ID of the model.</p>
56
56
  </div>
57
57
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
58
58
  <ul>
59
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L10">api/config/LDAIConfig.ts:10</a></li></ul></aside></section>
59
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L10">api/config/LDAIConfig.ts:10</a></li></ul></aside></section>
60
60
  <section class="tsd-panel tsd-member"><a id="temperature" class="tsd-anchor"></a>
61
61
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>temperature</span><a href="#temperature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
62
62
  <div class="tsd-signature"><span class="tsd-kind-property">temperature</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -65,7 +65,7 @@ model.</p>
65
65
  </div>
66
66
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
67
67
  <ul>
68
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L16">api/config/LDAIConfig.ts:16</a></li></ul></aside></section></section></div>
68
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L16">api/config/LDAIConfig.ts:16</a></li></ul></aside></section></section></div>
69
69
  <div class="col-sidebar">
70
70
  <div class="page-menu">
71
71
  <div class="tsd-navigation settings">
@@ -89,17 +89,16 @@ model.</p>
89
89
  <li><a href="#modelId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model<wbr/>Id</span></a></li>
90
90
  <li><a href="#temperature" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>temperature</span></a></li></ul></div></details></div>
91
91
  <div class="site-menu">
92
- <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.2.1</span></a>
92
+ <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.3.0</span></a>
93
93
  <ul class="tsd-small-nested-navigation">
94
94
  <li><a href="../enums/LDFeedbackKind.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>LDFeedback<wbr/>Kind</span></a></li>
95
95
  <li><a href="LDAIClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>LDAIClient</span></a></li>
96
96
  <li><a href="LDAIConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig</span></a></li>
97
97
  <li><a href="LDAIConfigTracker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig<wbr/>Tracker</span></a></li>
98
- <li><a href="LDAIDefaults.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIDefaults</span></a></li>
99
- <li><a href="LDGenerationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDGeneration<wbr/>Config</span></a></li>
100
98
  <li><a href="LDMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDMessage</span></a></li>
101
99
  <li><a href="LDModelConfig.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDModel<wbr/>Config</span></a></li>
102
100
  <li><a href="LDTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDToken<wbr/>Usage</span></a></li>
101
+ <li><a href="../types/LDAIDefaults.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>LDAIDefaults</span></a></li>
103
102
  <li><a href="../functions/createBedrockTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Bedrock<wbr/>Token<wbr/>Usage</span></a></li>
104
103
  <li><a href="../functions/initAi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>init<wbr/>Ai</span></a></li></ul></nav></div></div></div>
105
104
  <div class="tsd-generator">
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDTokenUsage | @launchdarkly/server-sdk-ai - v0.2.1</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDTokenUsage | @launchdarkly/server-sdk-ai - v0.3.0</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.2.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.3.0</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -24,7 +24,7 @@
24
24
  <ul class="tsd-hierarchy">
25
25
  <li><span class="target">LDTokenUsage</span></li></ul></section><aside class="tsd-sources">
26
26
  <ul>
27
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L4">api/metrics/LDTokenUsage.ts:4</a></li></ul></aside>
27
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L4">api/metrics/LDTokenUsage.ts:4</a></li></ul></aside>
28
28
  <section class="tsd-panel-group tsd-index-group">
29
29
  <section class="tsd-panel tsd-index-panel">
30
30
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -45,7 +45,7 @@
45
45
  </div>
46
46
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
47
47
  <ul>
48
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L13">api/metrics/LDTokenUsage.ts:13</a></li></ul></aside></section>
48
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L13">api/metrics/LDTokenUsage.ts:13</a></li></ul></aside></section>
49
49
  <section class="tsd-panel tsd-member"><a id="output" class="tsd-anchor"></a>
50
50
  <h3 class="tsd-anchor-link"><span>output</span><a href="#output" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
51
51
  <div class="tsd-signature"><span class="tsd-kind-property">output</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -53,7 +53,7 @@
53
53
  </div>
54
54
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
55
55
  <ul>
56
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L18">api/metrics/LDTokenUsage.ts:18</a></li></ul></aside></section>
56
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L18">api/metrics/LDTokenUsage.ts:18</a></li></ul></aside></section>
57
57
  <section class="tsd-panel tsd-member"><a id="total" class="tsd-anchor"></a>
58
58
  <h3 class="tsd-anchor-link"><span>total</span><a href="#total" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
59
59
  <div class="tsd-signature"><span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -61,7 +61,7 @@
61
61
  </div>
62
62
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
63
63
  <ul>
64
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L8">api/metrics/LDTokenUsage.ts:8</a></li></ul></aside></section></section></div>
64
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/metrics/LDTokenUsage.ts#L8">api/metrics/LDTokenUsage.ts:8</a></li></ul></aside></section></section></div>
65
65
  <div class="col-sidebar">
66
66
  <div class="page-menu">
67
67
  <div class="tsd-navigation settings">
@@ -85,17 +85,16 @@
85
85
  <li><a href="#output" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>output</span></a></li>
86
86
  <li><a href="#total" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>total</span></a></li></ul></div></details></div>
87
87
  <div class="site-menu">
88
- <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.2.1</span></a>
88
+ <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.3.0</span></a>
89
89
  <ul class="tsd-small-nested-navigation">
90
90
  <li><a href="../enums/LDFeedbackKind.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>LDFeedback<wbr/>Kind</span></a></li>
91
91
  <li><a href="LDAIClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>LDAIClient</span></a></li>
92
92
  <li><a href="LDAIConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig</span></a></li>
93
93
  <li><a href="LDAIConfigTracker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig<wbr/>Tracker</span></a></li>
94
- <li><a href="LDAIDefaults.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIDefaults</span></a></li>
95
- <li><a href="LDGenerationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDGeneration<wbr/>Config</span></a></li>
96
94
  <li><a href="LDMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDMessage</span></a></li>
97
95
  <li><a href="LDModelConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDModel<wbr/>Config</span></a></li>
98
96
  <li><a href="LDTokenUsage.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDToken<wbr/>Usage</span></a></li>
97
+ <li><a href="../types/LDAIDefaults.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>LDAIDefaults</span></a></li>
99
98
  <li><a href="../functions/createBedrockTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Bedrock<wbr/>Token<wbr/>Usage</span></a></li>
100
99
  <li><a href="../functions/initAi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>init<wbr/>Ai</span></a></li></ul></nav></div></div></div>
101
100
  <div class="tsd-generator">
@@ -0,0 +1,64 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDAIDefaults | @launchdarkly/server-sdk-ai - v0.3.0</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.3.0</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
+ <div class="container container-main">
12
+ <div class="col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../index.html">@launchdarkly/server-sdk-ai</a></li>
16
+ <li><a href="LDAIDefaults.html">LDAIDefaults</a></li></ul>
17
+ <h1>Type alias LDAIDefaults</h1></div>
18
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">LDAIDefaults</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LDAIConfig.html" class="tsd-signature-type tsd-kind-interface">LDAIConfig</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;tracker&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;enabled&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <div class="tsd-comment tsd-typography"><p>Default value for a <code>modelConfig</code>. This is the same as the LDAIConfig, but it does not include
20
+ a tracker and <code>enabled</code> is optional.</p>
21
+ </div>
22
+ <div class="tsd-type-declaration">
23
+ <h4>Type declaration</h4>
24
+ <ul class="tsd-parameters">
25
+ <li class="tsd-parameter">
26
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
27
+ <div class="tsd-comment tsd-typography"><p>Whether the configuration is enabled.</p>
28
+ <p>defaults to false</p>
29
+ </div>
30
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
31
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
32
+ <ul>
33
+ <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/70584a1/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L71">api/config/LDAIConfig.ts:71</a></li></ul></aside></div>
34
+ <div class="col-sidebar">
35
+ <div class="page-menu">
36
+ <div class="tsd-navigation settings">
37
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
38
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
39
+ <div class="tsd-accordion-details">
40
+ <div class="tsd-filter-visibility">
41
+ <h4 class="uppercase">Member Visibility</h4><form>
42
+ <ul id="tsd-filter-options">
43
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
44
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
45
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
46
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
47
+ <div class="tsd-theme-toggle">
48
+ <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
49
+ <div class="site-menu">
50
+ <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.3.0</span></a>
51
+ <ul class="tsd-small-nested-navigation">
52
+ <li><a href="../enums/LDFeedbackKind.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>LDFeedback<wbr/>Kind</span></a></li>
53
+ <li><a href="../interfaces/LDAIClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>LDAIClient</span></a></li>
54
+ <li><a href="../interfaces/LDAIConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig</span></a></li>
55
+ <li><a href="../interfaces/LDAIConfigTracker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig<wbr/>Tracker</span></a></li>
56
+ <li><a href="../interfaces/LDMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDMessage</span></a></li>
57
+ <li><a href="../interfaces/LDModelConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDModel<wbr/>Config</span></a></li>
58
+ <li><a href="../interfaces/LDTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDToken<wbr/>Usage</span></a></li>
59
+ <li><a href="LDAIDefaults.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>LDAIDefaults</span></a></li>
60
+ <li><a href="../functions/createBedrockTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Bedrock<wbr/>Token<wbr/>Usage</span></a></li>
61
+ <li><a href="../functions/initAi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>init<wbr/>Ai</span></a></li></ul></nav></div></div></div>
62
+ <div class="tsd-generator">
63
+ <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
64
+ <div class="overlay"></div></body></html>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@launchdarkly/server-sdk-ai",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "LaunchDarkly AI SDK for Server-Side JavaScript",
5
5
  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/server-ai",
6
6
  "repository": {
@@ -2,7 +2,7 @@ import * as Mustache from 'mustache';
2
2
 
3
3
  import { LDContext } from '@launchdarkly/js-server-sdk-common';
4
4
 
5
- import { LDAIConfig, LDGenerationConfig, LDMessage, LDModelConfig } from './api/config';
5
+ import { LDAIConfig, LDAIDefaults, LDMessage, LDModelConfig } from './api/config';
6
6
  import { LDAIClient } from './api/LDAIClient';
7
7
  import { LDAIConfigTrackerImpl } from './LDAIConfigTrackerImpl';
8
8
  import { LDClientMin } from './LDClientMin';
@@ -32,16 +32,28 @@ export class LDAIClientImpl implements LDAIClient {
32
32
  return Mustache.render(template, variables, undefined, { escape: (item: any) => item });
33
33
  }
34
34
 
35
- async modelConfig<TDefault extends LDGenerationConfig>(
35
+ async modelConfig(
36
36
  key: string,
37
37
  context: LDContext,
38
- defaultValue: TDefault,
38
+ defaultValue: LDAIDefaults,
39
39
  variables?: Record<string, unknown>,
40
40
  ): Promise<LDAIConfig> {
41
41
  const value: VariationContent = await this._ldClient.variation(key, context, defaultValue);
42
+ const tracker = new LDAIConfigTrackerImpl(
43
+ this._ldClient,
44
+ key,
45
+ // eslint-disable-next-line no-underscore-dangle
46
+ value._ldMeta?.versionKey ?? '',
47
+ context,
48
+ );
49
+ // eslint-disable-next-line no-underscore-dangle
50
+ const enabled = !!value._ldMeta?.enabled;
51
+ const config: LDAIConfig = {
52
+ tracker,
53
+ enabled,
54
+ };
42
55
  // We are going to modify the contents before returning them, so we make a copy.
43
56
  // This isn't a deep copy and the application developer should not modify the returned content.
44
- const config: LDGenerationConfig = {};
45
57
  if (value.model) {
46
58
  config.model = { ...value.model };
47
59
  }
@@ -54,18 +66,6 @@ export class LDAIClientImpl implements LDAIClient {
54
66
  }));
55
67
  }
56
68
 
57
- return {
58
- config,
59
- // eslint-disable-next-line no-underscore-dangle
60
- tracker: new LDAIConfigTrackerImpl(
61
- this._ldClient,
62
- key,
63
- // eslint-disable-next-line no-underscore-dangle
64
- value._ldMeta?.versionKey ?? '',
65
- context,
66
- ),
67
- // eslint-disable-next-line no-underscore-dangle
68
- enabled: !!value._ldMeta?.enabled,
69
- };
69
+ return config;
70
70
  }
71
71
  }
@@ -1,16 +1,6 @@
1
1
  import { LDContext } from '@launchdarkly/js-server-sdk-common';
2
2
 
3
- import { LDAIConfig, LDGenerationConfig } from './config/LDAIConfig';
4
-
5
- /**
6
- * Interface for default model configuration.
7
- */
8
- export interface LDAIDefaults extends LDGenerationConfig {
9
- /**
10
- * Whether the configuration is enabled.
11
- */
12
- enabled?: boolean;
13
- }
3
+ import { LDAIConfig, LDAIDefaults } from './config/LDAIConfig';
14
4
 
15
5
  /**
16
6
  * Interface for performing AI operations using LaunchDarkly.
@@ -77,10 +67,10 @@ export interface LDAIClient {
77
67
  * }
78
68
  * ```
79
69
  */
80
- modelConfig<TDefault extends LDAIDefaults>(
70
+ modelConfig(
81
71
  key: string,
82
72
  context: LDContext,
83
- defaultValue: TDefault,
73
+ defaultValue: LDAIDefaults,
84
74
  variables?: Record<string, unknown>,
85
75
  ): Promise<LDAIConfig>;
86
76
  }
@@ -7,7 +7,7 @@ export interface LDModelConfig {
7
7
  /**
8
8
  * The ID of the model.
9
9
  */
10
- modelId?: string;
10
+ modelId: string;
11
11
 
12
12
  /**
13
13
  * Tuning parameter for randomness versus determinism. Exact effect will be determined by the
@@ -41,9 +41,9 @@ export interface LDMessage {
41
41
  }
42
42
 
43
43
  /**
44
- * Configuration which affects generation.
44
+ * AI configuration and tracker.
45
45
  */
46
- export interface LDGenerationConfig {
46
+ export interface LDAIConfig {
47
47
  /**
48
48
  * Optional model configuration.
49
49
  */
@@ -52,16 +52,6 @@ export interface LDGenerationConfig {
52
52
  * Optional prompt data.
53
53
  */
54
54
  prompt?: LDMessage[];
55
- }
56
-
57
- /**
58
- * AI Config value and tracker.
59
- */
60
- export interface LDAIConfig {
61
- /**
62
- * The result of the AI Config customization.
63
- */
64
- config: LDGenerationConfig;
65
55
 
66
56
  /**
67
57
  * A tracker which can be used to generate analytics.
@@ -73,3 +63,16 @@ export interface LDAIConfig {
73
63
  */
74
64
  enabled: boolean;
75
65
  }
66
+
67
+ /**
68
+ * Default value for a `modelConfig`. This is the same as the LDAIConfig, but it does not include
69
+ * a tracker and `enabled` is optional.
70
+ */
71
+ export type LDAIDefaults = Omit<LDAIConfig, 'tracker' | 'enabled'> & {
72
+ /**
73
+ * Whether the configuration is enabled.
74
+ *
75
+ * defaults to false
76
+ */
77
+ enabled?: boolean;
78
+ };
@@ -1,107 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LDAIDefaults | @launchdarkly/server-sdk-ai - v0.2.1</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.2.1</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../index.html">@launchdarkly/server-sdk-ai</a></li>
16
- <li><a href="LDAIDefaults.html">LDAIDefaults</a></li></ul>
17
- <h1>Interface LDAIDefaults</h1></div>
18
- <section class="tsd-panel tsd-comment">
19
- <div class="tsd-comment tsd-typography"><p>Interface for default model configuration.</p>
20
- </div>
21
- <div class="tsd-comment tsd-typography"></div></section>
22
- <section class="tsd-panel tsd-hierarchy">
23
- <h4>Hierarchy</h4>
24
- <ul class="tsd-hierarchy">
25
- <li><a href="LDGenerationConfig.html" class="tsd-signature-type tsd-kind-interface">LDGenerationConfig</a>
26
- <ul class="tsd-hierarchy">
27
- <li><span class="target">LDAIDefaults</span></li></ul></li></ul></section><aside class="tsd-sources">
28
- <ul>
29
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/LDAIClient.ts#L8">api/LDAIClient.ts:8</a></li></ul></aside>
30
- <section class="tsd-panel-group tsd-index-group">
31
- <section class="tsd-panel tsd-index-panel">
32
- <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
33
- <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
34
- <div class="tsd-accordion-details">
35
- <section class="tsd-index-section">
36
- <h3 class="tsd-index-heading">Properties</h3>
37
- <div class="tsd-index-list"><a href="LDAIDefaults.html#enabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>enabled?</span></a>
38
- <a href="LDAIDefaults.html#model" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model?</span></a>
39
- <a href="LDAIDefaults.html#prompt" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prompt?</span></a>
40
- </div></section></div></details></section></section>
41
- <section class="tsd-panel-group tsd-member-group">
42
- <h2>Properties</h2>
43
- <section class="tsd-panel tsd-member"><a id="enabled" class="tsd-anchor"></a>
44
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>enabled</span><a href="#enabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
45
- <div class="tsd-signature"><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
46
- <div class="tsd-comment tsd-typography"><p>Whether the configuration is enabled.</p>
47
- </div>
48
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
49
- <ul>
50
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/LDAIClient.ts#L12">api/LDAIClient.ts:12</a></li></ul></aside></section>
51
- <section class="tsd-panel tsd-member tsd-is-inherited"><a id="model" class="tsd-anchor"></a>
52
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
53
- <div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">?:</span> <a href="LDModelConfig.html" class="tsd-signature-type tsd-kind-interface">LDModelConfig</a></div>
54
- <div class="tsd-comment tsd-typography"><p>Optional model configuration.</p>
55
- </div>
56
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
57
- <p>Inherited from <a href="LDGenerationConfig.html">LDGenerationConfig</a>.<a href="LDGenerationConfig.html#model">model</a></p>
58
- <ul>
59
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L50">api/config/LDAIConfig.ts:50</a></li></ul></aside></section>
60
- <section class="tsd-panel tsd-member tsd-is-inherited"><a id="prompt" class="tsd-anchor"></a>
61
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>prompt</span><a href="#prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
62
- <div class="tsd-signature"><span class="tsd-kind-property">prompt</span><span class="tsd-signature-symbol">?:</span> <a href="LDMessage.html" class="tsd-signature-type tsd-kind-interface">LDMessage</a><span class="tsd-signature-symbol">[]</span></div>
63
- <div class="tsd-comment tsd-typography"><p>Optional prompt data.</p>
64
- </div>
65
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
66
- <p>Inherited from <a href="LDGenerationConfig.html">LDGenerationConfig</a>.<a href="LDGenerationConfig.html#prompt">prompt</a></p>
67
- <ul>
68
- <li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/8ad7d46/packages/sdk/server-ai/src/api/config/LDAIConfig.ts#L54">api/config/LDAIConfig.ts:54</a></li></ul></aside></section></section></div>
69
- <div class="col-sidebar">
70
- <div class="page-menu">
71
- <div class="tsd-navigation settings">
72
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
73
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
74
- <div class="tsd-accordion-details">
75
- <div class="tsd-filter-visibility">
76
- <h4 class="uppercase">Member Visibility</h4><form>
77
- <ul id="tsd-filter-options">
78
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
79
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
80
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
81
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
82
- <div class="tsd-theme-toggle">
83
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
84
- <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
85
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
86
- <div class="tsd-accordion-details">
87
- <ul>
88
- <li><a href="#enabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>enabled</span></a></li>
89
- <li><a href="#model" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model</span></a></li>
90
- <li><a href="#prompt" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prompt</span></a></li></ul></div></details></div>
91
- <div class="site-menu">
92
- <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@launchdarkly/server-<wbr/>sdk-<wbr/>ai -<wbr/> v0.2.1</span></a>
93
- <ul class="tsd-small-nested-navigation">
94
- <li><a href="../enums/LDFeedbackKind.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>LDFeedback<wbr/>Kind</span></a></li>
95
- <li><a href="LDAIClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>LDAIClient</span></a></li>
96
- <li><a href="LDAIConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig</span></a></li>
97
- <li><a href="LDAIConfigTracker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIConfig<wbr/>Tracker</span></a></li>
98
- <li><a href="LDAIDefaults.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDAIDefaults</span></a></li>
99
- <li><a href="LDGenerationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDGeneration<wbr/>Config</span></a></li>
100
- <li><a href="LDMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDMessage</span></a></li>
101
- <li><a href="LDModelConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDModel<wbr/>Config</span></a></li>
102
- <li><a href="LDTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>LDToken<wbr/>Usage</span></a></li>
103
- <li><a href="../functions/createBedrockTokenUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Bedrock<wbr/>Token<wbr/>Usage</span></a></li>
104
- <li><a href="../functions/initAi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>init<wbr/>Ai</span></a></li></ul></nav></div></div></div>
105
- <div class="tsd-generator">
106
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
107
- <div class="overlay"></div></body></html>