From 7f5a4df1c69a5505ac83f91eb72932386fb61b38 Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Thu, 5 Sep 2024 13:37:20 -0700 Subject: [PATCH] lint and toc --- docs/gen-ai/gen-ai-events.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index 2b40ab07bd..824042573f 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -10,16 +10,16 @@ linkTitle: Generative AI events -- [Naming pattern](#naming-pattern) - [Common attributes](#common-attributes) -- [System message](#system-message) -- [User message](#user-message) -- [Assistant message](#assistant-message) +- [System event](#system-event) +- [User event](#user-event) +- [Assistant event](#assistant-event) - [`ToolCall` object](#toolcall-object) - [`Function` object](#function-object) -- [Tool message](#tool-message) -- [Choice message](#choice-message) +- [Tool event](#tool-event) +- [Choice event](#choice-event) - [`Message` object](#message-object) +- [Custom events](#custom-events) - [Examples](#examples) - [Chat completion](#chat-completion) - [Tools](#tools) @@ -93,7 +93,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. -## System message +## System event This event describes the instructions passed to the GenAI model. It's NOT RECOMMENDED to report this event when capturing content is disabled, unless there are additional system-specific fields @@ -105,7 +105,7 @@ The event name MUST be `gen_ai.system.message`. |---|---|---|---|---| | `content` | `AnyValue` | The contents of the system message. | `"You're a friendly bot that answers questions about OpenTelemetry."` | `Opt-In` | -## User message +## User event This event describes the prompt message specified by the user. @@ -115,7 +115,7 @@ The event name MUST be `gen_ai.user.message`. |---|---|---|---|---| | `content` | `AnyValue` | The contents of the user message. | `What telemetry is reported by OpenAI instrumentations?` | `Opt-In` | -## Assistant message +## Assistant event This event describes the assistant message. @@ -141,7 +141,7 @@ The event name MUST be `gen_ai.assistant.message`. | `name` | string | The name of the function to call | `get_link_to_otel_semconv` | `Required` | | `arguments` | `AnyValue` | The arguments to pass the the function | `{"semconv": "gen_ai"}` | `Opt-In` | -## Tool message +## Tool event This event describes the output of the tool or function submitted back to the model.