Update markdowns

open-telemetry · Jun 19, 2024 · 76c3814 · 76c3814
1 parent 65df716
commit 76c3814
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md
@@ -18,7 +18,7 @@ This document defines the attributes used to describe telemetry in the context o
 | `gen_ai.request.model`           | string   | The name of the LLM a request is being made to.                                                  | `gpt-4`                                                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `gen_ai.request.temperature`     | double   | The temperature setting for the LLM request.                                                     | `0.0`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `gen_ai.request.top_p`           | double   | The top_p sampling setting for the LLM request.                                                  | `1.0`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.request.stop`           | string[]   | List of sequences that the model will use to stop generating further tokens.                             | `['forest', 'lived']`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.request.stop_sequences`           | string[]   | List of sequences that the model will use to stop generating further tokens.                             | `['forest', 'lived']`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `gen_ai.request.top_k`           | double   | The top_k sampling setting for the LLM request.                                                  | `1.0`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `gen_ai.request.frequency_penalty`           | double   | The frequency penalty setting for the LLM request.                                                  | `1.0`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `gen_ai.request.presence_penalty`           | double   | The presence penalty setting for the LLM request.                                                  | `1.0`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md
@@ -10,9 +10,10 @@ linkTitle: Generative AI traces
 
 <!-- toc -->
 
-- [Configuration](#configuration)
-- [GenAI attributes](#genai-attributes)
-- [Events](#events)
+- [Semantic Conventions for GenAI operations](#semantic-conventions-for-genai-operations)
+  - [Configuration](#configuration)
+  - [GenAI attributes](#genai-attributes)
+  - [Events](#events)
 
 <!-- tocstop -->
 

diff --git a/model/registry/gen-ai.yaml b/model/registry/gen-ai.yaml
@@ -63,18 +63,18 @@ groups:
       - id: request.stop_sequences
         stability: experimental
         type: string[]
-        brief: The stop sequences provided in the request.
-        examples: ['\n']
+        brief: List of sequences that the model will use to stop generating further tokens.
+        examples: ['forest', 'lived']
       - id: request.frequency_penalty
         stability: experimental
         type: double
-        brief: The frequency penalty to provide.
+        brief: The frequency penalty setting for the LLM request.
         examples: [0.1]
         tag: llm-generic-request
       - id: request.presence_penalty
         stability: experimental
         type: double
-        brief: The presence penalty to provide.
+        brief: The presence penalty setting for the LLM request.
         examples: [0.1]
         tag: llm-generic-request
       - id: response.id