Refactor AiModel and remove AiPlan

[IMax153]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Warning

This PR will depend on merge of #4910 to replace AiPlan.

The goal of this PR is to simplify the usage of AiModels in both Effect and Stream programs by leveraging well-known patterns in Effect for requiring and providing services. The ergonomics of AiModel have been substantially improved - an AiModel now returns a plain Layer which can be used to provide services to a program that makes use of large language model interactions.

Before

import { AiLanguageModel } from "@effect/ai"
import { OpenAiClient, OpenAiLanguageModel } from "@effect/ai-openai"
import { NodeHttpClient } from "@effect/platform-node"
import { Config, Console, Effect, Layer } from "effect"

// Produces an `AiModel<AiLanguageModel, OpenAiClient>`
const Gpt4o = OpenAiLanguageModel.model("gpt-4o")

// Generate a dad joke
const getDadJoke = AiLanguageModel.generateText({
  prompt: "Tell me a dad joke"
})

const program = Effect.gen(function*() {
  // Build the `AiModel` into a `Provider`
  const gpt4o = yield* Gpt4o
  // Use the built `AiModel` to run the program
  const response = yield* gpt4o.use(getDadJoke)
  // Log the response
  yield* Console.log(response.text)
})

const OpenAi = OpenAiClient.layerConfig({
  apiKey: Config.redacted("OPENAI_API_KEY")
}).pipe(Layer.provide(NodeHttpClient.layerUndici))

program.pipe(
  Effect.provide(OpenAi),
  Effect.runPromise
)

After

import { AiLanguageModel } from "@effect/ai"
import { OpenAiClient, OpenAiLanguageModel } from "@effect/ai-openai"
import { NodeHttpClient } from "@effect/platform-node"
import { Config, Console, Effect, Layer } from "effect"

// Produces a `Layer<AiLanguageModel, never, OpenAiClient>`
const Gpt4o = OpenAiLanguageModel.model("gpt-4o")

const program = AiLanguageModel.generateText({
  prompt: "Tell me a dad joke"
}).pipe(
  Effect.flatMap((response) => Console.log(response.text)),
  // Provide the model to use
  Effect.provide(Gpt4o)
)

const OpenAi = OpenAiClient.layerConfig({
  apiKey: Config.redacted("OPENAI_API_KEY")
}).pipe(Layer.provide(NodeHttpClient.layerUndici))

program.pipe(
  Effect.provide(OpenAi),
  Effect.runPromise
)

In addition, AiModel can be yield*'ed to produce a layer with no requirements.

This shifts the requirements of building the layer into the calling effect, which is particularly useful for creating AI-powered services.

import { AiLanguageModel } from "@effect/ai"
import { OpenAiLanguageModel } from "@effect/ai-openai"
import { Effect } from "effect"

class DadJokes extends Effect.Service<DadJokes>()("DadJokes", {
  effect: Effect.gen(function*() {
    // Yielding the model will return a layer with no requirements
    // 
    //      ┌─── Layer<AiLanguageModel>
    //      ▼
    const model = yield* OpenAiLanguageModel.model("gpt-4o")

    const getDadJoke = AiLanguageModel.generateText({
      prompt: "Generate a dad joke"
    }).pipe(Effect.provide(model))

    return { getDadJoke } as const
  })
}) {}

// The requirements are lifted into the service constructor
// 
//          ┌─── Layer<DadJokes, never, OpenAiClient>
//          ▼
DadJokes.Default 

Related

• Related Issue #
• Closes #

[changeset-bot]

🦋 Changeset detected

Latest commit: 5da36c5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@effect/ai-anthropic	Major
@effect/ai-openai	Major
@effect/ai	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[tim-smart]

/rebase