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

package/src/index.ts

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 // @barrel: Auto-generated exports. Do not edit manually.
@@ -10,12 +10,30 @@
  * Provides a type-safe, Effect-based client for Anthropic operations including
  * messages and streaming responses.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as AnthropicClient from "./AnthropicClient.ts"
 
 /**
- * @since 1.0.0
+ * The `AnthropicConfig` module provides contextual configuration for the
+ * Anthropic AI provider integration. It is used to customize the generated
+ * Anthropic HTTP client without changing individual request code.
+ *
+ * **Common tasks**
+ *
+ * - Provide a shared `HttpClient` transformation for Anthropic requests
+ * - Add provider-specific concerns such as request instrumentation, proxying,
+ *   retries, or header manipulation
+ * - Scope a client transformation to a single effect with {@link withClientTransform}
+ *
+ * **Gotchas**
+ *
+ * - Configuration is read from the Effect context, so overrides only apply to
+ *   effects run inside the configured scope
+ * - `withClientTransform` replaces the current `transformClient` value while
+ *   preserving any other Anthropic configuration fields
+ *
+ * @since 4.0.0
  */
 export * as AnthropicConfig from "./AnthropicConfig.ts"
 
@@ -25,12 +43,38 @@ export * as AnthropicConfig from "./AnthropicConfig.ts"
  * Provides Anthropic-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to Anthropic error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as AnthropicError from "./AnthropicError.ts"
 
 /**
- * @since 1.0.0
+ * The `AnthropicLanguageModel` module provides the Anthropic implementation of
+ * Effect AI's `LanguageModel` service. It turns Effect AI prompts, tools, files,
+ * reasoning parts, and provider options into Anthropic Messages API requests,
+ * and converts Anthropic responses and streams back into Effect AI response
+ * parts with Anthropic-specific metadata.
+ *
+ * **When to use**
+ *
+ * - Create an Anthropic-backed model with {@link model}
+ * - Build or provide a `LanguageModel.LanguageModel` layer with {@link layer}
+ *   or {@link make}
+ * - Supply default request options through {@link Config}
+ * - Override configuration for a scoped operation with {@link withConfigOverride}
+ * - Attach Anthropic provider options for prompt caching, document citations,
+ *   reasoning signatures, MCP metadata, and server-side tools
+ *
+ * **Gotchas**
+ *
+ * - Prompt files are translated to Anthropic image or document blocks; only the
+ *   supported media types can be sent to the provider.
+ * - Structured output support depends on the selected Claude model, so this
+ *   module may use Anthropic's native structured output or fall back to a JSON
+ *   response tool.
+ * - Some features require Anthropic beta headers, which are added
+ *   automatically from the selected tools, files, and model capabilities.
+ *
+ * @since 4.0.0
  */
 export * as AnthropicLanguageModel from "./AnthropicLanguageModel.ts"
 
@@ -41,7 +85,7 @@ export * as AnthropicLanguageModel from "./AnthropicLanguageModel.ts"
  * semantic conventions, extending the base GenAI attributes with Anthropic-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as AnthropicTelemetry from "./AnthropicTelemetry.ts"
 
@@ -51,11 +95,11 @@ export * as AnthropicTelemetry from "./AnthropicTelemetry.ts"
  * Provides tools that are natively supported by Anthropic's API, including
  * Bash, Code Execution, Computer Use, Memory, and Text Editor functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as AnthropicTool from "./AnthropicTool.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Generated from "./Generated.ts"

package/src/internal/errors.ts

@@ -190,8 +190,8 @@ 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 requestsLimitRaw = headers["anthropic-ratelimit-requests-limit"]
@@ -200,13 +200,15 @@ export const parseRateLimitHeaders = (headers: Record<string, string>) => {
   const tokensRemainingRaw = headers["anthropic-ratelimit-tokens-remaining"]
   return {
     retryAfter,
-    requestsLimit: Predicate.isNotUndefined(requestsLimitRaw) ? Number.parse(requestsLimitRaw) ?? null : null,
+    requestsLimit: Predicate.isNotUndefined(requestsLimitRaw) ? Option.getOrNull(Number.parse(requestsLimitRaw)) : null,
     requestsRemaining: Predicate.isNotUndefined(requestsRemainingRaw)
-      ? Number.parse(requestsRemainingRaw) ?? null
+      ? Option.getOrNull(Number.parse(requestsRemainingRaw))
       : null,
     requestsReset: headers["anthropic-ratelimit-requests-reset"] ?? null,
-    tokensLimit: Predicate.isNotUndefined(tokensLimitRaw) ? Number.parse(tokensLimitRaw) ?? null : null,
-    tokensRemaining: Predicate.isNotUndefined(tokensRemainingRaw) ? Number.parse(tokensRemainingRaw) ?? null : null,
+    tokensLimit: Predicate.isNotUndefined(tokensLimitRaw) ? Option.getOrNull(Number.parse(tokensLimitRaw)) : null,
+    tokensRemaining: Predicate.isNotUndefined(tokensRemainingRaw)
+      ? Option.getOrNull(Number.parse(tokensRemainingRaw))
+      : null,
     tokensReset: headers["anthropic-ratelimit-tokens-reset"] ?? null
   }
 }
@@ -222,7 +224,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>
 })