Repository navigation
chore(ai-sdks): Document embedding spans - #20252
Open
alexander-alderman-webb wants to merge 4 commits into
Open
alexander-alderman-webb wants to merge 4 commits into
alexander-alderman-webb wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
sdk-develop-docs
Contributor
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
This information helps the Docs team prioritize your review. |
Contributor
|
Rollouts skipped this pull request: The pull request is documentation-only (a single develop-docs MDX file) in an application repo, which the criteria exclude from monitoring unless it is getsent… Mention |
alexander-alderman-webb
force-pushed
the
webb/embedding-spans
branch
from
October 27, 2026 14:53
3cd22f1 to
2c451e4
Compare
sentrivana
approved these changes
Oct 27, 2026
giortzisg
approved these changes
Oct 27, 2026
Comment on lines
+120
to
+123
| - Attribute `gen_ai.operation.name` **MUST** be `"embeddings"`. | ||
| - Attribute `gen_ai.provider.name` **MUST** be the Generative AI product as identified by the client or server instrumentation. (e.g. `"openai"`) | ||
| - Attribute `gen_ai.request.model` **MUST** be the requested model. (e.g. `"text-embedding-3-small"`) | ||
| - Attribute `gen_ai.response.model` **MUST** be the concrete response model. (e.g. `"text-embedding-3-small-001"`) |
Member
There was a problem hiding this comment.
Do these really need to be MUST-level requirements? E.g. what if the integration does not allow retrieving these values?
I would downgrade to SHOULD
| - If the request originates from an agent, the `gen_ai.agent.name` attribute **SHOULD** be set to the name of the agent. (e.g. `"Weather Agent"`) | ||
| - If relevant, the `gen_ai.pipeline.name` attribute **SHOULD** be set to the name of the AI workflow, pipeline or chain within which the agent operates. (e.g. `"weather-pipeline"`) | ||
|
|
||
| Additional attributes on the span: |
Member
There was a problem hiding this comment.
Are the MAY, SHOULD, or MUST?
This branch had an error being deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document embedding span requirements separately from chat spans.