Skip to content

Commit 388794c

Browse files
aabmasslmolkova
andcommitted
Add gen_ai _ref attributes for referencing external uploaded content
Adapted from 092db44 Co-authored-by: Liudmila Molkova <[email protected]>
1 parent bbefe43 commit 388794c

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

.chloggen/genai-refs.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
change_type: enhancement
2+
component: gen_ai
3+
note: Add gen_ai `_ref` attributes for referencing external uploaded content
4+
issues: [2753]

model/gen-ai/registry.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,20 @@ groups:
471471
"content": "Your mission is to translate text in English to French."
472472
}
473473
]
474+
- id: gen_ai.system_instructions_ref
475+
stability: development
476+
type: string
477+
brief: The link to the system message or instructions recorded in a separate
478+
storage.
479+
examples: ["s3://acme.prod.support_bot.chats.2025/conv_1234/invocation_42.json"]
480+
note: >
481+
This attribute records the reference to the content of
482+
`gen_ai.system_instructions` attribute when the content is too large or
483+
contains sensitive information and should be stored separately from
484+
general telemetry data.
485+
486+
Refer to the [Uploading content to external storage](/docs/gen-ai/gen-ai-spans.md#uploading-content-to-external-storage)
487+
section for more details.
474488
- id: gen_ai.input.messages
475489
stability: development
476490
type: any
@@ -527,6 +541,19 @@ groups:
527541
]
528542
}
529543
]
544+
- id: gen_ai.input.messages_ref
545+
stability: development
546+
type: string
547+
brief: The link to the input messages recorded in a separate storage.
548+
examples: ["s3://acme.prod.support_bot.chats.2025/conv_1234/run_42.json"]
549+
note: |
550+
This attribute records the reference to the content of
551+
`gen_ai.input.messages` attribute when the content is too large or
552+
contains sensitive information and should be stored separately from
553+
general telemetry data.
554+
555+
Refer to the [Uploading content to external storage](/docs/gen-ai/gen-ai-spans.md#uploading-content-to-external-storage)
556+
section for more details.
530557
- id: gen_ai.output.messages
531558
stability: development
532559
type: any
@@ -566,6 +593,19 @@ groups:
566593
"finish_reason": "stop"
567594
}
568595
]
596+
- id: gen_ai.output.messages_ref
597+
stability: development
598+
type: string
599+
brief: The link to the model or agent output recorded in a separate storage.
600+
examples: ["s3://acme.prod.support_bot.chats.2025/conv_1234/run_42.json"]
601+
note: |
602+
This attribute records the reference to the content of
603+
`gen_ai.output.messages` attribute when the content is too large or
604+
contains sensitive information and should be stored separately from
605+
general telemetry data.
606+
607+
Refer to the [Uploading content to external storage](/docs/gen-ai/gen-ai-spans.md#uploading-content-to-external-storage)
608+
section for more details.
569609
- id: gen_ai.evaluation.name
570610
stability: development
571611
type: string

model/gen-ai/spans.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,19 @@ groups:
9191
9292
- ref: gen_ai.system_instructions
9393
requirement_level: opt_in
94+
- ref: gen_ai.system_instructions_ref
95+
requirement_level:
96+
recommended: if applicable
9497
- ref: gen_ai.input.messages
9598
requirement_level: opt_in
99+
- ref: gen_ai.input.messages_ref
100+
requirement_level:
101+
recommended: if applicable
96102
- ref: gen_ai.output.messages
97103
requirement_level: opt_in
104+
- ref: gen_ai.output.messages_ref
105+
requirement_level:
106+
recommended: if applicable
98107
- ref: gen_ai.tool.definitions
99108
requirement_level: opt_in
100109

@@ -282,7 +291,6 @@ groups:
282291
- ref: gen_ai.output.messages
283292
requirement_level: opt_in
284293

285-
286294
- id: span.gen_ai.execute_tool.internal
287295
type: span
288296
stability: development

0 commit comments

Comments
 (0)