@effect/ai 0.26.0 → 0.27.0

package/dist/dts/Response.d.ts

@@ -0,0 +1,1519 @@
+import type * as DateTime from "effect/DateTime";
+import type * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import type * as Tool from "./Tool.js";
+import type * as Toolkit from "./Toolkit.js";
+/**
+ * Unique identifier for Response Part instances.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const PartTypeId = "~effect/ai/Content/Part";
+/**
+ * Type-level representation of the Response Part identifier.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type PartTypeId = typeof PartTypeId;
+/**
+ * Type guard to check if a value is a Response Part.
+ *
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isPart: (u: unknown) => u is AnyPart;
+/**
+ * Union type representing all possible response content parts.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AnyPart = TextPart | TextStartPart | TextDeltaPart | TextEndPart | ReasoningPart | ReasoningStartPart | ReasoningDeltaPart | ReasoningEndPart | ToolParamsStartPart | ToolParamsDeltaPart | ToolParamsEndPart | ToolCallPart<any, any> | ToolResultPart<any, any> | FilePart | DocumentSourcePart | UrlSourcePart | ResponseMetadataPart | FinishPart | ErrorPart;
+/**
+ * Encoded representation of all possible response content parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AnyPartEncoded = TextPartEncoded | TextStartPartEncoded | TextDeltaPartEncoded | TextEndPartEncoded | ReasoningPartEncoded | ReasoningStartPartEncoded | ReasoningDeltaPartEncoded | ReasoningEndPartEncoded | ToolParamsStartPartEncoded | ToolParamsDeltaPartEncoded | ToolParamsEndPartEncoded | ToolCallPartEncoded | ToolResultPartEncoded | FilePartEncoded | DocumentSourcePartEncoded | UrlSourcePartEncoded | ResponseMetadataPartEncoded | FinishPartEncoded | ErrorPartEncoded;
+/**
+ * Union type for all response parts with tool-specific typing.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AllParts<Tools extends Record<string, Tool.Any>> = TextPart | TextStartPart | TextDeltaPart | TextEndPart | ReasoningPart | ReasoningStartPart | ReasoningDeltaPart | ReasoningEndPart | ToolParamsStartPart | ToolParamsDeltaPart | ToolParamsEndPart | ToolCallParts<Tools> | ToolResultParts<Tools> | FilePart | DocumentSourcePart | UrlSourcePart | ResponseMetadataPart | FinishPart | ErrorPart;
+/**
+ * Encoded representation of all response parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AllPartsEncoded = TextPartEncoded | TextStartPartEncoded | TextDeltaPartEncoded | TextEndPartEncoded | ReasoningPartEncoded | ReasoningStartPartEncoded | ReasoningDeltaPartEncoded | ReasoningEndPartEncoded | ToolParamsStartPartEncoded | ToolParamsDeltaPartEncoded | ToolParamsEndPartEncoded | ToolCallPartEncoded | ToolResultPartEncoded | FilePartEncoded | DocumentSourcePartEncoded | UrlSourcePartEncoded | ResponseMetadataPartEncoded | FinishPartEncoded | ErrorPartEncoded;
+/**
+ * Creates a Schema for all response parts based on a toolkit.
+ *
+ * Generates a schema that includes all possible response parts, with tool call
+ * and tool result parts dynamically created based on the provided toolkit.
+ *
+ * @example
+ * ```ts
+ * import { Response, Tool, Toolkit } from "@effect/ai"
+ * import { Schema } from "effect"
+ *
+ * const myToolkit = Toolkit.make(
+ *   Tool.make("GetWeather", {
+ *     parameters: { city: Schema.String },
+ *     success: Schema.Struct({ temperature: Schema.Number })
+ *   })
+ * )
+ *
+ * const allPartsSchema = Response.AllParts(myToolkit)
+ * ```
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const AllParts: <T extends Toolkit.Any | Toolkit.WithHandler<any>>(toolkit: T) => Schema.Schema<AllParts<Toolkit.Tools<T>>, AllParts<Toolkit.Tools<T>>>;
+/**
+ * A type for representing non-streaming response parts with tool-specific
+ * typing.
+ *
+ * @template Tools - Record of tools with their schemas
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type Part<Tools extends Record<string, Tool.Any>> = TextPart | ReasoningPart | ToolCallParts<Tools> | ToolResultParts<Tools> | FilePart | DocumentSourcePart | UrlSourcePart | ResponseMetadataPart | FinishPart;
+/**
+ * Encoded representation of non-streaming response parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type PartEncoded = TextPartEncoded | ReasoningPartEncoded | ReasoningDeltaPartEncoded | ReasoningEndPartEncoded | ToolCallPartEncoded | ToolResultPartEncoded | FilePartEncoded | DocumentSourcePartEncoded | UrlSourcePartEncoded | ResponseMetadataPartEncoded | FinishPartEncoded;
+/**
+ * Creates a Schema for non-streaming response parts based on a toolkit.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const Part: <T extends Toolkit.Any | Toolkit.WithHandler<any>>(toolkit: T) => Schema.Schema<Part<Toolkit.Tools<T>>, PartEncoded>;
+/**
+ * A type for representing streaming response parts with tool-specific typing.
+ *
+ * @template Tools - Record of tools with their schemas
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type StreamPart<Tools extends Record<string, Tool.Any>> = TextStartPart | TextDeltaPart | TextEndPart | ReasoningStartPart | ReasoningDeltaPart | ReasoningEndPart | ToolParamsStartPart | ToolParamsDeltaPart | ToolParamsEndPart | ToolCallParts<Tools> | ToolResultParts<Tools> | FilePart | DocumentSourcePart | UrlSourcePart | ResponseMetadataPart | FinishPart | ErrorPart;
+/**
+ * Encoded representation of streaming response parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type StreamPartEncoded = TextStartPartEncoded | TextDeltaPartEncoded | TextEndPartEncoded | ReasoningStartPartEncoded | ReasoningDeltaPartEncoded | ReasoningEndPartEncoded | ToolParamsStartPartEncoded | ToolParamsDeltaPartEncoded | ToolParamsEndPartEncoded | ToolCallPartEncoded | ToolResultPartEncoded | FilePartEncoded | DocumentSourcePartEncoded | UrlSourcePartEncoded | ResponseMetadataPartEncoded | FinishPartEncoded | ErrorPartEncoded;
+/**
+ * Creates a Schema for streaming response parts based on a toolkit.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const StreamPart: <T extends Toolkit.Any | Toolkit.WithHandler<any>>(toolkit: T) => Schema.Schema<StreamPart<Toolkit.Tools<T>>, StreamPartEncoded>;
+/**
+ * Utility type that extracts tool call parts from a set of tools.
+ *
+ * @template Tools - Record of tools with their schemas
+ *
+ * @since 1.0.0
+ * @category Utility Types
+ */
+export type ToolCallParts<Tools extends Record<string, Tool.Any>> = {
+    [Name in keyof Tools]: Name extends string ? ToolCallPart<Name, Tool.ParametersSchema<Tools[Name]>["fields"]> : never;
+}[keyof Tools];
+/**
+ * Utility type that extracts tool result parts from a set of tools.
+ *
+ * @template Tools - Record of tools with their schemas
+ *
+ * @since 1.0.0
+ * @category Utility Types
+ */
+export type ToolResultParts<Tools extends Record<string, Tool.Any>> = {
+    [Name in keyof Tools]: Name extends string ? ToolResultPart<Name, Tool.Success<Tools[Name]>> : never;
+}[keyof Tools];
+/**
+ * Schema for provider-specific metadata which can be attached to response parts.
+ *
+ * Provider-specific metadata is namespaced by provider and has the structure:
+ *
+ * ```
+ * {
+ *   "<provider-specific-key>": {
+ *     // Provider-specific metadata
+ *   }
+ * }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ProviderMetadata: Schema.Record$<typeof Schema.String, Schema.UndefinedOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type ProviderMetadata = typeof ProviderMetadata.Type;
+/**
+ * Base interface for all response content parts.
+ *
+ * Provides common structure including type identifier and optional metadata.
+ *
+ * @template Type - String literal type for the part type
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BasePart<Type extends string, Metadata extends ProviderMetadata> {
+    readonly [PartTypeId]: PartTypeId;
+    /**
+     * The type of this response part.
+     */
+    readonly type: Type;
+    /**
+     * Optional provider-specific metadata for this part.
+     */
+    readonly metadata: Metadata;
+}
+/**
+ * Base interface for encoded response content parts.
+ *
+ * @template Type - String literal type for the part type
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BasePartEncoded<Type extends string, Metadata extends ProviderMetadata> {
+    /**
+     * The type of this response part.
+     */
+    readonly type: Type;
+    /**
+     * Optional provider-specific metadata for this part.
+     */
+    readonly metadata?: Metadata | undefined;
+}
+/**
+ * Creates a new response content part of the specified type.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const textPart = Response.makePart("text", {
+ *   text: "Hello, world!"
+ * })
+ *
+ * const toolCallPart = Response.makePart("tool-call", {
+ *   id: "call_123",
+ *   name: "get_weather",
+ *   params: { city: "San Francisco" },
+ *   providerExecuted: false
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const makePart: <const Type extends AnyPart["type"]>(
+/**
+ * The type of part to create.
+ */
+type: Type, 
+/**
+ * Parameters specific to the part type being created.
+ */
+params: Omit<Extract<AnyPart, {
+    type: Type;
+}>, PartTypeId | "type" | "metadata"> & {
+    /**
+     * Optional provider-specific metadata for this part.
+     */
+    readonly metadata?: Extract<AnyPart, {
+        type: Type;
+    }>["metadata"] | undefined;
+}) => Extract<AnyPart, {
+    type: Type;
+}>;
+/**
+ * Response part representing plain text content.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const textPart: Response.TextPart = Response.makePart("text", {
+ *   text: "The answer to your question is 42.",
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextPart extends BasePart<"text", TextPartMetadata> {
+    /**
+     * The text content.
+     */
+    readonly text: string;
+}
+/**
+ * Encoded representation of text parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextPartEncoded extends BasePartEncoded<"text", TextPartMetadata> {
+    /**
+     * The text content.
+     */
+    readonly text: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `TextPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface TextPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of text parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const TextPart: Schema.Schema<TextPart, TextPartEncoded>;
+/**
+ * Response part indicating the start of streaming text content.
+ *
+ * Marks the beginning of a text chunk with a unique identifier.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextStartPart extends BasePart<"text-start", TextStartPartMetadata> {
+    /**
+     * Unique identifier for this text chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Encoded representation of text start parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextStartPartEncoded extends BasePartEncoded<"text-start", TextStartPartMetadata> {
+    /**
+     * Unique identifier for this text chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `TextStartPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface TextStartPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of text start parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const TextStartPart: Schema.Schema<TextStartPart, TextStartPartEncoded>;
+/**
+ * Response part containing incremental text content to be added to the existing
+ * text chunk with the same unique identifier.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextDeltaPart extends BasePart<"text-delta", TextDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding text chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental text content to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Encoded representation of text delta parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextDeltaPartEncoded extends BasePartEncoded<"text-delta", TextDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding text chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental text content to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `TextDeltaPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface TextDeltaPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of text delta parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const TextDeltaPart: Schema.Schema<TextDeltaPart, TextDeltaPartEncoded>;
+/**
+ * Response part indicating the end of streaming text content.
+ *
+ * Marks the completion of a text chunk.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextEndPart extends BasePart<"text-end", TextEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding text chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Encoded representation of text end parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextEndPartEncoded extends BasePartEncoded<"text-end", TextEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding text chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `TextEndPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface TextEndPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of text end parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const TextEndPart: Schema.Schema<TextEndPart, TextEndPartEncoded>;
+/**
+ * Response part representing reasoning or chain-of-thought content.
+ *
+ * Contains the internal reasoning process or explanation from the large
+ * language model.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const reasoningPart: Response.ReasoningPart = Response.makePart("reasoning", {
+ *   text: "Let me think step by step: First I need to analyze the user's question...",
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningPart extends BasePart<"reasoning", ReasoningPartMetadata> {
+    /**
+     * The reasoning or thought process text.
+     */
+    readonly text: string;
+}
+/**
+ * Encoded representation of reasoning parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningPartEncoded extends BasePartEncoded<"reasoning", ReasoningPartMetadata> {
+    /**
+     * The reasoning or thought process text.
+     */
+    readonly text: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ReasoningPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ReasoningPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of reasoning parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ReasoningPart: Schema.Schema<ReasoningPart, ReasoningPartEncoded>;
+/**
+ * Response part indicating the start of streaming reasoning content.
+ *
+ * Marks the beginning of a reasoning chunk with a unique identifier.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningStartPart extends BasePart<"reasoning-start", ReasoningStartPartMetadata> {
+    /**
+     * Unique identifier for this reasoning chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Encoded representation of reasoning start parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningStartPartEncoded extends BasePartEncoded<"reasoning-start", ReasoningStartPartMetadata> {
+    /**
+     * Unique identifier for this reasoning stream.
+     */
+    readonly id: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ReasoningStartPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ReasoningStartPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of reasoning start parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ReasoningStartPart: Schema.Schema<ReasoningStartPart, ReasoningStartPartEncoded>;
+/**
+ * Response part containing incremental reasoning content to be added to the
+ * existing chunk of reasoning text with the same unique identifier.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningDeltaPart extends BasePart<"reasoning-delta", ReasoningDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding reasoning chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental reasoning content to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Encoded representation of reasoning delta parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningDeltaPartEncoded extends BasePartEncoded<"reasoning-delta", ReasoningDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding reasoning chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental reasoning content to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ReasoningDeltaPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of reasoning delta parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ReasoningDeltaPart: Schema.Schema<ReasoningDeltaPart, ReasoningDeltaPartEncoded>;
+/**
+ * Response part indicating the end of streaming reasoning content.
+ *
+ * Marks the completion of a chunk of reasoning content.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningEndPart extends BasePart<"reasoning-end", ReasoningEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding reasoning chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Encoded representation of reasoning end parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningEndPartEncoded extends BasePartEncoded<"reasoning-end", ReasoningEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding reasoning chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ReasoningEndPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ReasoningEndPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of reasoning end parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ReasoningEndPart: Schema.Schema<ReasoningEndPart, ReasoningEndPartEncoded>;
+/**
+ * Response part indicating the start of streaming tool parameters.
+ *
+ * Marks the beginning of tool parameter streaming with metadata about the tool
+ * call.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsStartPart extends BasePart<"tool-params-start", ToolParamsStartPartMetadata> {
+    /**
+     * Unique identifier for this tool parameter chunk.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: string;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted: boolean;
+}
+/**
+ * Encoded representation of tool params start parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsStartPartEncoded extends BasePartEncoded<"tool-params-start", ToolParamsStartPartMetadata> {
+    /**
+     * Unique identifier for this tool parameter chunk.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: string;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted?: boolean;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ToolParamsStartPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolParamsStartPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of tool params start parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolParamsStartPart: Schema.Schema<ToolParamsStartPart, ToolParamsStartPartEncoded>;
+/**
+ * Response part containing incremental tool parameter content.
+ *
+ * Represents a chunk of tool parameters being streamed, containing the
+ * incremental JSON content that forms the tool parameters.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsDeltaPart extends BasePart<"tool-params-delta", ToolParamsDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding tool parameter chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental parameter content (typically JSON fragment) to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Encoded representation of tool params delta parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsDeltaPartEncoded extends BasePartEncoded<"tool-params-delta", ToolParamsDeltaPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding tool parameter chunk.
+     */
+    readonly id: string;
+    /**
+     * The incremental parameter content (typically JSON fragment) to add.
+     */
+    readonly delta: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ToolParamsDeltaPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolParamsDeltaPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of tool params delta parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolParamsDeltaPart: Schema.Schema<ToolParamsDeltaPart, ToolParamsDeltaPartEncoded>;
+/**
+ * Response part indicating the end of streaming tool parameters.
+ *
+ * Marks the completion of a tool parameter stream, indicating that all
+ * parameter data has been sent and the tool call is ready to be executed.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsEndPart extends BasePart<"tool-params-end", ToolParamsEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding tool parameter chunk.
+     */
+    readonly id: string;
+}
+/**
+ * Encoded representation of tool params end parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolParamsEndPartEncoded extends BasePartEncoded<"tool-params-end", ToolParamsEndPartMetadata> {
+    /**
+     * Unique identifier matching the corresponding tool parameter stream.
+     */
+    readonly id: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ToolParamsEndPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolParamsEndPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of tool params end parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolParamsEndPart: Schema.Schema<ToolParamsEndPart, ToolParamsEndPartEncoded>;
+/**
+ * Response part representing a tool call request.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ * import { Schema } from "effect"
+ *
+ * const weatherParams = Schema.Struct({
+ *   city: Schema.String,
+ *   units: Schema.optional(Schema.Literal("celsius", "fahrenheit"))
+ * })
+ *
+ * const toolCallPart: Response.ToolCallPart<
+ *   "get_weather",
+ *   typeof weatherParams.fields
+ * > = Response.makePart("tool-call", {
+ *   id: "call_123",
+ *   name: "get_weather",
+ *   params: { city: "San Francisco", units: "celsius" },
+ *   providerExecuted: false,
+ * })
+ * ```
+ *
+ * @template Name - String literal type for the tool name
+ * @template Params - Schema fields type for the tool parameters
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolCallPart<Name extends string, Params extends Schema.Struct.Fields> extends BasePart<"tool-call", ToolCallPartMetadata> {
+    /**
+     * Unique identifier for this tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: Name;
+    /**
+     * Parameters to pass to the tool.
+     */
+    readonly params: Schema.Struct.Type<Params>;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted: boolean;
+}
+/**
+ * Encoded representation of tool call parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolCallPartEncoded extends BasePartEncoded<"tool-call", ToolCallPartMetadata> {
+    /**
+     * Unique identifier for this tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: string;
+    /**
+     * Parameters to pass to the tool.
+     */
+    readonly params: unknown;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted?: boolean | undefined;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ToolCallPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolCallPartMetadata extends ProviderMetadata {
+}
+/**
+ * Creates a Schema for tool call parts with specific tool name and parameters.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolCallPart: <const Name extends string, Params extends Schema.Struct.Fields>(
+/**
+ * Name of the tool.
+ */
+name: Name, 
+/**
+ * Schema for the tool parameters.
+ */
+params: Schema.Struct<Params>) => Schema.Schema<ToolCallPart<Name, Params>, ToolCallPartEncoded>;
+/**
+ * Response part representing the result of a tool call.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * interface WeatherData {
+ *   temperature: number
+ *   condition: string
+ *   humidity: number
+ * }
+ *
+ * const toolResultPart: Response.ToolResultPart<
+ *   "get_weather",
+ *   WeatherData
+ * > = Response.makePart("tool-result", {
+ *   id: "call_123",
+ *   name: "get_weather",
+ *   result: {
+ *     temperature: 22,
+ *     condition: "sunny",
+ *     humidity: 65
+ *   },
+ *   encodedResult: {
+ *     temperature: 22,
+ *     condition: "sunny",
+ *     humidity: 65
+ *   },
+ *   providerExecuted: false
+ * })
+ * ```
+ *
+ * @template Name - String literal type for the tool name
+ * @template Result - Type of the tool result
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolResultPart<Name extends string, Result> extends BasePart<"tool-result", ToolResultPartMetadata> {
+    /**
+     * Unique identifier matching the original tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: Name;
+    /**
+     * The decoded result returned by the tool execution.
+     */
+    readonly result: Result;
+    /**
+     * The encoded result for serialization purposes.
+     */
+    readonly encodedResult: unknown;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted: boolean;
+}
+/**
+ * Encoded representation of tool result parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolResultPartEncoded extends BasePartEncoded<"tool-result", ToolResultPartMetadata> {
+    /**
+     * Unique identifier matching the original tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool being called, which corresponds to the name of the tool
+     * in the `Toolkit` included with the request.
+     */
+    readonly name: string;
+    /**
+     * The result returned by the tool execution.
+     */
+    readonly result: unknown;
+    /**
+     * Optional provider-specific name for the tool, which can be useful when the
+     * name of the tool in the `Toolkit` and the name of the tool used by the
+     * model are different.
+     *
+     * This is usually happens only with provider-defined tools which require a
+     * user-space handler.
+     */
+    readonly providerName?: string | undefined;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted?: boolean | undefined;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ToolResultPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolResultPartMetadata extends ProviderMetadata {
+}
+/**
+ * Creates a Schema for tool result parts with specific tool name and result type.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolResultPart: <const Name extends string, Result extends Schema.Schema.Any>(
+/**
+ * Name of the tool.
+ */
+name: Name, 
+/**
+ * Schema for the tool result.
+ */
+result: Result) => Schema.Schema<ToolResultPart<Name, Schema.Schema.Type<Result>>, ToolResultPartEncoded>;
+/**
+ * Response part representing a file attachment.
+ *
+ * Supports various file types including images, documents, and binary data.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const imagePart: Response.FilePart = Response.makePart("file", {
+ *   mediaType: "image/jpeg",
+ *   data: new Uint8Array([1, 2, 3]),
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FilePart extends BasePart<"file", FilePartMetadata> {
+    /**
+     * MIME type of the file (e.g., "image/jpeg", "application/pdf").
+     */
+    readonly mediaType: string;
+    /**
+     * File data as a byte array.
+     */
+    readonly data: Uint8Array;
+}
+/**
+ * Encoded representation of file parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FilePartEncoded extends BasePartEncoded<"file", FilePartMetadata> {
+    /**
+     * MIME type of the file (e.g., "image/jpeg", "application/pdf").
+     */
+    readonly mediaType: string;
+    /**
+     * File data as a base64 string.
+     */
+    readonly data: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `FilePart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface FilePartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of file parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const FilePart: Schema.Schema<FilePart, FilePartEncoded>;
+/**
+ * Response part representing a document source reference.
+ *
+ * Used to reference documents that were used in generating the response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface DocumentSourcePart extends BasePart<"source", DocumentSourcePartMetadata> {
+    /**
+     * Type discriminator for document sources.
+     */
+    readonly sourceType: "document";
+    /**
+     * Unique identifier for the document.
+     */
+    readonly id: string;
+    /**
+     * MIME type of the document.
+     */
+    readonly mediaType: string;
+    /**
+     * Display title of the document.
+     */
+    readonly title: string;
+    /**
+     * Optional filename of the document.
+     */
+    readonly fileName?: string;
+}
+/**
+ * Encoded representation of document source parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface DocumentSourcePartEncoded extends BasePartEncoded<"source", DocumentSourcePartMetadata> {
+    /**
+     * Type discriminator for document sources.
+     */
+    readonly sourceType: "document";
+    /**
+     * Unique identifier for the document.
+     */
+    readonly id: string;
+    /**
+     * MIME type of the document.
+     */
+    readonly mediaType: string;
+    /**
+     * Display title of the document.
+     */
+    readonly title: string;
+    /**
+     * Optional filename of the document.
+     */
+    readonly fileName?: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `DocumentSourcePart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface DocumentSourcePartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of document source parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const DocumentSourcePart: Schema.Schema<DocumentSourcePart, DocumentSourcePartEncoded>;
+/**
+ * Response part representing a URL source reference.
+ *
+ * Used to reference web URLs that were used in generating the response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface UrlSourcePart extends BasePart<"source", UrlSourcePartMetadata> {
+    /**
+     * Type discriminator for URL sources.
+     */
+    readonly sourceType: "url";
+    /**
+     * Unique identifier for the URL.
+     */
+    readonly id: string;
+    /**
+     * The URL that was referenced.
+     */
+    readonly url: URL;
+    /**
+     * Display title of the URL content.
+     */
+    readonly title: string;
+}
+/**
+ * Encoded representation of URL source parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface UrlSourcePartEncoded extends BasePartEncoded<"source", UrlSourcePartMetadata> {
+    /**
+     * Type discriminator for URL sources.
+     */
+    readonly sourceType: "url";
+    /**
+     * Unique identifier for the URL.
+     */
+    readonly id: string;
+    /**
+     * The URL that was referenced as a string.
+     */
+    readonly url: string;
+    /**
+     * Display title of the URL content.
+     */
+    readonly title: string;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `UrlSourcePart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface UrlSourcePartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of url source parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const UrlSourcePart: Schema.Schema<UrlSourcePart, UrlSourcePartEncoded>;
+/**
+ * Response part containing metadata about the large language model response.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ * import { Option, DateTime } from "effect"
+ *
+ * const metadataPart: Response.ResponseMetadataPart = Response.makePart("response-metadata", {
+ *   id: Option.some("resp_123"),
+ *   modelId: Option.some("gpt-4"),
+ *   timestamp: Option.some(DateTime.unsafeNow())
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ResponseMetadataPart extends BasePart<"response-metadata", ResponseMetadataPartMetadata> {
+    /**
+     * Optional unique identifier for this specific response.
+     */
+    readonly id: Option.Option<string>;
+    /**
+     * Optional identifier of the AI model that generated the response.
+     */
+    readonly modelId: Option.Option<string>;
+    /**
+     * Optional timestamp when the response was generated.
+     */
+    readonly timestamp: Option.Option<DateTime.Utc>;
+}
+/**
+ * Encoded representation of response metadata parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ResponseMetadataPartEncoded extends BasePartEncoded<"response-metadata", ResponseMetadataPartMetadata> {
+    /**
+     * Optional unique identifier for this specific response.
+     */
+    readonly id?: string | undefined;
+    /**
+     * Optional identifier of the AI model that generated the response.
+     */
+    readonly modelId?: string | undefined;
+    /**
+     * Optional timestamp when the response was generated.
+     */
+    readonly timestamp?: string | undefined;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ResponseMetadataPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ResponseMetadataPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of response metadata parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ResponseMetadataPart: Schema.Schema<ResponseMetadataPart, ResponseMetadataPartEncoded>;
+/**
+ * Represents the reason why a model finished generation of a response.
+ *
+ * Possible finish reasons:
+ * - `"stop"`: The model generated a stop sequence.
+ * - `"length"`: The model exceeded its token budget.
+ * - `"content-filter"`: The model generated content which violated a content filter.
+ * - `"tool-calls"`: The model triggered a tool call.
+ * - `"error"`: The model encountered an error.
+ * - `"pause"`: The model requested to pause execution.
+ * - `"other"`: The model stopped for a reason not supported by this protocol.
+ * - `"unknown"`: The model did not specify a finish reason.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const FinishReason: Schema.Literal<[
+    "stop",
+    "length",
+    "content-filter",
+    "tool-calls",
+    "error",
+    "pause",
+    "other",
+    "unknown"
+]>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type FinishReason = typeof FinishReason.Type;
+declare const Usage_base: Schema.Class<Usage, {
+    /**
+     * The number of tokens sent in the request to the model.
+     */
+    inputTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The number of tokens that the model generated for the request.
+     */
+    outputTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The total of number of input tokens and output tokens as reported by the
+     * large language model provider.
+     *
+     * **NOTE**: This value may differ from the sum of `inputTokens` and
+     * `outputTokens` due to inclusion of reasoning tokens or other
+     * provider-specific overhead.
+     */
+    totalTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The number of reasoning tokens that the model used to generate the output
+     * for the request.
+     */
+    reasoningTokens: Schema.optional<typeof Schema.Number>;
+    /**
+     * The number of input tokens read from the prompt cache for the request.
+     */
+    cachedInputTokens: Schema.optional<typeof Schema.Number>;
+}, Schema.Struct.Encoded<{
+    /**
+     * The number of tokens sent in the request to the model.
+     */
+    inputTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The number of tokens that the model generated for the request.
+     */
+    outputTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The total of number of input tokens and output tokens as reported by the
+     * large language model provider.
+     *
+     * **NOTE**: This value may differ from the sum of `inputTokens` and
+     * `outputTokens` due to inclusion of reasoning tokens or other
+     * provider-specific overhead.
+     */
+    totalTokens: Schema.UndefinedOr<typeof Schema.Number>;
+    /**
+     * The number of reasoning tokens that the model used to generate the output
+     * for the request.
+     */
+    reasoningTokens: Schema.optional<typeof Schema.Number>;
+    /**
+     * The number of input tokens read from the prompt cache for the request.
+     */
+    cachedInputTokens: Schema.optional<typeof Schema.Number>;
+}>, never, {
+    readonly inputTokens: number | undefined;
+} & {
+    readonly outputTokens: number | undefined;
+} & {
+    readonly totalTokens: number | undefined;
+} & {
+    readonly reasoningTokens?: number | undefined;
+} & {
+    readonly cachedInputTokens?: number | undefined;
+}, {}, {}>;
+/**
+ * Represents usage information for a request to a large language model provider.
+ *
+ * If the model provider returns additional usage information than what is
+ * specified here, you can generally find that information under the provider
+ * metadata of the finish part of the response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class Usage extends Usage_base {
+}
+/**
+ * Response part indicating the completion of a response generation.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const finishPart: Response.FinishPart = Response.makePart("finish", {
+ *   reason: "stop",
+ *   usage: {
+ *     inputTokens: 50,
+ *     outputTokens: 25,
+ *     totalTokens: 75
+ *   }
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FinishPart extends BasePart<"finish", FinishPartMetadata> {
+    /**
+     * The reason why the model finished generating the response.
+     */
+    readonly reason: FinishReason;
+    /**
+     * Token usage statistics for the request.
+     */
+    readonly usage: Usage;
+}
+/**
+ * Encoded representation of finish parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FinishPartEncoded extends BasePartEncoded<"finish", FinishPartMetadata> {
+    /**
+     * The reason why the model finished generating the response.
+     */
+    readonly reason: typeof FinishReason.Encoded;
+    /**
+     * Token usage statistics for the request.
+     */
+    readonly usage: typeof Usage.Encoded;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `FinishPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface FinishPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of finish parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const FinishPart: Schema.Schema<FinishPart, FinishPartEncoded>;
+/**
+ * Response part indicating that an error occurred generating the response.
+ *
+ * @example
+ * ```ts
+ * import { Response } from "@effect/ai"
+ *
+ * const errorPart: Response.ErrorPart = Response.makePart("error", {
+ *   error: new Error("boom")
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ErrorPart extends BasePart<"error", ErrorPartMetadata> {
+    readonly error: unknown;
+}
+/**
+ * Encoded representation of error parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ErrorPartEncoded extends BasePartEncoded<"error", ErrorPartMetadata> {
+    readonly error: unknown;
+}
+/**
+ * Represents provider-specific metadata that can be associated with a
+ * `ErrorPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ErrorPartMetadata extends ProviderMetadata {
+}
+/**
+ * Schema for validation and encoding of error parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ErrorPart: Schema.Schema<ErrorPart, ErrorPartEncoded>;
+export {};
+//# sourceMappingURL=Response.d.ts.map