Rename L.assistantStruct -> L.assistantSchema, misc. (#362)

Author: harrysolovay

.changeset/modern-eyes-give.md

@@ -0,0 +1,5 @@
+---
+"liminal": minor
+---
+
+Rename `L.assistantStruct` to `L.assistantSchema`, is it now supports all schemas, not just struct schemas. Template tag calls are properly dedented and normalized. Additionally, `L.userJson` now uses the optional schema to JSONC-encode with description annotations as comments on corresponding fields.

.gitattributes

@@ -1,2 +1,3 @@
 *.css linguist-vendored
-*.html linguist-vendored
+*.html linguist-vendored
+*.vue linguist-vendored

bun.lock

@@ -1,8 +1,8 @@
 import { Console, Effect, flow } from "effect"
 import { L, LPretty } from "liminal"
 
-export const logger = L.handle(flow(
+export const logger = L.listen(flow(
   LPretty.event,
   Console.log,
-  Effect.andThen(Console.log()),
+  Effect.andThen(Console.log()), // Line-break between events.
 ))

examples/_logger.ts

@@ -18,7 +18,7 @@ Effect.gen(function*() {
   let i = 0
   const activities: Array<typeof Activity.Type> = []
   while (i < 5) {
-    activities.push(yield* L.assistantStruct(Activity))
+    activities.push(yield* L.assistantSchema(Activity))
     yield* L.user`Another please.`
     i++
   }

examples/activity_suggestions.ts

@@ -5,11 +5,11 @@ import { logger } from "./_logger.ts"
 
 Effect.gen(function*() {
   yield* logger
-  yield* L.user`Hey`
+  yield* L.user`Hey.`
   yield* L.assistant
 }).pipe(
   L.strand,
-  Effect.scoped,
   Effect.provide(ModelLive),
+  Effect.scoped,
   Effect.runFork,
 )

examples/basic.ts

@@ -18,7 +18,7 @@ Effect.gen(function*() {
 
     Copy to evaluate: ${copy}
   `
-  const qualityMetrics = yield* L.assistantStruct({
+  const qualityMetrics = yield* L.assistantSchema({
     hasCallToAction: Schema.Boolean,
     emotionalAppeal: Schema.Number,
     clarity: Schema.Number,

examples/chaining.ts

@@ -1,15 +1,17 @@
 import { OpenAiLanguageModel } from "@effect/ai-openai"
-import { Effect, Schema } from "effect"
+import { Console, Effect, Schema } from "effect"
 import { L } from "liminal"
 import { ClientLive, ModelLive } from "./_layers.ts"
 import { logger } from "./_logger.ts"
 
 Effect.gen(function*() {
   yield* logger
+
   yield* L.user`Write a rap about type-level programming in TypeScript`
   yield* L.assistant
   yield* L.user`Rewrite it in whatever way you think best.`
-  const variants = yield* Effect.all({
+
+  const rewrites = yield* Effect.all({
     a: L.branch(L.assistant),
     b: L.assistant.pipe(
       L.branch,
@@ -20,16 +22,16 @@ Effect.gen(function*() {
       Effect.provide(OpenAiLanguageModel.model("gpt-3.5-turbo")),
     ),
   }, { concurrency: "unbounded" })
+
   yield* L.clear
   yield* L.user`
     Out of the following variants, which is your favorite?:
 
-    ${JSON.stringify(variants)}
+    ${JSON.stringify(rewrites)}
   `
-  const { key } = yield* L.assistantStruct({
-    key: Schema.Literal("a", "b", "c"),
-  })
-  return variants[key]
+  yield* L.assistantSchema(Schema.Literal("a", "b", "c")).pipe(
+    Effect.flatMap((key) => Console.log(rewrites[key])),
+  )
 }).pipe(
   L.strand,
   Effect.scoped,

examples/compare_models.ts

@@ -5,19 +5,10 @@ import * as Console from "effect/Console"
 import { L } from "liminal"
 import { ModelLive } from "./_layers.ts"
 
+// TODO: use this for actual docs
 declare const LIB_DIR: string
 declare const DOCS_DIR: string
 
-const Suggestions = Schema.Struct({
-  suggestions: Schema.Option(
-    Schema.Array(
-      Schema.String.pipe(Schema.annotations({
-        description: "Improvements to be made to the document.",
-      })),
-    ),
-  ),
-})
-
 Effect.gen(function*() {
   yield* L.user`I'm about to provide you with a repomix summary of the current codebase.`
 
@@ -41,7 +32,13 @@ Effect.gen(function*() {
 
         ${fs.readFileString(docPath)}
       `
-      const maybeChanges = yield* L.assistantStruct(Suggestions)
+      const maybeChanges = yield* L.assistantSchema(Schema.Option(
+        Schema.Array(
+          Schema.String.pipe(Schema.annotations({
+            description: "Improvements to be made to the document.",
+          })),
+        ),
+      ))
       return [docPath, maybeChanges] as const
     }),
     L.branch,

examples/documentation_qa.ts

@@ -4,16 +4,16 @@ import { L, LPretty } from "liminal"
 const ExampleSchema = Schema.Struct({
   inner: Schema.String.pipe(
     Schema.annotations({
-      jsonSchema: {
-        description: "Some description for the LLM.",
-      },
+      description: "Some description for the LLM.",
     }),
   ),
 })
 
 Effect.gen(function*() {
   yield* L.userJson({ inner: "value" }, ExampleSchema)
-  const message = yield* yield* L.messages.pipe(Effect.map(Array.head))
+  const message = yield* yield* L.messages.pipe(
+    Effect.map(Array.head),
+  )
   yield* Console.log(LPretty.message(message))
 }).pipe(
   L.strand,