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

AiInput.ts overview

Since v1.0.0


Exports Grouped by Category


base64

Base64DataUrl

Signature

declare const Base64DataUrl: Base64DataUrl

Source

Since v1.0.0

Base64DataUrl (interface)

Signature

export interface Base64DataUrl
  extends Schema_.transformOrFail<
    typeof Schema_.String,
    Schema_.Struct<{
      data: Schema_.Schema<Uint8Array>
      contentType: typeof Schema_.String
    }>
  > {}

Source

Since v1.0.0

constructors

empty

Signature

declare const empty: Chunk.Chunk<Message>

Source

Since v1.0.0

make

Signature

declare const make: (input: Input, options?: { readonly role?: AiRole.AiRole }) => AiInput

Source

Since v1.0.0

message

Message (class)

Signature

declare class Message

Source

Since v1.0.0

is (static method)

Signature

declare const is: (u: unknown) => u is Message

Source

Since v1.0.0

fromInput (static method)

Signature

declare const fromInput: (input: Message.Input, role?: AiRole.AiRole) => Message

Source

Since v1.0.0

fromResponse (static method)

Signature

declare const fromResponse: (response: AiResponse) => Option.Option<Message>

Source

Since v1.0.0

fromWithResolved (static method)

Signature

declare const fromWithResolved: <A>(response: WithResolved<A>) => Message

Source

Since v1.0.0

[MessageTypeId] (property)

Signature

readonly [MessageTypeId]: unique symbol

Source

Since v1.0.0

Message (namespace)

Source

Since v1.0.0

Input (type alias)

Signature

type Input = string | Part | Iterable<Part>

Source

Since v1.0.0

MessageTypeId

Signature

declare const MessageTypeId: unique symbol

Source

Since v1.0.0

MessageTypeId (type alias)

Signature

type MessageTypeId = typeof MessageTypeId

Source

Since v1.0.0

models

AiInput (type alias)

Signature

type AiInput = Chunk.Chunk<Message>

Source

Since v1.0.0

Input (type alias)

Signature

type Input = string | Part | Iterable<Part> | Message | Iterable<Message> | AiResponse | WithResolved<unknown>

Source

Since v1.0.0

parts

ImagePart (class)

Signature

declare class ImagePart

Source

Since v1.0.0

fromPath (static method)

Signature

declare const fromPath: (
  path: string,
  quality?: ImageQuality
) => Effect.Effect<ImagePart, PlatformError, FileSystem.FileSystem | Path.Path>

Source

Since v1.0.0

fromBlob (static method)

Signature

declare const fromBlob: (blob: Blob, quality?: ImageQuality) => Effect.Effect<ImagePart>

Source

Since v1.0.0

[PartTypeId] (property)

Signature

readonly [PartTypeId]: unique symbol

Source

Since v1.0.0

ImageQuality

Signature

declare const ImageQuality: any

Source

Since v1.0.0

ImageQuality (type alias)

Signature

type ImageQuality = typeof ImageQuality.Type

Source

Since v1.0.0

ImageUrlPart (class)

Signature

declare class ImageUrlPart

Source

Since v1.0.0

[PartTypeId] (property)

Signature

readonly [PartTypeId]: unique symbol

Source

Since v1.0.0

Part

Signature

declare const Part: Schema_.Union<
  [typeof TextPart, typeof ToolCallPart, typeof ToolCallResolvedPart, typeof ImagePart, typeof ImageUrlPart]
>

Source

Since v1.0.0

Part (type alias)

Signature

type Part = TextPart | ToolCallPart | ToolCallResolvedPart | ImagePart | ImageUrlPart

Source

Since v1.0.0

Part (namespace)

Source

Since v1.0.0

Schema (type alias)

Signature

type Schema = Schema_.Union<
  [typeof TextPart, typeof ToolCallPart, typeof ToolCallResolvedPart, typeof ImagePart, typeof ImageUrlPart]
>

Source

Since v1.0.0

PartTypeId

Signature

declare const PartTypeId: unique symbol

Source

Since v1.0.0

PartTypeId (type alias)

Signature

type PartTypeId = typeof PartTypeId

Source

Since v1.0.0

TextPart (class)

Signature

declare class TextPart

Source

Since v1.0.0

fromContent (static method)

Signature

declare const fromContent: (content: string) => TextPart

Source

Since v1.0.0

[PartTypeId] (property)

Signature

readonly [PartTypeId]: unique symbol

Source

Since v1.0.0

ToolCallPart (class)

Signature

declare class ToolCallPart

Source

Since v1.0.0

[PartTypeId] (property)

Signature

readonly [PartTypeId]: unique symbol

Source

Since v1.0.0

ToolCallResolvedPart (class)

Signature

declare class ToolCallResolvedPart

Source

Since v1.0.0

[PartTypeId] (property)

Signature

readonly [PartTypeId]: unique symbol

Source

Since v1.0.0

isPart

Signature

declare const isPart: (u: unknown) => u is Part

Source

Since v1.0.0

schemas

Schema

Signature

declare const Schema: Schema_.Chunk<typeof Message>

Source

Since v1.0.0

SchemaJson

Signature

declare const SchemaJson: Schema_.Schema<Chunk.Chunk<Message>, string>

Source

Since v1.0.0

system

SystemInstruction (class)

Signature

declare class SystemInstruction

Source

Since v1.0.0

provideSystem

Signature

declare const provideSystem: {
  (input: string): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, SystemInstruction>>
  <A, E, R>(effect: Effect.Effect<A, E, R>, input: string): Effect.Effect<A, E, Exclude<R, SystemInstruction>>
}

Source

Since v1.0.0