docs: full TypeScript GenAI Observability SDK reference (fix wrong repo link) - #439
Merged
Merged
Conversation
…po link) The TypeScript SDK page was a 'Coming Soon' stub that linked to a nonexistent repo (genai-observability-sdk-js). The SDK is released as @opensearch-project/genai-observability-sdk-ts. Rewrite the page at parity with the Python SDK page, documenting register(), observe(), withObserve(), Op, enrich(), auto-instrumentation, score(), evaluate(), Benchmark, OpenSearchTraceRetriever, and AWSSigV4OTLPExporter, with an env-var reference. Also fix the stale package/status in the AI-agents landing table and add a TypeScript SDK next-step link. Signed-off-by: Shenoy Pratik Gurudatt <ps48@users.noreply.github.com>
ps48
requested review from
anirudha,
goyamegh,
joshuali925,
kylehounslow and
vamsimanohar
as code owners
August 31, 2026 23:21
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 55.62% 55.62%
=======================================
Files 4 4
Lines 169 169
Branches 47 48 +1
=======================================
Hits 94 94
Misses 74 74
Partials 1 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kylehounslow
approved these changes
Aug 31, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
The TypeScript SDK page (
send-data/ai-agents/typescript) was a "Coming Soon" stub that linked to a repo that does not exist:opensearch-project/genai-observability-sdk-js. The SDK is in fact released as@opensearch-project/genai-observability-sdk-ts(source).This PR rewrites the page to full parity with the Python SDK page.
Changes
typescript.md→typescript.mdx(drops the "Coming Soon" badge), documenting the released API, verified against the SDK source:register()(endpoint/protocol resolution, options, examples incl. SigV4)observe()(three calling styles,Opconstants, auto-set attributes,nameFrom, sync/async/generator support)withObserve(),enrich()(param →gen_ai.*attribute mapping)@opentelemetry/instrumentation-openai)score(),evaluate(),Benchmark,OpenSearchTraceRetriever,AWSSigV4OTLPExporterindex.md): the JS/TS row now shows the correct package (@opensearch-project/genai-observability-sdk-ts) with status Available, and added a TypeScript SDK reference next-step link.The sidebar entry and redirects in
astro.config.mjsalready point to/send-data/ai-agents/typescript/, so no config change is needed.Notes
@opensearch-project/genai-observability-sdk-ts(the published package, v0.1.1). The unscopedopensearch-genai-observability-sdk-tson npm is a stale 0.0.1 placeholder and is intentionally not referenced.npm run buildlocally to render-verify (Astro config fails to load in my local Node environment — reproduces identically on unmodifiedmain, so it's environmental). The new.mdxmirrors the existing, known-goodpython.mdxstructure (sameimport { Aside }usage).