Class Scroll`Abstract`

Abstract base class for LLM provider implementations. Provides a unified interface for different LLM providers.

Hierarchy (view full)

Scroll
- OpenAIScroll

Index

Constructors

Properties

Methods

generateText generateObject streamText streamObject getInfo getProviderName testConnection

Constructors

constructor

new Scroll(config): Scroll
Parameters
- config: ScrollConfig
Returns Scroll
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:18

Properties

`Protected` config

config: ScrollConfig

Methods

`Abstract` generateText

generateText(options): Promise<ScrollResponse<string>>
Generate text response
Parameters
- options: GenerateTextOptions
Returns Promise<ScrollResponse<string>>
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:25

`Abstract` generateObject

generateObject<T>(options): Promise<ScrollResponse<T>>
Generate structured object response
Type Parameters
- T
Parameters
- options: GenerateObjectOptions
Returns Promise<ScrollResponse<T>>
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:30

`Abstract` streamText

streamText(options): Promise<ScrollStreamResponse<string>>
Stream text response
Parameters
- options: StreamTextOptions
Returns Promise<ScrollStreamResponse<string>>
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:35

`Abstract` streamObject

streamObject<T>(options): Promise<ScrollStreamResponse<T>>
Stream structured object response
Type Parameters
- T
Parameters
- options: StreamObjectOptions
Returns Promise<ScrollStreamResponse<T>>
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:40

getInfo

getInfo(): {
    provider: string;
    model: string;
    config: ScrollConfig;
}
Get provider information

Returns {
    provider: string;
    model: string;
    config: ScrollConfig;
}
- provider: string
- model: string
- config: ScrollConfig
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:45

`Abstract` getProviderName

getProviderName(): string
Get provider name

Returns string
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:56

`Abstract` testConnection

testConnection(): Promise<boolean>
Test connection to provider

Returns Promise<boolean>
- Defined in packages/ninja-agents/src/scroll/core/Scroll.ts:61