From 3179b34552b6c519aca76fb9bcdfdd58d4c9126e Mon Sep 17 00:00:00 2001 From: Guangya Liu Date: Sat, 14 Dec 2024 10:31:21 -0500 Subject: [PATCH 1/3] [chore] Update vertex_ai to vertex.ai Signed-off-by: Guangya Liu --- docs/attributes-registry/gen-ai.md | 3 ++- docs/gen-ai/gen-ai-events.md | 10 +++++----- docs/gen-ai/gen-ai-metrics.md | 10 +++++----- docs/gen-ai/gen-ai-spans.md | 2 +- model/gen-ai/registry.yaml | 9 +++++++-- 5 files changed, 20 insertions(+), 14 deletions(-) diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md index 61a0b08cce..05af2d629f 100644 --- a/docs/attributes-registry/gen-ai.md +++ b/docs/attributes-registry/gen-ai.md @@ -79,7 +79,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex_ai` | Deprecated. Use `vertex.ai` instead. | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vertex.ai`. | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | --- diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index b43bb2578f..cc0f60e7cb 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -94,7 +94,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -157,7 +157,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -220,7 +220,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -298,7 +298,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -362,7 +362,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** diff --git a/docs/gen-ai/gen-ai-metrics.md b/docs/gen-ai/gen-ai-metrics.md index ac473e6c76..c581bd8f77 100644 --- a/docs/gen-ai/gen-ai-metrics.md +++ b/docs/gen-ai/gen-ai-metrics.md @@ -114,7 +114,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | --- @@ -215,7 +215,7 @@ Instrumentations SHOULD document the list of errors they report. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -314,7 +314,7 @@ Instrumentations SHOULD document the list of errors they report. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -400,7 +400,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -485,7 +485,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md index 24a70cade6..8939f3c9b5 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -128,7 +128,7 @@ Instrumentations SHOULD document the list of errors they report. | `ibm.watsonx.ai` | IBM Watsonx AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `perplexity` | Perplexity | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `xai` | xAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/gen-ai/registry.yaml b/model/gen-ai/registry.yaml index 09c36698e4..abb8a6f121 100644 --- a/model/gen-ai/registry.yaml +++ b/model/gen-ai/registry.yaml @@ -13,9 +13,9 @@ groups: stability: experimental value: "openai" brief: 'OpenAI' - - id: vertex_ai + - id: vertex.ai stability: experimental - value: "vertex_ai" + value: "vertex.ai" brief: 'Vertex AI' - id: gemini stability: experimental @@ -61,6 +61,11 @@ groups: stability: experimental value: "groq" brief: 'Groq' + - id: vertex_ai + stability: experimental + value: "vertex_ai" + brief: 'Deprecated. Use `vertex.ai` instead.' + deprecated: "Replaced by `vertex.ai`." brief: The Generative AI product as identified by the client or server instrumentation. note: | From 61cb2e807b2b2577de341d2d8131362c4e9600ed Mon Sep 17 00:00:00 2001 From: Guangya Liu Date: Sun, 15 Dec 2024 21:58:58 -0500 Subject: [PATCH 2/3] Added changelog --- .chloggen/1684-vertex-ai.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .chloggen/1684-vertex-ai.yaml diff --git a/.chloggen/1684-vertex-ai.yaml b/.chloggen/1684-vertex-ai.yaml new file mode 100644 index 0000000000..4e7473e99e --- /dev/null +++ b/.chloggen/1684-vertex-ai.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: Update vertex_ai to vertex.ai + +# 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: [1684] + +# (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: From 3beb495bed7c84b7669bba87df97d699dbb68390 Mon Sep 17 00:00:00 2001 From: Guangya Liu Date: Mon, 16 Dec 2024 08:38:46 -0800 Subject: [PATCH 3/3] updated changelog to deprecation --- .chloggen/1684-vertex-ai.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/1684-vertex-ai.yaml b/.chloggen/1684-vertex-ai.yaml index 4e7473e99e..3afd6c77df 100644 --- a/.chloggen/1684-vertex-ai.yaml +++ b/.chloggen/1684-vertex-ai.yaml @@ -4,7 +4,7 @@ # your pull request title with [chore] or use the "Skip Changelog" label. # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' -change_type: enhancement +change_type: deprecation # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) component: gen_ai