diff --git a/.chloggen/1684-vertex-ai.yaml b/.chloggen/1684-vertex-ai.yaml new file mode 100644 index 0000000000..3afd6c77df --- /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: deprecation + +# 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: diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md index 6606150d2e..c31984adc5 100644 --- a/docs/attributes-registry/gen-ai.md +++ b/docs/attributes-registry/gen-ai.md @@ -70,7 +70,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `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`. | --- diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index 4c12ee55d5..f4b0981a16 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -87,7 +87,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -142,7 +142,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -197,7 +197,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -267,7 +267,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **Body fields:** @@ -323,7 +323,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![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 f47e0b2280..842e958e64 100644 --- a/docs/gen-ai/gen-ai-metrics.md +++ b/docs/gen-ai/gen-ai-metrics.md @@ -107,7 +107,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | --- @@ -200,7 +200,7 @@ Instrumentations SHOULD document the list of errors they report. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -291,7 +291,7 @@ Instrumentations SHOULD document the list of errors they report. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -369,7 +369,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -446,7 +446,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![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 70c8d3d5bf..c4953b913b 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -120,7 +120,7 @@ Instrumentations SHOULD document the list of errors they report. | `cohere` | Cohere | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![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) | +| `vertex.ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/gen-ai/registry.yaml b/model/gen-ai/registry.yaml index 918b0a2f21..aede99db1e 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: anthropic stability: experimental @@ -37,6 +37,11 @@ groups: stability: experimental value: "aws.bedrock" brief: 'AWS Bedrock' + - 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: | The `gen_ai.system` describes a family of GenAI models with specific model identified