Skip to main content

Class: OpenAIAgentsTraceClientInterceptor

openaiAgents.OpenAIAgentsTraceClientInterceptor

Implement any of these methods to intercept WorkflowClient outbound calls

Standalone Activities are experimental. APIs may be subject to change.

Implements

Constructors

constructor

new OpenAIAgentsTraceClientInterceptor(options?): OpenAIAgentsTraceClientInterceptor

Parameters

NameType
options?OpenAIAgentsTraceClientInterceptorOptions

Returns

OpenAIAgentsTraceClientInterceptor

Methods

query

query(input, next): Promise<unknown>

Parameters

NameType
inputWorkflowQueryInput
nextOmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>>

Returns

Promise<unknown>

Implementation of

WorkflowClientInterceptor.query


signal

signal(input, next): Promise<void>

Parameters

NameType
inputWorkflowSignalInput
nextOmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>) => Promise<void>>

Returns

Promise<void>

Implementation of

WorkflowClientInterceptor.signal


signalWithStart

signalWithStart(input, next): Promise<string>

Parameters

NameType
inputWorkflowSignalWithStartInput
nextOmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>>

Returns

Promise<string>

Implementation of

WorkflowClientInterceptor.signalWithStart


startUpdate

startUpdate(input, next): Promise<WorkflowStartUpdateOutput>

Parameters

NameType
inputWorkflowStartUpdateInput
nextOmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateOutput>>) => Promise<WorkflowStartUpdateOutput>>

Returns

Promise<WorkflowStartUpdateOutput>

Implementation of

WorkflowClientInterceptor.startUpdate


startUpdateWithStart

startUpdateWithStart(input, next): Promise<WorkflowStartUpdateWithStartOutput>

Parameters

NameType
inputWorkflowStartUpdateWithStartInput
nextOmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateWithStartOutput>>) => Promise<WorkflowStartUpdateWithStartOutput>>

Returns

Promise<WorkflowStartUpdateWithStartOutput>

Implementation of

WorkflowClientInterceptor.startUpdateWithStart


startWithDetails

startWithDetails(input, next): Promise<WorkflowStartOutput>

Parameters

NameType
inputWorkflowStartInput
nextOmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartOutput>>) => Promise<WorkflowStartOutput>>

Returns

Promise<WorkflowStartOutput>

Implementation of

WorkflowClientInterceptor.startWithDetails