@effect/ai-openai 4.0.0-beta.7 → 4.0.0-beta.70

package/src/OpenAiTelemetry.ts

@@ -5,7 +5,7 @@
  * semantic conventions, extending the base GenAI attributes with OpenAI-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import { dual } from "effect/Function"
 import * as String from "effect/String"
@@ -17,10 +17,10 @@ import * as Telemetry from "effect/unstable/ai/Telemetry"
  * The attributes used to describe telemetry in the context of Generative
  * Artificial Intelligence (GenAI) Models requests and responses.
  *
- * {@see https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/}
+ * @see https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiTelemetryAttributes = Simplify<
   & Telemetry.GenAITelemetryAttributes
@@ -32,8 +32,8 @@ export type OpenAiTelemetryAttributes = Simplify<
  * All telemetry attributes which are part of the GenAI specification,
  * including the OpenAi-specific attributes.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type AllAttributes = Telemetry.AllAttributes & RequestAttributes & ResponseAttributes
 
@@ -41,8 +41,8 @@ export type AllAttributes = Telemetry.AllAttributes & RequestAttributes & Respon
  * Telemetry attributes which are part of the GenAI specification and are
  * namespaced by `gen_ai.openai.request`.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface RequestAttributes {
   /**
@@ -59,8 +59,8 @@ export interface RequestAttributes {
  * Telemetry attributes which are part of the GenAI specification and are
  * namespaced by `gen_ai.openai.response`.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface ResponseAttributes {
   /**
@@ -78,11 +78,13 @@ export interface ResponseAttributes {
  * The `gen_ai.openai.request.response_format` attribute has the following
  * list of well-known values.
  *
+ * **Details**
+ *
  * If one of them applies, then the respective value **MUST** be used;
  * otherwise, a custom value **MAY** be used.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type WellKnownResponseFormat = "json_object" | "json_schema" | "text"
 
@@ -90,17 +92,22 @@ export type WellKnownResponseFormat = "json_object" | "json_schema" | "text"
  * The `gen_ai.openai.request.service_tier` attribute has the following
  * list of well-known values.
  *
+ * **Details**
+ *
  * If one of them applies, then the respective value **MUST** be used;
  * otherwise, a custom value **MAY** be used.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type WellKnownServiceTier = "auto" | "default"
 
 /**
- * @since 1.0.0
- * @since models
+ * Options accepted by `addGenAIAnnotations`, combining standard GenAI
+ * telemetry attributes with optional OpenAI request and response attributes.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type OpenAiTelemetryAttributeOptions = Telemetry.GenAITelemetryAttributeOptions & {
   openai?: {
@@ -120,30 +127,36 @@ const addOpenAiResponseAttributes = Telemetry.addSpanAttributes("gen_ai.openai.r
  * Applies the specified OpenAi GenAI telemetry attributes to the provided
  * `Span`.
  *
- * **NOTE**: This method will mutate the `Span` **in-place**.
+ * **Gotchas**
  *
- * @since 1.0.0
- * @since utilities
+ * This method will mutate the `Span` **in-place**.
+ *
+ * @category tracing
+ * @since 4.0.0
  */
 export const addGenAIAnnotations: {
   /**
    * Applies the specified OpenAi GenAI telemetry attributes to the provided
    * `Span`.
    *
-   * **NOTE**: This method will mutate the `Span` **in-place**.
+   * **Gotchas**
+   *
+   * This method will mutate the `Span` **in-place**.
    *
-   * @since 1.0.0
-   * @since utilities
+   * @category tracing
+   * @since 4.0.0
    */
   (options: OpenAiTelemetryAttributeOptions): (span: Span) => void
   /**
    * Applies the specified OpenAi GenAI telemetry attributes to the provided
    * `Span`.
    *
-   * **NOTE**: This method will mutate the `Span` **in-place**.
+   * **Gotchas**
+   *
+   * This method will mutate the `Span` **in-place**.
    *
-   * @since 1.0.0
-   * @since utilities
+   * @category tracing
+   * @since 4.0.0
    */
   (span: Span, options: OpenAiTelemetryAttributeOptions): void
 } = dual(2, (span: Span, options: OpenAiTelemetryAttributeOptions) => {

package/src/OpenAiTool.ts

@@ -4,7 +4,7 @@
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Schema from "effect/Schema"
 import * as Tool from "effect/unstable/ai/Tool"
@@ -13,8 +13,8 @@ import * as Generated from "./Generated.ts"
 /**
  * Union of all OpenAI provider-defined tools.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiTool =
   | ReturnType<typeof ApplyPatch>
@@ -28,14 +28,12 @@ export type OpenAiTool =
   | ReturnType<typeof WebSearchPreview>
 
 /**
- * OpenAI Apply Patch tool.
+ * OpenAI Apply Patch tool that allows the model to apply diffs by creating,
+ * deleting, or updating files. This local tool runs in your environment and
+ * requires a handler to execute file operations.
  *
- * Allows the model to apply diffs by creating, deleting, or updating files.
- * This is a local tool that runs in your environment and requires a handler
- * to execute file operations.
- *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const ApplyPatch = Tool.providerDefined({
   id: "openai.apply_patch",
@@ -53,12 +51,11 @@ export const ApplyPatch = Tool.providerDefined({
 })
 
 /**
- * OpenAI Code Interpreter tool.
- *
- * Allows the model to execute Python code in a sandboxed environment.
+ * OpenAI Code Interpreter tool that allows the model to execute Python code in
+ * a sandboxed environment.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const CodeInterpreter = Tool.providerDefined({
   id: "openai.code_interpreter",
@@ -77,12 +74,11 @@ export const CodeInterpreter = Tool.providerDefined({
 })
 
 /**
- * OpenAI File Search tool.
- *
- * Enables the model to search through uploaded files and vector stores.
+ * OpenAI File Search tool that enables the model to search through uploaded
+ * files and vector stores.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const FileSearch = Tool.providerDefined({
   id: "openai.file_search",
@@ -102,12 +98,11 @@ export const FileSearch = Tool.providerDefined({
 })
 
 /**
- * OpenAI Image Generation tool.
+ * OpenAI Image Generation tool that enables the model to generate images using
+ * the GPT image models.
  *
- * Enables the model to generate images using the GPT image models.
- *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const ImageGeneration = Tool.providerDefined({
   id: "openai.image_generation",
@@ -131,13 +126,12 @@ export const ImageGeneration = Tool.providerDefined({
 })
 
 /**
- * OpenAI Local Shell tool.
- *
- * Enables the model to run a command with a local shell. This is a local tool
- * that runs in your environment and requires a handler to execute commands.
+ * OpenAI Local Shell tool that enables the model to run a command with a local
+ * shell. This local tool runs in your environment and requires a handler to
+ * execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const LocalShell = Tool.providerDefined({
   id: "openai.local_shell",
@@ -153,13 +147,11 @@ export const LocalShell = Tool.providerDefined({
 })
 
 /**
- * OpenAI MCP tool.
+ * OpenAI MCP tool that gives the model access to additional tools via remote
+ * Model Context Protocol (MCP) servers.
  *
- * Gives the model access to additional tools via remote Model Context Protocol
- * (MCP) servers
- *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const Mcp = Tool.providerDefined({
   id: "openai.mcp",
@@ -174,6 +166,7 @@ export const Mcp = Tool.providerDefined({
     server_label: Generated.MCPTool.fields.server_label,
     server_url: Generated.MCPTool.fields.server_url
   }),
+  parameters: Schema.Unknown,
   success: Schema.Struct({
     type: Generated.MCPToolCall.fields.type,
     name: Generated.MCPToolCall.fields.name,
@@ -185,14 +178,12 @@ export const Mcp = Tool.providerDefined({
 })
 
 /**
- * OpenAI Function Shell tool.
- *
- * Enables the model to execute one or more shell commands in a managed
- * environment. This is a local tool that runs in your environment and requires
- * a handler to execute commands.
+ * OpenAI Function Shell tool that enables the model to execute one or more shell
+ * commands in a managed environment. This local tool runs in your environment
+ * and requires a handler to execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const Shell = Tool.providerDefined({
   id: "openai.shell",
@@ -203,17 +194,16 @@ export const Shell = Tool.providerDefined({
     action: Generated.FunctionShellCall.fields.action
   }),
   success: Schema.Struct({
-    output: Generated.FunctionShellCallOutputItemParam.fields.output
+    output: Generated.FunctionShellCallOutput.fields.output
   })
 })
 
 /**
- * OpenAI Web Search tool.
+ * OpenAI Web Search tool that enables the model to search the web for
+ * information.
  *
- * Enables the model to search the web for information.
- *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const WebSearch = Tool.providerDefined({
   id: "openai.web_search",
@@ -234,12 +224,11 @@ export const WebSearch = Tool.providerDefined({
 })
 
 /**
- * OpenAI Web Search Preview tool.
- *
- * Preview version of the web search tool with additional features.
+ * OpenAI Web Search Preview tool, a preview version of the web search tool with
+ * additional features.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const WebSearchPreview = Tool.providerDefined({
   id: "openai.web_search_preview",

package/src/index.ts

@@ -1,11 +1,11 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Generated from "./Generated.ts"
 
@@ -15,22 +15,52 @@ export * as Generated from "./Generated.ts"
  * Provides a type-safe, Effect-based client for OpenAI operations including
  * completions, embeddings, and streaming responses.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
+ */
+export * as OpenAiClientGenerated from "./OpenAiClientGenerated.ts"
+
+/**
+ * The `OpenAiConfig` module provides contextual configuration for the
+ * `@effect/ai-openai` integration. It is used to customize how OpenAI clients
+ * are built and interpreted without threading configuration through every API
+ * call manually.
+ *
+ * The primary use case is installing an HTTP client transform with
+ * {@link withClientTransform}. This lets applications adapt the underlying
+ * OpenAI HTTP client for cross-cutting concerns such as custom middleware,
+ * instrumentation, proxying, or request policy changes while keeping the
+ * OpenAI service APIs unchanged.
+ *
+ * Configuration is scoped through Effect's context, so transforms only apply to
+ * the effect they are provided to and anything evaluated inside that scope.
+ * When multiple transforms are needed, compose them into a single
+ * `HttpClient => HttpClient` function before providing the configuration.
+ *
+ * @since 4.0.0
  */
 export * as OpenAiConfig from "./OpenAiConfig.ts"
 
+/**
+ * OpenAI Embedding Model implementation.
+ *
+ * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
+ *
+ * @since 4.0.0
+ */
+export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.ts"
+
 /**
  * OpenAI error metadata augmentation.
  *
  * Provides OpenAI-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to OpenAI error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiError from "./OpenAiError.ts"
 
@@ -40,10 +70,17 @@ export * as OpenAiError from "./OpenAiError.ts"
  * Provides a LanguageModel implementation for OpenAI's responses API,
  * supporting text generation, structured output, tool calling, and streaming.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.ts"
 
+/**
+ * Minimal local OpenAI schemas used by the handwritten Responses client path.
+ *
+ * @since 4.0.0
+ */
+export * as OpenAiSchema from "./OpenAiSchema.ts"
+
 /**
  * OpenAI telemetry attributes for OpenTelemetry integration.
  *
@@ -51,7 +88,7 @@ export * as OpenAiLanguageModel from "./OpenAiLanguageModel.ts"
  * semantic conventions, extending the base GenAI attributes with OpenAI-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTelemetry from "./OpenAiTelemetry.ts"
 
@@ -61,6 +98,6 @@ export * as OpenAiTelemetry from "./OpenAiTelemetry.ts"
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTool from "./OpenAiTool.ts"

package/src/internal/errors.ts

@@ -161,12 +161,14 @@ export const parseRateLimitHeaders = (headers: Record<string, string>) => {
   let retryAfter: Duration.Duration | undefined
   if (Predicate.isNotUndefined(retryAfterRaw)) {
     const parsed = Number.parse(retryAfterRaw)
-    if (Predicate.isNotUndefined(parsed)) {
-      retryAfter = Duration.seconds(parsed)
+    if (Option.isSome(parsed)) {
+      retryAfter = Duration.seconds(parsed.value)
     }
   }
   const remainingRaw = headers["x-ratelimit-remaining-requests"]
-  const remaining = Predicate.isNotUndefined(remainingRaw) ? Number.parse(remainingRaw) ?? null : null
+  const remaining = Predicate.isNotUndefined(remainingRaw)
+    ? Option.getOrNull(Number.parse(remainingRaw))
+    : null
   return {
     retryAfter,
     limit: headers["x-ratelimit-limit-requests"] ?? null,
@@ -187,7 +189,7 @@ export const buildHttpRequestDetails = (
   method: request.method,
   url: request.url,
   urlParams: Array.from(request.urlParams),
-  hash: request.hash,
+  hash: Option.getOrUndefined(request.hash),
   headers: Redactable.redact(request.headers) as Record<string, string>
 })