Skip to content

[chore]fix formating of gen ai docs #3141

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[chore]fix formating of gen ai docs #3141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions docs/gen-ai/gen-ai-spans.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,14 +398,18 @@ Function: A tool executed on the client-side, where the agent generates paramete
Client-side operations are actions taken on the user's end or within the client application.
Datastore: A tool used by the agent to access and query structured or unstructured external data for retrieval-augmented tasks or knowledge updates.

**[4] `gen_ai.tool.call.arguments`:** > [!WARNING]
**[4] `gen_ai.tool.call.arguments`:**

> [!WARNING]
> This attribute may contain sensitive information.

It's expected to be an object - in case a serialized string is available
to the instrumentation, the instrumentation SHOULD do the best effort to
deserialize it to an object. When recorded on spans, it MAY be recorded as a JSON string if structured format is not supported and SHOULD be recorded in structured form otherwise.

**[5] `gen_ai.tool.call.result`:** > [!WARNING]
**[5] `gen_ai.tool.call.result`:**

> [!WARNING]
> This attribute may contain sensitive information.

It's expected to be an object - in case a serialized string is available
Expand Down
8 changes: 6 additions & 2 deletions docs/registry/attributes/gen-ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,18 @@ system instructions.
See [Recording content on attributes](/docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes)
section for more details.

**[10] `gen_ai.tool.call.arguments`:** > [!WARNING]
**[10] `gen_ai.tool.call.arguments`:**

> [!WARNING]
> This attribute may contain sensitive information.

It's expected to be an object - in case a serialized string is available
to the instrumentation, the instrumentation SHOULD do the best effort to
deserialize it to an object. When recorded on spans, it MAY be recorded as a JSON string if structured format is not supported and SHOULD be recorded in structured form otherwise.

**[11] `gen_ai.tool.call.result`:** > [!WARNING]
**[11] `gen_ai.tool.call.result`:**

> [!WARNING]
> This attribute may contain sensitive information.

It's expected to be an object - in case a serialized string is available
Expand Down
4 changes: 4 additions & 0 deletions model/gen-ai/registry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ groups:
type: any
brief: Parameters passed to the tool call.
note: |


> [!WARNING]
Copy link
Member

@trask trask Nov 27, 2025

Choose a reason for hiding this comment

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

This seems fragile, any other options?

Copy link
Contributor Author

@thompson-tomo thompson-tomo Nov 27, 2025

Choose a reason for hiding this comment

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

Agree and it didn't end up working due to trimming. If we could add text before the note we would be fine. Hence have asked the gen-ai folks on slack for input.

> This attribute may contain sensitive information.

Expand All @@ -279,6 +281,8 @@ groups:
type: any
brief: The result returned by the tool call (if any and if execution was successful).
note: |


> [!WARNING]
> This attribute may contain sensitive information.

Expand Down
Loading