@effect/ai-anthropic 4.0.0-beta.9 → 4.0.0-beta.91

package/dist/AnthropicLanguageModel.d.ts

@@ -1,28 +1,34 @@
+import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import * as Layer from "effect/Layer";
 import * as Schema from "effect/Schema";
-import * as ServiceMap from "effect/ServiceMap";
 import * as LanguageModel from "effect/unstable/ai/LanguageModel";
 import * as AiModel from "effect/unstable/ai/Model";
 import { AnthropicClient } from "./AnthropicClient.ts";
 import type * as Generated from "./Generated.ts";
 /**
- * The available Anthropic Claude model identifiers.
+ * Known Anthropic Claude model identifiers exposed by the generated Anthropic schema.
+ *
+ * **Details**
+ *
+ * The Anthropic language model constructors accept `Model` values and custom
+ * string model ids, so this type is best used for autocomplete and type checking
+ * of known Claude ids.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type Model = typeof Generated.Model.Type;
-declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic/AnthropicLanguageModel/Config", {
+declare const Config_base: Context.ServiceClass<Config, "@effect/ai-anthropic/AnthropicLanguageModel/Config", {
     readonly model?: "claude-opus-4-6" | "claude-sonnet-4-6" | "claude-opus-4-5-20251101" | "claude-opus-4-5" | "claude-3-7-sonnet-latest" | "claude-3-7-sonnet-20250219" | "claude-3-5-haiku-latest" | "claude-3-5-haiku-20241022" | "claude-haiku-4-5" | "claude-haiku-4-5-20251001" | "claude-sonnet-4-20250514" | "claude-sonnet-4-0" | "claude-4-sonnet-20250514" | "claude-sonnet-4-5" | "claude-sonnet-4-5-20250929" | "claude-opus-4-0" | "claude-opus-4-20250514" | "claude-4-opus-20250514" | "claude-opus-4-1-20250805" | "claude-3-opus-latest" | "claude-3-opus-20240229" | "claude-3-haiku-20240307";
-    readonly thinking?: {
-        readonly type: "adaptive";
-    } | {
-        readonly type: "disabled";
-    } | {
-        readonly type: "enabled";
-        readonly budget_tokens: number;
-    };
+    readonly thinking?: Schema.Struct.ReadonlySide<{
+        readonly budget_tokens: Schema.Number;
+        readonly type: Schema.Literal<"enabled">;
+    }, "Encoded"> | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"disabled">;
+    }, "Encoded"> | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"adaptive">;
+    }, "Encoded">;
     readonly max_tokens?: number;
     readonly cache_control?: {
         readonly type: "ephemeral";
@@ -30,40 +36,40 @@ declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic
     } | null;
     readonly context_management?: {
         readonly edits?: readonly ({
-            readonly type: "compact_20260112";
-            readonly instructions?: string | null;
-            readonly pause_after_compaction?: boolean;
-            readonly trigger?: {
-                readonly type: "input_tokens";
-                readonly value: number;
-            } | null;
-        } | {
-            readonly type: "clear_thinking_20251015";
-            readonly keep?: "all" | {
-                readonly type: "all";
-            } | {
-                readonly type: "thinking_turns";
-                readonly value: number;
-            };
-        } | {
             readonly type: "clear_tool_uses_20250919";
-            readonly trigger?: {
-                readonly type: "input_tokens";
-                readonly value: number;
-            } | {
-                readonly type: "tool_uses";
-                readonly value: number;
-            };
-            readonly keep?: {
-                readonly type: "tool_uses";
-                readonly value: number;
-            };
-            readonly clear_at_least?: {
-                readonly type: "input_tokens";
-                readonly value: number;
-            } | null;
+            readonly trigger?: Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"input_tokens">;
+                readonly value: Schema.Number;
+            }, "Encoded"> | Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"tool_uses">;
+                readonly value: Schema.Number;
+            }, "Encoded">;
+            readonly keep?: Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"tool_uses">;
+                readonly value: Schema.Number;
+            }, "Encoded">;
+            readonly clear_at_least?: Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"input_tokens">;
+                readonly value: Schema.Number;
+            }, "Encoded"> | null;
             readonly clear_tool_inputs?: boolean | readonly string[] | null;
             readonly exclude_tools?: readonly string[] | null;
+        } | {
+            readonly type: "clear_thinking_20251015";
+            readonly keep?: "all" | Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"thinking_turns">;
+                readonly value: Schema.Number;
+            }, "Encoded"> | Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"all">;
+            }, "Encoded">;
+        } | {
+            readonly type: "compact_20260112";
+            readonly instructions?: string | null;
+            readonly pause_after_compaction?: boolean;
+            readonly trigger?: Schema.Struct.ReadonlySide<{
+                readonly type: Schema.Literal<"input_tokens">;
+                readonly value: Schema.Number;
+            }, "Encoded"> | null;
         })[];
     } | null;
     readonly container?: string | {
@@ -94,12 +100,10 @@ declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic
             readonly allowed_tools?: readonly string[] | null;
         } | null;
     }[];
-    readonly output_format?: {
-        readonly type: "json_schema";
-        readonly schema: {
-            readonly [x: string]: Schema.Json;
-        };
-    } | null;
+    readonly output_format?: Schema.Struct.ReadonlySide<{
+        readonly schema: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+        readonly type: Schema.Literal<"json_schema">;
+    }, "Encoded"> | null;
     readonly system?: string | readonly {
         readonly type: "text";
         readonly text: string;
@@ -107,42 +111,42 @@ declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic
             readonly type: "ephemeral";
             readonly ttl?: "5m" | "1h";
         } | null;
-        readonly citations?: readonly ({
-            readonly type: "char_location";
-            readonly cited_text: string;
-            readonly document_index: number;
-            readonly document_title: string | null;
-            readonly end_char_index: number;
-            readonly start_char_index: number;
-        } | {
-            readonly type: "content_block_location";
-            readonly cited_text: string;
-            readonly document_index: number;
-            readonly document_title: string | null;
-            readonly end_block_index: number;
-            readonly start_block_index: number;
-        } | {
-            readonly type: "page_location";
-            readonly cited_text: string;
-            readonly document_index: number;
-            readonly document_title: string | null;
-            readonly end_page_number: number;
-            readonly start_page_number: number;
-        } | {
-            readonly title: string | null;
-            readonly type: "search_result_location";
-            readonly source: string;
-            readonly cited_text: string;
-            readonly end_block_index: number;
-            readonly start_block_index: number;
-            readonly search_result_index: number;
-        } | {
-            readonly title: string | null;
-            readonly type: "web_search_result_location";
-            readonly cited_text: string;
-            readonly url: string;
-            readonly encrypted_index: string;
-        })[] | null;
+        readonly citations?: readonly (Schema.Struct.ReadonlySide<{
+            readonly cited_text: Schema.String;
+            readonly document_index: Schema.Number;
+            readonly document_title: Schema.Union<readonly [Schema.String, Schema.Null]>;
+            readonly end_char_index: Schema.Number;
+            readonly start_char_index: Schema.Number;
+            readonly type: Schema.Literal<"char_location">;
+        }, "Encoded"> | Schema.Struct.ReadonlySide<{
+            readonly cited_text: Schema.String;
+            readonly document_index: Schema.Number;
+            readonly document_title: Schema.Union<readonly [Schema.String, Schema.Null]>;
+            readonly end_page_number: Schema.Number;
+            readonly start_page_number: Schema.Number;
+            readonly type: Schema.Literal<"page_location">;
+        }, "Encoded"> | Schema.Struct.ReadonlySide<{
+            readonly cited_text: Schema.String;
+            readonly document_index: Schema.Number;
+            readonly document_title: Schema.Union<readonly [Schema.String, Schema.Null]>;
+            readonly end_block_index: Schema.Number;
+            readonly start_block_index: Schema.Number;
+            readonly type: Schema.Literal<"content_block_location">;
+        }, "Encoded"> | Schema.Struct.ReadonlySide<{
+            readonly cited_text: Schema.String;
+            readonly encrypted_index: Schema.String;
+            readonly title: Schema.Union<readonly [Schema.String, Schema.Null]>;
+            readonly type: Schema.Literal<"web_search_result_location">;
+            readonly url: Schema.String;
+        }, "Encoded"> | Schema.Struct.ReadonlySide<{
+            readonly cited_text: Schema.String;
+            readonly end_block_index: Schema.Number;
+            readonly search_result_index: Schema.Number;
+            readonly source: Schema.String;
+            readonly start_block_index: Schema.Number;
+            readonly title: Schema.Union<readonly [Schema.String, Schema.Null]>;
+            readonly type: Schema.Literal<"search_result_location">;
+        }, "Encoded">)[] | null;
     }[];
     readonly output_config?: {
         readonly effort?: "low" | "medium" | "high" | null;
@@ -151,6 +155,8 @@ declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic
     /**
      * Whether to use strict JSON schema validation for tool calls.
      *
+     * **Details**
+     *
      * Only applies to models that support structured outputs. Defaults to
      * `true` when structured outputs are supported.
      */
