effect 4.0.0-beta.3 → 4.0.0-beta.31

package/src/unstable/ai/AiError.ts

@@ -89,8 +89,11 @@ import { HttpRequestDetails, HttpResponseDetails } from "./Response.ts"
 
 const ReasonTypeId = "~effect/unstable/ai/AiError/Reason" as const
 
-const constEmptyObjectOption = () => Option.some({})
-const constEmptyObject = () => ({})
+const providerMetadataWithDefaults = <Metadata extends ProviderMetadata>() =>
+  (ProviderMetadata as unknown as typeof ProviderMetadata & Schema.Schema<Metadata>).pipe(
+    Schema.withConstructorDefault(() => Option.some({} as Metadata)),
+    Schema.withDecodingDefault(() => ({} as Metadata))
+  )
 
 const redactHeaders = (headers: Record<string, string>): Record<string, string> => {
   const redacted = redact(headers) as Record<string, string | Redacted.Redacted>
@@ -247,9 +250,9 @@ export class NetworkError extends Schema.ErrorClass<NetworkError>(
  * @since 1.0.0
  * @category schemas
  */
-export const ProviderMetadata: Schema.Record$<
+export const ProviderMetadata: Schema.$Record<
   Schema.String,
-  Schema.NullOr<Schema.Codec<Schema.MutableJson, Schema.MutableJson, never, never>>
+  Schema.NullOr<Schema.Codec<Schema.MutableJson>>
 > = Schema.Record(Schema.String, Schema.NullOr(Schema.MutableJson))
 
 /**
@@ -258,6 +261,86 @@ export const ProviderMetadata: Schema.Record$<
  */
 export type ProviderMetadata = typeof ProviderMetadata.Type
 
+/**
+ * Provider-specific metadata attached to `RateLimitError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface RateLimitErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `QuotaExhaustedError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface QuotaExhaustedErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `AuthenticationError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface AuthenticationErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `ContentPolicyError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface ContentPolicyErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `InvalidRequestError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface InvalidRequestErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `InternalProviderError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface InternalProviderErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `InvalidOutputError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface InvalidOutputErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `StructuredOutputError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface StructuredOutputErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `UnsupportedSchemaError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface UnsupportedSchemaErrorMetadata extends ProviderMetadata {}
+
+/**
+ * Provider-specific metadata attached to `UnknownError`.
+ *
+ * @since 1.0.0
+ * @category provider options
+ */
+export interface UnknownErrorMetadata extends ProviderMetadata {}
+
 /**
  * Token usage information from AI operations.
  *
@@ -313,10 +396,7 @@ export class RateLimitError extends Schema.ErrorClass<RateLimitError>(
 )({
   _tag: Schema.tag("RateLimitError"),
   retryAfter: Schema.optional(Schema.Duration),
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<RateLimitErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -364,10 +444,7 @@ export class QuotaExhaustedError extends Schema.ErrorClass<QuotaExhaustedError>(
 )({
   _tag: Schema.tag("QuotaExhaustedError"),
   resetAt: Schema.optional(Schema.DateTimeUtc),
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<QuotaExhaustedErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -417,10 +494,7 @@ export class AuthenticationError extends Schema.ErrorClass<AuthenticationError>(
 )({
   _tag: Schema.tag("AuthenticationError"),
   kind: Schema.Literals(["InvalidKey", "ExpiredKey", "MissingKey", "InsufficientPermissions", "Unknown"]),
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<AuthenticationErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -475,10 +549,7 @@ export class ContentPolicyError extends Schema.ErrorClass<ContentPolicyError>(
 )({
   _tag: Schema.tag("ContentPolicyError"),
   description: Schema.String,
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<ContentPolicyErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -530,10 +601,7 @@ export class InvalidRequestError extends Schema.ErrorClass<InvalidRequestError>(
   parameter: Schema.optional(Schema.String),
   constraint: Schema.optional(Schema.String),
   description: Schema.optional(Schema.String),
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<InvalidRequestErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -585,10 +653,7 @@ export class InternalProviderError extends Schema.ErrorClass<InternalProviderErr
 )({
   _tag: Schema.tag("InternalProviderError"),
   description: Schema.String,
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<InternalProviderErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**
@@ -636,10 +701,7 @@ export class InvalidOutputError extends Schema.ErrorClass<InvalidOutputError>(
 )({
   _tag: Schema.tag("InvalidOutputError"),
   description: Schema.String,
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<InvalidOutputErrorMetadata>(),
   usage: Schema.optional(UsageInfo)
 }) {
   /**
@@ -694,7 +756,8 @@ export class InvalidOutputError extends Schema.ErrorClass<InvalidOutputError>(
  * import { AiError } from "effect/unstable/ai"
  *
  * const error = new AiError.StructuredOutputError({
- *   description: "Expected a valid JSON object"
+ *   description: "Expected a valid JSON object",
+ *   responseText: "{\"foo\":}"
  * })
  *
  * console.log(error.isRetryable) // true
@@ -710,10 +773,8 @@ export class StructuredOutputError extends Schema.ErrorClass<StructuredOutputErr
 )({
   _tag: Schema.tag("StructuredOutputError"),
   description: Schema.String,
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  responseText: Schema.String,
+  metadata: providerMetadataWithDefaults<StructuredOutputErrorMetadata>(),
   usage: Schema.optional(UsageInfo)
 }) {
   /**
@@ -739,16 +800,18 @@ export class StructuredOutputError extends Schema.ErrorClass<StructuredOutputErr
    * import { AiError } from "effect/unstable/ai"
    *
    * declare const schemaError: Schema.SchemaError
+   * declare const rawText: string
    *
-   * const parseError = AiError.StructuredOutputError.fromSchemaError(schemaError)
+   * const parseError = AiError.StructuredOutputError.fromSchemaError(schemaError, rawText)
    * ```
    *
    * @since 1.0.0
    * @category constructors
    */
-  static fromSchemaError(error: Schema.SchemaError): StructuredOutputError {
+  static fromSchemaError(error: Schema.SchemaError, responseText: string): StructuredOutputError {
     return new StructuredOutputError({
-      description: error.message
+      description: error.message,
+      responseText
     })
   }
 
@@ -785,10 +848,7 @@ export class UnsupportedSchemaError extends Schema.ErrorClass<UnsupportedSchemaE
 )({
   _tag: Schema.tag("UnsupportedSchemaError"),
   description: Schema.String,
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  )
+  metadata: providerMetadataWithDefaults<UnsupportedSchemaErrorMetadata>()
 }) {
   /**
    * @since 1.0.0
@@ -835,10 +895,7 @@ export class UnknownError extends Schema.ErrorClass<UnknownError>(
 )({
   _tag: Schema.tag("UnknownError"),
   description: Schema.optional(Schema.String),
-  metadata: ProviderMetadata.pipe(
-    Schema.withConstructorDefault(constEmptyObjectOption),
-    Schema.withDecodingDefault(constEmptyObject)
-  ),
+  metadata: providerMetadataWithDefaults<UnknownErrorMetadata>(),
   http: Schema.optional(HttpContext)
 }) {
   /**

package/src/unstable/ai/Chat.ts

@@ -53,6 +53,7 @@ import * as Option from "../../Option.ts"
 import * as Predicate from "../../Predicate.ts"
 import * as Ref from "../../Ref.ts"
 import * as Schema from "../../Schema.ts"
+import * as Semaphore from "../../Semaphore.ts"
 import * as ServiceMap from "../../ServiceMap.ts"
 import * as Stream from "../../Stream.ts"
 import type { NoExcessProperties } from "../../Types.ts"
@@ -63,7 +64,6 @@ import * as IdGenerator from "./IdGenerator.ts"
 import * as LanguageModel from "./LanguageModel.ts"
 import * as Prompt from "./Prompt.ts"
 import type * as Response from "./Response.ts"
-import type * as Tool from "./Tool.ts"
 
 /**
  * The `Chat` service tag for dependency injection.
@@ -199,10 +199,9 @@ export interface Service {
    * ```
    */
   readonly generateText: <
-    Options extends NoExcessProperties<LanguageModel.GenerateTextOptions<any>, Options>,
-    Tools extends Record<string, Tool.Any> = {}
-  >(options: Options & LanguageModel.GenerateTextOptions<Tools>) => Effect.Effect<
-    LanguageModel.GenerateTextResponse<Tools>,
+    Options extends NoExcessProperties<LanguageModel.GenerateTextOptions<any>, Options>
+  >(options: Options & LanguageModel.GenerateTextOptions<LanguageModel.ExtractTools<Options>>) => Effect.Effect<
+    LanguageModel.GenerateTextResponse<LanguageModel.ExtractTools<Options>>,
     LanguageModel.ExtractError<Options>,
     LanguageModel.LanguageModel | LanguageModel.ExtractServices<Options>
   >
@@ -233,10 +232,9 @@ export interface Service {
    * ```
    */
   readonly streamText: <
-    Options extends NoExcessProperties<LanguageModel.GenerateTextOptions<any>, Options>,
-    Tools extends Record<string, Tool.Any> = {}
-  >(options: Options & LanguageModel.GenerateTextOptions<Tools>) => Stream.Stream<
-    Response.StreamPart<Tools>,
+    Options extends NoExcessProperties<LanguageModel.GenerateTextOptions<any>, Options>
+  >(options: Options & LanguageModel.GenerateTextOptions<LanguageModel.ExtractTools<Options>>) => Stream.Stream<
+    Response.StreamPart<LanguageModel.ExtractTools<Options>>,
     LanguageModel.ExtractError<Options>,
     LanguageModel.LanguageModel | LanguageModel.ExtractServices<Options>
   >
@@ -276,11 +274,12 @@ export interface Service {
    */
   readonly generateObject: <
     ObjectEncoded extends Record<string, any>,
-    ObjectSchema extends Schema.Codec<any, ObjectEncoded, any, any>,
-    Options extends NoExcessProperties<LanguageModel.GenerateObjectOptions<any, ObjectSchema>, Options>,
-    Tools extends Record<string, Tool.Any> = {}
-  >(options: Options & LanguageModel.GenerateObjectOptions<Tools, ObjectSchema>) => Effect.Effect<
-    LanguageModel.GenerateObjectResponse<Tools, ObjectSchema["Type"]>,
+    ObjectSchema extends Schema.Encoder<ObjectEncoded, unknown>,
+    Options extends NoExcessProperties<LanguageModel.GenerateObjectOptions<any, ObjectSchema>, Options>
+  >(
+    options: Options & LanguageModel.GenerateObjectOptions<LanguageModel.ExtractTools<Options>, ObjectSchema>
+  ) => Effect.Effect<
+    LanguageModel.GenerateObjectResponse<LanguageModel.ExtractTools<Options>, ObjectSchema["Type"]>,
     LanguageModel.ExtractError<Options>,
     LanguageModel.ExtractServices<Options> | ObjectSchema["DecodingServices"] | LanguageModel.LanguageModel
   >
@@ -295,42 +294,8 @@ const encodeHistoryJson = Schema.encodeUnknownEffect(Schema.fromJsonString(Promp
 // Constructors
 // =============================================================================
 
-/**
- * Creates a new Chat service with empty conversation history.
- *
- * This is the most common way to start a fresh chat session without
- * any initial context or system prompts.
- *
- * @example
- * ```ts
- * import { Effect } from "effect"
- * import { Chat } from "effect/unstable/ai"
- *
- * const freshChat = Effect.gen(function*() {
- *   const chat = yield* Chat.empty
- *
- *   const response = yield* chat.generateText({
- *     prompt: "Hello! Can you introduce yourself?"
- *   })
- *
- *   console.log(response.content)
- *
- *   return chat
- * })
- * ```
- *
- * @since 4.0.0
- * @category constructors
- */
-export const empty: Effect.Effect<Service> = Effect.gen(function*() {
-  const history = yield* Ref.make(Prompt.empty)
-  const services = yield* Effect.services<never>()
-  const semaphore = yield* Effect.makeSemaphore(1)
-
-  const provideContext = <A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> =>
-    Effect.updateServices(effect, (existing) => ServiceMap.merge(services, existing))
-  const provideContextStream = <A, E, R>(stream: Stream.Stream<A, E, R>): Stream.Stream<A, E, R> =>
-    Stream.updateServices(stream, (existing) => ServiceMap.merge(services, existing))
+const makeUnsafe = (history: Ref.Ref<Prompt.Prompt>) => {
+  const semaphore = Semaphore.makeUnsafe(1)
 
   return Chat.of({
     history,
@@ -367,7 +332,6 @@ export const empty: Effect.Effect<Service> = Effect.gen(function*() {
 
         return response
       },
-      provideContext,
       semaphore.withPermits(1),
       (effect) => Effect.withSpan(effect, "Chat.generateText", { captureStackTrace: false })
     ),
@@ -396,7 +360,6 @@ export const empty: Effect.Effect<Service> = Effect.gen(function*() {
               semaphore.release(1)
             )
         )).pipe(
-          provideContextStream,
           Stream.withSpan("Chat.streamText", {
             captureStackTrace: false
           })
@@ -417,7 +380,6 @@ export const empty: Effect.Effect<Service> = Effect.gen(function*() {
 
         return response
       },
-      provideContext,
       semaphore.withPermits(1),
       (effect, options) =>
         Effect.withSpan(effect, "Chat.generateObject", {
@@ -428,7 +390,36 @@ export const empty: Effect.Effect<Service> = Effect.gen(function*() {
         })
     )
   })
-})
+}
+
+/**
+ * Creates a new Chat service with empty conversation history.
+ *
+ * This is the most common way to start a fresh chat session without
+ * any initial context or system prompts.
+ *
+ * @example
+ * ```ts
+ * import { Effect } from "effect"
+ * import { Chat } from "effect/unstable/ai"
+ *
+ * const freshChat = Effect.gen(function*() {
+ *   const chat = yield* Chat.empty
+ *
+ *   const response = yield* chat.generateText({
+ *     prompt: "Hello! Can you introduce yourself?"
+ *   })
+ *
+ *   console.log(response.content)
+ *
+ *   return chat
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category constructors
+ */
+export const empty: Effect.Effect<Service> = Effect.sync(() => makeUnsafe(Ref.makeUnsafe(Prompt.empty)))
 
 /**
  * Creates a new Chat service from an initial prompt.
@@ -488,13 +479,8 @@ export const empty: Effect.Effect<Service> = Effect.gen(function*() {
  * @since 4.0.0
  * @category constructors
  */
-export const fromPrompt = Effect.fnUntraced(
-  function*(prompt: Prompt.RawInput) {
-    const chat = yield* empty
-    yield* Ref.set(chat.history, Prompt.make(prompt))
-    return chat
-  }
-)
+export const fromPrompt = (prompt: Prompt.RawInput) =>
+  Effect.sync(() => makeUnsafe(Ref.makeUnsafe(Prompt.make(prompt))))
 
 /**
  * Creates a Chat service from previously exported chat data.
@@ -533,8 +519,7 @@ export const fromPrompt = Effect.fnUntraced(
  */
 export const fromExport = (data: unknown): Effect.Effect<
   Service,
-  Schema.SchemaError,
-  LanguageModel.LanguageModel
+  Schema.SchemaError
 > => Effect.flatMap(decodeHistory(data), fromPrompt)
 
 /**
@@ -575,8 +560,7 @@ export const fromExport = (data: unknown): Effect.Effect<
  */
 export const fromJson = (data: string): Effect.Effect<
   Service,
-  Schema.SchemaError,
-  LanguageModel.LanguageModel
+  Schema.SchemaError
 > => Effect.flatMap(decodeHistoryJson(data), fromPrompt)
 
 // =============================================================================
@@ -627,7 +611,7 @@ export declare namespace Persistence {
      * the persistence store, a `ChatNotFoundError` will be returned.
      */
     readonly get: (chatId: string, options?: {
-      readonly timeToLive?: Duration.DurationInput | undefined
+      readonly timeToLive?: Duration.Input | undefined
     }) => Effect.Effect<Persisted, ChatNotFoundError | PersistenceError>
 
     /**
@@ -637,7 +621,7 @@ export declare namespace Persistence {
      * returned.
      */
     readonly getOrCreate: (chatId: string, options?: {
-      readonly timeToLive?: Duration.DurationInput | undefined
+      readonly timeToLive?: Duration.Input | undefined
     }) => Effect.Effect<Persisted, AiError.AiError | PersistenceError>
   }
 }
@@ -680,7 +664,7 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
   const store = yield* persistence.make(options.storeId)
 
   const toPersisted = Effect.fnUntraced(
-    function*(chatId: string, chat: Service, ttl: Duration.DurationInput | undefined) {
+    function*(chatId: string, chat: Service, ttl: Duration.Input | undefined) {
       const idGenerator = yield* Effect.serviceOption(IdGenerator.IdGenerator).pipe(
         Effect.map(Option.getOrElse(() => IdGenerator.defaultIdGenerator))
       )
@@ -712,7 +696,7 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
           yield* Ref.set(chat.history, history)
           // Export the chat history
           const exported = yield* Effect.orDie(chat.export)
-          const timeToLive = Predicate.isNotUndefined(ttl) ? Duration.fromDurationInput(ttl) : undefined
+          const timeToLive = Predicate.isNotUndefined(ttl) ? Duration.fromInput(ttl) : undefined
           // Save the chat to the backing store
           yield* store.set(chatId, exported as object, timeToLive)
         }
@@ -748,13 +732,13 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
   )
 
   const createChat = Effect.fnUntraced(
-    function*(chatId: string, ttl: Duration.DurationInput | undefined) {
+    function*(chatId: string, ttl: Duration.Input | undefined) {
       // Create an empty chat
       const chat = yield* empty
       // Export the chat history
       const history = yield* Effect.orDie(chat.export)
       // Save the history for the newly created chat
-      const timeToLive = Predicate.isNotUndefined(ttl) ? Duration.fromDurationInput(ttl) : undefined
+      const timeToLive = Predicate.isNotUndefined(ttl) ? Duration.fromInput(ttl) : undefined
       yield* store.set(chatId, history as object, timeToLive)
       // Convert the chat to a persisted chat
       return yield* toPersisted(chatId, chat, ttl)
@@ -762,7 +746,7 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
   )
 
   const getChat = Effect.fnUntraced(
-    function*(chatId: string, ttl: Duration.DurationInput | undefined) {
+    function*(chatId: string, ttl: Duration.Input | undefined) {
       // Create an empty chat
       const chat = yield* empty
       // Attempt to retrieve the previous history from the store
@@ -783,7 +767,7 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
 
   const get = Effect.fnUntraced(
     function*(chatId: string, options?: {
-      readonly timeToLive?: Duration.DurationInput | undefined
+      readonly timeToLive?: Duration.Input | undefined
     }) {
       return yield* getChat(chatId, options?.timeToLive)
     },
@@ -795,7 +779,7 @@ export const makePersisted = Effect.fnUntraced(function*(options: {
 
   const getOrCreate = Effect.fnUntraced(
     function*(chatId: string, options?: {
-      readonly timeToLive?: Duration.DurationInput | undefined
+      readonly timeToLive?: Duration.Input | undefined
     }) {
       return yield* getChat(chatId, options?.timeToLive).pipe(
         Effect.catchTag("ChatNotFoundError", () => createChat(chatId, options?.timeToLive))