@effect/ai 0.14.1 → 0.16.0

package/dist/dts/AiResponse.d.ts

@@ -1,72 +1,517 @@
 /**
  * @since 1.0.0
  */
-import * as Chunk from "effect/Chunk";
-import * as Data from "effect/Data";
+import type * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import * as Option from "effect/Option";
 import * as Schema from "effect/Schema";
 import { AiError } from "./AiError.js";
-import * as AiRole from "./AiRole.js";
+import type * as AiTool from "./AiTool.js";
 /**
  * @since 1.0.0
- * @category type ids
+ * @category Type Ids
  */
 export declare const TypeId: unique symbol;
 /**
  * @since 1.0.0
- * @category type ids
+ * @category Type Ids
  */
 export type TypeId = typeof TypeId;
+declare const AiResponse_base: Schema.Class<AiResponse, {
+    /**
+     * The parts of the response.
+     */
+    parts: Schema.Array$<Schema.suspend<TextPart | ReasoningPart | RedactedReasoningPart | ToolCallPart | MetadataPart | FinishPart, {
+        readonly _tag: "TextPart";
+        readonly text: string;
+        readonly annotations?: readonly ({
+            readonly _tag: "ContentSourceAnnotation";
+            readonly id: string;
+            readonly index: number;
+            readonly type: string;
+            readonly referencedContent: string;
+            readonly startIndex: number;
+            readonly endIndex: number;
+        } | {
+            readonly _tag: "FileAnnotation";
+            readonly id: string;
+            readonly index: number;
+            readonly type: string;
+        } | {
+            readonly _tag: "UrlAnnotation";
+            readonly startIndex: number;
+            readonly endIndex: number;
+            readonly url: string;
+            readonly title: string;
+        })[] | undefined;
+    } | {
+        readonly _tag: "ReasoningPart";
+        readonly reasoningText: string;
+        readonly signature?: string | undefined;
+    } | {
+        readonly _tag: "RedactedReasoningPart";
+        readonly redactedText: string;
+    } | {
+        readonly _tag: "ToolCallPart";
+        readonly name: string;
+        readonly id: string;
+        readonly params: unknown;
+    } | {
+        readonly _tag: "MetadataPart";
+        readonly model: string;
+        readonly id?: string | undefined;
+        readonly timestamp?: number | undefined;
+    } | {
+        readonly _tag: "FinishPart";
+        readonly usage: {
+            readonly inputTokens: number;
+            readonly outputTokens: number;
+            readonly totalTokens: number;
+            readonly reasoningTokens: number;
+            readonly cacheReadInputTokens: number;
+            readonly cacheWriteInputTokens: number;
+        };
+        readonly reason: "length" | "stop" | "content-filter" | "tool-calls" | "error" | "other" | "unknown";
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    }, never>>;
+}, Schema.Struct.Encoded<{
+    /**
+     * The parts of the response.
+     */
+    parts: Schema.Array$<Schema.suspend<TextPart | ReasoningPart | RedactedReasoningPart | ToolCallPart | MetadataPart | FinishPart, {
+        readonly _tag: "TextPart";
+        readonly text: string;
+        readonly annotations?: readonly ({
+            readonly _tag: "ContentSourceAnnotation";
+            readonly id: string;
+            readonly index: number;
+            readonly type: string;
+            readonly referencedContent: string;
+            readonly startIndex: number;
+            readonly endIndex: number;
+        } | {
+            readonly _tag: "FileAnnotation";
+            readonly id: string;
+            readonly index: number;
+            readonly type: string;
+        } | {
+            readonly _tag: "UrlAnnotation";
+            readonly startIndex: number;
+            readonly endIndex: number;
+            readonly url: string;
+            readonly title: string;
+        })[] | undefined;
+    } | {
+        readonly _tag: "ReasoningPart";
+        readonly reasoningText: string;
+        readonly signature?: string | undefined;
+    } | {
+        readonly _tag: "RedactedReasoningPart";
+        readonly redactedText: string;
+    } | {
+        readonly _tag: "ToolCallPart";
+        readonly name: string;
+        readonly id: string;
+        readonly params: unknown;
+    } | {
+        readonly _tag: "MetadataPart";
+        readonly model: string;
+        readonly id?: string | undefined;
+        readonly timestamp?: number | undefined;
+    } | {
+        readonly _tag: "FinishPart";
+        readonly usage: {
+            readonly inputTokens: number;
+            readonly outputTokens: number;
+            readonly totalTokens: number;
+            readonly reasoningTokens: number;
+            readonly cacheReadInputTokens: number;
+            readonly cacheWriteInputTokens: number;
+        };
+        readonly reason: "length" | "stop" | "content-filter" | "tool-calls" | "error" | "other" | "unknown";
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    }, never>>;
+}>, never, {
+    readonly parts: readonly (TextPart | ReasoningPart | RedactedReasoningPart | ToolCallPart | MetadataPart | FinishPart)[];
+}, {}, {}>;
+/**
+ * Represents a response received from a large language model.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class AiResponse extends AiResponse_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [TypeId]: TypeId;
+    /**
+     * Returns the generated text content of the response.
+     */
+    get text(): string;
+    /**
+     * Returns the finish reason for the response, or `"unknown"` if the finish
+     * reason is not known.
+     */
+    get finishReason(): FinishReason;
+    /**
+     * Attempts to retrieve provider-specific response metadata.
+     */
+    getProviderMetadata<I, S>(tag: Context.Tag<I, S>): Option.Option<S>;
+}
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const FromJson: Schema.transform<Schema.SchemaClass<unknown, string, never>, typeof AiResponse>;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Type Ids
+ */
+export declare const StructuredResponseTypeId: unique symbol;
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type StructuredResponseTypeId = typeof StructuredResponseTypeId;
+/**
+ * Represents a response generated by a large language model that includes
+ * structured output.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class WithStructuredOutput<A> extends AiResponse {
+    /**
+     * @since 1.0.0
+     */
+    readonly [StructuredResponseTypeId]: StructuredResponseTypeId;
+    /**
+     * The identifier of the tool which generated the structured output.
+     */
+    readonly id: ToolCallId;
+    /**
+     * The name of the tool which generated the structured output.
+     */
+    readonly name: string;
+    /**
+     * The structured output generated by the model.
+     */
+    readonly value: A;
+    constructor(props: {
+        /**
+         * The identifier of the tool which generated the structured output.
+         */
+        readonly id: ToolCallId;
+        /**
+         * The name of the tool which generated the structured output.
+         */
+        readonly name: string;
+        /**
+         * The structured output generated by the model.
+         */
+        readonly value: A;
+        /**
+         * The parts of the response.
+         */
+        readonly parts: ReadonlyArray<Part>;
+    }, options?: Schema.MakeOptions);
+}
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const WithToolCallResultsTypeId: unique symbol;
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type WithToolCallResultsTypeId = typeof WithToolCallResultsTypeId;
+/**
+ * Represents a response generated by a large language model that includes
+ * tool call results.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class WithToolCallResults<Tools extends AiTool.Any> extends AiResponse {
+    /**
+     * @since 1.0.0
+     */
+    readonly [WithToolCallResultsTypeId]: WithToolCallResultsTypeId;
+    /**
+     * The tool call results, represented as a mapping between the tool call
+     * identifier and the result of the tool call handler.
+     */
+    readonly results: ReadonlyMap<ToolCallId, AiTool.Success<Tools>>;
+    /**
+     * The encoded tool call results, suitable for incorporation into subsequent
+     * requests to the large language model.
+     */
+    readonly encodedResults: ReadonlyMap<ToolCallId, unknown>;
+    constructor(props: {
+        /**
+         * The tool call results, represented as a mapping between the tool call
+         * identifier and the result of the tool call handler.
+         */
+        readonly results: ReadonlyMap<ToolCallId, AiTool.Success<Tools>>;
+        /**
+         * The encoded tool call results, suitable for incorporation into subsequent
+         * requests to the large language model.
+         */
+        readonly encodedResults: ReadonlyMap<ToolCallId, unknown>;
+        /**
+         * The parts of the response.
+         */
+        readonly parts: ReadonlyArray<Part>;
+    }, options?: Schema.MakeOptions);
+}
+/**
+ * @since 1.0.0
+ * @category Type Ids
  */
 export declare const PartTypeId: unique symbol;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Type Ids
  */
 export type PartTypeId = typeof PartTypeId;
