clean up and add gen-ai specific temp attribute for payload

open-telemetry · May 29, 2024 · dbf10e0 · dbf10e0
1 parent 2a30cab
commit dbf10e0
Show file tree

Hide file tree

Showing 6 changed files with 137 additions and 108 deletions.
diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md
@@ -10,28 +10,23 @@
 
 This document defines the attributes used to describe telemetry in the context of LLM (Large Language Models) requests and responses.
 
-| Attribute                        | Type   | Description                                                                | Examples                                                                | Stability                                                        |
-| -------------------------------- | ------ | -------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `gen_ai.completion`              | string | The full response received from the LLM. [1]                               | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.operation.name`          | string | The name of the operation being performed.                                 | `chat`; `completion`                                                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.prompt`                  | string | The full prompt sent to an LLM. [2]                                        | `[{'role': 'user', 'content': 'What is the capital of France?'}]`       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.request.max_tokens`      | int    | The maximum number of tokens the LLM generates for a request.              | `100`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `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.response.finish_reason`  | string | The reason the model stopped generating tokens.                            | `stop`; `content_filter`; `tool_calls`                                  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.response.id`             | string | The unique identifier for the completion.                                  | `chatcmpl-123`                                                          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.response.model`          | string | The name of the LLM a response was generated from.                         | `gpt-4-0613`                                                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.system`                  | string | The Generative AI product as identified by the client instrumentation. [3] | `openai`                                                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.token.type`              | string | The type of token being counted.                                           | `input`; `output`                                                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.usage.completion_tokens` | int    | The number of tokens used in the LLM response (completion).                | `180`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `gen_ai.usage.prompt_tokens`     | int    | The number of tokens used in the LLM prompt.                               | `100`                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
-**[1]:** It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation)
-
-**[2]:** It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation)
-
-**[3]:** The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge.
+| Attribute                        | Type   | Description                                                                | Examples                                                          | Stability                                                        |
+| -------------------------------- | ------ | -------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `gen_ai.event.content`           | string | The GenAI event payload serialized into JSON string.                       | `[{'content': 'What is the capital of France?'}]`; `plain string` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.operation.name`          | string | The name of the operation being performed.                                 | `chat`; `completion`                                              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.request.max_tokens`      | int    | The maximum number of tokens the LLM generates for a request.              | `100`                                                             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `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.response.finish_reason`  | string | The reason the model stopped generating tokens.                            | `stop`; `content_filter`; `tool_calls`                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.response.id`             | string | The unique identifier for the completion.                                  | `chatcmpl-123`                                                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.response.model`          | string | The name of the LLM a response was generated from.                         | `gpt-4-0613`                                                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.system`                  | string | The Generative AI product as identified by the client instrumentation. [1] | `openai`                                                          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.token.type`              | string | The type of token being counted.                                           | `input`; `output`                                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.usage.completion_tokens` | int    | The number of tokens used in the LLM response (completion).                | `180`                                                             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen_ai.usage.prompt_tokens`     | int    | The number of tokens used in the LLM prompt.                               | `100`                                                             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+**[1]:** The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge.
 
 `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
 

diff --git a/docs/attributes-registry/llm.md b/docs/attributes-registry/llm.md
@@ -24,25 +24,6 @@ linkTitle: LLM
 <!-- markdownlint-capture -->
 <!-- markdownlint-disable -->
 
-| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
-|---|---|---|---|---|---|
-| [`gen_ai.request.max_tokens`](/docs/attributes-registry/.md) | int | The maximum number of tokens the LLM generates for a request. | `100` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.request.model`](/docs/attributes-registry/.md) | string | The name of the LLM a request is being made to. | `gpt-4` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.request.temperature`](/docs/attributes-registry/.md) | double | The temperature setting for the LLM request. | `0.0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.request.top_p`](/docs/attributes-registry/.md) | double | The top_p sampling setting for the LLM request. | `1.0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.system`](/docs/attributes-registry/.md) | string | The Generative AI product as identified by the client instrumentation. [1] | `openai` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
-**[1]:** The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge.
-
-
-
-`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
-
-| Value  | Description | Stability |
-|---|---|---|
-| `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
-
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
@@ -60,10 +41,7 @@ linkTitle: LLM
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`gen_ai.response.id`](/docs/attributes-registry/.md) | string | The unique identifier for the completion. | `chatcmpl-123` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.response.model`](/docs/attributes-registry/.md) | string | The name of the LLM a response was generated from. | `gpt-4-0613` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`gen_ai.usage.completion_tokens`](/docs/attributes-registry/.md) | int | The number of tokens used in the LLM response (completion). | `180` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.usage.prompt_tokens`](/docs/attributes-registry/.md) | int | The number of tokens used in the LLM prompt. | `100` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -80,17 +58,6 @@ linkTitle: LLM
 <!-- markdownlint-capture -->
 <!-- markdownlint-disable -->
 
-| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
-|---|---|---|---|---|---|
-| [`gen_ai.completion`](/docs/attributes-registry/.md) | string | The full response received from the LLM. [1] | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`gen_ai.prompt`](/docs/attributes-registry/.md) | string | The full prompt sent to an LLM. [2] | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
-**[1]:** It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation)
-
-**[2]:** It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation)
-
-
-
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->

diff --git a/docs/gen-ai/README.md b/docs/gen-ai/README.md
@@ -10,12 +10,13 @@ path_base_for_github_subdir:
 **Status**: [Experimental][DocumentStatus]
 
 **Warning**:
-The semantic conventions for GenAI and LLM are currently in development.
+The semantic conventions for GenAI are currently in development.
 We encourage instrumentation libraries and telemetry consumers developers to
 use the conventions in limited non-critical workloads and share the feedback
 
-This document defines semantic conventions for the following kind of Generative AI systems:
+Semantic conventions for Generative AI operations are defined for the following signals:
 
+<<<<<<< HEAD
 * LLMs
 
 Semantic conventions for Generative AI operations are defined for the following signals:
@@ -25,5 +26,8 @@ Semantic conventions for Generative AI operations are defined for the following
 Semantic conventions for LLM operations are defined for the following signals:
 
 * [LLM Spans](llm-spans.md): Semantic Conventions for LLM requests - *spans*.
+=======
+* [Generative AI Spans](llm-spans.md): Semantic Conventions for Generative AI *spans*.
+>>>>>>> 1d913bc7 (clean up and add gen-ai specific temp attribute for payload)
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md