Added more deprecations/aliases (#65)

antonpirker · web-flow · commit fbb4397b404c · 2025-06-25T09:23:45.000-04:00
diff --git a/generated/attributes/ai.md b/generated/attributes/ai.md
@@ -5,21 +5,17 @@
 - [Stable Attributes](#stable-attributes)
   - [ai.citations](#aicitations)
   - [ai.documents](#aidocuments)
-  - [ai.input_messages](#aiinput_messages)
   - [ai.is_search_required](#aiis_search_required)
   - [ai.metadata](#aimetadata)
   - [ai.pipeline.name](#aipipelinename)
   - [ai.preamble](#aipreamble)
   - [ai.raw_prompting](#airaw_prompting)
   - [ai.response_format](#airesponse_format)
-  - [ai.responses](#airesponses)
   - [ai.search_queries](#aisearch_queries)
   - [ai.search_results](#aisearch_results)
   - [ai.streaming](#aistreaming)
   - [ai.tags](#aitags)
   - [ai.texts](#aitexts)
-  - [ai.tool_calls](#aitool_calls)
-  - [ai.tools](#aitools)
   - [ai.total_cost](#aitotal_cost)
   - [ai.warnings](#aiwarnings)
 - [Deprecated Attributes](#deprecated-attributes)
@@ -28,12 +24,16 @@
   - [ai.frequency_penalty](#aifrequency_penalty)
   - [ai.function_call](#aifunction_call)
   - [ai.generation_id](#aigeneration_id)
+  - [ai.input_messages](#aiinput_messages)
   - [ai.model_id](#aimodel_id)
   - [ai.model.provider](#aimodelprovider)
   - [ai.presence_penalty](#aipresence_penalty)
   - [ai.prompt_tokens.used](#aiprompt_tokensused)
+  - [ai.responses](#airesponses)
   - [ai.seed](#aiseed)
   - [ai.temperature](#aitemperature)
+  - [ai.tool_calls](#aitool_calls)
+  - [ai.tools](#aitools)
   - [ai.top_k](#aitop_k)
   - [ai.top_p](#aitop_p)
   - [ai.total_tokens.used](#aitotal_tokensused)
@@ -62,18 +62,6 @@ Documents or content chunks used as context for the AI model.
 | Exists in OpenTelemetry | No |
 | Example | `["document1.txt","document2.pdf"]` |
 
-### ai.input_messages
-
-The input messages sent to the model
-
-| Property | Value |
-| --- | --- |
-| Type | `string` |
-| Has PII | maybe |
-| Exists in OpenTelemetry | No |
-| Example | `[{"role": "user", "message": "hello"}]` |
-| Aliases | `gen_ai.prompt` |
-
 ### ai.is_search_required
 
 Boolean indicating if the model needs to perform a search.
@@ -140,17 +128,6 @@ For an AI model call, the format of the response
 | Exists in OpenTelemetry | No |
 | Example | `json_object` |
 
-### ai.responses
-
-The response messages sent back by the AI model.
-
-| Property | Value |
-| --- | --- |
-| Type | `string[]` |
-| Has PII | false |
-| Exists in OpenTelemetry | No |
-| Example | `["hello","world"]` |
-
 ### ai.search_queries
 
 Queries used to search for relevant context or documents.
@@ -206,28 +183,6 @@ Raw text inputs provided to the model.
 | Exists in OpenTelemetry | No |
 | Example | `["Hello, how are you?","What is the capital of France?"]` |
 
-### ai.tool_calls
-
-For an AI model call, the tool calls that were made.
-
-| Property | Value |
-| --- | --- |
-| Type | `string[]` |
-| Has PII | true |
-| Exists in OpenTelemetry | No |
-| Example | `["tool_call_1","tool_call_2"]` |
-
-### ai.tools
-
-For an AI model call, the functions that are available
-
-| Property | Value |
-| --- | --- |
-| Type | `string[]` |
-| Has PII | false |
-| Exists in OpenTelemetry | No |
-| Example | `["function_1","function_2"]` |
-
 ### ai.total_cost
 
 The total cost for the tokens used.
@@ -315,6 +270,19 @@ Unique identifier for the completion.
 | Example | `gen_123abc` |
 | Deprecated | Yes, use `gen_ai.response.id` instead |
 
+### ai.input_messages
+
+The input messages sent to the model
+
+| Property | Value |
+| --- | --- |
+| Type | `string` |
+| Has PII | maybe |
+| Exists in OpenTelemetry | No |
+| Example | `[{"role": "user", "message": "hello"}]` |
+| Deprecated | Yes, use `gen_ai.request.messages` instead |
+| Aliases | `gen_ai.prompt`, `gen_ai.request.messages` |
+
 ### ai.model_id
 
 The vendor-specific ID of the model used.
@@ -365,6 +333,18 @@ The number of tokens used to process just the prompt.
 | Deprecated | Yes, use `gen_ai.usage.input_tokens` instead |
 | Aliases | `gen_ai.usage.prompt_tokens`, `gen_ai.usage.input_tokens` |
 
+### ai.responses
+
+The response messages sent back by the AI model.
+
+| Property | Value |
+| --- | --- |
+| Type | `string[]` |
+| Has PII | false |
+| Exists in OpenTelemetry | No |
+| Example | `["hello","world"]` |
+| Deprecated | Yes, use `gen_ai.response.text` instead |
+
 ### ai.seed
 
 The seed, ideally models given the same seed and same other parameters will produce the exact same output.
@@ -389,6 +369,30 @@ For an AI model call, the temperature parameter. Temperature essentially means h
 | Example | `0.1` |
 | Deprecated | Yes, use `gen_ai.request.temperature` instead |
 
+### ai.tool_calls
+
+For an AI model call, the tool calls that were made.
+
+| Property | Value |
+| --- | --- |
+| Type | `string[]` |
+| Has PII | true |
+| Exists in OpenTelemetry | No |
+| Example | `["tool_call_1","tool_call_2"]` |
+| Deprecated | Yes, use `gen_ai.response.tool_calls` instead |
+
+### ai.tools
+
+For an AI model call, the functions that are available
+
+| Property | Value |
+| --- | --- |
+| Type | `string[]` |
+| Has PII | false |
+| Exists in OpenTelemetry | No |
+| Example | `["function_1","function_2"]` |
+| Deprecated | Yes, use `gen_ai.request.available_tools` instead |
+
 ### ai.top_k
 
 Limits the model to only consider the K most likely next tokens, where K is an integer (e.g., top_k=20 means only the 20 highest probability tokens are considered).
diff --git a/generated/attributes/gen_ai.md b/generated/attributes/gen_ai.md
@@ -135,7 +135,7 @@ The maximum number of tokens to generate in the response.
 
 ### gen_ai.request.messages
 
-The messages passed to the model. The "content" can be a string or an array of objects. It has to be a stringified version of an array of objects.
+The messages passed to the model. It has to be a stringified version of an array of objects. The "content" can be a string or an array of objects.
 
 | Property | Value |
 | --- | --- |
diff --git a/javascript/sentry-conventions/src/attributes.ts b/javascript/sentry-conventions/src/attributes.ts
@@ -158,8 +158,9 @@ export type AI_GENERATION_ID_TYPE = string;
  *
  * Attribute defined in OTEL: No
  *
- * Aliases: {@link GEN_AI_PROMPT} `gen_ai.prompt`
+ * Aliases: {@link GEN_AI_PROMPT} `gen_ai.prompt`, {@link GEN_AI_REQUEST_MESSAGES} `gen_ai.request.messages`
  *
+ * @deprecated Use {@link GEN_AI_REQUEST_MESSAGES} (gen_ai.request.messages) instead
  * @example "[{\"role\": \"user\", \"message\": \"hello\"}]"
  */
 export const AI_INPUT_MESSAGES = 'ai.input_messages';
@@ -388,6 +389,7 @@ export type AI_RESPONSE_FORMAT_TYPE = string;
  *
  * Attribute defined in OTEL: No
  *
+ * @deprecated Use {@link GEN_AI_RESPONSE_TEXT} (gen_ai.response.text) instead
  * @example ["hello","world"]
  */
 export const AI_RESPONSES = 'ai.responses';
@@ -550,6 +552,7 @@ export type AI_TEXTS_TYPE = Array<string>;
  *
  * Attribute defined in OTEL: No
  *
+ * @deprecated Use {@link GEN_AI_RESPONSE_TOOL_CALLS} (gen_ai.response.tool_calls) instead
  * @example ["tool_call_1","tool_call_2"]
  */
 export const AI_TOOL_CALLS = 'ai.tool_calls';
@@ -570,6 +573,7 @@ export type AI_TOOL_CALLS_TYPE = Array<string>;
  *
  * Attribute defined in OTEL: No
  *
+ * @deprecated Use {@link GEN_AI_REQUEST_AVAILABLE_TOOLS} (gen_ai.request.available_tools) instead
  * @example ["function_1","function_2"]
  */
 export const AI_TOOLS = 'ai.tools';
@@ -2016,7 +2020,7 @@ export type GEN_AI_REQUEST_MAX_TOKENS_TYPE = number;
 // Path: model/attributes/gen_ai/gen_ai__request__messages.json
 
 /**
- * The messages passed to the model. The "content" can be a string or an array of objects. It has to be a stringified version of an array of objects. `gen_ai.request.messages`
+ * The messages passed to the model. It has to be a stringified version of an array of objects. The "content" can be a string or an array of objects. `gen_ai.request.messages`
  *
  * Attribute Value Type: `string` {@link GEN_AI_REQUEST_MESSAGES_TYPE}
  *
@@ -5989,21 +5993,17 @@ export type AttributeValue = string | number | boolean | Array<string> | Array<n
 export type Attributes = {
   [AI_CITATIONS]?: AI_CITATIONS_TYPE;
   [AI_DOCUMENTS]?: AI_DOCUMENTS_TYPE;
-  [AI_INPUT_MESSAGES]?: AI_INPUT_MESSAGES_TYPE;
   [AI_IS_SEARCH_REQUIRED]?: AI_IS_SEARCH_REQUIRED_TYPE;
   [AI_METADATA]?: AI_METADATA_TYPE;
   [AI_PIPELINE_NAME]?: AI_PIPELINE_NAME_TYPE;
   [AI_PREAMBLE]?: AI_PREAMBLE_TYPE;
   [AI_RAW_PROMPTING]?: AI_RAW_PROMPTING_TYPE;
   [AI_RESPONSE_FORMAT]?: AI_RESPONSE_FORMAT_TYPE;
-  [AI_RESPONSES]?: AI_RESPONSES_TYPE;
   [AI_SEARCH_QUERIES]?: AI_SEARCH_QUERIES_TYPE;
   [AI_SEARCH_RESULTS]?: AI_SEARCH_RESULTS_TYPE;
   [AI_STREAMING]?: AI_STREAMING_TYPE;
   [AI_TAGS]?: AI_TAGS_TYPE;
   [AI_TEXTS]?: AI_TEXTS_TYPE;
-  [AI_TOOL_CALLS]?: AI_TOOL_CALLS_TYPE;
-  [AI_TOOLS]?: AI_TOOLS_TYPE;
   [AI_TOTAL_COST]?: AI_TOTAL_COST_TYPE;
   [AI_WARNINGS]?: AI_WARNINGS_TYPE;
   [APP_START_TYPE]?: APP_START_TYPE_TYPE;
diff --git a/model/attributes/ai/ai__input_messages.json b/model/attributes/ai/ai__input_messages.json
@@ -7,6 +7,10 @@
   },
   "is_in_otel": false,
   "example": "[{\"role\": \"user\", \"message\": \"hello\"}]",
-  "alias": ["gen_ai.prompt"],
-  "sdks": ["python"]
+  "alias": ["gen_ai.prompt", "gen_ai.request.messages"],
+  "sdks": ["python"],
+  "deprecation": {
+    "_status": null,
+    "replacement": "gen_ai.request.messages"
+  }
 }
diff --git a/model/attributes/ai/ai__responses.json b/model/attributes/ai/ai__responses.json
@@ -7,5 +7,9 @@
   },
   "is_in_otel": false,
   "example": ["hello", "world"],
-  "sdks": ["python"]
+  "sdks": ["python"],
+  "deprecation": {
+    "_status": null,
+    "replacement": "gen_ai.response.text"
+  }
 }
diff --git a/model/attributes/ai/ai__tool_calls.json b/model/attributes/ai/ai__tool_calls.json
@@ -6,5 +6,9 @@
     "key": "true"
   },
   "is_in_otel": false,
-  "example": ["tool_call_1", "tool_call_2"]
+  "example": ["tool_call_1", "tool_call_2"],
+  "deprecation": {
+    "_status": null,
+    "replacement": "gen_ai.response.tool_calls"
+  }
 }
diff --git a/model/attributes/ai/ai__tools.json b/model/attributes/ai/ai__tools.json
@@ -6,5 +6,9 @@
     "key": "false"
   },
   "is_in_otel": false,
-  "example": ["function_1", "function_2"]
+  "example": ["function_1", "function_2"],
+  "deprecation": {
+    "_status": null,
+    "replacement": "gen_ai.request.available_tools"
+  }
 }
diff --git a/shared/deprecated_attributes.json b/shared/deprecated_attributes.json
@@ -212,6 +212,22 @@
         "replacement": "gen_ai.response.id"
       }
     },
+    {
+      "key": "ai.input_messages",
+      "brief": "The input messages sent to the model",
+      "type": "string",
+      "pii": {
+        "key": "maybe"
+      },
+      "is_in_otel": false,
+      "example": "[{\"role\": \"user\", \"message\": \"hello\"}]",
+      "alias": ["gen_ai.prompt", "gen_ai.request.messages"],
+      "sdks": ["python"],
+      "deprecation": {
+        "_status": null,
+        "replacement": "gen_ai.request.messages"
+      }
+    },
     {
       "key": "ai.model.provider",
       "brief": "The provider of the model.",
@@ -272,6 +288,21 @@
         "replacement": "gen_ai.usage.input_tokens"
       }
     },
+    {
+      "key": "ai.responses",
+      "brief": "The response messages sent back by the AI model.",
+      "type": "string[]",
+      "pii": {
+        "key": "false"
+      },
+      "is_in_otel": false,
+      "example": ["hello", "world"],
+      "sdks": ["python"],
+      "deprecation": {
+        "_status": null,
+        "replacement": "gen_ai.response.text"
+      }
+    },
     {
       "key": "ai.seed",
       "brief": "The seed, ideally models given the same seed and same other parameters will produce the exact same output.",
@@ -300,6 +331,34 @@
         "replacement": "gen_ai.request.temperature"
       }
     },
+    {
+      "key": "ai.tool_calls",
+      "brief": "For an AI model call, the tool calls that were made.",
+      "type": "string[]",
+      "pii": {
+        "key": "true"
+      },
+      "is_in_otel": false,
+      "example": ["tool_call_1", "tool_call_2"],
+      "deprecation": {
+        "_status": null,
+        "replacement": "gen_ai.response.tool_calls"
+      }
+    },
+    {
+      "key": "ai.tools",
+      "brief": "For an AI model call, the functions that are available",
+      "type": "string[]",
+      "pii": {
+        "key": "false"
+      },
+      "is_in_otel": false,
+      "example": ["function_1", "function_2"],
+      "deprecation": {
+        "_status": null,
+        "replacement": "gen_ai.request.available_tools"
+      }
+    },
     {
       "key": "ai.top_k",
       "brief": "Limits the model to only consider the K most likely next tokens, where K is an integer (e.g., top_k=20 means only the 20 highest probability tokens are considered).",
