Skip to content

llm_observability: document prompt_uuid for OTel Prompt Tracking #39675

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.

Sign up for GitHub

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

Draft
yahya-mouman wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

llm_observability: document prompt_uuid for OTel Prompt Tracking #39675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c51d189
llm_observability: document prompt_uuid for OTel Prompt Tracking
yahya-mouman Sep 2, 2026
8317e6e
llm_observability: document prompt_uuid for HTTP API Prompt object
yahya-mouman Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions hugo/content/en/llm_observability/instrument/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ An image on a message. Provide either `content` or `attachment_key`.
| query_variable_keys | [string] | Variable keys that contain the user query. Used for hallucination detection. |
| context_variable_keys | [string] | Variable keys that contain ground-truth or context content. Used for hallucination detection. |
| tags | Dict[key (string), string] | Tags to attach to the prompt run. |
| prompt_uuid | string | No, unless linking to Prompt Management. The prompt's UUID from [Prompt Management][6]. Required for the span to link back to its Prompt Management registry entry. |
| prompt_version_uuid | string | The specific prompt version's UUID from [Prompt Management][6]. |

{{% /tab %}}
{{% tab "Example" %}}
Expand All @@ -279,6 +281,8 @@ An image on a message. Provide either `content` or `attachment_key`.
{{% /tab %}}
{{< /tabs >}}

**Note**: If your prompt comes from the [Prompt Management][6] registry (for example, fetched through the Prompt Management REST API in a language without a native Agent Observability SDK), include the `prompt_uuid` (and `prompt_version_uuid`, if available) returned by the API alongside `id` and `version`. Without `prompt_uuid`, the span's prompt metadata is tracked but does not link back to the registry entry in the Prompts view.

#### Meta
| Field | Type | Description |
|-------------|-------------------|--------------|
Expand Down Expand Up @@ -704,3 +708,4 @@ For feedback events, provide exactly one of `span_id`, `trace_id`, `session_id`,
[3]: /getting_started/tagging/
[4]: /llm_observability/investigate/evaluations/end_user_feedback
[5]: /llm_observability/instrument/sdk/?tab=python#enriching-spans
[6]: /llm_observability/configure/prompt_management
4 changes: 4 additions & 0 deletions hugo/content/en/llm_observability/instrument/prompt_tracking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,14 @@ The following fields are supported in the prompt tracking JSON:
| `id` | string | No | Unique identifier for the prompt. Defaults to `{ml_app}_unnamed-prompt` if omitted |
| `name` | string | No | Prompt name. Used as a fallback for `id` if `id` is omitted |
| `version` | string | No | User-supplied version tag |
| `prompt_uuid` | string | No, unless linking to Prompt Management | The prompt's UUID from [Prompt Management][8]. Required for the span to link back to its Prompt Management registry entry |
| `prompt_version_uuid` | string | No | The specific prompt version's UUID from [Prompt Management][8] |
| `variables` | object | No | Template variable substitutions |
| `rag_context_variables` | array of strings | No | Names of variables in `variables` that contain RAG context (ground truth). Used by RAG evaluators |
| `rag_query_variables` | array of strings | No | Names of variables in `variables` that contain the user query. Used by RAG evaluators |

**Note**: If your prompt comes from the [Prompt Management][8] registry (for example, fetched through the Prompt Management REST API in a language without a native Agent Observability SDK), include the `prompt_uuid` (and `prompt_version_uuid`, if available) returned by the API alongside `id` and `version`. Without `prompt_uuid`, the span's prompt metadata is tracked but does not link back to the registry entry in the Prompts view.

<div class="alert alert-info">If you are using prompt templates, Agent Observability can automatically attach version information based on prompt content.</div>

### With LangChain templates
Expand Down
Loading