Skip to main content Link Search Menu Expand Document (external link)

AiChat.ts overview

Since v1.0.0


Exports Grouped by Category


constructors

empty

Signature

declare const empty: Effect.Effect<AiChat.Service, never, Completions>

Source

Since v1.0.0

fromExport

Signature

declare const fromExport: (data: unknown) => Effect.Effect<AiChat.Service, ParseError, Completions>

Source

Since v1.0.0

fromInput

Signature

declare const fromInput: any

Source

Since v1.0.0

fromJson

Signature

declare const fromJson: (data: string) => Effect.Effect<AiChat.Service, ParseError, Completions>

Source

Since v1.0.0

models

AiChat (namespace)

Source

Since v1.0.0

Service (interface)

Signature

export interface Service {
  readonly history: Effect.Effect<AiInput.AiInput>
  readonly export: Effect.Effect<unknown>
  readonly exportJson: Effect.Effect<string>
  readonly send: (input: AiInput.Input) => Effect.Effect<AiResponse, AiError>
  readonly stream: (input: AiInput.Input) => Stream.Stream<AiResponse, AiError>
  readonly structured: {
    <A, I, R>(options: {
      readonly input: AiInput.Input
      readonly schema: Completions.StructuredSchema<A, I, R>
    }): Effect.Effect<A, AiError, R>
    <A, I, R>(options: {
      readonly input: AiInput.Input
      readonly schema: Schema.Schema<A, I, R>
      readonly toolCallId: string
    }): Effect.Effect<A, AiError, R>
  }
  readonly toolkit: <Tools extends AiToolkit.Tool.AnySchema>(options: {
    readonly input: AiInput.Input
    readonly tools: AiToolkit.Handlers<Tools>
    readonly required?: Tools["_tag"] | boolean | undefined
    readonly concurrency?: Concurrency | undefined
  }) => Effect.Effect<
    WithResolved<AiToolkit.Tool.Success<Tools>>,
    AiError | AiToolkit.Tool.Failure<Tools>,
    AiToolkit.Tool.Context<Tools>
  >
  readonly toolkitStream: <Tools extends AiToolkit.Tool.AnySchema>(options: {
    readonly input: AiInput.Input
    readonly tools: AiToolkit.Handlers<Tools>
    readonly required?: Tools["_tag"] | boolean | undefined
    readonly concurrency?: Concurrency | undefined
  }) => Stream.Stream<
    WithResolved<AiToolkit.Tool.Success<Tools>>,
    AiError | AiToolkit.Tool.Failure<Tools>,
    AiToolkit.Tool.Context<Tools>
  >
}

Source

Since v1.0.0

tags

AiChat (class)

Signature

declare class AiChat

Source

Since v1.0.0