Skip to content

docs(genai): clarify standalone library usage and manual examples #294

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

Merged
sipercai merged 2 commits into from
Oct 29, 2026
Merged

docs(genai): clarify standalone library usage and manual examples #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1119de8
docs(genai): correct manual instrumentation examples
sipercai Oct 29, 2026
ed97ede
docs(genai): describe standalone SDK usage
sipercai Oct 29, 2026
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
27 changes: 27 additions & 0 deletions docs/instrumentation-genai/util.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
OpenTelemetry Python - GenAI Util
=================================

.. LoongSuite Extension: link the manual guide and expose the extended public API.

.. rstcheck: ignore-directives=autoclass,autofunction

GenAI Utils is a standalone library that uses application-configured OpenTelemetry
providers and exporters. For installation, runnable examples, field mappings, custom
attributes, and content/context configuration, see the
`LoongSuite manual instrumentation guide <https://github.com/alibaba/loongsuite-python/blob/main/util/opentelemetry-util-genai/README-loongsuite.rst>`_.

.. automodule:: opentelemetry.util.genai
:members:
:undoc-members:
Expand Down Expand Up @@ -29,3 +38,21 @@ OpenTelemetry Python - GenAI Util
.. automodule:: opentelemetry.util.genai._upload
:members:
:show-inheritance:

LoongSuite extended API
----------------------------------------

.. autoclass:: opentelemetry.util.genai.extended_handler.ExtendedTelemetryHandler
:members:
:no-show-inheritance:

.. autofunction:: opentelemetry.util.genai.extended_handler.get_extended_telemetry_handler

.. automodule:: opentelemetry.util.genai.extended_types
:members:
:undoc-members:
:show-inheritance:

.. automodule:: opentelemetry.util.genai.extended_memory
:members: MemoryInvocation
:show-inheritance:
8 changes: 8 additions & 0 deletions util/opentelemetry-util-genai/CHANGELOG-loongsuite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

### Fixed

- Correct rerank field names and standardize manual instrumentation examples on
explicit Invocation objects. Document custom attribute boundaries, content and
event coverage, Provider setup, context lifetimes, and version troubleshooting.
Present GenAI Utils as a standalone library configured through the OpenTelemetry
SDK, with optional storage backends separate from the setup guide.

## Version 0.9.0 (2026-09-07)

There are no changelog entries for this release.
Expand Down
Loading
Loading