update documentation

Author: keith-decker

util/opentelemetry-util-genai/README.rst

@@ -1,21 +1,42 @@
 OpenTelemetry Util for GenAI
-=======================
+============================
 
 
 The GenAI Utils package will include boilerplate and helpers to standardize instrumentation for Generative AI. 
 This package will provide APIs and decorators to minimize the work needed to instrument genai libraries, 
 while providing standardization for generating both types of otel, "spans and metrics" and "spans, metrics and events"
 
 This package provides these span attributes.
--> gen_ai.operation.name: Str(chat)
 -> gen_ai.provider.name: Str(openai)
--> gen_ai.system: Str(ChatOpenAI)
+-> gen_ai.operation.name: Str(chat)
+-> gen_ai.framework: Str(langchain)
+-> gen_ai.system: Str(openai) # deprecated
 -> gen_ai.request.model: Str(gpt-3.5-turbo)
 -> gen_ai.response.finish_reasons: Slice(["stop"])
 -> gen_ai.response.model: Str(gpt-3.5-turbo-0125)
 -> gen_ai.response.id: Str(chatcmpl-Bz8yrvPnydD9pObv625n2CGBPHS13)
 -> gen_ai.usage.input_tokens: Int(24)
 -> gen_ai.usage.output_tokens: Int(7)
+-> gen_ai.input.messages: Str("[{\"role\": \"user\", \"content\": \"hello world\"}]")
+
+
+This package also provides these metric attributes.
+Token Usage Metrics:
+-> gen_ai.provider.name: Str(openai)
+-> gen_ai.operation.name: Str(chat)
+-> gen_ai.framework: Str(langchain)
+-> gen_ai.request.model: Str(gpt-3.5-turbo)
+-> gen_ai.response.model: Str(gpt-3.5-turbo-0125)
+-> gen_ai.usage.input_tokens: Int(24)
+-> gen_ai.usage.output_tokens: Int(7)
+-> gen_ai.token.type: Str(input|output)
+
+Duration Metrics:
+-> gen_ai.provider.name: Str(openai)
+-> gen_ai.operation.name: Str(chat)
+-> gen_ai.framework: Str(langchain)
+-> gen_ai.request.model: Str(gpt-3.5-turbo)
+-> gen_ai.response.model: Str(gpt-3.5-turbo-0125)
 
 Installation
 ------------

util/opentelemetry-util-genai/tests/test_utils.py

@@ -71,7 +71,8 @@ def test_llm_start_and_stop_creates_span(
     # Add more attribute checks as needed
 
     # Verify span timing
-    assert span.start_time > 0
+    assert span.start_time is not None
+    assert span.end_time is not None
     assert span.end_time > span.start_time
 
     # Verify invocation data