Skip to content

Commit

Permalink
lint and toc
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Sep 5, 2024
1 parent a000714 commit 7f5a4df
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/gen-ai/gen-ai-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ linkTitle: Generative AI events

<!-- toc -->

- [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)
Expand Down Expand Up @@ -93,7 +93,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`.
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## 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
Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand Down

0 comments on commit 7f5a4df

Please sign in to comment.