Introduce generic `gen_ai.output.type` instead of `gen_ai.openai.request.response_format` by lmolkova · Pull Request #1757 · open-telemetry/semantic-conventions

lmolkova · 2025-01-17T17:31:44Z

Response format today could only work for structured outputs, but it should be useful in multi-modal cases.
In this PR, the proposal is to capture modality in the gen_ai.output.type and have dedicated attributes to describe format for specific types such as gen_ai.output.json.schema.name.

E.g. for structured outputs gen_ai.output.type = json and gen_ai.output.json.schema.name = my_type_name.
For images it could be gen_ai.output.type = image, gen_ai.output.image.format = url.

See Cohere, Azure AI Inference, Vertex AI, Vertex AI docs

Also fixing a tiny bug where we have different id and value for completion token types and other minor nits.

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

aabmass

Vertex AI/Gemini also supports response schema. I'll take a look and see if it works with this PR

karthikscale3

LGTM

Co-authored-by: Trent Mick <trentm@gmail.com>

drewby

One fix, and a couple questions. Otherwise LGTM.

- Generate `semconv/v1.31.0` - Stop generating deprecated metric semconv similar to all other generation - Fix acronyms: - `ReplicationController` - `ResourceQuota` ## [`v1.31.0` semantic convention release notes](https://github.com/open-telemetry/semantic-conventions/releases/tag/v1.31.0): <h3>🛑 Breaking changes 🛑</h3> <ul> <li> <code>code</code>: <code>code.function.name</code> value should contain the fully qualified function name, <code>code.namespace</code> is now deprecated (<a href="open-telemetry/semantic-conventions#1677" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1677/hovercard">#1677</a>) </li> <li> <code>gen-ai</code>: Introduce <code>gen_ai.output.type</code>and deprecate <code>gen_ai.openai.request.response_format</code> (<a href="open-telemetry/semantic-conventions#1757" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1757/hovercard">#1757</a>) </li> <li> <code>mobile</code>: Rework <code>device.app.lifecycle</code> mobile event. (<a href="open-telemetry/semantic-conventions#1880" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1880/hovercard">#1880</a>) The <code>device.app.lifecycle</code> event has been reworked to use attributes instead of event body fields. The <code>ios.app.state</code> and <code>android.app.state</code> attributes have been reintroduced to the attribute registry. </li> <li> <code>system</code>: Move CPU-related system.cpu.* metrics to CPU namespace (<a href="open-telemetry/semantic-conventions#1873" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1873/hovercard">#1873</a>) </li> <li> <code>k8s</code>: Change k8s.replication_controller metrics to k8s.replicationcontroller (<a href="open-telemetry/semantic-conventions#1848" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1848/hovercard">#1848</a>) </li> <li> <code>db</code>: Rename <code>db.system</code> to <code>db.system.name</code> in database metrics, and update the values to be consistent with database spans. (<a href="open-telemetry/semantic-conventions#1581" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1581/hovercard">#1581</a>) </li> <li> <code>session</code>: Move <code>session.id</code> and <code>session.previous_id</code> from body fields to event attributes, and yamlize <code>session.start</code> and <code>session.end</code> events. (<a href="open-telemetry/semantic-conventions#1845" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1845/hovercard">#1845</a>) As part of the ongoing migration of event fields from LogRecord body to extended/complex attributes, the <code>session.start</code> and <code>session.end</code> events have been redefined. </li> </ul> <h3>💡 Enhancements 💡</h3> <ul> <li> <code>code</code>: Mark <code>code.*</code> semantic conventions as release candidate (<a href="open-telemetry/semantic-conventions#1377" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1377/hovercard">#1377</a>) </li> <li> <code>gen-ai</code>: Added AI Agent Semantic Convention (<a href="open-telemetry/semantic-conventions#1732" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1732/hovercard">#1732</a>, <a href="open-telemetry/semantic-conventions#1739" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1739/hovercard">#1739</a>) </li> <li> <code>db</code>: Add database-specific notes on db.operation.name and db.collection.name for Cassandra, Cosmos DB, HBase, MongoDB, and Redis, covering their batch/bulk terms and lack of cross-table queries. (<a href="open-telemetry/semantic-conventions#1863" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1863/hovercard">#1863</a>, <a href="open-telemetry/semantic-conventions#1573" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1573/hovercard">#1573</a>) </li> <li> <code>gen-ai</code>: Adds <code>gen_ai.request.choice.count</code> span attribute (<a href="open-telemetry/semantic-conventions#1888" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1888/hovercard">#1888</a>) Enables recording target number of completions to generate </li> <li> <code>enduser</code>: Undeprecate 'enduser.id' and introduce new attribute <code>enduser.pseudo.id</code> (<a href="open-telemetry/semantic-conventions#1104" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1104/hovercard">#1104</a>) The new attribute <code>enduser.pseudo.id</code> is intended to provide a unique identifier of a pseudonymous enduser. </li> <li> <code>k8s</code>: Add <code>k8s.hpa</code>, <code>k8s.resourcequota</code> and <code>k8s.replicationcontroller</code> attributes and resources (<a href="open-telemetry/semantic-conventions#1656" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1656/hovercard">#1656</a>) </li> <li> <code>k8s</code>: How to populate resource attributes based on attributes, labels and transformation (<a href="open-telemetry/semantic-conventions#236" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/236/hovercard">#236</a>) </li> <li> <code>process</code>: Adjust the semantic expectations for <code>process.executable.name</code> (<a href="open-telemetry/semantic-conventions#1736" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1736/hovercard">#1736</a>) </li> <li> <code>otel</code>: Adds SDK self-monitoring metrics for span processing (<a href="open-telemetry/semantic-conventions#1631" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1631/hovercard">#1631</a>) </li> <li> <code>cicd</code>: Adds a new attribute <code>cicd.pipeline.run.url.full</code> and corrects the attribute description of <code>cicd.pipeline.task.run.url.full</code> (<a href="open-telemetry/semantic-conventions#1796" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1796/hovercard">#1796</a>) </li> <li> <code>user-agent</code>: Add <code>user_agent.os.name</code> and <code>user_agent.os.version</code> attributes (<a href="open-telemetry/semantic-conventions#1433" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1433/hovercard">#1433</a>) </li> </ul> <h3>🧰 Bug fixes 🧰</h3> <ul> <li><code>process</code>: Fix units of process.open_file_descriptor.count and process.context_switches (<a href="open-telemetry/semantic-conventions#1662" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1662/hovercard">#1662</a>)</li> </ul> --------- Co-authored-by: Robert Pająk <pellared@hotmail.com>

