Class BaseClient

Hierarchy (View Summary)

BaseClient

Implements

SmolClient

Index

Constructors

constructor

Properties

config statelogClient?

Methods

_textStream _textSync checkForToolLoops checkMessageLimit extractResponse getAbortSignal isAbortError text textStream textSync textWithRetry

Constructors

constructor

new BaseClient(config: ResolvedSmolConfig): BaseClient
Parameters
- config: ResolvedSmolConfig
Returns BaseClient

Properties

`Protected`config

config: ResolvedSmolConfig

`Protected` `Optional`statelogClient

statelogClient?: StatelogClient

Methods

_textStream

_textStream(config: PromptConfig): AsyncGenerator<StreamChunk>
Parameters
- config: PromptConfig
Returns AsyncGenerator<StreamChunk>

Implementation of SmolClient._textStream

_textSync

_textSync(promptConfig: PromptConfig): Promise<Result<PromptResult>>
Parameters
- promptConfig: PromptConfig
Returns Promise<Result<PromptResult>>

Implementation of SmolClient._textSync

checkForToolLoops

checkForToolLoops(
promptConfig: PromptConfig,
): { continue: boolean; newPromptConfig: PromptConfig }
Parameters
- promptConfig: PromptConfig
Returns { continue: boolean; newPromptConfig: PromptConfig }

checkMessageLimit

checkMessageLimit(promptConfig: PromptConfig): Result<PromptResult> | null
Parameters
- promptConfig: PromptConfig
Returns Result<PromptResult> | null

extractResponse

extractResponse(
    promptConfig: PromptConfig,
    rawValue: any,
    schema: any,
    depth?: number,
): any
Parameters
- promptConfig: PromptConfig
- rawValue: any
- schema: any
- depth: number = 0
Returns any

`Protected`getAbortSignal

getAbortSignal(promptConfig: PromptConfig): AbortSignal | undefined
Parameters
- promptConfig: PromptConfig
Returns AbortSignal | undefined

`Protected`isAbortError

isAbortError(err: unknown): boolean
Parameters
- err: unknown
Returns boolean

text

text(promptConfig: Omit<PromptConfig, "stream">): Promise<Result<PromptResult>>
Parameters
- promptConfig: Omit<PromptConfig, "stream">
Returns Promise<Result<PromptResult>>

Implementation of SmolClient.text
text(
promptConfig: Omit<PromptConfig, "stream"> & { stream: false },
): Promise<Result<PromptResult>>
Parameters
- promptConfig: Omit<PromptConfig, "stream"> & { stream: false }
Returns Promise<Result<PromptResult>>

Implementation of SmolClient.text
text(
promptConfig: Omit<PromptConfig, "stream"> & { stream: true },
): AsyncGenerator<StreamChunk>
Parameters
- promptConfig: Omit<PromptConfig, "stream"> & { stream: true }
Returns AsyncGenerator<StreamChunk>

Implementation of SmolClient.text
text(
promptConfig: PromptConfig,
): Promise<Result<PromptResult>> | AsyncGenerator<StreamChunk, any, any>
Parameters
- promptConfig: PromptConfig
Returns Promise<Result<PromptResult>> | AsyncGenerator<StreamChunk, any, any>

Implementation of SmolClient.text

textStream

textStream(config: PromptConfig): AsyncGenerator<StreamChunk>
Parameters
- config: PromptConfig
Returns AsyncGenerator<StreamChunk>

Implementation of SmolClient.textStream

textSync

textSync(promptConfig: PromptConfig): Promise<Result<PromptResult>>
Parameters
- promptConfig: PromptConfig
Returns Promise<Result<PromptResult>>

Implementation of SmolClient.textSync

textWithRetry

textWithRetry(
promptConfig: PromptConfig,
retries: number,
): Promise<Result<PromptResult>>
Parameters
- promptConfig: PromptConfig
- retries: number
Returns Promise<Result<PromptResult>>

Class BaseClient

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseClient

Properties

Protectedconfig

Protected OptionalstatelogClient

Methods

_textStream

Parameters

Returns AsyncGenerator<StreamChunk>

_textSync

Parameters

Returns Promise<Result<PromptResult>>

checkForToolLoops

Parameters

Returns { continue: boolean; newPromptConfig: PromptConfig }

checkMessageLimit

Parameters

Returns Result<PromptResult> | null

extractResponse

Parameters

Returns any

ProtectedgetAbortSignal

Parameters

Returns AbortSignal | undefined

ProtectedisAbortError

Parameters

Returns boolean

text

Parameters

Returns Promise<Result<PromptResult>>

Parameters

Returns Promise<Result<PromptResult>>

Parameters

Returns AsyncGenerator<StreamChunk>

Parameters

Returns Promise<Result<PromptResult>> | AsyncGenerator<StreamChunk, any, any>

textStream

Parameters

Returns AsyncGenerator<StreamChunk>

textSync

Parameters

Returns Promise<Result<PromptResult>>

textWithRetry

Parameters

Returns Promise<Result<PromptResult>>

Settings

On This Page

`Protected`config

`Protected` `Optional`statelogClient

`Protected`getAbortSignal

`Protected`isAbortError