Extend GenAI system well-known values (#1020)

open-telemetry · Jun 4, 2024 · a2c9cff · a2c9cff
1 parent ec6366d
commit a2c9cff
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 3 deletions.
diff --git a/.chloggen/extend-gen-ai-system-values.yaml b/.chloggen/extend-gen-ai-system-values.yaml
@@ -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:
diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md
@@ -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.
 
-| Value    | Description | Stability                                                        |
-| -------- | ----------- | ---------------------------------------------------------------- |
-| `openai` | OpenAI      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| 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) |
+| `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.
 

diff --git a/docs/gen-ai/gen-ai-metrics.md b/docs/gen-ai/gen-ai-metrics.md
@@ -87,7 +87,10 @@ This metric SHOULD be specified with [ExplicitBucketBoundaries] of [1, 4, 16, 64
 
 | 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) |
+| `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.
@@ -167,7 +170,10 @@ Instrumentations SHOULD document the list of errors they report.
 
 | 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) |
+| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 

diff --git a/docs/gen-ai/llm-spans.md b/docs/gen-ai/llm-spans.md
@@ -68,7 +68,10 @@ These attributes track input data and metadata for a request to an LLM. Each att
 
 | 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) |
+| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 

diff --git a/model/registry/gen-ai.yaml b/model/registry/gen-ai.yaml
@@ -14,6 +14,18 @@ groups:
               stability: experimental
               value: "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.
         note: >
           The actual GenAI product may differ from the one identified by the client.