openai / Exports / PayloadLogger
Class: PayloadLogger
Utility class for logging OpenAI API payloads to files
Table of contents
Constructors
Methods
Constructors
constructor
• new PayloadLogger(enabled?, logDir?, includeTimestamp?): PayloadLogger
Parameters
| Name | Type | Default value |
|---|---|---|
enabled | boolean | false |
logDir | string | './logs/api-payloads' |
includeTimestamp | boolean | true |
Returns
Defined in
Methods
logPayload
▸ logPayload(payload, type?): Promise<void>
Log API payload to file
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
payload | OpenAILogData | undefined | The API request payload |
type | "chat" | "stream" | 'chat' | Type of request ('chat' or 'stream') |
Returns
Promise<void>
Defined in
isEnabled
▸ isEnabled(): boolean
Check if logging is enabled
Returns
boolean