Skip to content

chore(ai-sdks): Document embedding spans - #20252

Open
alexander-alderman-webb wants to merge 4 commits into
masterfrom
webb/embedding-spans
Open

alexander-alderman-webb wants to merge 4 commits into
masterfrom
webb/embedding-spans

Conversation

@alexander-alderman-webb

Copy link
Copy Markdown
Contributor

Document embedding span requirements separately from chat spans.

@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 29, 2026 10:05pm UTC
sentry-docs Ready Ready Preview Oct 29, 2026 10:05pm UTC

Request Review

@github-actions github-actions Bot added sdk-develop-docs PRs touching develop-docs/sdk Priority: Needs Triage The PR description is missing valid priority information labels Oct 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown
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 @change-monitor in a comment to monitor it anyway.

Base automatically changed from webb/remove-requirement-level to master October 27, 2026 14:44
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"`)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Are the MAY, SHOULD, or MUST?

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

This branch was successfully deployed

1 active deployment
Preview – develop-docs — 2c451e48 Deployed Oct 27, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants