@effect/ai-openai 4.0.0-beta.51 → 4.0.0-beta.53

package/dist/index.js

@@ -15,6 +15,10 @@ export * as Generated from "./Generated.js";
  * @since 1.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.js";
+/**
+ * @since 1.0.0
+ */
+export * as OpenAiClientGenerated from "./OpenAiClientGenerated.js";
 /**
  * @since 1.0.0
  */
@@ -45,6 +49,12 @@ export * as OpenAiError from "./OpenAiError.js";
  * @since 1.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.js";
+/**
+ * Minimal local OpenAI schemas used by the handwritten Responses client path.
+ *
+ * @since 1.0.0
+ */
+export * as OpenAiSchema from "./OpenAiSchema.js";
 /**
  * OpenAI telemetry attributes for OpenTelemetry integration.
  *

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Generated","OpenAiClient","OpenAiConfig","OpenAiEmbeddingModel","OpenAiError","OpenAiLanguageModel","OpenAiTelemetry","OpenAiTool"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;AAQA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;AAOA,OAAO,KAAKC,oBAAoB,MAAM,2BAA2B;AAEjE;;;;;;;;AAQA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;AAQA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;;;;;;;AASA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;;;;;;AAQA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Generated","OpenAiClient","OpenAiClientGenerated","OpenAiConfig","OpenAiEmbeddingModel","OpenAiError","OpenAiLanguageModel","OpenAiSchema","OpenAiTelemetry","OpenAiTool"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;AAQA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,qBAAqB,MAAM,4BAA4B;AAEnE;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;AAOA,OAAO,KAAKC,oBAAoB,MAAM,2BAA2B;AAEjE;;;;;;;;AAQA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;AAQA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;;;AAKA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;AASA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;;;;;;AAQA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/ai-openai",
-  "version": "4.0.0-beta.51",
+  "version": "4.0.0-beta.53",
   "type": "module",
   "license": "MIT",
   "description": "An OpenAI provider integration for Effect AI SDK",
@@ -43,10 +43,10 @@
     "provenance": true
   },
   "devDependencies": {
-    "effect": "^4.0.0-beta.51"
+    "effect": "^4.0.0-beta.53"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.51"
+    "effect": "^4.0.0-beta.53"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/OpenAiClient.ts

@@ -30,9 +30,9 @@ import * as HttpClient from "effect/unstable/http/HttpClient"
 import * as HttpClientRequest from "effect/unstable/http/HttpClientRequest"
 import * as HttpClientResponse from "effect/unstable/http/HttpClientResponse"
 import * as Socket from "effect/unstable/socket/Socket"
-import * as Generated from "./Generated.ts"
 import * as Errors from "./internal/errors.ts"
 import { OpenAiConfig } from "./OpenAiConfig.ts"
+import * as OpenAiSchema from "./OpenAiSchema.ts"
 
 // =============================================================================
 // Service Interface
@@ -46,17 +46,17 @@ import { OpenAiConfig } from "./OpenAiConfig.ts"
  */
 export interface Service {
   /**
-   * The underlying generated OpenAI client.
+   * The transformed HTTP client used by this service.
    */
-  readonly client: Generated.OpenAiClient
+  readonly client: HttpClient.HttpClient
 
   /**
    * Create a response using the OpenAI responses endpoint.
    */
   readonly createResponse: (
-    options: typeof Generated.CreateResponse.Encoded
+    options: typeof OpenAiSchema.CreateResponse.Encoded
   ) => Effect.Effect<
-    readonly [body: typeof Generated.Response.Type, response: HttpClientResponse.HttpClientResponse],
+    readonly [body: typeof OpenAiSchema.Response.Type, response: HttpClientResponse.HttpClientResponse],
     AiError.AiError
   >
 
@@ -64,11 +64,11 @@ export interface Service {
    * Create a streaming response using the OpenAI responses endpoint.
    */
   readonly createResponseStream: (
-    options: Omit<typeof Generated.CreateResponse.Encoded, "stream">
+    options: Omit<typeof OpenAiSchema.CreateResponse.Encoded, "stream">
   ) => Effect.Effect<
     readonly [
       response: HttpClientResponse.HttpClientResponse,
-      stream: Stream.Stream<typeof Generated.ResponseStreamEvent.Type, AiError.AiError>
+      stream: Stream.Stream<typeof OpenAiSchema.ResponseStreamEvent.Type, AiError.AiError>
     ],
     AiError.AiError
   >
@@ -77,8 +77,8 @@ export interface Service {
    * Create embeddings using the OpenAI embeddings endpoint.
    */
   readonly createEmbedding: (
-    options: typeof Generated.CreateEmbeddingRequest.Encoded
-  ) => Effect.Effect<typeof Generated.CreateEmbeddingResponse.Type, AiError.AiError>
+    options: typeof OpenAiSchema.CreateEmbeddingRequest.Encoded
+  ) => Effect.Effect<typeof OpenAiSchema.CreateEmbeddingResponse.Type, AiError.AiError>
 }
 
 // =============================================================================
@@ -176,45 +176,57 @@ export const make = Effect.fnUntraced(
           : identity,
         HttpClientRequest.acceptJson
       )),