@@ -158,17 +164,36 @@ declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-anthropic
     readonly strictJsonSchema?: boolean | undefined | undefined;
 }>;
 /**
- * Configuration options for the Anthropic language model.
+ * Context service for Anthropic language model configuration.
+ *
+ * **When to use**
  *
- * This service can be used to provide default configuration values or to
- * override configuration on a per-request basis.
+ * Use when you need scoped Anthropic model request defaults or per-operation
+ * overrides from Effect context.
+ *
+ * **Details**
+ *
+ * The service stores request fields that are merged into Anthropic Messages API
+ * requests. Scoped configuration overrides defaults supplied to `model`,
+ * `make`, or `layer`.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export declare class Config extends Config_base {
 }
 declare module "effect/unstable/ai/Prompt" {
+    /**
+     * Anthropic-specific options for system messages.
+     *
+     * **Details**
+     *
+     * These options are used when translating system messages into Anthropic
+     * request content.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface SystemMessageOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -177,6 +202,17 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for user messages.
+     *
+     * **Details**
+     *
+     * These options are used when translating user messages into Anthropic
+     * request content.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface UserMessageOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -185,6 +221,17 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for assistant messages.
+     *
+     * **Details**
+     *
+     * These options are used when replaying assistant messages in Anthropic
+     * conversation history.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface AssistantMessageOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -193,6 +240,17 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for tool messages.
+     *
+     * **Details**
+     *
+     * These options are used when converting tool results into Anthropic user
+     * content blocks.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolMessageOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -201,6 +259,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for text prompt parts.
+     *
+     * **When to use**
+     *
+     * Use when you use these options to control how text blocks are sent to Anthropic.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface TextPartOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -209,6 +277,17 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for reasoning prompt parts.
+     *
+     * **Details**
+     *
+     * Preserves Claude thinking metadata when reasoning content is sent back to
+     * Anthropic in later turns.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ReasoningPartOptions extends ProviderOptions {
         readonly anthropic?: {
             readonly info?: {
@@ -232,6 +311,17 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for file prompt parts.
+     *
+     * **Details**
+     *
+     * Controls document metadata, citations, and prompt caching for files sent to
+     * Anthropic.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface FilePartOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -251,11 +341,24 @@ declare module "effect/unstable/ai/Prompt" {
              * Additional context about the document that will be forwarded to the
              * large language model, but will not be used towards cited content.
              *
-             * Useful for storing additional document metadata as text or stringified JSON.
+             * **When to use**
+             *
+             * Use when storing additional document metadata as text or stringified JSON.
              */
             readonly documentContext?: string | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for tool call prompt parts.