-declare const TextPart_base: Schema.TaggedClass<TextPart, "Text", {
-    readonly _tag: Schema.tag<"Text">;
+declare const ContentSourceAnnotation_base: Schema.TaggedClass<ContentSourceAnnotation, "ContentSourceAnnotation", {
+    readonly _tag: Schema.tag<"ContentSourceAnnotation">;
 } & {
-    content: typeof Schema.String;
+    /**
+     * The identifier for the content source.
+     */
+    id: typeof Schema.String;
+    /**
+     * The index of the content source in the list of sources provided in the
+     * model request parameters.
+     */
+    index: typeof Schema.Int;
+    /**
+     * The provider-specific type of the file annotation.
+     *
+     * For example, when using Anthropic the type may be `char_location`,
+     * `page_location`, or `content_block_location`.
+     */
+    type: typeof Schema.String;
+    /**
+     * The content used from the content source in the message generated by the
+     * model.
+     */
+    referencedContent: typeof Schema.String;
+    /**
+     * The index of the first character of the content referenced by the content
+     * source in the message generated by the model.
+     */
+    startIndex: typeof Schema.Int;
+    /**
+     * The index of the last character of the content referenced by the content
+     * source in the message generated by the model.
+     */
+    endIndex: typeof Schema.Int;
 }>;
 /**
+ * Represents a content source that was used to generate a model response.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
+ */
+export declare class ContentSourceAnnotation extends ContentSourceAnnotation_base {
+}
+declare const FileAnnotation_base: Schema.TaggedClass<FileAnnotation, "FileAnnotation", {
+    readonly _tag: Schema.tag<"FileAnnotation">;
+} & {
+    /**
+     * The identifier for the file.
+     */
+    id: typeof Schema.String;
+    /**
+     * The provider-specific type of the file annotation.
+     *
+     * For example, when using OpenAi the type may be `file_citation` or
+     * `file_path`.
+     */
+    type: typeof Schema.String;
+    /**
+     * The index of the file in the list of files provided in the model request
+     * parameters.
+     */
+    index: typeof Schema.Int;
+}>;
+/**
+ * Represents a file that was used to generate a model response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class FileAnnotation extends FileAnnotation_base {
+}
+declare const UrlAnnotation_base: Schema.TaggedClass<UrlAnnotation, "UrlAnnotation", {
+    readonly _tag: Schema.tag<"UrlAnnotation">;
+} & {
+    /**
+     * The URL of the web resource.
+     */
+    url: typeof Schema.String;
+    /**
+     * The title of the web resource.
+     */
+    title: typeof Schema.String;
+    /**
+     * The index of the first character of the content referenced by the web
+     * resource in the message generated by the model.
+     */
+    startIndex: typeof Schema.Int;
+    /**
+     * The index of the last character of the content referenced by the web
+     * resource in the message generated by the model.
+     */
+    endIndex: typeof Schema.Int;
+}>;
+/**
+ * Represents a web resource that was used to generate a model response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class UrlAnnotation extends UrlAnnotation_base {
+}
+/**
+ * Represents annotations that were used to support the message generated by
+ * a model.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const Annotation: Schema.Union<[
+    typeof ContentSourceAnnotation,
+    typeof FileAnnotation,
+    typeof UrlAnnotation
+]>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type Annotation = typeof Annotation.Type;
+declare const TextPart_base: Schema.TaggedClass<TextPart, "TextPart", {
+    readonly _tag: Schema.tag<"TextPart">;
+} & {
+    /**
+     * The text content generated by the model.
+     */
+    text: typeof Schema.String;
+    /**
+     * The annotations used to support the text generated by the model.
+     */
+    annotations: Schema.optionalWith<Schema.Array$<Schema.Union<[typeof ContentSourceAnnotation, typeof FileAnnotation, typeof UrlAnnotation]>>, {
+        default: () => never[];
+    }>;
+}>;
+/**
+ * Represents part of the text generated by the model.
+ *
+ * @since 1.0.0
+ * @category Models
  */
 export declare class TextPart extends TextPart_base {
     /**
      * @since 1.0.0
      */
     readonly [PartTypeId]: PartTypeId;
+}
+declare const ReasoningPart_base: Schema.TaggedClass<ReasoningPart, "ReasoningPart", {
+    readonly _tag: Schema.tag<"ReasoningPart">;
+} & {
+    /**
+     * The reasoning content that the model used to return the output.
+     */
+    reasoningText: typeof Schema.String;
+    /**
+     * An optional signature which verifies that the reasoning text was generated
+     * by the model.
+     */
+    signature: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * Represents part of the reasoning carried out by the model to generate a
+ * response.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class ReasoningPart extends ReasoningPart_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [PartTypeId]: PartTypeId;
+}
+declare const RedactedReasoningPart_base: Schema.TaggedClass<RedactedReasoningPart, "RedactedReasoningPart", {
+    readonly _tag: Schema.tag<"RedactedReasoningPart">;
+} & {
+    /**
+     * The content in the reasoning that was encrypted by the model provider for
+     * safety reasons.
+     */
+    redactedText: typeof Schema.String;
+}>;
+/**
+ * Represents part of the reasoning carried out by the model to generate a
+ * response which needed to be encrypted by the model provider for safety
+ * reasons.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class RedactedReasoningPart extends RedactedReasoningPart_base {
     /**
      * @since 1.0.0
      */
