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

GenAI events - yamlify body definitions and cosmetic examples improvements #1469

Merged
merged 12 commits into from
Dec 12, 2024

Conversation

lmolkova
Copy link
Contributor

@lmolkova lmolkova commented Oct 11, 2024

  • Adds yaml definitions for GenAI events in preparation for Render events with bodies #1464
  • Updates examples to be more concise and readable, fixes small inconsistencies, adds diagrams.

Merge requirement checklist

@lmolkova lmolkova requested review from a team as code owners October 11, 2024 01:58
@lmolkova lmolkova changed the title GenAI event examples - cosmetic improvements GenAI events - yamlify body definitions and cosmetic examples improvements Oct 11, 2024
@lmolkova lmolkova force-pushed the gen-ai-events-improvements branch from e225e77 to c62aa16 Compare October 18, 2024 22:16
@lmolkova lmolkova requested a review from a team as a code owner October 18, 2024 22:32
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Nov 16, 2024
@lmolkova lmolkova removed the Stale label Nov 18, 2024
@lmolkova lmolkova force-pushed the gen-ai-events-improvements branch from 18ff568 to 24b7a60 Compare December 9, 2024 01:36
@lmolkova lmolkova requested a review from a team as a code owner December 9, 2024 01:36
Copy link
Contributor

@codefromthecrypt codefromthecrypt left a comment

Choose a reason for hiding this comment

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

thanks

Copy link
Member

@drewby drewby left a comment

Choose a reason for hiding this comment

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

Overall looks good. While the examples at the end of the markdown help clarify, I think the short descriptions of the input messages by role can be clearer.

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

Reviewing for general semconv.

Overall, glad we can now put the ToolCall structure/semantics in the YAML. I think this is a good first step.

I do think seeing the hierarchy with the spaces in markdown still leaves a bit wanting. I'm not sure what options we have with markdown here, unfortunately.

I like the look of what prometheus docs have done here but this requires dropping into HTML table land, and it ruins the readabiltiy of the markdown by itself. That may be ok if it's autogenerated.

@lmolkova
Copy link
Contributor Author

I do think seeing the hierarchy with the spaces in markdown still leaves a bit wanting. I'm not sure what options we have with markdown here, unfortunately.

We could switch to (pseudo) code or some form of JSON, I've heard you like designing languages, @jsuereth :)

@lmolkova lmolkova force-pushed the gen-ai-events-improvements branch from 24b7a60 to 557b99d Compare December 12, 2024 04:01
Copy link
Member

@drewby drewby left a comment

Choose a reason for hiding this comment

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

Looks good!

@lmolkova lmolkova merged commit abd92c1 into open-telemetry:main Dec 12, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

9 participants