openai chat summary

Author: amychisholm03

lib/llm-events-new/chat-message.js

@@ -38,19 +38,19 @@ class LlmChatCompletionMessage extends LlmEvent {
     super({ agent, segment, transaction, vendor, responseModel, requestId })
 
     this.completion_id = completionId
-    if (isResponse) this.is_response = isResponse
     this.sequence = sequence
+    if (isResponse) this.is_response = isResponse
 
     if (role) {
       this.role = role
     } else {
       // If the role attribute is not available, a value of user MUST be sent for
       // requests and a value of assistant MUST be sent for responses.
-      if (sequence === 0) {
+      if (isResponse) {
+        this.role = 'assistant'
+      } else if (sequence === 0) {
         // We can assume the first message in the sequence is the request message.
         this.role = 'user'
-      } else if (this.is_response) {
-        this.role = 'assistant'
       }
     }
 

lib/llm-events-new/chat-summary.js

@@ -2,3 +2,54 @@
  * Copyright 2026 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+
+const LlmEvent = require('./base')
+
+/**
+ * @property {number} request.temperature Value representing how random or
+ *  deterministic the output responses should be
+ * @property {number} request.max_tokens Maximum number of tokens that can be
+ *  generated in a chat completion
+ * @property {string} request.model  Model name specified in the request (e.g. 'gpt-4')
+ * @property {number} response.number_of_messages Number of messages comprising a
+ *  chat completion including system, user, and assistant messages
+ * @property {string} response.choices.finish_reason Reason the model stopped generating tokens (e.g. "stop")
+ * @property {string} response.organization Organization ID returned in the response or response headers
+ * @property {number} timestamp Timestamp captured at the time of the LLM request with millisecond precision
+ */
+class LlmChatCompletionSummary extends LlmEvent {
+  /**
+   * @param {object} params constructor parameters
+   * @param {Agent} params.agent New Relic agent instance
+   * @param {object} params.segment Current segment
+   * @param {object} params.transaction Current and active transaction
+   * @param {string} params.vendor Lowercase vendor name, e.g. "openai"
+   * @param {string} params.responseModel Model name from response
+   * @param {string} params.requestModel  Model name specified in the request (e.g. 'gpt-4')
+   * @param {string} params.requestId ID from request/response headers
+   * @param {boolean} [params.error] Set to `true` if an error occurred during creation call, omitted if no error occurred
+   * @param {string} params.responseOrg Organization ID returned in the response or response headers
+   * @param {number} params.temperature Value representing how random or
+   *  deterministic the output responses should be
+   * @param {number} params.maxTokens Maximum number of tokens that can be
+   *  generated in a chat completion
+   * @param {number} params.numMsgs Number of messages comprising a
+   *  chat completion including system, user, and assistant messages
+   * @param {string} params.finishReason Reason the model stopped generating tokens (e.g. "stop")
+   */
+  constructor({ agent, segment, transaction, vendor, responseModel, requestModel, requestId, error,
+    responseOrg, temperature, maxTokens, numMsgs, finishReason }) {
+    super({ agent, segment, transaction, vendor, responseModel, requestId, error })
+
+    this['request.model'] = requestModel
+    this['request.max_tokens'] = maxTokens
+    this['request.temperature'] = temperature
+    this['response.number_of_messages'] = numMsgs
+    this['response.choices.finish_reason'] = finishReason
+    this['response.organization'] = responseOrg
+    this.timestamp = segment.timer.start
+    this.duration = segment.getDurationInMillis()
+  }
+}
+
+module.exports = LlmChatCompletionSummary

lib/llm-events-new/openai/chat-message.js

@@ -6,6 +6,9 @@
 const LlmChatCompletionMessage = require('../chat-message')
 const { getUsageTokens } = require('./utils')
 
+/**
+ * Encapsulates an OpenAI `LlmChatCompletionMessage` event.
+ */
 class OpenAiLlmChatCompletionMessage extends LlmChatCompletionMessage {
   constructor({ agent,
     segment,

lib/llm-events-new/openai/chat-summary.js

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const LlmChatCompletionSummary = require('../chat-summary')
+const { getUsageTokens } = require('./utils')
+
+/**
+ * Encapsulates an OpenAI `LlmChatCompletionSummary` event.
+ */
+class OpenAiLlmChatCompletionSummary extends LlmChatCompletionSummary {
+  constructor({ agent, segment, transaction, request = {}, response = {}, error }) {
+    super({
+      agent,
+      segment,
+      transaction,
+      vendor: 'openai',
+      error,
+      responseModel: response?.model,
+      responseOrg: response?.headers?.['openai-organization'],
+      requestModel: request?.model,
+      requestId: response?.headers?.['x-request-id'],
+      temperature: request?.temperature,
+      maxTokens: request?.max_tokens ?? request?.max_output_tokens
+    })
+
+    if (request?.input) {
+      // `responses.create` api logic
+      // `request.input` can be an array or a string.
+      const requestLength = Array.isArray(request.input) ? request.input.length : 1
+      this['response.number_of_messages'] = requestLength + (response?.output?.length ?? 0)
+      this['response.choices.finish_reason'] = response?.status
+    } else {
+      // `chat.completions.create` api logic
+      this['response.number_of_messages'] = request?.messages?.length + response?.choices?.length
+      this['response.choices.finish_reason'] = response?.choices?.[0]?.finish_reason
+    }
+
+    this.setTokens(agent, request, response)
+    if (response.headers) {
+      // Set response.headers.*
+      this['response.headers.llmVersion'] = response.headers['openai-version']
+      this['response.headers.ratelimitLimitRequests'] = response.headers['x-ratelimit-limit-requests']
+      this['response.headers.ratelimitLimitTokens'] = response.headers['x-ratelimit-limit-tokens']
+      this['response.headers.ratelimitResetTokens'] = response.headers['x-ratelimit-reset-tokens']
+      this['response.headers.ratelimitRemainingTokens'] = response.headers['x-ratelimit-remaining-tokens']
+      this['response.headers.ratelimitRemainingRequests'] = response.headers['x-ratelimit-remaining-requests']
+    }
+  }
+
+  setTokens(agent, request, response) {
+    const tokenCB = agent.llm?.tokenCountCallback
+
+    // Prefer callback for prompt and completion tokens; if unavailable, fall back to response data.
+    if (tokenCB) {
+      const messages = request?.input || request?.messages
+
+      const promptContent = typeof messages === 'string'
+        ? messages
+        : messages?.map((msg) => msg.content).join(' ')
+
+      const completionContent = response?.output
+        ? response.output.map((resContent) => resContent.content[0].text).join(' ')
+        : response?.choices?.map((resContent) => resContent.message.content).join(' ')
+
+      if (promptContent && completionContent) {
+        this.setTokenUsageFromCallback(
+          {
+            tokenCB,
+            reqModel: request.model,
+            resModel: this['response.model'],
+            promptContent,
+            completionContent
+          }
+        )
+      }
+      return
+    }
+
+    const tokens = getUsageTokens(response)
+    this.setTokensInResponse(tokens)
+  }
+}
+
+module.exports = OpenAiLlmChatCompletionSummary

lib/llm-events-new/openai/embedding.js

@@ -7,6 +7,9 @@
 const LlmEmbedding = require('../embedding')
 const { getUsageTokens } = require('./utils')
 
+/**
+ * Encapsulates an OpenAI `LlmEmbedding` event.
+ */
 class OpenAiLlmEmbedding extends LlmEmbedding {
   constructor({ agent, segment, transaction, request = {}, response = {}, error = null }) {
     super({ agent,

lib/llm-events-new/openai/index.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const LlmChatCompletionMessage = require('./chat-message')
+const LlmChatCompletionSummary = require('./chat-summary')
+const LlmEmbedding = require('./embedding')
+
+module.exports = {
+  LlmChatCompletionMessage,
+  LlmChatCompletionSummary,
+  LlmEmbedding
+}

lib/llm-events/openai/chat-completion-summary.js

@@ -13,8 +13,7 @@ const { AiMonitoringChatSubscriber } = require('../ai-monitoring')
 const { AI } = require('#agentlib/metrics/names.js')
 const semver = require('semver')
 const MIN_STREAM_VERSION = '4.12.2'
-const { LlmChatCompletionSummary } = require('#agentlib/llm-events/openai/index.js')
-const OpenAiLlmChatCompletionMessage = require('#agentlib/llm-events-new/openai/chat-message.js')
+const { LlmChatCompletionSummary, LlmChatCompletionMessage } = require('#agentlib/llm-events-new/openai/index.js')
 const { wrapPromise } = require('../utils')
 
 class OpenAIChatCompletions extends AiMonitoringChatSubscriber {
@@ -163,7 +162,7 @@ class OpenAIChatCompletions extends AiMonitoringChatSubscriber {
       transaction,
       request,
       response: { ...response, headers },
-      withError: !!err
+      error: !!err
     })
     return summary
   }
@@ -250,7 +249,7 @@ class OpenAIChatCompletions extends AiMonitoringChatSubscriber {
       isResponse = message.content === response?.choices?.[0]?.message?.content
     }
 
-    return new OpenAiLlmChatCompletionMessage({
+    return new LlmChatCompletionMessage({
       agent: this.agent,
       segment,
       transaction,