+      HttpClient.filterStatusOk,
       options.transformClient
         ? options.transformClient
         : identity
     )
 
-    const httpClientOk = HttpClient.filterStatusOk(httpClient)
+    const resolveHttpClient = Effect.map(
+      OpenAiConfig.getOrUndefined,
+      (config) =>
+        Predicate.isNotUndefined(config?.transformClient)
+          ? config.transformClient(httpClient)
+          : httpClient
+    )
 
-    const client = Generated.make(httpClient, {
-      transformClient: Effect.fnUntraced(function*(client) {
-        const config = yield* OpenAiConfig.getOrUndefined
-        if (Predicate.isNotUndefined(config?.transformClient)) {
-          return config.transformClient(client)
-        }
-        return client
-      })
-    })
+    const decodeResponse = HttpClientResponse.schemaBodyJson(OpenAiSchema.Response)
 
     const createResponse = (
-      payload: typeof Generated.CreateResponse.Encoded
+      payload: typeof OpenAiSchema.CreateResponse.Encoded
     ): Effect.Effect<
-      [body: typeof Generated.Response.Type, response: HttpClientResponse.HttpClientResponse],
+      [body: typeof OpenAiSchema.Response.Type, response: HttpClientResponse.HttpClientResponse],
       AiError.AiError
     > =>
-      client.createResponse({ payload, config: { includeResponse: true } }).pipe(
-        Effect.catchTags({
-          HttpClientError: (error) => Errors.mapHttpClientError(error, "createResponse"),
-          SchemaError: (error) => Effect.fail(Errors.mapSchemaError(error, "createResponse"))
-        })
-      )
+      Effect.flatMap(resolveHttpClient, (client) =>
+        client.execute(
+          HttpClientRequest.post("/responses", {
+            body: HttpBody.jsonUnsafe(payload)
+          })
+        ).pipe(
+          Effect.flatMap((response) =>
+            decodeResponse(response).pipe(
+              Effect.map((body): [typeof OpenAiSchema.Response.Type, HttpClientResponse.HttpClientResponse] => [
+                body,
+                response
+              ])
+            )
+          ),
+          Effect.catchTags({
+            HttpClientError: (error) => Errors.mapHttpClientError(error, "createResponse"),
+            SchemaError: (error) => Effect.fail(Errors.mapSchemaError(error, "createResponse"))
+          })
+        ))
 
     const buildResponseStream = (
       response: HttpClientResponse.HttpClientResponse
     ): [
       HttpClientResponse.HttpClientResponse,
-      Stream.Stream<typeof Generated.ResponseStreamEvent.Type, AiError.AiError>
+      Stream.Stream<typeof OpenAiSchema.ResponseStreamEvent.Type, AiError.AiError>
     ] => {
       const stream = response.stream.pipe(
         Stream.decodeText(),
-        Stream.pipeThroughChannel(Sse.decodeDataSchema(Generated.ResponseStreamEvent)),
+        Stream.pipeThroughChannel(Sse.decodeDataSchema(OpenAiSchema.ResponseStreamEvent)),
         Stream.takeUntil((event) =>
           event.data.type === "response.completed" ||
           event.data.type === "response.incomplete"
@@ -226,7 +238,7 @@ export const make = Effect.fnUntraced(
           HttpClientError: (error) => Stream.fromEffect(Errors.mapHttpClientError(error, "createResponseStream")),
           SchemaError: (error) => Stream.fail(Errors.mapSchemaError(error, "createResponseStream"))
         })
-      ) as any
+      )
       return [response, stream]
     }
 
