Docs/API Reference/TypeScript SDK Reference
TypeScript API Reference
Complete API reference for exported classes, options, and types in @bablusingh-dev/agentcore.
Agent Class
Agent.d.ts
| 1 | export class Agent { |
| 2 | readonly name: string; |
| 3 | constructor(config?: AgentConfig); |
| 4 | |
| 5 | run(input: PromptInput): Promise<ModelResponse>; |
| 6 | runStream(input: PromptInput, onChunk: (chunk: string) => void): Promise<ModelResponse>; |
| 7 | stream(input: PromptInput): Promise<{ |
| 8 | textStream: AsyncIterable<string>; |
| 9 | response: Promise<ModelResponse>; |
| 10 | }>; |
| 11 | |
| 12 | getHistory(): AgentMessage[]; |
| 13 | clearHistory(): void; |
| 14 | } |
streamText() Function
streamText.d.ts
| 1 | export function streamText(options: GenerateTextOptions): { |
| 2 | textStream: AsyncIterable<string>; |
| 3 | text: Promise<string>; |
| 4 | response: Promise<ModelResponse>; |
| 5 | }; |
Providers & ModelRegistry
Providers.d.ts
| 1 | export abstract class BaseProvider { |
| 2 | abstract readonly name: string; |
| 3 | abstract generate(messages: AgentMessage[], options: ModelOptions, tools?: ToolDefinition[]): Promise<ModelResponse>; |
| 4 | abstract generateStream(messages: AgentMessage[], options: ModelOptions, tools?: ToolDefinition[], onChunk?: (chunk: string) => void): Promise<ModelResponse>; |
| 5 | } |
| 6 | |
| 7 | export class OpenAIProvider extends BaseProvider {} |
| 8 | export class AnthropicProvider extends BaseProvider {} |
| 9 | export class GeminiProvider extends BaseProvider {} |
| 10 | export class OllamaProvider extends BaseProvider {} |
| 11 | export class DeepSeekProvider extends BaseProvider {} |
| 12 | export class MistralProvider extends BaseProvider {} |
| 13 | export class GrokProvider extends BaseProvider {} |
AIGateway Router
AIGateway.d.ts
| 1 | export class AIGateway extends BaseProvider { |
| 2 | constructor(config: GatewayConfig); |
| 3 | route(messages: AgentMessage[], options: ModelOptions, tools?: ToolDefinition[]): Promise<ModelResponse>; |
| 4 | } |
GuardrailEngine
GuardrailEngine.d.ts
| 1 | export class GuardrailEngine { |
| 2 | addInputRule(evaluator: GuardrailEvaluator): this; |
| 3 | addOutputRule(evaluator: GuardrailEvaluator): this; |
| 4 | validateInput(content: string): Promise<GuardrailResult>; |
| 5 | validateOutput(content: string): Promise<GuardrailResult>; |
| 6 | } |
EvaluationHarness
EvaluationHarness.d.ts
| 1 | export class EvaluationHarness { |
| 2 | addTestCase(testCase: TestCase): this; |
| 3 | run(runner: (input: string) => Promise<string>): Promise<EvaluationResult[]>; |
| 4 | } |