-    static fromContent(content: string): TextPart;
+    readonly [PartTypeId]: PartTypeId;
 }
 /**
+ * Represents the identifier generated by a model when a tool call is requested.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare const ToolCallId: Schema.brand<typeof Schema.String, "ToolCallId">;
+export declare const ToolCallId: Schema.brand<typeof Schema.String, "@effect/ai/ToolCallId">;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
 export type ToolCallId = typeof ToolCallId.Type;
-declare const ToolCallPart_base: Schema.TaggedClass<ToolCallPart, "ToolCall", {
-    readonly _tag: Schema.tag<"ToolCall">;
+declare const ToolCallPart_base: Schema.TaggedClass<ToolCallPart, "ToolCallPart", {
+    readonly _tag: Schema.tag<"ToolCallPart">;
 } & {
-    id: Schema.brand<typeof Schema.String, "ToolCallId">;
+    /**
+     * The identifier generated by a model when requesting a tool call.
+     */
+    id: Schema.brand<typeof Schema.String, "@effect/ai/ToolCallId">;
+    /**
+     * The name of the tool to call.
+     */
     name: typeof Schema.String;
+    /**
+     * The arguments to call the tool with as a JSON-serializable object that
+     * matches the tool call input schema.
+     */
     params: typeof Schema.Unknown;
 }>;
 /**
+ * Represents a request by a model to call a specific tool that it has been
+ * provided with.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
 export declare class ToolCallPart extends ToolCallPart_base {
     /**
@@ -74,6 +519,10 @@ export declare class ToolCallPart extends ToolCallPart_base {
      */
     readonly [PartTypeId]: PartTypeId;
     /**
+     * Converts a raw tool call into a `ToolCallPart` by parsing tool call
+     * parameters as a JSON string. If your tool call parameters are already
+     * parsed, use `ToolCallPart.fromUnknown`.
+     *
      * @since 1.0.0
      */
     static fromJson({ id, name, params }: {
@@ -82,6 +531,10 @@ export declare class ToolCallPart extends ToolCallPart_base {
         readonly params: string;
     }): Effect.Effect<ToolCallPart, AiError>;
     /**
+     * Converts a raw tool call into a `ToolCallPart` assuming that the tool call
+     * parameters have already been parsed. If your tool call parameters have not
+     * already been parsed, use `ToolCallPart.fromJson`.
+     *
      * @since 1.0.0
      */
     static fromUnknown({ id, name, params }: {
@@ -90,146 +543,304 @@ export declare class ToolCallPart extends ToolCallPart_base {
         readonly params: unknown;
     }): ToolCallPart;
 }
-declare const ImageUrlPart_base: Schema.TaggedClass<ImageUrlPart, "ImageUrl", {
-    readonly _tag: Schema.tag<"ImageUrl">;
+declare const MetadataPart_base: Schema.TaggedClass<MetadataPart, "MetadataPart", {
+    readonly _tag: Schema.tag<"MetadataPart">;
 } & {
-    url: typeof Schema.String;
+    /**
+     * The unique identifier for the response. Each chunk of the response should
+     * have the same identifier.
+     */
+    id: Schema.optional<typeof Schema.String>;
+    /**
+     * The model that was used to generate the response.
+     */
+    model: typeof Schema.String;
+    /**
+     * The Unix timestamp of when the model began generated the response.
+     */
+    timestamp: Schema.optional<typeof Schema.DateFromNumber>;
 }>;
 /**
+ * Represents the initial response metadata generated by a model when responding
+ * to a request.
+ *
  * @since 1.0.0
- * @category parts
+ * @categor Models
  */
-export declare class ImageUrlPart extends ImageUrlPart_base {
+export declare class MetadataPart extends MetadataPart_base {
     /**
      * @since 1.0.0
      */
     readonly [PartTypeId]: PartTypeId;
 }
 /**
+ * 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.
+ * - `"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 parts
- */
-export type Part = TextPart | ToolCallPart | ImageUrlPart;
-/**
- * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare const Part: Schema.Union<[
-    typeof TextPart,
-    typeof ToolCallPart,
-    typeof ImageUrlPart
+export declare const FinishReason: Schema.Literal<[
+    "stop",
+    "length",
+    "content-filter",
+    "tool-calls",
+    "error",
+    "other",
+    "unknown"
 ]>;
-declare const AiResponse_base: Schema.Class<AiResponse, {
-    role: Schema.Union<[typeof AiRole.User, typeof AiRole.UserWithName, typeof AiRole.Model]>;
-    parts: Schema.Chunk<Schema.Union<[typeof TextPart, typeof ToolCallPart, typeof ImageUrlPart]>>;
-}, Schema.Struct.Encoded<{
-    role: Schema.Union<[typeof AiRole.User, typeof AiRole.UserWithName, typeof AiRole.Model]>;
-    parts: Schema.Chunk<Schema.Union<[typeof TextPart, typeof ToolCallPart, typeof ImageUrlPart]>>;
-}>, never, {
-    readonly role: AiRole.User | AiRole.UserWithName | AiRole.Model;
-} & {
-    readonly parts: Chunk.Chunk<TextPart | ToolCallPart | ImageUrlPart>;
-}, {}, {}>;
 /**
  * @since 1.0.0
- * @category models
+ * @category Models
  */
-export declare class AiResponse extends AiResponse_base {
+export type FinishReason = typeof FinishReason.Type;
+declare const Usage_base: Schema.Class<Usage, {
     /**
-     * @since 1.0.0
+     * The number of tokens sent in the request to the model.
      */
-    readonly [TypeId]: TypeId;
+    inputTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The number of tokens that the model generated for the request.
      */
-    static is(u: unknown): u is AiResponse;
+    outputTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The total of number of input tokens and output tokens generated by the
+     * model.
      */
-    static readonly empty: AiResponse;
+    totalTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The number of reasoning tokens that the model used to generate the output
+     * for the request.
      */
-    static fromText(options: {
-        role: AiRole.AiRole;
-        content: string;
-    }): AiResponse;
+    reasoningTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The number of input tokens read from the prompt cache for the request.
      */
-    get text(): string;
+    cacheReadInputTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The number of input tokens written to the prompt cache for the request.
      */
-    get imageUrl(): Option.Option<string>;
+    cacheWriteInputTokens: typeof Schema.Number;
+}, Schema.Struct.Encoded<{
     /**
-     * @since 1.0.0
+     * The number of tokens sent in the request to the model.
      */
-    withToolCallsJson(calls: Iterable<{
-        readonly id: string;
-        readonly name: string;
-        readonly params: string;
-    }>): Effect.Effect<AiResponse, AiError>;
+    inputTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The number of tokens that the model generated for the request.
      */
-    withToolCallsUnknown(calls: Iterable<{
-        readonly id: string;
-        readonly name: string;
-        readonly params: unknown;
-    }>): AiResponse;
+    outputTokens: typeof Schema.Number;
     /**
-     * @since 1.0.0
+     * The total of number of input tokens and output tokens generated by the
+     * model.
      */
-    concat(that: AiResponse): AiResponse;
-}
-/**
- * @since 1.0.0
- * @category tools
- */
-export declare const WithResolvedTypeId: unique symbol;
+    totalTokens: typeof Schema.Number;
+    /**
+     * The number of reasoning tokens that the model used to generate the output
+     * for the request.
+     */
+    reasoningTokens: typeof Schema.Number;
+    /**
+     * The number of input tokens read from the prompt cache for the request.
+     */
+    cacheReadInputTokens: typeof Schema.Number;
+    /**
+     * The number of input tokens written to the prompt cache for the request.
+     */
+    cacheWriteInputTokens: typeof Schema.Number;
+}>, never, {
+    readonly inputTokens: number;
+} & {
+    readonly outputTokens: number;
+} & {
+    readonly totalTokens: number;
+} & {
+    readonly reasoningTokens: number;
+} & {
+    readonly cacheReadInputTokens: number;
+} & {
+    readonly cacheWriteInputTokens: number;
+}, {}, {}>;
 /**
+ * Represents information about the number of tokens used by the model to
+ * generate a response.
+ *
  * @since 1.0.0
- * @category tools
+ * @category Models
  */
-export type WithResolvedTypeId = typeof WithResolvedTypeId;
+export declare class Usage extends Usage_base {
+}
 /**
+ * Represents additional provider-specific metadata that was returned by the
+ * model. Specific providers will use module augmentation to add their own
+ * specific provider metadata.
+ *
+ * The outer record is keyed by provider name, while the inner record is keyed
+ * by the names of the provider-specific metadata properties.
+ *
+ * For example:
+ *
+ * ```ts
+ * const providerMeta = {
+ *   "amazon-bedrock": {
+ *     // Provider specific metadata
+ *   }
+ * }
+ * ```
+ *
  * @since 1.0.0
- * @category tools
+ * @category Models
  */
-export declare class WithResolved<A> extends Data.Class<{
-    readonly response: AiResponse;
-    readonly resolved: ReadonlyMap<ToolCallId, A>;
-    readonly encoded: ReadonlyMap<ToolCallId, unknown>;
-}> {
+export interface ProviderMetadata {
+}
+declare const FinishPart_base: Schema.TaggedClass<FinishPart, "FinishPart", {
+    readonly _tag: Schema.tag<"FinishPart">;
+} & {
     /**
-     * @since 1.0.0
+     * The usage information for the response.
      */
-    readonly [WithResolvedTypeId]: WithResolvedTypeId;
+    usage: typeof Usage;
     /**
-     * @since 1.0.0
+     * The reason the model finished generating a response.
+     */
+    reason: Schema.Literal<["stop", "length", "content-filter", "tool-calls", "error", "other", "unknown"]>;
+    /**
+     * Provider-specific metadata associated with the response.
      */
-    static is<A>(u: unknown): u is WithResolved<A>;
+    providerMetadata: Schema.optionalWith<Schema.Record$<typeof Schema.String, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>, {
+        default: () => {};
+    }>;
+}>;
+/**
+ * Represents the final part of a response generated by a large language model.
+ *
+ * Contains useful information such as tokens used as part of the interaction
+ * with the model.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class FinishPart extends FinishPart_base {
     /**
      * @since 1.0.0
      */
-    static readonly empty: WithResolved<never>;
+    readonly [PartTypeId]: PartTypeId;
+}
+/**
+ * Represents an single part of a response received from a large language model.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const Part: Schema.Union<[
+    typeof TextPart,
+    typeof ReasoningPart,
+    typeof RedactedReasoningPart,
+    typeof ToolCallPart,
+    typeof MetadataPart,
+    typeof FinishPart
+]>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type Part = typeof Part.Type;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const is: (u: unknown) => u is AiResponse;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isPart: (u: unknown) => u is Part;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isStructured: (u: unknown) => u is WithStructuredOutput<any>;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const hasToolCallResults: (u: unknown) => u is WithToolCallResults<any>;
+/**
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const empty: AiResponse;
+/**
+ * Combines two responses into a single response.
+ *
+ * @since 1.0.0
+ * @category Combination
+ */
+export declare const merge: {
     /**
+     * Combines two responses into a single response.
+     *
      * @since 1.0.0
+     * @category Combination
      */
-    get values(): Array<A>;
+    (other: AiResponse): (self: AiResponse) => AiResponse;
     /**
+     * Combines two responses into a single response.
+     *
      * @since 1.0.0
+     * @category Combination
      */
-    get value(): Option.Option<A>;
+    (self: AiResponse, other: AiResponse): AiResponse;
+};
+/**
+ * Adds the specified tool calls to the provided `AiResponse`.
+ *
+ * **NOTE**: With this method, the tool call parameters will be parsed as a
+ * JSON string. If your tool call parameters are already parsed, use
+ * `AiResponse.withToolCallsUnknown`.
+ *
+ * @since 1.0.0
+ * @category Combination
+ */
+export declare const withToolCallsJson: {
     /**
+     * Adds the specified tool calls to the provided `AiResponse`.
+     *
+     * **NOTE**: With this method, the tool call parameters will be parsed as a
+     * JSON string. If your tool call parameters are already parsed, use
+     * `AiResponse.withToolCallsUnknown`.
+     *
      * @since 1.0.0
+     * @category Combination
      */
-    get unsafeValue(): A;
+    (toolCalls: Iterable<{
+        readonly id: string;
+        readonly name: string;
+        readonly params: string;
+    }>): (self: AiResponse) => Effect.Effect<AiResponse, AiError>;
     /**
+     * Adds the specified tool calls to the provided `AiResponse`.
+     *
+     * **NOTE**: With this method, the tool call parameters will be parsed as a
+     * JSON string. If your tool call parameters are already parsed, use
+     * `AiResponse.withToolCallsUnknown`.
+     *
      * @since 1.0.0
+     * @category Combination
      */
-    concat<B>(that: WithResolved<B>): WithResolved<A | B>;
-}
+    (self: AiResponse, toolCalls: Iterable<{
+        readonly id: string;
+        readonly name: string;
+        readonly params: string;
+    }>): Effect.Effect<AiResponse, AiError>;
+};
 export {};
 //# sourceMappingURL=AiResponse.d.ts.map