@accordkit/provider-openai - v0.2.0
    Preparing search index...

    Interface OpenAIAdapterOptions

    Configuration knobs for withOpenAI, allowing callers to tune which AccordKit events the adapter emits and how they are labeled.

    interface OpenAIAdapterOptions {
        enableResponsesApi?: boolean;
        enableImagesApi?: boolean;
        enableAudioApi?: boolean;
        provider?: Provider;
        operationName?: string;
        emitPrompts?: boolean;
        emitResponses?: boolean;
        emitToolCalls?: boolean;
        emitUsage?: boolean;
        emitToolResults?: boolean;
        emitSpan?: boolean;
    }
    Index

    Properties

    enableResponsesApi? enableImagesApi? enableAudioApi? provider? operationName? emitPrompts? emitResponses? emitToolCalls? emitUsage? emitToolResults? emitSpan?

    Properties

    enableResponsesApi?: boolean

    Enable instrumentation for the Responses API (responses.create/stream).

    enableImagesApi?: boolean

    Enable instrumentation for Images API (images.generate).

    enableAudioApi?: boolean

    Enable instrumentation for Audio API (audio.speech/transcriptions/translations).

    provider?: Provider

    Provider identifier attached to emitted events. Defaults to 'openai'. Override if you proxy OpenAI behind another service and want distinct labeling.

    operationName?: string

    Operation name recorded on tool_result/span events. Defaults to 'openai.chat.completions.create'.

    emitPrompts?: boolean

    Emit message events for user/system prompts before the API call executes. Enabled by default.

    emitResponses?: boolean

    Emit message events for assistant completions returned by OpenAI. Enabled by default.

    emitToolCalls?: boolean

    Emit tool_call events for function/tool invocations requested by the assistant. Enabled by default.

    emitUsage?: boolean

    Emit usage events when OpenAI reports token accounting information. Enabled by default.

    emitToolResults?: boolean

    Emit tool_result events summarizing request latency and outcome (success/error). Enabled by default.

    emitSpan?: boolean

    Emit a span event around each API invocation capturing duration and status. Enabled by default.

    Settings

    Member Visibility

    On This Page

    Properties