lmolkova changed the title ~~Rename gen-ai.openai.request.response_format to gen-ai.request.response_format generic~~ Rename gen-ai.openai.request.response_format to gen-ai.request.response_format Jan 17, 2025

lmolkova marked this pull request as ready for review January 17, 2025 17:35

lmolkova requested review from a team as code owners January 17, 2025 17:35

lmolkova added area:gen-ai breaking labels Jan 17, 2025

aabmass reviewed Jan 17, 2025

View reviewed changes

karthikscale3 approved these changes Jan 17, 2025

View reviewed changes

trentm approved these changes Jan 17, 2025

View reviewed changes

Comment thread docs/attributes-registry/gen-ai.md Outdated

Comment thread .chloggen/1757.yaml Outdated

aabmass reviewed Jan 17, 2025

View reviewed changes

Comment thread docs/gen-ai/openai.md Outdated

aabmass mentioned this pull request Jan 17, 2025

GenAI capture json schema and tool schemas #1760

Open

lmolkova changed the title ~~Rename gen-ai.openai.request.response_format to gen-ai.request.response_format~~ Rename gen_ai.openai.request.response_format to gen_ai.request.response_format Jan 18, 2025

lmolkova mentioned this pull request Jan 18, 2025

Don't render deprecated enum members #1764

