Class OpenAIScroll

OpenAI implementation of the Scroll interface. Provides access to OpenAI's GPT models through the unified Scroll API.

Hierarchy (view full)

Scroll
- OpenAIScroll

Index

Constructors

Properties

Methods

getInfo generateText generateObject streamText streamObject getProviderName testConnection

Constructors

constructor

new OpenAIScroll(config): OpenAIScroll
Parameters
- config: ScrollConfig
Returns OpenAIScroll
Overrides Scroll.constructor
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:23

Properties

`Protected` config

config: ScrollConfig

Methods

getInfo

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

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

generateText

generateText(options): Promise<ScrollResponse<string>>
Generate text using OpenAI
Parameters
- options: GenerateTextOptions
Returns Promise<ScrollResponse<string>>
Overrides Scroll.generateText
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:34

generateObject

generateObject<T>(options): Promise<ScrollResponse<T>>
Generate structured object using OpenAI
Type Parameters
- T
Parameters
- options: GenerateObjectOptions
Returns Promise<ScrollResponse<T>>
Overrides Scroll.generateObject
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:76

streamText

streamText(options): Promise<ScrollStreamResponse<string>>
Stream text using OpenAI
Parameters
- options: StreamTextOptions
Returns Promise<ScrollStreamResponse<string>>
Overrides Scroll.streamText
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:137

streamObject

streamObject<T>(options): Promise<ScrollStreamResponse<T>>
Stream structured object using OpenAI
Type Parameters
- T
Parameters
- options: StreamObjectOptions
Returns Promise<ScrollStreamResponse<T>>
Overrides Scroll.streamObject
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:203

getProviderName

getProviderName(): string
Get provider name

Returns string
Overrides Scroll.getProviderName
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:279

testConnection

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

Returns Promise<boolean>
Overrides Scroll.testConnection
- Defined in packages/ninja-agents/src/scroll/providers/OpenAIScroll.ts:286