Regenerate markdown based on yaml model

traceloop · Jan 29, 2024 · c80b80c · c80b80c
1 parent fd57c6c
commit c80b80c
Show file tree

Hide file tree

Showing 4 changed files with 96 additions and 105 deletions.
diff --git a/docs/ai/llm-spans.md b/docs/ai/llm-spans.md
@@ -12,7 +12,6 @@ linkTitle: LLM Calls
 
 - [Configuration](#configuration)
 - [LLM Request attributes](#llm-request-attributes)
-- [LLM Response attributes](#llm-response-attributes)
 - [Events](#events)
 
 <!-- tocstop -->
@@ -36,65 +35,52 @@ By default, these configurations SHOULD NOT capture prompts and completions.
 
 These attributes track input data and metadata for a request to an LLM. Each attribute represents a concept that is common to most LLMs.
 
-<!-- semconv ai(tag=llm-request) -->
+<!-- semconv llm.request -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `llm.vendor` | string | The name of the LLM foundation model vendor, if applicable. If not using a vendor-supplied model, this field is left blank. | `openai` | Recommended |
-| `llm.request.model` | string | The name of the LLM a request is being made to. If the LLM is supplied by a vendor, then the value must be the exact name of the model requested. If the LLM is a fine-tuned custom model, the value SHOULD have a more specific name than the base model that's been fine-tuned. | `gpt-4` | Required |
-| `llm.request.max_tokens` | int | The maximum number of tokens the LLM generates for a request. | `100` | Recommended |
-| `llm.temperature` | float | The temperature setting for the LLM request. | `0.0` | Recommended |
-| `llm.top_p` | float | The top_p sampling setting for the LLM request. | `1.0` | Recommended |
-| `llm.stream` | bool | Whether the LLM responds with a stream. | `false` | Recommended |
-| `llm.stop_sequences` | array | Array of strings the LLM uses as a stop sequence. | `["stop1"]` | Recommended |
-
-`llm.model` 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 |
-|---|---|
-| `gpt-4` | GPT-4 |
-| `gpt-4-32k` | GPT-4 with 32k context window |
-| `gpt-3.5-turbo` | GPT-3.5-turbo |
-| `gpt-3.5-turbo-16k` | GPT-3.5-turbo with 16k context window|
-| `claude-instant-1` | Claude Instant (latest version) |
-| `claude-2` | Claude 2 (latest version) |
-| `other-llm` | Any LLM not listed in this table. Use for any fine-tuned version of a model. |
+| [`llm.request.is_stream`](../attributes-registry/llm.md) | boolean | Whether the LLM responds with a stream. | `False` | Recommended |
+| [`llm.request.max_tokens`](../attributes-registry/llm.md) | int | The maximum number of tokens the LLM generates for a request. | `100` | Recommended |
+| [`llm.request.model`](../attributes-registry/llm.md) | string | The name of the LLM a request is being made to. [1] | `gpt-4` | Required |
+| [`llm.request.stop_sequences`](../attributes-registry/llm.md) | string | Array of strings the LLM uses as a stop sequence. | `stop1` | Recommended |
+| [`llm.request.temperature`](../attributes-registry/llm.md) | double | The temperature setting for the LLM request. | `0.0` | Recommended |
+| [`llm.request.top_p`](../attributes-registry/llm.md) | double | The top_p sampling setting for the LLM request. | `1.0` | Recommended |
+| [`llm.response.finish_reason`](../attributes-registry/llm.md) | string | The reason the model stopped generating tokens. | `stop` | Recommended |
+| [`llm.response.id`](../attributes-registry/llm.md) | string[] | The unique identifier for the completion. | `[chatcmpl-123]` | Recommended |
+| [`llm.response.model`](../attributes-registry/llm.md) | string | The name of the LLM a response is being made to. [2] | `gpt-4-0613` | Required |
+| [`llm.system`](../attributes-registry/llm.md) | string | The name of the LLM foundation model vendor, if applicable. [3] | `openai` | Recommended |
+| [`llm.usage.completion_tokens`](../attributes-registry/llm.md) | int | The number of tokens used in the LLM response (completion). | `180` | Recommended |
+| [`llm.usage.prompt_tokens`](../attributes-registry/llm.md) | int | The number of tokens used in the LLM prompt. | `100` | Recommended |
+| [`llm.usage.total_tokens`](../attributes-registry/llm.md) | int | The total number of tokens used in the LLM prompt and response. | `280` | Recommended |
+
+**[1]:** The name of the LLM a request is being made to. If the LLM is supplied by a vendor, then the value must be the exact name of the model requested. If the LLM is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
+
+**[2]:** The name of the LLM a response is being made to. If the LLM is supplied by a vendor, then the value must be the exact name of the model actually used. If the LLM is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
+
+**[3]:** The name of the LLM foundation model vendor, if applicable. If not using a vendor-supplied model, this field is left blank.
 <!-- endsemconv -->
 
-## LLM Response attributes
+## Events
+
+In the lifetime of an LLM span, an event for prompts sent and completions received MAY be created, depending on the configuration of the instrumentation.
 
-These attributes track output data and metadata for a response from an LLM. Each attribute represents a concept that is common to most LLMs.
+<!-- semconv llm.content.prompt -->
+The event name MUST be `llm.content.prompt`.
 
-<!-- semconv ai(tag=llm-response) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `llm.response.id` | string | The unique identifier for the completion. | `chatcmpl-123` | Recommended |
-| `llm.response.model` | string | The name of the LLM a response is being made to. If the LLM is supplied by a vendor, then the value must be the exact name of the model actually used. If the LLM is a fine-tuned custom model, the value SHOULD have a more specific name than the base model that's been fine-tuned. | `gpt-4-0613` | Required |
-| `llm.response.finish_reason` | string | The reason the model stopped generating tokens | `stop` | Recommended |
-| `llm.usage.prompt_tokens` | int | The number of tokens used in the LLM prompt. | `100` | Recommended |
-| `llm.usage.completion_tokens` | int | The number of tokens used in the LLM response (completion). | `180` | Recommended |
-| `llm.usage.total_tokens` | int | The total number of tokens used in the LLM prompt and response. | `280` | Recommended |
-
-`llm.response.finish_reason` MUST be one of the following:
-
-| Value  | Description |
-|---|---|
-| `stop` | If the model hit a natural stop point or a provided stop sequence. |
-| `max_tokens` | If the maximum number of tokens specified in the request was reached. |
-| `tool_call` | If a function / tool call was made by the model (for models that support such functionality). |
-<!-- endsemconv -->
+| [`llm.prompt`](../attributes-registry/llm.md) | string | The full prompt string sent to an LLM in a request. [1] | `\\n\\nHuman:You are an AI assistant that tells jokes. Can you tell me a joke about OpenTelemetry?\\n\\nAssistant:` | Recommended |
 
-## Events
+**[1]:** The full prompt string sent to an LLM in a request. If the LLM accepts a more complex input like a JSON object, this field is blank, and the response is instead captured in an event determined by the specific LLM technology semantic convention.
+<!-- endsemconv -->
 
-In the lifetime of an LLM span, an event for prompts sent and completions received MAY be created, depending on the configuration of the instrumentation.
+<!-- semconv llm.content.completion -->
+The event name MUST be `llm.content.completion`.
 
-<!-- semconv ai(tag=llm-prompt) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
-| `llm.prompt` | string | The full prompt string sent to an LLM in a request. If the LLM accepts a more complex input like a JSON object made up of several pieces (such as OpenAI's different message types), this field is blank, and the response is instead captured in an event determined by the specific LLM technology semantic convention. | `\n\nHuman:You are an AI assistant that tells jokes. Can you tell me a joke about OpenTelemetry?\n\nAssistant:` | Recommended |
-<!-- endsemconv -->
+|---|---|---|---|---|
+| [`llm.completion`](../attributes-registry/llm.md) | string | The full response string from an LLM in a response. [1] | `Why did the developer stop using OpenTelemetry? Because they couldnt trace their steps!` | Recommended |
 
-<!-- semconv ai(tag=llm-completion) -->
-| Attribute  | Type | Description  | Examples  | Requirement Level |
-| `llm.completion` | string | The full response string from an LLM. If the LLM responds with a more complex output like a JSON object made up of several pieces (such as OpenAI's message choices), this field is the content of the response. If the LLM produces multiple responses, then this field is left blank, and each response is instead captured in an event determined by the specific LLM technology semantic convention.| `Why did the developer stop using OpenTelemetry? Because they couldn't trace their steps!` | Recommended |
+**[1]:** The full response string from an LLM. If the LLM responds with a more complex output like a JSON object made up of several pieces (such as OpenAI's message choices), this field is the content of the response. If the LLM produces multiple responses, then this field is left blank, and each response is instead captured in an event determined by the specific LLM technology semantic convention.
 <!-- endsemconv -->
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
diff --git a/docs/ai/openai-metrics.md b/docs/ai/openai-metrics.md
@@ -341,7 +341,7 @@ of `[ 0, 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5,
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
 | [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Recommended |
-| [`llm.response.model`](../attributes-registry/llm.md) | string | The name of the LLM a response is being made to. | `gpt-4-0613` | Required |
+| [`llm.response.model`](../attributes-registry/llm.md) | string | The name of the LLM a response is being made to. | `gpt-4-0613` | Conditionally Required: if the operation ended in error |
 | [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [2] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
 
 **[1]:** The `error.type` SHOULD be predictable and SHOULD have low cardinality.