OpenAI Integration

The OpenAI integration provides automatic monitoring for GPT API calls with minimal code changes. Simply wrap your existing OpenAI client to start tracking all chat completions, token usage, costs, and compliance violations.

Prerequisites

openai package installed
AI Agents House SDK installed
Valid OpenAI and AI Agents House API keys

Basic Setup

Installation

If you haven’t already, install both the OpenAI SDK and AI Agents House SDK:

npm install openai @agent-governance/node

Initialize the Monitor

Use the OpenAIAgentMonitor class for automatic GPT monitoring:

import { OpenAIAgentMonitor } from '@agent-governance/node';
import OpenAI from 'openai';

const monitor = new OpenAIAgentMonitor({
  apiKey: 'your-governance-api-key',
  organizationId: 'your-org-id',
  environment: 'development',
  enableComplianceChecks: true
});

Register Your Agent

await monitor.registerAgent({
  id: 'gpt-banking-assistant',
  name: 'GPT Banking Assistant',
  category: 'tool_calling',
  specialty: 'customer_service',
  version: '1.0.0',
  llmProvider: 'openai',
  model: 'gpt-4o',
  description: 'GPT-4o powered customer service assistant',
  complianceSettings: {
    sr11_7_enabled: true,
    fair_lending_monitoring: true,
    bsa_aml_checks: true
  }
});

Wrap the OpenAI Client

Wrap your existing OpenAI client to enable automatic monitoring:

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY
});

// Wrap the client - all chat completion calls will now be monitored
const monitoredOpenAI = monitor.wrapOpenAI(openai, 'gpt-banking-assistant');

Usage Examples

Basic Chat Completion

Use the wrapped client exactly as you would the original openai client. All calls to chat.completions.create will be monitored automatically.

const response = await monitoredOpenAI.chat.completions.create({
  model: 'gpt-4o-mini',
  messages: [
    {
      role: 'system',
      content: 'You are a helpful banking assistant.'
    },
    {
      role: 'user',
      content: 'Can you help me understand my account fees?'
    }
  ],
  max_tokens: 500
});

console.log(response.choices[0].message.content);
// Response: "I'd be happy to help explain your account fees..."

With Function Calling

The integration automatically tracks when GPT decides to call functions (also known as tools).

const response = await monitoredOpenAI.chat.completions.create({
  model: 'gpt-4o',
  messages: [
    {
      role: 'user',
      content: 'What is my current checking account balance?'
    }
  ],
  tools: [
    {
      type: 'function',
      function: {
        name: 'get_account_balance',
        description: 'Get the current balance for a specific account',
        parameters: {
          type: 'object',
          properties: {
            account_type: {
              type: 'string',
              description: 'Type of account (e.g., checking, savings)'
            }
          },
          required: ['account_type']
        }
      }
    }
  ],
  tool_choice: 'auto'
});

// If GPT decides to call a function, it's automatically tracked.
// The 'tool_call' event is logged with the function name and arguments.

Automatic Tracking Features

The OpenAI integration automatically captures:

Conversation Events: User messages, agent responses, and function calls.
Performance Metrics: API call latency, token usage (prompt and completion), and calculated costs.
Compliance Monitoring: Real-time scanning of agent responses for PII, Fair Lending violations, and BSA/AML keywords.

Cost Tracking

The integration automatically calculates costs based on OpenAI’s pricing for various models.

GPT-4o Models
GPT-4 Turbo
GPT-3.5 Turbo

GPT-4o: $5 input /$ 15 output per 1M tokens
GPT-4o Mini: $0.15 input /$ 0.60 output per 1M tokens

Costs are calculated based on the usage data returned by the API and are included in the tracked agent_response event.

Best Practices

Troubleshooting

Events not appearing in dashboard

Ensure your apiKey and organizationId are correct. For scripts that exit quickly, you may need to call await monitor.shutdown() to ensure the final batch of events is sent.

Session tracking is not working

Session context must be configured when you call wrapOpenAI. The OpenAI SDK does not have a built-in concept of a session, so you must provide it to the wrapper.

Function calls are not being tracked

The SDK tracks function calls when the API response includes a tool_calls object. Verify that your prompt is successfully inducing the model to use your defined tools.

User messages are not detected correctly

The wrapper identifies the user message by looking for the last message in the messages array with role: 'user'. Ensure your conversation history is structured correctly.

Comparison with Manual Tracking

The OpenAI wrapper significantly simplifies the monitoring process.

Automatic (Recommended)
Manual Tracking

// Wrap once, monitor everything
const monitoredOpenAI = monitor.wrapOpenAI(openai, 'agent-id', {sessionId: 'customer-session-123'});
const response = await monitoredOpenAI.chat.completions.create({
model: 'gpt-4o',
messages: [{ role: 'user', content: 'Hello' }]
});
// All tracking (user message, agent response, latency, cost) happens automatically.

// Manual tracking requires multiple explicit calls
const sessionId = 'customer-session-123';
monitor.trackUserMessage('agent-id', sessionId, 'Hello');

const startTime = Date.now();
const response = await openai.chat.completions.create({
model: 'gpt-4o',
messages: [{ role: 'user', content: 'Hello' }]
});
const latency = Date.now() - startTime;

monitor.trackAgentResponse('agent-id', sessionId, response.choices[0].message.content, {
llmLatency: latency,
tokensUsed: response.usage,
// ... and you would need to calculate cost manually
});

Next Steps

Anthropic Integration

Learn about monitoring Claude models

Manual Tracking

Explore advanced event tracking capabilities for custom integrations.

Compliance Engine

Deep dive into real-time compliance monitoring.

Configuration

Review advanced SDK configuration options.

Getting Started

Core Features

Integrations

Examples

Prerequisites

Basic Setup

Installation

Initialize the Monitor

Register Your Agent

Wrap the OpenAI Client

Usage Examples

Basic Chat Completion

With Function Calling

Automatic Tracking Features

Cost Tracking

Best Practices

Troubleshooting

Comparison with Manual Tracking

Next Steps

Anthropic Integration

Manual Tracking

Compliance Engine

Configuration

​Prerequisites

​Basic Setup

​Installation

​Initialize the Monitor

​Register Your Agent

​Wrap the OpenAI Client

​Usage Examples

​Basic Chat Completion

​With Function Calling

​Automatic Tracking Features

​Cost Tracking

​Best Practices

​Troubleshooting

​Comparison with Manual Tracking

​Next Steps

Anthropic Integration

Manual Tracking

Compliance Engine

Configuration

Prerequisites

Basic Setup

Installation

Initialize the Monitor

Register Your Agent

Wrap the OpenAI Client

Usage Examples

Basic Chat Completion

With Function Calling

Automatic Tracking Features

Cost Tracking

Best Practices

Troubleshooting

Comparison with Manual Tracking

Next Steps