effect 4.0.0-beta.5 → 4.0.0-beta.51

package/src/unstable/ai/Model.ts

@@ -14,7 +14,7 @@
  *
  * declare const myAnthropicLayer: Layer.Layer<LanguageModel.LanguageModel>
  *
- * const anthropicModel = Model.make("anthropic", myAnthropicLayer)
+ * const anthropicModel = Model.make("anthropic", "claude-3-5-haiku", myAnthropicLayer)
  *
  * const program = Effect.gen(function*() {
  *   const response = yield* LanguageModel.generateText({
@@ -28,11 +28,11 @@
  *
  * @since 4.0.0
  */
+import * as Context from "../../Context.ts"
 import * as Effect from "../../Effect.ts"
 import { identity } from "../../Function.ts"
 import { PipeInspectableProto, YieldableProto } from "../../internal/core.ts"
 import * as Layer from "../../Layer.ts"
-import * as ServiceMap from "../../ServiceMap.ts"
 
 const TypeId = "~effect/ai/Model" as const
 
@@ -55,8 +55,13 @@ const TypeId = "~effect/ai/Model" as const
  */
 export interface Model<in out Provider, in out Provides, in out Requires>
   extends
-    Layer.Layer<Provides | ProviderName, never, Requires>,
-    Effect.Yieldable<Model<Provider, Provides, Requires>, Layer.Layer<Provides | ProviderName>, never, Requires>
+    Layer.Layer<Provides | ProviderName | ModelName, never, Requires>,
+    Effect.Yieldable<
+      Model<Provider, Provides, Requires>,
+      Layer.Layer<Provides | ProviderName | ModelName>,
+      never,
+      Requires
+    >
 {
   readonly [TypeId]: typeof TypeId
   /**
@@ -75,10 +80,24 @@ export interface Model<in out Provider, in out Provides, in out Requires>
  * @since 4.0.0
  * @category services
  */
-export class ProviderName extends ServiceMap.Service<ProviderName, string>()(
+export class ProviderName extends Context.Service<ProviderName, string>()(
   "effect/unstable/ai/Model/ProviderName"
 ) {}
 
+/**
+ * Service tag that provides the current large language model name.
+ *
+ * This tag is automatically provided by Model instances and can be used to
+ * access the name of the model that is currently in use within a given Effect
+ * program.
+ *
+ * @since 4.0.0
+ * @category services
+ */
+export class ModelName extends Context.Service<ModelName, string>()(
+  "effect/unstable/ai/Model/ModelName"
+) {}
+
 const Proto = {
   ...YieldableProto,
   ...PipeInspectableProto,
@@ -89,8 +108,8 @@ const Proto = {
     _RIn: identity
   },
   asEffect(this: Model<any, any, any>) {
-    return Effect.servicesWith((services: ServiceMap.ServiceMap<never>) =>
-      Effect.succeed(Layer.provide(this, Layer.succeedServices(services)))
+    return Effect.contextWith((context: Context.Context<never>) =>
+      Effect.succeed(Layer.provide(this, Layer.succeedContext(context)))
     )
   },
   toJSON(this: Model<any, any, any>): unknown {
@@ -112,11 +131,12 @@ const Proto = {
  *
  * declare const bedrockLayer: Layer.Layer<LanguageModel.LanguageModel>
  *
- * // Model automatically provides ProviderName service
+ * // Model automatically provides ProviderName and ModelName services
  * const checkProviderAndGenerate = Effect.gen(function*() {
  *   const provider = yield* Model.ProviderName
+ *   const modelName = yield* Model.ModelName
  *
- *   console.log(`Generating with: ${provider}`)
+ *   console.log(`Generating with: ${provider}/${modelName}`)
  *
  *   return yield* LanguageModel.generateText({
  *     prompt: `Hello from ${provider}!`
@@ -124,19 +144,23 @@ const Proto = {
  * })
  *
  * const program = checkProviderAndGenerate.pipe(
- *   Effect.provide(Model.make("amazon-bedrock", bedrockLayer))
+ *   Effect.provide(Model.make("amazon-bedrock", "claude-3-5-haiku", bedrockLayer))
  * )
- * // Will log: "Generating with: amazon-bedrock"
+ * // Will log: "Generating with: amazon-bedrock/claude-3-5-haiku"
  * ```
  *
  * @since 4.0.0
  * @category constructors
  */
-export const make = <const Provider extends string, Provides, Requires>(
+export const make = <const Provider extends string, const Name extends string, Provides, Requires>(
   /**
    * Provider identifier (e.g., "openai", "anthropic", "amazon-bedrock").
    */
   provider: Provider,
+  /**
+   * Model identifier (e.g., "gpt-5", "claude-3-5-haiku").
+   */
+  modelName: Name,
   /**
    * Layer that provides the AI services for this provider.
    */
@@ -145,5 +169,12 @@ export const make = <const Provider extends string, Provides, Requires>(
   Object.assign(
     Object.create(Proto),
     { provider },
-    Layer.merge(Layer.succeed(ProviderName)(provider), layer)
+    Layer.merge(
+      layer,
+      Layer.succeedContext(
+        ProviderName.context(provider).pipe(
+          Context.add(ModelName, modelName)
+        )
+      )
+    )
   )

package/src/unstable/ai/OpenAiStructuredOutput.ts

@@ -4,13 +4,14 @@
  * @since 1.0.0
  */
 import * as Arr from "../../Array.ts"
-import type * as JsonSchema from "../../JsonSchema.ts"
+import * as JsonSchema from "../../JsonSchema.ts"
 import * as Option from "../../Option.ts"
 import * as Predicate from "../../Predicate.ts"
 import * as Rec from "../../Record.ts"
 import * as Schema from "../../Schema.ts"
 import * as AST from "../../SchemaAST.ts"
 import * as Transformation from "../../SchemaTransformation.ts"
+import * as Tool from "./Tool.ts"
 
 /**
  * Transforms a `Schema.Codec` into a form compatible with OpenAI's
@@ -48,7 +49,7 @@ export function toCodecOpenAI<T, E, RD, RE>(
   const to = schema.ast
   const from = recurOpenAI(AST.toEncoded(to))
   const codec = from === to ? schema : Schema.make<typeof schema>(AST.decodeTo(from, to, Transformation.passthrough()))
-  const document = Schema.toJsonSchemaDocument(codec)
+  const document = JsonSchema.resolveTopLevel$ref(Schema.toJsonSchemaDocument(codec))
   const jsonSchema = rewriteOpenAI(document.schema)
   if (Object.keys(document.definitions).length > 0) {
     jsonSchema.$defs = Rec.map(document.definitions, rewriteOpenAI)
@@ -81,6 +82,9 @@ function rewriteOpenAI(schema: JsonSchema.JsonSchema): JsonSchema.JsonSchema {
       out[k] = v
     }
   }
+  if (out.type === "object" && out.properties === undefined && out.additionalProperties === false) {
+    out.properties = {}
+  }
   return out
 }
 
@@ -243,6 +247,9 @@ function recurOpenAI(ast: AST.AST): AST.AST {
         }
       } else if (ast.indexSignatures.length === 1 && ast.propertySignatures.length === 0) {
         const is = ast.indexSignatures[0]
+        if (Tool.isEmptyParamsRecord(is)) {
+          return ast
+        }
         // records are not supported by OpenAI, so we translate them to arrays of key-value pairs
         if (annotations !== undefined && typeof annotations.description === "string") {
           annotations.description = `${RECORD_DESCRIPTION}; ${annotations.description}`

package/src/unstable/ai/Prompt.ts

@@ -53,7 +53,7 @@
  */
 import * as Arr from "../../Array.ts"
 import * as Effect from "../../Effect.ts"
-import { constFalse, dual } from "../../Function.ts"
+import { dual } from "../../Function.ts"
 import * as Option from "../../Option.ts"
 import { type Pipeable, pipeArguments } from "../../Pipeable.ts"
 import * as Predicate from "../../Predicate.ts"
@@ -63,8 +63,6 @@ import * as Parser from "../../SchemaParser.ts"
 import * as SchemaTransformation from "../../SchemaTransformation.ts"
 import type * as Response from "./Response.ts"
 
-const constEmptyObject = () => ({})
-
 // =============================================================================
 // Options
 // =============================================================================
@@ -86,9 +84,9 @@ const constEmptyObject = () => ({})
  * @since 4.0.0
  * @category models
  */
-export const ProviderOptions: Schema.Record$<
+export const ProviderOptions: Schema.$Record<
   Schema.String,
-  Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+  Schema.NullOr<Schema.Codec<Schema.Json>>
 > = Schema.Record(Schema.String, Schema.NullOr(Schema.Json))
 
 /**
@@ -103,8 +101,6 @@ export type ProviderOptions = typeof ProviderOptions.Type
 
 const PartTypeId = "~effect/ai/Prompt/Part" as const
 
-const constPartTypeId = () => PartTypeId
-
 /**
  * Type guard to check if a value is a Part.
  *
@@ -185,9 +181,9 @@ export interface BasePartEncoded<Type extends string, Options extends ProviderOp
 
 const BasePart = Schema.Struct({
   [PartTypeId]: Schema.Literal(PartTypeId).pipe(
-    Schema.withDecodingDefaultKey(constPartTypeId, { encodingStrategy: "omit" })
+    Schema.withDecodingDefaultKey(Effect.succeed(PartTypeId), { encodingStrategy: "omit" })
   ),
-  options: ProviderOptions.pipe(Schema.withDecodingDefault(constEmptyObject))
+  options: ProviderOptions.pipe(Schema.withDecodingDefault(Effect.succeed({})))
 })
 
 /**
@@ -309,9 +305,9 @@ export const TextPart: Schema.Struct<
     readonly text: Schema.String
     readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
     readonly options: Schema.withDecodingDefault<
-      Schema.Record$<
+      Schema.$Record<
         Schema.String,
-        Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+        Schema.NullOr<Schema.Codec<Schema.Json>>
       >
     >
   }
@@ -389,9 +385,9 @@ export const ReasoningPart: Schema.Struct<{
   readonly text: Schema.String
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -497,9 +493,9 @@ export const FilePart: Schema.Struct<{
   readonly data: Schema.Union<readonly [Schema.String, Schema.Uint8Array, Schema.URL]>
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -607,9 +603,9 @@ export const ToolCallPart: Schema.Struct<{
   readonly providerExecuted: Schema.withDecodingDefault<Schema.Boolean>
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -618,7 +614,7 @@ export const ToolCallPart: Schema.Struct<{
   id: Schema.String,
   name: Schema.String,
   params: Schema.Unknown,
-  providerExecuted: Schema.Boolean.pipe(Schema.withDecodingDefault(constFalse))
+  providerExecuted: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false)))
 }).annotate({ identifier: "ToolCallPart" })
 
 /**
@@ -723,9 +719,9 @@ export const ToolResultPart: Schema.Struct<{
   readonly result: Schema.Unknown
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -841,9 +837,9 @@ export const ToolApprovalResponsePart: Schema.Struct<{
   readonly reason: Schema.optional<Schema.String>
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -942,9 +938,9 @@ export const ToolApprovalRequestPart: Schema.Struct<{
   readonly toolCallId: Schema.String
   readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -970,8 +966,6 @@ export const toolApprovalRequestPart = (
 
 const MessageTypeId = "~effect/ai/Prompt/Message" as const
 
-const constMessageTypeId = () => MessageTypeId
-
 /**
  * Type guard to check if a value is a Message.
  *
@@ -1021,9 +1015,9 @@ export interface BaseMessageEncoded<Role extends string, Options extends Provide
 
 const BaseMessage = Schema.Struct({
   [MessageTypeId]: Schema.Literal(MessageTypeId).pipe(
-    Schema.withDecodingDefaultKey(constMessageTypeId, { encodingStrategy: "omit" })
+    Schema.withDecodingDefaultKey(Effect.succeed(MessageTypeId), { encodingStrategy: "omit" })
   ),
-  options: ProviderOptions.pipe(Schema.withDecodingDefault(constEmptyObject))
+  options: ProviderOptions.pipe(Schema.withDecodingDefault(Effect.succeed({})))
 })
 
 /**
@@ -1087,9 +1081,9 @@ export const ContentFromString: Schema.decodeTo<
         readonly text: Schema.String
         readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
         readonly options: Schema.withDecodingDefault<
-          Schema.Record$<
+          Schema.$Record<
             Schema.String,
-            Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+            Schema.NullOr<Schema.Codec<Schema.Json>>
           >
         >
       }>
@@ -1166,9 +1160,9 @@ export const SystemMessage: Schema.Struct<{
   readonly content: Schema.String
   readonly "~effect/ai/Prompt/Message": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Message">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -1285,9 +1279,9 @@ export const UserMessage: Schema.Struct<{
               readonly text: Schema.String
               readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
               readonly options: Schema.withDecodingDefault<
-                Schema.Record$<
+                Schema.$Record<
                   Schema.String,
-                  Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+                  Schema.NullOr<Schema.Codec<Schema.Json>>
                 >
               >
             }>
@@ -1297,7 +1291,7 @@ export const UserMessage: Schema.Struct<{
         never,
         never
       >,
-      Schema.Array$<
+      Schema.$Array<
         Schema.Union<
           readonly [
             Schema.Struct<{
@@ -1305,9 +1299,9 @@ export const UserMessage: Schema.Struct<{
               readonly text: Schema.String
               readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
               readonly options: Schema.withDecodingDefault<
-                Schema.Record$<
+                Schema.$Record<
                   Schema.String,
-                  Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+                  Schema.NullOr<Schema.Codec<Schema.Json>>
                 >
               >
             }>,
@@ -1318,9 +1312,9 @@ export const UserMessage: Schema.Struct<{
               readonly data: Schema.Union<readonly [Schema.String, Schema.Uint8Array, Schema.URL]>
               readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
               readonly options: Schema.withDecodingDefault<
-                Schema.Record$<
+                Schema.$Record<
                   Schema.String,
-                  Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+                  Schema.NullOr<Schema.Codec<Schema.Json>>
                 >
               >
             }>
@@ -1331,9 +1325,9 @@ export const UserMessage: Schema.Struct<{
   >
   readonly "~effect/ai/Prompt/Message": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Message">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -1470,9 +1464,9 @@ export const AssistantMessage: Schema.Struct<{
               readonly text: Schema.String
               readonly "~effect/ai/Prompt/Part": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Part">>
               readonly options: Schema.withDecodingDefault<
-                Schema.Record$<
+                Schema.$Record<
                   Schema.String,
-                  Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+                  Schema.NullOr<Schema.Codec<Schema.Json>>
                 >
               >
             }>
@@ -1482,7 +1476,7 @@ export const AssistantMessage: Schema.Struct<{
         never,
         never
       >,
-      Schema.Array$<
+      Schema.$Array<
         Schema.Union<
           readonly [
             typeof TextPart,
@@ -1498,9 +1492,9 @@ export const AssistantMessage: Schema.Struct<{
   >
   readonly "~effect/ai/Prompt/Message": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Message">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({
@@ -1613,14 +1607,14 @@ export interface ToolMessageOptions extends ProviderOptions {}
  */
 export const ToolMessage: Schema.Struct<{
   readonly role: Schema.Literal<"tool">
-  readonly content: Schema.Array$<
+  readonly content: Schema.$Array<
     Schema.Union<readonly [typeof ToolResultPart, typeof ToolApprovalResponsePart]>
   >
   readonly "~effect/ai/Prompt/Message": Schema.withDecodingDefaultKey<Schema.Literal<"~effect/ai/Prompt/Message">>
   readonly options: Schema.withDecodingDefault<
-    Schema.Record$<
+    Schema.$Record<
       Schema.String,
-      Schema.NullOr<Schema.Codec<Schema.Json, Schema.Json>>
+      Schema.NullOr<Schema.Codec<Schema.Json>>
     >
   >
 }> = Schema.Struct({