@promptbook/google
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
204 lines (203 loc) • 18.8 kB
TypeScript
/// <reference types="node" />
/**
* Loads the OpenAI AgentKit SDK (`@openai/agents`) on demand
*
* Note: [🐌] The AgentKit SDK is one of the heaviest dependencies of Promptbook, loading it eagerly would slow down
* every single run of the `ptbk` CLI utility even when no AgentKit agent is used
*
* @private internal utility of `@promptbook/openai`
*/
export declare const loadOpenAiAgentsModule: () => Promise<{
default: typeof import("@openai/agents");
applyPatchTool: typeof import("@openai/agents").applyPatchTool;
shellTool: typeof import("@openai/agents").shellTool;
realtime: typeof import("@openai/agents-realtime");
RuntimeEventEmitter: typeof import("events");
Agent: typeof import("@openai/agents").Agent;
AgentsError: typeof import("@openai/agents").AgentsError;
GuardrailExecutionError: typeof import("@openai/agents").GuardrailExecutionError;
InputGuardrailTripwireTriggered: typeof import("@openai/agents").InputGuardrailTripwireTriggered;
MaxTurnsExceededError: typeof import("@openai/agents").MaxTurnsExceededError;
ModelBehaviorError: typeof import("@openai/agents").ModelBehaviorError;
OutputGuardrailTripwireTriggered: typeof import("@openai/agents").OutputGuardrailTripwireTriggered;
ToolInputGuardrailTripwireTriggered: typeof import("@openai/agents").ToolInputGuardrailTripwireTriggered;
ToolOutputGuardrailTripwireTriggered: typeof import("@openai/agents").ToolOutputGuardrailTripwireTriggered;
ToolCallError: typeof import("@openai/agents").ToolCallError;
ToolTimeoutError: typeof import("@openai/agents").ToolTimeoutError;
UserError: typeof import("@openai/agents").UserError;
SystemError: typeof import("@openai/agents").SystemError;
RunAgentUpdatedStreamEvent: typeof import("@openai/agents").RunAgentUpdatedStreamEvent;
RunRawModelStreamEvent: typeof import("@openai/agents").RunRawModelStreamEvent;
RunItemStreamEvent: typeof import("@openai/agents").RunItemStreamEvent;
defineOutputGuardrail: typeof import("@openai/agents").defineOutputGuardrail;
ToolGuardrailFunctionOutputFactory: {
allow(outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
rejectContent(message: string, outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
throwException(outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
};
defineToolInputGuardrail: typeof import("@openai/agents").defineToolInputGuardrail;
defineToolOutputGuardrail: typeof import("@openai/agents").defineToolOutputGuardrail;
resolveToolInputGuardrails: typeof import("@openai/agents").resolveToolInputGuardrails;
resolveToolOutputGuardrails: typeof import("@openai/agents").resolveToolOutputGuardrails;
getHandoff: typeof import("@openai/agents").getHandoff;
getTransferMessage: typeof import("@openai/agents").getTransferMessage;
Handoff: typeof import("@openai/agents").Handoff;
handoff: typeof import("@openai/agents").handoff;
assistant: typeof import("@openai/agents").assistant;
system: typeof import("@openai/agents").system;
user: typeof import("@openai/agents").user;
extractAllTextOutput: typeof import("@openai/agents").extractAllTextOutput;
RunHandoffCallItem: typeof import("@openai/agents").RunHandoffCallItem;
RunHandoffOutputItem: typeof import("@openai/agents").RunHandoffOutputItem;
RunMessageOutputItem: typeof import("@openai/agents").RunMessageOutputItem;
RunReasoningItem: typeof import("@openai/agents").RunReasoningItem;
RunToolApprovalItem: typeof import("@openai/agents").RunToolApprovalItem;
RunToolCallItem: typeof import("@openai/agents").RunToolCallItem;
RunToolCallOutputItem: typeof import("@openai/agents").RunToolCallOutputItem;
AgentHooks: typeof import("@openai/agents").AgentHooks;
getLogger: typeof import("@openai/agents").getLogger;
applyDiff: typeof import("@openai/agents").applyDiff;
getAllMcpTools: typeof import("@openai/agents").getAllMcpTools;
invalidateServerToolsCache: typeof import("@openai/agents").invalidateServerToolsCache;
mcpToFunctionTool: typeof import("@openai/agents").mcpToFunctionTool;
MCPServerStdio: typeof import("@openai/agents").MCPServerStdio;
MCPServerStreamableHttp: typeof import("@openai/agents").MCPServerStreamableHttp;
MCPServerSSE: typeof import("@openai/agents").MCPServerSSE;
MCPServers: typeof import("@openai/agents").MCPServers;
connectMcpServers: typeof import("@openai/agents").connectMcpServers;
createMCPToolStaticFilter: typeof import("@openai/agents").createMCPToolStaticFilter;
OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME: "OPENAI_DEFAULT_MODEL";
gpt5ReasoningSettingsRequired: typeof import("@openai/agents").gpt5ReasoningSettingsRequired;
getDefaultModel: typeof import("@openai/agents").getDefaultModel;
getDefaultModelSettings: typeof import("@openai/agents").getDefaultModelSettings;
isGpt5Default: typeof import("@openai/agents").isGpt5Default;
setDefaultModelProvider: typeof import("@openai/agents").setDefaultModelProvider;
RunResult: typeof import("@openai/agents").RunResult;
StreamedRunResult: typeof import("@openai/agents").StreamedRunResult;
run: typeof import("@openai/agents").run;
Runner: typeof import("@openai/agents").Runner;
RunContext: typeof import("@openai/agents").RunContext;
RunState: typeof import("@openai/agents").RunState;
computerTool: typeof import("@openai/agents").computerTool;
hostedMcpTool: typeof import("@openai/agents").hostedMcpTool;
tool: typeof import("@openai/agents").tool;
invokeFunctionTool: typeof import("@openai/agents").invokeFunctionTool;
getGlobalTraceProvider: typeof import("@openai/agents").getGlobalTraceProvider;
TraceProvider: typeof import("@openai/agents").TraceProvider;
runToolInputGuardrails: typeof import("@openai/agents").runToolInputGuardrails;
runToolOutputGuardrails: typeof import("@openai/agents").runToolOutputGuardrails;
RequestUsage: typeof import("@openai/agents").RequestUsage;
Usage: typeof import("@openai/agents").Usage;
isOpenAIResponsesCompactionAwareSession: typeof import("@openai/agents").isOpenAIResponsesCompactionAwareSession;
MemorySession: typeof import("@openai/agents").MemorySession;
protocol: typeof import("@openai/agents-core/dist/types/protocol");
addTraceProcessor(processor: import("@openai/agents").TracingProcessor): void;
setTraceProcessors(processors: import("@openai/agents").TracingProcessor[]): void;
setTracingDisabled(disabled: boolean): void;
startTraceExportLoop(): void;
getCurrentSpan: typeof import("@openai/agents").getCurrentSpan;
getCurrentTrace: typeof import("@openai/agents").getCurrentTrace;
getOrCreateTrace: typeof import("@openai/agents").getOrCreateTrace;
resetCurrentSpan: typeof import("@openai/agents").resetCurrentSpan;
setCurrentSpan: typeof import("@openai/agents").setCurrentSpan;
withTrace: typeof import("@openai/agents").withTrace;
BatchTraceProcessor: typeof import("@openai/agents").BatchTraceProcessor;
ConsoleSpanExporter: typeof import("@openai/agents").ConsoleSpanExporter;
NoopSpan: typeof import("@openai/agents").NoopSpan;
Span: typeof import("@openai/agents").Span;
NoopTrace: typeof import("@openai/agents").NoopTrace;
Trace: typeof import("@openai/agents").Trace;
generateGroupId: typeof import("@openai/agents").generateGroupId;
generateSpanId: typeof import("@openai/agents").generateSpanId;
generateTraceId: typeof import("@openai/agents").generateTraceId;
createResponseSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").ResponseSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").ResponseSpanData>;
createAgentSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").AgentSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").AgentSpanData>;
createFunctionSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").FunctionSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").FunctionSpanData>;
createHandoffSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").HandoffSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").HandoffSpanData>;
createGenerationSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GenerationSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").GenerationSpanData>;
createCustomSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").CustomSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").CustomSpanData>;
createGuardrailSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GuardrailSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").GuardrailSpanData>;
createTranscriptionSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").TranscriptionSpanData>> & {
data: {
input: {
data: string;
format: (string & {}) | "pcm";
};
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").TranscriptionSpanData>;
createSpeechSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechSpanData>> & {
data: {
output: {
data: string;
format: (string & {}) | "pcm";
};
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").SpeechSpanData>;
createSpeechGroupSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechGroupSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").SpeechGroupSpanData>;
createMCPListToolsSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").MCPListToolsSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").MCPListToolsSpanData>;
withResponseSpan: <TOutput>(fn: (span: import("@openai/agents").Span<import("@openai/agents").ResponseSpanData>) => Promise<TOutput>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").ResponseSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput>;
withAgentSpan: <TOutput_1>(fn: (span: import("@openai/agents").Span<import("@openai/agents").AgentSpanData>) => Promise<TOutput_1>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").AgentSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_1>;
withFunctionSpan: <TOutput_2>(fn: (span: import("@openai/agents").Span<import("@openai/agents").FunctionSpanData>) => Promise<TOutput_2>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").FunctionSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_2>;
withHandoffSpan: <TOutput_3>(fn: (span: import("@openai/agents").Span<import("@openai/agents").HandoffSpanData>) => Promise<TOutput_3>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").HandoffSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_3>;
withGenerationSpan: <TOutput_4>(fn: (span: import("@openai/agents").Span<import("@openai/agents").GenerationSpanData>) => Promise<TOutput_4>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GenerationSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_4>;
withCustomSpan: <TOutput_5>(fn: (span: import("@openai/agents").Span<import("@openai/agents").CustomSpanData>) => Promise<TOutput_5>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").CustomSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_5>;
withGuardrailSpan: <TOutput_6>(fn: (span: import("@openai/agents").Span<import("@openai/agents").GuardrailSpanData>) => Promise<TOutput_6>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GuardrailSpanData>> & {
data: {
name: string;
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_6>;
withTranscriptionSpan: <TOutput_7>(fn: (span: import("@openai/agents").Span<import("@openai/agents").TranscriptionSpanData>) => Promise<TOutput_7>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").TranscriptionSpanData>> & {
data: {
input: {
data: string;
format: (string & {}) | "pcm";
};
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_7>;
withSpeechSpan: <TOutput_8>(fn: (span: import("@openai/agents").Span<import("@openai/agents").SpeechSpanData>) => Promise<TOutput_8>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechSpanData>> & {
data: {
output: {
data: string;
format: (string & {}) | "pcm";
};
};
}, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_8>;
withSpeechGroupSpan: <TOutput_9>(fn: (span: import("@openai/agents").Span<import("@openai/agents").SpeechGroupSpanData>) => Promise<TOutput_9>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechGroupSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_9>;
withMCPListToolsSpan: <TOutput_10>(fn: (span: import("@openai/agents").Span<import("@openai/agents").MCPListToolsSpanData>) => Promise<TOutput_10>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").MCPListToolsSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_10>;
OpenAIProvider: typeof import("@openai/agents").OpenAIProvider;
OpenAIResponsesModel: typeof import("@openai/agents").OpenAIResponsesModel;
OpenAIChatCompletionsModel: typeof import("@openai/agents").OpenAIChatCompletionsModel;
setDefaultOpenAIClient: typeof import("@openai/agents").setDefaultOpenAIClient;
setOpenAIAPI: typeof import("@openai/agents").setOpenAIAPI;
setDefaultOpenAIKey: typeof import("@openai/agents").setDefaultOpenAIKey;
setTracingExportApiKey: typeof import("@openai/agents").setTracingExportApiKey;
setDefaultOpenAITracingExporter: typeof import("@openai/agents").setDefaultOpenAITracingExporter;
OpenAITracingExporter: typeof import("@openai/agents").OpenAITracingExporter;
webSearchTool: typeof import("@openai/agents").webSearchTool;
fileSearchTool: typeof import("@openai/agents").fileSearchTool;
codeInterpreterTool: typeof import("@openai/agents").codeInterpreterTool;
imageGenerationTool: typeof import("@openai/agents").imageGenerationTool;
OpenAIConversationsSession: typeof import("@openai/agents").OpenAIConversationsSession;
startOpenAIConversationsSession: typeof import("@openai/agents").startOpenAIConversationsSession;
OpenAIResponsesCompactionSession: typeof import("@openai/agents").OpenAIResponsesCompactionSession;
}>;