Java SDK: document embedding/retrieval annotation - #39036
Closed
ebrevan wants to merge 1 commit into
Closed
Conversation
… Observability SDK Co-authored-by: ebrevan <104702479+ebrevan@users.noreply.github.com>
|
Bits Code status: ✅ Done Comment @datadog-staging to request changes |
|
I can only run on private repositories. |
Contributor
Preview links (active after the
|
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 does this PR do? What is the motivation?
Adds documentation for two new Java SDK methods,
annotateEmbeddingIO()andannotateRetrievalIO(), introduced in dd-trace-java#12149. These methods let customers annotate embedding and retrieval spans with structured document objects (LLMObs.Document) rather than plain strings, giving the trace view richer context for those span types.The changes land in the Java tab of Enriching spans > Annotating inputs and outputs in the LLM Observability SDK reference page.
Changes:
#### Argumentsheading to#### annotateIO() argumentsfor clarity.#### annotateEmbeddingIO() argumentsand#### annotateRetrievalIO() argumentssubsections, each documenting its parameters and preserving the existing null/empty-argument behavior guidance.#### Documentssubsection documenting how to constructLLMObs.Documentvalues (requiredtext; optionalname,id,score), parallel to the existing#### LLM Messagessubsection.#### Exampleto#### Examplesand adds concise embedding-span and retrieval-span code examples alongside the existing LLM-span example.annotateEmbeddingIO()andannotateRetrievalIO()requiredd-trace-java1.66.0 or later.Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Used Claude Code (Bits Code) to draft, structure, and write the documentation changes.
Additional notes
Source PR: DataDog/dd-trace-java#12149
PR by Bits - View session in Datadog
Comment @datadog-staging to request changes