Merged

3 tasks

aabmass approved these changes Jan 22, 2025

View reviewed changes

Liudmila Molkova and others added 7 commits January 22, 2025 19:24

Make gen-ai.openai.request.response_format generic and clean ups

3dda66c

add respone format to common attributes

aa3ef14

changelog

37eddbc

nit

6ca5fdd

nit

0039379

Apply suggestions from code review

f522c83

Co-authored-by: Trent Mick <trentm@gmail.com>

break down response_format to output type and schema name

07f27d5

lmolkova requested review from aabmass, karthikscale3 and trentm January 23, 2025 05:44

TaoChenOSU approved these changes Jan 23, 2025

View reviewed changes

lmolkova force-pushed the gen-ai-response-format-generic branch from 5e574a5 to 07f27d5 Compare January 23, 2025 21:51

lmolkova requested a review from TaoChenOSU January 23, 2025 21:52

trentm reviewed Jan 24, 2025

View reviewed changes

Comment thread schema-next.yaml Outdated

Comment thread .chloggen/1757.yaml Outdated

lmolkova changed the title ~~Rename gen_ai.openai.request.response_format to gen_ai.request.response_format~~ Introduce gen_ai.output.type and gen_ai.output.json.schema.name to record response type and format. Deprecate gen_ai.openai.request.response_format Jan 27, 2025

undo schema-next change - this is not transformable anymore

ffc9507

up

a72c5ee

gyliu513 approved these changes Jan 28, 2025

View reviewed changes

aabmass reviewed Jan 28, 2025

View reviewed changes

Comment thread model/gen-ai/registry.yaml Outdated

drewby approved these changes Jan 28, 2025

View reviewed changes

Comment thread model/gen-ai/deprecated/registry-deprecated.yaml Outdated

Comment thread model/gen-ai/registry.yaml Outdated

Comment thread model/gen-ai/spans.yaml

feedback: deprecation and unnamed schema

43d97f3

aabmass approved these changes Jan 29, 2025

View reviewed changes

Comment thread model/gen-ai/registry.yaml Outdated

remove gen_ai.output.json.schema.name for now

23b8810

lmolkova changed the title ~~Introduce gen_ai.output.type and gen_ai.output.json.schema.name, deprecate gen_ai.openai.request.response_format~~ Introduce generic gen_ai.output.type instead of gen_ai.openai.request.response_format Jan 31, 2025

Merge branch 'main' into gen-ai-response-format-generic

a73c909

trask approved these changes Feb 1, 2025

View reviewed changes

Comment thread .chloggen/1757.yaml Outdated

Comment thread model/gen-ai/registry.yaml Outdated

Comment thread model/gen-ai/spans.yaml

Liudmila Molkova added 2 commits February 3, 2025 13:59

review

cb9b7a0

Merge branch 'main' into gen-ai-response-format-generic

1d25611

lmolkova merged commit dcb30bf into open-telemetry:main Feb 3, 2025

MrAlias mentioned this pull request Mar 20, 2025

Generate v1.31.0 semconv open-telemetry/opentelemetry-go#6479

Merged

SrdjanLL mentioned this pull request Apr 15, 2025

Add semconv-1.31.0 changes to openai instrumentation elastic/elastic-otel-python-instrumentations#77

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce generic `gen_ai.output.type` instead of `gen_ai.openai.request.response_format`#1757

Introduce generic `gen_ai.output.type` instead of `gen_ai.openai.request.response_format`#1757
lmolkova merged 14 commits intoopen-telemetry:mainfrom
lmolkova:gen-ai-response-format-generic

lmolkova commented Jan 17, 2025 •

edited

Loading

Uh oh!

aabmass left a comment

Uh oh!

karthikscale3 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

drewby left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

lmolkova commented Jan 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge requirement checklist

Uh oh!

aabmass left a comment

Choose a reason for hiding this comment

Uh oh!

karthikscale3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

drewby left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

lmolkova commented Jan 17, 2025 •

edited

Loading