Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Update vertex_ai to vertex.ai #1684

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .chloggen/1684-vertex-ai.yaml
Original file line number Diff line number Diff line change
@@ -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:
3 changes: 2 additions & 1 deletion docs/attributes-registry/gen-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br>Replaced by `vertex.ai`. |

---

Expand Down
10 changes: 5 additions & 5 deletions docs/gen-ai/gen-ai-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down
10 changes: 5 additions & 5 deletions docs/gen-ai/gen-ai-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

---

Expand Down Expand Up @@ -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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down Expand Up @@ -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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down Expand Up @@ -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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down Expand Up @@ -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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down
2 changes: 1 addition & 1 deletion docs/gen-ai/gen-ai-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down
9 changes: 7 additions & 2 deletions model/gen-ai/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ groups:
stability: experimental
value: "openai"
brief: 'OpenAI'
- id: vertex_ai
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lmolkova do you know if we can also need to mark vertex_ai as deprecated? if so, how to make it? This is a value and not an attribute, did not find any example for this, thanks!

- id: vertex.ai
stability: experimental
value: "vertex_ai"
value: "vertex.ai"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find any evidence of just "Vertex" without "AI" in GCP's docs, so vertex_ai actually seems appropriate to me. I can't imagine any other vertex.* values.

If that reasoning holds water to keep it as vertex_ai, I can verify with the team.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we're here, should we prefix with gcp. like we have for some other vendors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, we can name it as gcp.vertex.ai or google.vertex.ai

Copy link
Contributor

@lmolkova lmolkova Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're really inconsistent in semconv on prefixing things with cloud name (not intentionally). General issue - #608

E.g. we have spanner and it's ok since there is just one spanner DB.
We have gcp_pubsub for messaging because pubsub is too generic. We also have some gcp.* attributes and resources.

Both vertex.ai or vertext_ai are unique enough - they don't have to have a prefix similarly to spanner. If we add prefix, it should be gcp.

So what should we do:

  1. spanner, vertex_ai, gcp_pubsub
  2. spanner, vertex_ai, gcp.pubsub
  3. gcp.spanner, gcp.vertex_ai, gcp.pubsub
  4. gcp_spanner, gcp_vertex_ai, gcp_pubsub
  5. ...
    ?

Speaking from Azure side, we're likely to stay where we are: cosmosdb, eventhubs, az.ai.inference (use product name when it's unique enough, use az. namespace when it's not). Reasons: it's nice to be consistent, but some of these things are de-facto stable and are used wide enough to make breaking really problematic.

cc @jsuereth if he has any thoughts

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the cloud.platform values which look like azure_functions, gcp_cloud_functions .

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm like 80% confident we can rename azure_functions to az.functions. Let me try

brief: 'Vertex AI'
- id: anthropic
stability: experimental
Expand All @@ -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
Expand Down
Loading