open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Extend GenAI system well-known values (#1020)

This commit is contained in:
Tao Chen 2024-06-04 09:14:17 -07:00 committed by GitHub
parent ec6366d259
commit a2c9cff852
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 49 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
.chloggen/extend-gen-ai-system-values.yaml Executable file
View File

@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: gen-ai
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add 3 well-known gen-ai systems as reference values of the gen-ai system attribute
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [ 1020 ]
# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

9
docs/attributes-registry/gen-ai.md
View File

@ -35,9 +35,12 @@ This document defines the attributes used to describe telemetry in the context o
`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability | | Value | Description | Stability |
| -------- | ----------- | ---------------------------------------------------------------- | | ----------- | ----------- | ---------------------------------------------------------------- |
| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `anthropic` | Anthropic | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. `gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

6
docs/gen-ai/gen-ai-metrics.md
View File

@ -87,7 +87,10 @@ This metric SHOULD be specified with [ExplicitBucketBoundaries] of [1, 4, 16, 64
| Value | Description | Stability | | Value | Description | Stability |
|---|---|---| |---|---|---|
| `anthropic` | Anthropic | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. `gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
@ -167,7 +170,10 @@ Instrumentations SHOULD document the list of errors they report.
| Value | Description | Stability | | Value | Description | Stability |
|---|---|---| |---|---|---|
| `anthropic` | Anthropic | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

3
docs/gen-ai/llm-spans.md
View File

@ -68,7 +68,10 @@ These attributes track input data and metadata for a request to an LLM. Each att
| Value | Description | Stability | | Value | Description | Stability |
|---|---|---| |---|---|---|
| `anthropic` | Anthropic | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

12
model/registry/gen-ai.yaml
View File

@ -14,6 +14,18 @@ groups:
stability: experimental stability: experimental
value: "openai" value: "openai"
brief: 'OpenAI' brief: 'OpenAI'
- id: vertex_ai
stability: experimental
value: "vertex_ai"
brief: 'Vertex AI'
- id: anthropic
stability: experimental
value: "anthropic"
brief: 'Anthropic'
- id: cohere
stability: experimental
value: "cohere"
brief: 'Cohere'
brief: The Generative AI product as identified by the client instrumentation. brief: The Generative AI product as identified by the client instrumentation.
note: > note: >
The actual GenAI product may differ from the one identified by the client. The actual GenAI product may differ from the one identified by the client.