@@ -234,31 +246,40 @@ export const make = Effect.fnUntraced(
       Effect.contextWith((services) => {
         const socket = Context.getOrUndefined(services, OpenAiSocket)
         if (socket) return socket.createResponseStream(payload)
-        return httpClientOk.execute(
-          HttpClientRequest.post("/responses", {
-            body: HttpBody.jsonUnsafe({ ...payload, stream: true })
-          })
-        ).pipe(
-          Effect.map(buildResponseStream),
-          Effect.catchTag(
-            "HttpClientError",
-            (error) => Errors.mapHttpClientError(error, "createResponseStream")
-          )
-        )
+        return Effect.flatMap(resolveHttpClient, (client) =>
+          client.execute(
+            HttpClientRequest.post("/responses", {
+              body: HttpBody.jsonUnsafe({ ...payload, stream: true })
+            })
+          ).pipe(
+            Effect.map(buildResponseStream),
+            Effect.catchTag(
+              "HttpClientError",
+              (error) => Errors.mapHttpClientError(error, "createResponseStream")
+            )
+          ))
       })
 
+    const decodeEmbedding = HttpClientResponse.schemaBodyJson(OpenAiSchema.CreateEmbeddingResponse)
+
     const createEmbedding = (
-      payload: typeof Generated.CreateEmbeddingRequest.Encoded
-    ): Effect.Effect<typeof Generated.CreateEmbeddingResponse.Type, AiError.AiError> =>
-      client.createEmbedding({ payload }).pipe(
-        Effect.catchTags({
-          HttpClientError: (error) => Errors.mapHttpClientError(error, "createEmbedding"),
-          SchemaError: (error) => Effect.fail(Errors.mapSchemaError(error, "createEmbedding"))
-        })
-      )
+      payload: typeof OpenAiSchema.CreateEmbeddingRequest.Encoded
+    ): Effect.Effect<typeof OpenAiSchema.CreateEmbeddingResponse.Type, AiError.AiError> =>
+      Effect.flatMap(resolveHttpClient, (client) =>
+        client.execute(
+          HttpClientRequest.post("/embeddings", {
+            body: HttpBody.jsonUnsafe(payload)
+          })
+        ).pipe(
+          Effect.flatMap(decodeEmbedding),
+          Effect.catchTags({
+            HttpClientError: (error) => Errors.mapHttpClientError(error, "createEmbedding"),
+            SchemaError: (error) => Effect.fail(Errors.mapSchemaError(error, "createEmbedding"))
+          })
+        ))
 
     return OpenAiClient.of({
-      client,
+      client: httpClient,
       createResponse,
       createResponseStream,
       createEmbedding
@@ -349,7 +370,7 @@ export const layerConfig = (options?: {
  * @since 1.0.0
  * @category Events
  */
-export type ResponseStreamEvent = typeof Generated.ResponseStreamEvent.Type
+export type ResponseStreamEvent = typeof OpenAiSchema.ResponseStreamEvent.Type
 
 /**
  * @since 1.0.0
@@ -360,7 +381,7 @@ export class OpenAiSocket extends Context.Service<OpenAiSocket, {
    * Create a streaming response using the OpenAI responses endpoint.
    */
   readonly createResponseStream: (
-    options: Omit<typeof Generated.CreateResponse.Encoded, "stream">
+    options: Omit<typeof OpenAiSchema.CreateResponse.Encoded, "stream">
   ) => Effect.Effect<
     readonly [
       response: HttpClientResponse.HttpClientResponse,
@@ -374,14 +395,22 @@ const makeSocket = Effect.gen(function*() {
   const client = yield* OpenAiClient
   const tracker = yield* ResponseIdTracker.make
   const socketScope = yield* Effect.scope
-  const makeRequest = Effect.orDie(client.client.httpClient.preprocess(HttpClientRequest.post("/responses")))
+  const makeRequest = Effect.flatMap(
+    OpenAiConfig.getOrUndefined,
+    (config) => {
+      const httpClient = Predicate.isNotUndefined(config?.transformClient)
+        ? config.transformClient(client.client)
+        : client.client
+      return Effect.orDie(httpClient.preprocess(HttpClientRequest.post("/responses")))
+    }
+  )
   const makeWebSocket = yield* Socket.WebSocketConstructor
 
   const decoder = new TextDecoder()
 
   const queueRef: RcRef.RcRef<
     {
-      readonly send: (message: typeof Generated.CreateResponse.Encoded) => Effect.Effect<void, AiError.AiError>
+      readonly send: (message: typeof OpenAiSchema.CreateResponse.Encoded) => Effect.Effect<void, AiError.AiError>
       readonly incoming: Queue.Dequeue<ResponseStreamEvent, AiError.AiError>
     }
   > = yield* RcRef.make({
@@ -403,7 +432,7 @@ const makeSocket = Effect.gen(function*() {
       })
 
       const incoming = yield* Queue.unbounded<ResponseStreamEvent, AiError.AiError>()
-      const send = (message: typeof Generated.CreateResponse.Encoded) =>
+      const send = (message: typeof OpenAiSchema.CreateResponse.Encoded) =>
         write(JSON.stringify({
           type: "response.create",
           ...message
@@ -432,15 +461,17 @@ const makeSocket = Effect.gen(function*() {
         try {
           const event = decodeEvent(text)
           if (event.type === "error" && "status" in event) {
-            const json = JSON.stringify(event.error)
+            const status = Number(event.status)
+            const error = "error" in event ? event.error : event
+            const json = JSON.stringify(error)
             return Effect.fail(
               AiError.make({
                 module: "OpenAiClient",
                 method: "createResponseStream",
                 reason: AiError.reasonFromHttpStatus({
                   description: json,
-                  status: event.status,
-                  metadata: event.error,
+                  status: isNaN(status) ? 500 : status,
+                  metadata: error as any,
                   http: {
                     body: json,
                     request: {
@@ -542,7 +573,7 @@ const ErrorEvent = Schema.Struct({
   })
 })
 
-const AllEvents = Schema.Union([ErrorEvent, Generated.ResponseStreamEvent])
+const AllEvents = Schema.Union([ErrorEvent, OpenAiSchema.ResponseStreamEvent])
 const decodeEvent = Schema.decodeUnknownSync(Schema.fromJsonString(AllEvents))
 
 /**

package/src/OpenAiClientGenerated.ts

@@ -0,0 +1,202 @@
+/**
+ * @since 1.0.0
+ */
+import * as Array from "effect/Array"
+import type * as Config from "effect/Config"
+import * as Context from "effect/Context"
+import * as Effect from "effect/Effect"
+import { identity } from "effect/Function"
+import * as Function from "effect/Function"
+import * as Layer from "effect/Layer"
+import * as Predicate from "effect/Predicate"
+import * as Redacted from "effect/Redacted"
+import * as Headers from "effect/unstable/http/Headers"
+import * as HttpClient from "effect/unstable/http/HttpClient"
+import * as HttpClientRequest from "effect/unstable/http/HttpClientRequest"
+import * as Generated from "./Generated.ts"
+import { OpenAiConfig } from "./OpenAiConfig.ts"
+
+// =============================================================================
+// Service Identifier
+// =============================================================================
+
+/**
+ * Service identifier for the generated OpenAI client.
+ *
+ * @since 1.0.0
+ * @category service
+ */
+export class OpenAiClientGenerated extends Context.Service<OpenAiClientGenerated, Generated.OpenAiClient>()(
+  "@effect/ai-openai/OpenAiClientGenerated"
+) {}
+
+// =============================================================================
+// Options
+// =============================================================================
+
+/**
+ * Options for configuring the generated OpenAI client.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type Options = {
+  /**
+   * The OpenAI API key.
+   */
+  readonly apiKey?: Redacted.Redacted<string> | undefined
+
+  /**
+   * The base URL for the OpenAI API.
+   *
+   * @default "https://api.openai.com/v1"
+   */
+  readonly apiUrl?: string | undefined
+
+  /**
+   * Optional organization ID for multi-org accounts.
+   */
+  readonly organizationId?: Redacted.Redacted<string> | undefined
+
+  /**
+   * Optional project ID for project-scoped requests.
+   */
+  readonly projectId?: Redacted.Redacted<string> | undefined
+
+  /**
+   * Optional transformer for the HTTP client.
+   */
+  readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined
+}
+
+const RedactedOpenAiHeaders = {
+  OpenAiOrganization: "OpenAI-Organization",
+  OpenAiProject: "OpenAI-Project"
+}
+
+// =============================================================================
+// Constructor
+// =============================================================================
+
+/**
+ * Creates a generated OpenAI client service with the given options.
+ *
+ * @since 1.0.0
+ * @category constructors
+ */
+export const make = Effect.fnUntraced(
+  function*(options: Options): Effect.fn.Return<Generated.OpenAiClient, never, HttpClient.HttpClient> {
+    const baseClient = yield* HttpClient.HttpClient
+    const apiUrl = options.apiUrl ?? "https://api.openai.com/v1"
+
+    const httpClient = baseClient.pipe(
+      HttpClient.mapRequest(Function.flow(
+        HttpClientRequest.prependUrl(apiUrl),
+        options.apiKey
+          ? HttpClientRequest.bearerToken(Redacted.value(options.apiKey))
+          : identity,
+        options.organizationId
+          ? HttpClientRequest.setHeader(
+            RedactedOpenAiHeaders.OpenAiOrganization,
+            Redacted.value(options.organizationId)
+          )
+          : identity,
+        options.projectId
+          ? HttpClientRequest.setHeader(
+            RedactedOpenAiHeaders.OpenAiProject,
+            Redacted.value(options.projectId)
+          )
+          : identity,
+        HttpClientRequest.acceptJson
+      )),
+      options.transformClient
+        ? options.transformClient
+        : identity
+    )
+
+    return Generated.make(httpClient, {
+      transformClient: Effect.fnUntraced(function*(client) {
+        const config = yield* OpenAiConfig.getOrUndefined
+        if (Predicate.isNotUndefined(config?.transformClient)) {
+          return config.transformClient(client)
+        }
+        return client
+      })
+    })
+  },
+  Effect.updateService(
+    Headers.CurrentRedactedNames,
+    Array.appendAll(Object.values(RedactedOpenAiHeaders))
+  )
+)
+
+// =============================================================================
+// Layers
+// =============================================================================
+
+/**
+ * Creates a layer for the generated OpenAI client with the given options.
+ *
+ * @since 1.0.0
+ * @category layers
+ */
+export const layer = (options: Options): Layer.Layer<OpenAiClientGenerated, never, HttpClient.HttpClient> =>
+  Layer.effect(OpenAiClientGenerated, make(options))
+
+/**
+ * Creates a layer for the generated OpenAI client, loading the requisite
+ * configuration via Effect's `Config` module.
+ *
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerConfig = (options?: {
+  /**
+   * The config value to load for the API key.
+   */
+  readonly apiKey?: Config.Config<Redacted.Redacted<string> | undefined> | undefined
+
+  /**
+   * The config value to load for the API URL.
+   */
+  readonly apiUrl?: Config.Config<string> | undefined
+
+  /**
+   * The config value to load for the organization ID.
+   */
+  readonly organizationId?: Config.Config<Redacted.Redacted<string> | undefined> | undefined
+
+  /**
+   * The config value to load for the project ID.
+   */
+  readonly projectId?: Config.Config<Redacted.Redacted<string> | undefined> | undefined
+
+  /**
+   * Optional transformer for the HTTP client.
+   */
+  readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined
+}): Layer.Layer<OpenAiClientGenerated, Config.ConfigError, HttpClient.HttpClient> =>
+  Layer.effect(
+    OpenAiClientGenerated,
+    Effect.gen(function*() {
+      const apiKey = Predicate.isNotUndefined(options?.apiKey)
+        ? yield* options.apiKey :
+        undefined
+      const apiUrl = Predicate.isNotUndefined(options?.apiUrl)
+        ? yield* options.apiUrl :
+        undefined
+      const organizationId = Predicate.isNotUndefined(options?.organizationId)
+        ? yield* options.organizationId
+        : undefined
+      const projectId = Predicate.isNotUndefined(options?.projectId)
+        ? yield* options.projectId :
+        undefined
+      return yield* make({
+        apiKey,
+        apiUrl,
+        organizationId,
+        projectId,
+        transformClient: options?.transformClient
+      })
+    })
+  )

package/src/OpenAiEmbeddingModel.ts

@@ -13,8 +13,8 @@ import type { Simplify } from "effect/Types"
 import * as AiError from "effect/unstable/ai/AiError"
 import * as EmbeddingModel from "effect/unstable/ai/EmbeddingModel"
 import * as AiModel from "effect/unstable/ai/Model"
-import type * as Generated from "./Generated.ts"
 import { OpenAiClient } from "./OpenAiClient.ts"
+import type * as OpenAiSchema from "./OpenAiSchema.ts"
 
 /**
  * @since 1.0.0
@@ -33,7 +33,7 @@ export class Config extends Context.Service<
   Simplify<
     & Partial<
       Omit<
-        typeof Generated.CreateEmbeddingRequest.Encoded,
+        typeof OpenAiSchema.CreateEmbeddingRequest.Encoded,
         "input"
       >
     >
@@ -155,7 +155,7 @@ export const withConfigOverride: {
 
 const mapProviderResponse = (
   inputLength: number,
-  response: typeof Generated.CreateEmbeddingResponse.Type
+  response: typeof OpenAiSchema.CreateEmbeddingResponse.Type
 ): Effect.Effect<EmbeddingModel.ProviderResponse, AiError.AiError> => {
   if (response.data.length !== inputLength) {
     return Effect.fail(
@@ -173,6 +173,9 @@ const mapProviderResponse = (
     if (seen.has(entry.index)) {
       return Effect.fail(invalidOutput("Provider returned duplicate embedding index: " + entry.index))
     }
+    if (!Array.isArray(entry.embedding)) {
+      return Effect.fail(invalidOutput("Provider returned non-vector embedding at index " + entry.index))
+    }
 
     seen.add(entry.index)
     results[entry.index] = [...entry.embedding]