newrelic/lib/llm-events/langchain/event.js

New Relic agent

/*
 * Copyright 2024 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

'use strict'

const BaseEvent = require('../event')
const { makeId } = require('../../util/hashes')
const { isSimpleObject } = require('../../util/objects')

/**
 * @typedef {object} LangChainEventParams
 * @property {object} agent A New Relic agent instance.
 * @property {object} segment A New Relic segment instance.
 * @property {string} runId The identifier LangChain has assigned to the "run."
 * @property {Object<string, string>} metadata The metadata, if any, associated with the
 * LangChain run.
 * @property {boolean|undefined} [error] Indicates if an error took place during
 * the conversation that resulted in the event.
 * @property {boolean|undefined} [virtual=true] Indicates that this event is a
 * LangChain specific event (`true`). LangChain is not itself an LLM, but an
 * interface to many LLMs. Any LLMs LangChain interacts with that we have
 * instrumented will have their own traces that are not "virtual."
 */
/**
 * @type {LangChainEventParams}
 */
const defaultParams = {
  agent: {},
  transaction: {},
  segment: {},
  tags: [],
  runId: '',
  metadata: {},
  error: undefined,
  virtual: undefined
}

/**
 * Baseline object representing an event in a LangChain conversation.
 */
class LangChainEvent extends BaseEvent {
  id = makeId(36)
  appName
  span_id
  request_id
  trace_id
  ingest_source = 'Node'
  vendor = 'langchain'
  virtual_llm = true

  constructor(params = defaultParams) {
    params = Object.assign({}, defaultParams, params)
    super(params)
    const { agent, segment, transaction } = params

    this.appName = agent.config.applications()[0]
    this.span_id = segment?.id
    this.request_id = params.runId
    this.trace_id = transaction?.traceId
    this.langchainMeta = params.metadata
    this.metadata = agent
    this.tags = Array.isArray(params.tags) ? params.tags.join(',') : params.tags
    this.error = params.error ?? null

    if (params.virtual !== undefined) {
      if (params.virtual !== true && params.virtual !== false) {
        throw Error('params.virtual must be a primitive boolean')
      }
      this.virtual_llm = params.virtual
    }
  }

  // eslint-disable-next-line accessor-pairs
  set langchainMeta(value) {
    if (isSimpleObject(value) === false) {
      return
    }
    for (const [key, val] of Object.entries(value)) {
      this[`metadata.${key}`] = val
    }
  }
}

module.exports = LangChainEvent