+     *
+     * **Details**
+     *
+     * Carries Anthropic tool caller metadata, MCP metadata, and cache control for
+     * tool use blocks.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolCallPartOptions extends ProviderOptions {
         readonly anthropic?: {
             readonly caller?: {
@@ -277,6 +380,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for tool result prompt parts.
+     *
+     * **Details**
+     *
+     * Controls Anthropic prompt caching for tool result content.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolResultPartOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -285,6 +398,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
+    /**
+     * Anthropic-specific options for tool approval request prompt parts.
+     *
+     * **Details**
+     *
+     * Controls prompt caching for human approval requests in conversations.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolApprovalRequestPartOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -293,14 +416,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
         } | null;
     }
-    interface ToolApprovalResponsePartOptions extends ProviderOptions {
-        readonly anthropic?: {
-            /**
-             * A breakpoint which marks the end of reusable content eligible for caching.
-             */
-            readonly cacheControl?: typeof Generated.CacheControlEphemeral.Encoded | null;
-        } | null;
-    }
+    /**
+     * Anthropic-specific options for tool approval response prompt parts.
+     *
+     * **Details**
+     *
+     * Controls prompt caching for human approval responses in conversations.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolApprovalResponsePartOptions extends ProviderOptions {
         readonly anthropic?: {
             /**
@@ -311,6 +436,17 @@ declare module "effect/unstable/ai/Prompt" {
     }
 }
 declare module "effect/unstable/ai/Response" {
+    /**
+     * Anthropic metadata attached when a reasoning block begins.
+     *
+     * **Details**
+     *
+     * Includes Claude thinking metadata needed to continue reasoning-aware
+     * conversations.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningStartPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly info?: {
@@ -330,6 +466,16 @@ declare module "effect/unstable/ai/Response" {
             } | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to streaming reasoning deltas.
+     *
+     * **Details**
+     *
+     * Includes the signature for streamed Claude thinking content when available.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningDeltaPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly info?: {
@@ -342,6 +488,16 @@ declare module "effect/unstable/ai/Response" {
             } | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to completed reasoning parts.
+     *
+     * **Details**
+     *
+     * Preserves Claude thinking or redacted thinking information for later turns.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly info?: {
@@ -361,6 +517,17 @@ declare module "effect/unstable/ai/Response" {
             } | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to tool call response parts.
+     *
+     * **Details**
+     *
+     * Identifies Anthropic caller details and MCP tool metadata emitted by the
+     * provider.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ToolCallPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly caller?: {
@@ -378,6 +545,17 @@ declare module "effect/unstable/ai/Response" {
             } | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to tool result response parts.
+     *
+     * **Details**
+     *
+     * Identifies MCP tool metadata associated with provider-executed tool
+     * results.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ToolResultPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             /**
@@ -391,6 +569,16 @@ declare module "effect/unstable/ai/Response" {
             } | null;
         } | null;
     }
+    /**
+     * Anthropic metadata for document citations in model responses.
+     *
+     * **Details**
+     *
+     * Records the cited document span by character position or page number.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface DocumentSourcePartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly source: "document";
@@ -424,6 +612,16 @@ declare module "effect/unstable/ai/Response" {
             readonly endPageNumber: number;
         } | null;
     }
+    /**
+     * Anthropic metadata for URL and web citations in model responses.
+     *
+     * **Details**
+     *
+     * Records cited URL text or web-search source freshness information.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface UrlSourcePartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly source: "url";
@@ -442,6 +640,17 @@ declare module "effect/unstable/ai/Response" {
             readonly pageAge: string | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to the finish part of a response.
+     *
+     * **Details**
+     *
+     * Includes container state, context management information, stop details, and
+     * token usage reported by Anthropic.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface FinishPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             readonly container: typeof Generated.BetaContainer.Encoded | null;
@@ -450,6 +659,16 @@ declare module "effect/unstable/ai/Response" {
             readonly usage: typeof Generated.BetaMessage.Encoded["usage"] | null;
         } | null;
     }
+    /**
+     * Anthropic metadata attached to error response parts.
+     *
+     * **Details**
+     *
+     * Includes the provider request identifier when Anthropic returns one.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ErrorPartMetadata extends ProviderMetadata {
         readonly anthropic?: {
             requestId?: string | null;
@@ -457,17 +676,39 @@ declare module "effect/unstable/ai/Response" {
     }
 }
 /**
- * Creates an Anthropic language model that can be used with `AiModel.provide`.
+ * Creates an Anthropic model descriptor that can be provided with `Effect.provide`.
+ *
+ * **When to use**
+ *
+ * Use when you want an Anthropic Claude model value that carries provider and
+ * model metadata and can be supplied directly to an Effect program.
+ *
+ * @see {@link layer} for creating a `LanguageModel.LanguageModel` layer directly
+ * @see {@link make} for constructing the language model service effectfully
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const model: (model: (string & {}) | Model, config?: Omit<typeof Config.Service, "model">) => AiModel.Model<"anthropic", LanguageModel.LanguageModel, AnthropicClient>;
 /**
- * Creates an Anthropic language model service.
+ * Creates an Anthropic `LanguageModel` service from a model identifier and optional request defaults.
+ *
+ * **When to use**
+ *
+ * Use when you need to construct a `LanguageModel.Service` value backed by
+ * `AnthropicClient` inside an Effect.
+ *
+ * **Details**
+ *
+ * The returned effect requires `AnthropicClient`. Request defaults from the
+ * `config` option are merged with any `Config` service in the context, with
+ * context values taking precedence.
+ *
+ * @see {@link layer} for providing the service as a `Layer`
+ * @see {@link model} for creating a model descriptor for `AiModel.provide`
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: (args_0: {
     readonly model: (string & {}) | Model;
@@ -476,8 +717,17 @@ export declare const make: (args_0: {
 /**
  * Creates a layer for the Anthropic language model.
  *
- * @since 1.0.0
+ * **When to use**
+ *
+ * Use when composing application layers and you want Anthropic to satisfy
+ * `LanguageModel.LanguageModel` while supplying `AnthropicClient` from another
+ * layer.
+ *
+ * @see {@link make} for constructing the language model service effectfully
+ * @see {@link model} for creating a model service directly
+ *
  * @category layers
+ * @since 4.0.0
  */
 export declare const layer: (options: {
     readonly model: (string & {}) | Model;
@@ -486,40 +736,98 @@ export declare const layer: (options: {
 /**
  * Provides config overrides for Anthropic language model operations.
  *
- * @since 1.0.0
+ * **When to use**
+ *
+ * Use to apply Anthropic request configuration to one effect without changing
+ * the model's default configuration.
+ *
+ * **Details**
+ *
+ * The overrides are merged with any existing `Config` service for the duration
+ * of the supplied effect. Fields in `overrides` take precedence over existing
+ * config, and the helper supports both `effect.pipe(withConfigOverride(overrides))`
+ * and `withConfigOverride(effect, overrides)`.
+ *
+ * @see {@link Config} for available Anthropic request configuration fields
+ *
  * @category configuration
+ * @since 4.0.0
  */
 export declare const withConfigOverride: {
     /**
      * Provides config overrides for Anthropic language model operations.
      *
-     * @since 1.0.0
+     * **When to use**
+     *
+     * Use to apply Anthropic request configuration to one effect without changing
+     * the model's default configuration.
+     *
+     * **Details**
+     *
+     * The overrides are merged with any existing `Config` service for the duration
+     * of the supplied effect. Fields in `overrides` take precedence over existing
+     * config, and the helper supports both `effect.pipe(withConfigOverride(overrides))`
+     * and `withConfigOverride(effect, overrides)`.
+     *
+     * @see {@link Config} for available Anthropic request configuration fields
+     *
      * @category configuration
+     * @since 4.0.0
      */
     (overrides: typeof Config.Service): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Config>>;
     /**
      * Provides config overrides for Anthropic language model operations.
      *
-     * @since 1.0.0
+     * **When to use**
+     *
+     * Use to apply Anthropic request configuration to one effect without changing
+     * the model's default configuration.
+     *
+     * **Details**
+     *
+     * The overrides are merged with any existing `Config` service for the duration
+     * of the supplied effect. Fields in `overrides` take precedence over existing
+     * config, and the helper supports both `effect.pipe(withConfigOverride(overrides))`
+     * and `withConfigOverride(effect, overrides)`.
+     *
+     * @see {@link Config} for available Anthropic request configuration fields
+     *
      * @category configuration
+     * @since 4.0.0
      */
     <A, E, R>(self: Effect.Effect<A, E, R>, overrides: typeof Config.Service): Effect.Effect<A, E, Exclude<R, Config>>;
 };
 /**
- * Represents a user-defined tool that can be passed to the Anthropic API.
+ * Encoded Anthropic custom tool definition that can be sent in a Messages API request.
+ *
+ * **When to use**
+ *
+ * Use when you need to type or inspect the provider-specific request payload for
+ * a custom Anthropic tool.
+ *
+ * **Details**
+ *
+ * This type aliases the encoded `Generated.BetaTool` schema used for Effect
+ * user-defined and dynamic tools after conversion. It contains the tool `name`,
+ * optional `description`, and `input_schema`, plus Anthropic-specific fields
+ * such as `strict` and `cache_control`.
+ *
+ * @see {@link AnthropicProviderDefinedTool} for the request shape used by Anthropic built-in provider tools
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export type AnthropicUserDefinedTool = typeof Generated.BetaTool.Encoded;
 /**
  * Represents a provider-defined tool that can be passed to the Anthropic API.
  *
+ * **Details**
+ *
  * These include Anthropic's built-in tools like computer use, code execution,
  * web search, and text editing.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export type AnthropicProviderDefinedTool = typeof Generated.BetaBashTool_20241022.Encoded | typeof Generated.BetaBashTool_20250124.Encoded | typeof Generated.BetaCodeExecutionTool_20250522.Encoded | typeof Generated.BetaCodeExecutionTool_20250825.Encoded | typeof Generated.BetaComputerUseTool_20241022.Encoded | typeof Generated.BetaComputerUseTool_20250124.Encoded | typeof Generated.BetaComputerUseTool_20251124.Encoded | typeof Generated.BetaMemoryTool_20250818.Encoded | typeof Generated.BetaTextEditor_20241022.Encoded | typeof Generated.BetaTextEditor_20250124.Encoded | typeof Generated.BetaTextEditor_20250429.Encoded | typeof Generated.BetaTextEditor_20250728.Encoded | typeof Generated.BetaToolSearchToolBM25_20251119.Encoded | typeof Generated.BetaToolSearchToolRegex_20251119.Encoded | typeof Generated.BetaWebFetchTool_20250910.Encoded | typeof Generated.BetaWebSearchTool_20250305.Encoded;
 export {};