Update comments

Author: amychisholm03

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

@@ -75,7 +75,7 @@ module.exports = class LlmChatCompletionSummary extends LlmEvent {
 
   /**
    * Sets the provided tokens counts on the LLM event.
-   * Checks if promptToken and completionToken are greater than zero before setting.
+   * Checks if `promptTokens` and `completionTokens` are greater than zero before setting.
    * This is because the spec states that token counts should only be set if both
    * are present.
    * @param {object} params to the function

lib/llm-events/event-base.js

@@ -12,6 +12,12 @@ const { makeId } = require('../util/hashes')
  * The base LLM event class that contains logic and properties
  * (e.g. `trace_id`, `vendor`) that are common to all LLM events.
  *
+ * Properties are defined as public fields rather than private because
+ * these LLM event objects are serialized and then sent via the custom
+ * event aggregator.
+ * The property names (using snake_case like `trace_id`) must be preserved
+ * exactly as-is in the serialized output to match the expected schema.
+ *
  * @property {boolean|undefined} error Set to `true` if an error occurred
  *  during creation call, omitted if no error occurred
  * @property {string} id UUID or identifier for the event
@@ -43,13 +49,15 @@ module.exports = class EventBase {
     this.vendor = vendor
     this.metadata = agent
 
-    // Omit `error` property if no error occurred
+    // The spec says that the `error` property should only be
+    // sent (via the collector) if it is set to true.
     if (error === true) {
       this.error = error
     }
 
-    // If a certain attribute value is not accessible via instrumentation,
-    // it can be omitted from the event.
+    // Like `error`, the spec says that if any other certain attribute value
+    // is not accessible via instrumentation (thus `undefined`), it will be
+    // omitted from the event.
     if (requestId) this.request_id = requestId
     if (responseModel) this['response.model'] = responseModel
   }