@effect/ai 0.14.1 → 0.16.0

package/dist/dts/AiInput.d.ts

@@ -1,288 +1,583 @@
+import * as Schema from "effect/Schema";
+import * as AiResponse from "./AiResponse.js";
 /**
  * @since 1.0.0
+ * @category Type Ids
  */
-import type { PlatformError } from "@effect/platform/Error";
-import * as FileSystem from "@effect/platform/FileSystem";
-import * as Path from "@effect/platform/Path";
-import * as Chunk from "effect/Chunk";
-import * as Context from "effect/Context";
-import * as Effect from "effect/Effect";
-import * as Option from "effect/Option";
-import * as Schema_ from "effect/Schema";
-import { AiResponse, WithResolved } from "./AiResponse.js";
-import * as AiRole from "./AiRole.js";
+export declare const TypeId: unique symbol;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Type Ids
  */
-export declare const PartTypeId: unique symbol;
+export type TypeId = typeof TypeId;
+declare const AiInput_base: Schema.Class<AiInput, {
+    messages: Schema.Array$<Schema.suspend<UserMessage | AssistantMessage | ToolMessage, {
+        readonly _tag: "UserMessage";
+        readonly parts: readonly ({
+            readonly _tag: "TextPart";
+            readonly text: string;
+        } | {
+            readonly _tag: "ImagePart";
+            readonly data: string;
+            readonly mediaType?: string | undefined;
+        } | {
+            readonly _tag: "ImageUrlPart";
+            readonly url: string;
+        } | {
+            readonly _tag: "FilePart";
+            readonly data: string;
+            readonly name?: string | undefined;
+            readonly mediaType?: string | undefined;
+        } | {
+            readonly _tag: "FileUrlPart";
+            readonly url: string;
+        })[];
+        readonly userName?: string | undefined;
+    } | {
+        readonly _tag: "AssistantMessage";
+        readonly parts: readonly ({
+            readonly _tag: "TextPart";
+            readonly text: string;
+        } | {
+            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: "ToolMessage";
+        readonly parts: readonly {
+            readonly _tag: "ToolCallResultPart";
+            readonly id: string;
+            readonly result: unknown;
+        }[];
+    }, never>>;
+}, Schema.Struct.Encoded<{
+    messages: Schema.Array$<Schema.suspend<UserMessage | AssistantMessage | ToolMessage, {
+        readonly _tag: "UserMessage";
+        readonly parts: readonly ({
+            readonly _tag: "TextPart";
+            readonly text: string;
+        } | {
+            readonly _tag: "ImagePart";
+            readonly data: string;
+            readonly mediaType?: string | undefined;
+        } | {
+            readonly _tag: "ImageUrlPart";
+            readonly url: string;
+        } | {
+            readonly _tag: "FilePart";
+            readonly data: string;
+            readonly name?: string | undefined;
+            readonly mediaType?: string | undefined;
+        } | {
+            readonly _tag: "FileUrlPart";
+            readonly url: string;
+        })[];
+        readonly userName?: string | undefined;
+    } | {
+        readonly _tag: "AssistantMessage";
+        readonly parts: readonly ({
+            readonly _tag: "TextPart";
+            readonly text: string;
+        } | {
+            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: "ToolMessage";
+        readonly parts: readonly {
+            readonly _tag: "ToolCallResultPart";
+            readonly id: string;
+            readonly result: unknown;
+        }[];
+    }, never>>;
+}>, never, {
+    readonly messages: readonly (UserMessage | AssistantMessage | ToolMessage)[];
+}, {}, {}>;
 /**
+ * Represents input to a large language model.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export type PartTypeId = typeof PartTypeId;
-declare const TextPart_base: Schema_.TaggedClass<TextPart, "Text", {
-    readonly _tag: Schema_.tag<"Text">;
+export declare class AiInput extends AiInput_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [TypeId]: TypeId;
+}
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const FromJson: Schema.transform<Schema.SchemaClass<unknown, string, never>, typeof AiInput>;
+/**
+ * Represents raw input types that can be converted into an `AiInput`.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type Raw = string | Message | Iterable<Message> | AiInput | AiResponse.AiResponse | AiResponse.WithStructuredOutput<any> | AiResponse.WithToolCallResults<any>;
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const MessageTypeId: unique symbol;
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type MessageTypeId = typeof MessageTypeId;
+declare const UserMessage_base: Schema.TaggedClass<UserMessage, "UserMessage", {
+    readonly _tag: Schema.tag<"UserMessage">;
 } & {
-    content: typeof Schema_.String;
+    parts: Schema.Array$<Schema.suspend<TextPart | ImagePart | ImageUrlPart | FilePart | FileUrlPart, {
+        readonly _tag: "TextPart";
+        readonly text: string;
+    } | {
+        readonly _tag: "ImagePart";
+        readonly data: string;
+        readonly mediaType?: string | undefined;
+    } | {
+        readonly _tag: "ImageUrlPart";
+        readonly url: string;
+    } | {
+        readonly _tag: "FilePart";
+        readonly data: string;
+        readonly name?: string | undefined;
+        readonly mediaType?: string | undefined;
+    } | {
+        readonly _tag: "FileUrlPart";
+        readonly url: string;
+    }, never>>;
+    userName: Schema.optional<typeof Schema.String>;
 }>;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare class TextPart extends TextPart_base {
-    /**
-     * @since 1.0.0
-     */
-    readonly [PartTypeId]: PartTypeId;
+export declare class UserMessage extends UserMessage_base {
     /**
      * @since 1.0.0
      */
-    static fromContent(content: string): TextPart;
+    readonly [MessageTypeId]: MessageTypeId;
 }
+declare const AssistantMessage_base: Schema.TaggedClass<AssistantMessage, "AssistantMessage", {
+    readonly _tag: Schema.tag<"AssistantMessage">;
+} & {
+    parts: Schema.Array$<Schema.suspend<TextPart | ReasoningPart | RedactedReasoningPart | ToolCallPart, {
+        readonly _tag: "TextPart";
+        readonly text: string;
+    } | {
+        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;
+    }, never>>;
+}>;
 /**
  * @since 1.0.0
- * @category parts
- */
-export declare const ImageQuality: Schema_.Literal<["low", "high", "auto"]>;
-/**
- * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export type ImageQuality = typeof ImageQuality.Type;
-declare const ImageUrlPart_base: Schema_.TaggedClass<ImageUrlPart, "ImageUrl", {
-    readonly _tag: Schema_.tag<"ImageUrl">;
+export declare class AssistantMessage extends AssistantMessage_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [MessageTypeId]: MessageTypeId;
+}
+declare const ToolMessage_base: Schema.TaggedClass<ToolMessage, "ToolMessage", {
+    readonly _tag: Schema.tag<"ToolMessage">;
 } & {
-    url: typeof Schema_.String;
-    quality: Schema_.PropertySignature<":", "low" | "high" | "auto", never, ":", "low" | "high" | "auto", true, never>;
+    parts: Schema.Array$<Schema.suspend<ToolCallResultPart, {
+        readonly _tag: "ToolCallResultPart";
+        readonly id: string;
+        readonly result: unknown;
+    }, never>>;
 }>;
 /**
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare class ImageUrlPart extends ImageUrlPart_base {
+export declare class ToolMessage extends ToolMessage_base {
     /**
      * @since 1.0.0
      */
-    readonly [PartTypeId]: PartTypeId;
+    readonly [MessageTypeId]: MessageTypeId;
 }
 /**
  * @since 1.0.0
- * @category base64
+ * @category Models
  */
-export interface Base64DataUrl extends Schema_.transformOrFail<typeof Schema_.String, Schema_.Struct<{
-    data: Schema_.Schema<Uint8Array>;
-    contentType: typeof Schema_.String;
-}>> {
-}
+export declare const Message: Schema.Union<[
+    typeof UserMessage,
+    typeof AssistantMessage,
+    typeof ToolMessage
+]>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type Message = typeof Message.Type;
 /**
  * @since 1.0.0
- * @category base64
+ * @category Type Ids
  */
-export declare const Base64DataUrl: Base64DataUrl;
-declare const ImagePart_base: Schema_.TaggedClass<ImagePart, "Image", {
-    readonly _tag: Schema_.tag<"Image">;
+export declare const PartTypeId: unique symbol;
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type PartTypeId = typeof PartTypeId;
+declare const TextPart_base: Schema.TaggedClass<TextPart, "TextPart", {
+    readonly _tag: Schema.tag<"TextPart">;
 } & {
-    image: Base64DataUrl;
-    quality: Schema_.PropertySignature<":", "low" | "high" | "auto", never, ":", "low" | "high" | "auto", true, never>;
+    /**
+     * The text content.
+     */
+    text: typeof Schema.String;
 }>;
 /**
+ * Represents a text part of a message.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare class ImagePart extends ImagePart_base {
+export declare class TextPart extends TextPart_base {
     /**
      * @since 1.0.0
      */
     readonly [PartTypeId]: PartTypeId;
+}
+declare const ImagePart_base: Schema.TaggedClass<ImagePart, "ImagePart", {
+    readonly _tag: Schema.tag<"ImagePart">;
+} & {
     /**
-     * @since 1.0.0
+     * The binary image data.
      */
-    static fromPath(path: string, quality?: ImageQuality): Effect.Effect<ImagePart, PlatformError, FileSystem.FileSystem | Path.Path>;
+    data: Schema.Schema<Uint8Array<ArrayBufferLike>, string, never>;
     /**
-     * @since 1.0.0
+     * The optional MIME type for the image.
      */
-    static fromBlob(blob: Blob, quality?: ImageQuality): Effect.Effect<ImagePart>;
-    get asBase64(): string;
-    get asDataUri(): string;
-}
-declare const ToolCallPart_base: Schema_.TaggedClass<ToolCallPart, "ToolCall", {
-    readonly _tag: Schema_.tag<"ToolCall">;
-} & {
-    id: Schema_.brand<typeof Schema_.String, "ToolCallId">;
-    name: typeof Schema_.String;
-    params: typeof Schema_.Unknown;
+    mediaType: Schema.optional<typeof Schema.String>;
 }>;
 /**
+ * Represents an image part of a message with binary image data.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare class ToolCallPart extends ToolCallPart_base {
+export declare class ImagePart extends ImagePart_base {
     /**
      * @since 1.0.0
      */
     readonly [PartTypeId]: PartTypeId;
 }
-declare const ToolCallResolvedPart_base: Schema_.TaggedClass<ToolCallResolvedPart, "ToolCallResolved", {
-    readonly _tag: Schema_.tag<"ToolCallResolved">;
+declare const ImageUrlPart_base: Schema.TaggedClass<ImageUrlPart, "ImageUrlPart", {
+    readonly _tag: Schema.tag<"ImageUrlPart">;
 } & {
-    toolCallId: Schema_.brand<typeof Schema_.String, "ToolCallId">;
-    value: typeof Schema_.Unknown;
+    /**
+     * The URL that points to the image.
+     */
+    url: typeof Schema.URL;
 }>;
 /**
+ * Represents an image part of a message with a URL pointing to the image.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare class ToolCallResolvedPart extends ToolCallResolvedPart_base {
+export declare class ImageUrlPart extends ImageUrlPart_base {
     /**
      * @since 1.0.0
      */
     readonly [PartTypeId]: PartTypeId;
 }
+declare const FilePart_base: Schema.TaggedClass<FilePart, "FilePart", {
+    readonly _tag: Schema.tag<"FilePart">;
+} & {
+    /**
+     * The binary file data.
+     */
+    data: Schema.Schema<Uint8Array<ArrayBufferLike>, string, never>;
+    /**
+     * The optional name of the file.
+     */
+    name: Schema.optional<typeof Schema.String>;
+    /**
+     * The optional MIME type for the image.
+     */
+    mediaType: Schema.optional<typeof Schema.String>;
+}>;
 /**
+ * Represents a file part of a message with binary file data.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export type Part = TextPart | ToolCallPart | ToolCallResolvedPart | ImagePart | ImageUrlPart;
+export declare class FilePart extends FilePart_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [PartTypeId]: PartTypeId;
+}
+declare const FileUrlPart_base: Schema.TaggedClass<FileUrlPart, "FileUrlPart", {
+    readonly _tag: Schema.tag<"FileUrlPart">;
+} & {
+    /**
+     * The URL that points to the file.
+     */
+    url: typeof Schema.URL;
+}>;
 /**
+ * Represents a file part of a message with a URL pointing to the file.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare const isPart: (u: unknown) => u is Part;
+export declare class FileUrlPart extends FileUrlPart_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [PartTypeId]: PartTypeId;
+}
+declare const ReasoningPart_base: Schema.TaggedClass<ReasoningPart, "ReasoningPart", {
+    readonly _tag: Schema.tag<"ReasoningPart">;
+} & {
+    /**
+     * The reasoning text 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 a part of a message containing reasoning that the model used to
+ * generate its output.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare namespace Part {
+export declare class ReasoningPart extends ReasoningPart_base {
     /**
      * @since 1.0.0
-     * @category parts
      */
-    type Schema = Schema_.Union<[
-        typeof TextPart,
-        typeof ToolCallPart,
-        typeof ToolCallResolvedPart,
-        typeof ImagePart,
-        typeof ImageUrlPart
-    ]>;
+    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 a part of a message containing content in the model's reasoning
+ * that was encrypted by the model provider for safety reasons.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export declare const Part: Part.Schema;
+export declare class RedactedReasoningPart extends RedactedReasoningPart_base {
+    /**
+     * @since 1.0.0
+     */
+    readonly [PartTypeId]: PartTypeId;
+}
 /**
+ * Represents the identifier generated by a model when a tool call is requested.
+ *
  * @since 1.0.0
- * @category message
+ * @category Models
  */
-export declare const MessageTypeId: unique symbol;
+export declare const ToolCallId: Schema.brand<typeof Schema.String, "@effect/ai/ToolCallId">;
 /**
  * @since 1.0.0
- * @category message
+ * @category Models
  */
-export type MessageTypeId = typeof MessageTypeId;
-declare const Message_base: Schema_.Class<Message, {
-    role: Schema_.Union<[typeof AiRole.User, typeof AiRole.UserWithName, typeof AiRole.Model]>;
-    parts: Schema_.Chunk<Part.Schema>;
-}, Schema_.Struct.Encoded<{
-    role: Schema_.Union<[typeof AiRole.User, typeof AiRole.UserWithName, typeof AiRole.Model]>;
-    parts: Schema_.Chunk<Part.Schema>;
-}>, never, {
-    readonly role: AiRole.User | AiRole.UserWithName | AiRole.Model;
+export type ToolCallId = typeof ToolCallId.Type;
+declare const ToolCallPart_base: Schema.TaggedClass<ToolCallPart, "ToolCallPart", {
+    readonly _tag: Schema.tag<"ToolCallPart">;
 } & {
-    readonly parts: Chunk.Chunk<TextPart | ImageUrlPart | ImagePart | ToolCallPart | ToolCallResolvedPart>;
-}, {}, {}>;
-/**
- * @since 1.0.0
- * @category message
- */
-export declare class Message extends Message_base {
     /**
-     * @since 1.0.0
+     * The identifier generated by a model when requesting a tool call.
      */
-    readonly [MessageTypeId]: MessageTypeId;
+    id: Schema.brand<typeof Schema.String, "@effect/ai/ToolCallId">;
     /**
-     * @since 1.0.0
+     * The name of the tool to call.
      */
-    static is(u: unknown): u is Message;
+    name: typeof Schema.String;
     /**
-     * @since 1.0.0
+     * The arguments to call the tool with as a JSON-serializable object that
+     * matches the tool call input schema.
      */
-    static fromInput(input: Message.Input, role?: AiRole.AiRole): Message;
+    params: typeof Schema.Unknown;
+}>;
+/**
+ * Represents a part of a message containing a tool call that the model has
+ * requested invocation of.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare class ToolCallPart extends ToolCallPart_base {
     /**
      * @since 1.0.0
      */
-    static fromResponse(response: AiResponse): Option.Option<Message>;
+    readonly [PartTypeId]: PartTypeId;
+    constructor(props: any, options?: Schema.MakeOptions);
+}
+declare const ToolCallResultPart_base: Schema.TaggedClass<ToolCallResultPart, "ToolCallResultPart", {
+    readonly _tag: Schema.tag<"ToolCallResultPart">;
+} & {
     /**
-     * @since 1.0.0
+     * The identifier generated by a model when requesting a tool call.
      */
-    static fromWithResolved<A>(response: WithResolved<A>): Message;
-}
+    id: Schema.brand<typeof Schema.String, "@effect/ai/ToolCallId">;
+    /**
+     * The result of the tool call as a JSON-serializable object.
+     */
+    result: typeof Schema.Unknown;
+}>;
 /**
+ * Represents a part of a message containing the results of tool calls that the
+ * model requested invocation of.
+ *
  * @since 1.0.0
- * @category message
+ * @category Models
  */
-export declare namespace Message {
+export declare class ToolCallResultPart extends ToolCallResultPart_base {
     /**
      * @since 1.0.0
-     * @category message
      */
-    type Input = string | Part | Iterable<Part>;
+    readonly [PartTypeId]: PartTypeId;
 }
 /**
+ * The valid parts of a user message.
+ *
  * @since 1.0.0
- * @category constructors
+ * @category Models
  */
-export declare const make: (input: Input, options?: {
-    readonly role?: AiRole.AiRole;
-}) => AiInput;
+export declare const UserMessagePart: Schema.Union<[
+    typeof TextPart,
+    typeof ImagePart,
+    typeof ImageUrlPart,
+    typeof FilePart,
+    typeof FileUrlPart
+]>;
 /**
  * @since 1.0.0
- * @category constructors
+ * @category Models
  */
-export declare const empty: AiInput;
+export type UserMessagePart = typeof UserMessagePart.Type;
 /**
+ * The valid parts of an assistant message.
+ *
  * @since 1.0.0
- * @category schemas
+ * @category Models
  */
-export declare const Schema: Schema_.Chunk<typeof Message>;
+export declare const AssistantMessagePart: Schema.Union<[
+    typeof TextPart,
+    typeof ReasoningPart,
+    typeof RedactedReasoningPart,
+    typeof ToolCallPart
+]>;
 /**
  * @since 1.0.0
- * @category schemas
+ * @category Models
  */
-export declare const SchemaJson: Schema_.Schema<Chunk.Chunk<Message>, string>;
+export type AssistantMessagePart = typeof AssistantMessagePart.Type;
 /**
+ * The valid parts of a tool message.
+ *
  * @since 1.0.0
- * @category models
+ * @category Models
  */
-export type Input = string | Part | Iterable<Part> | Message | Iterable<Message> | AiResponse | WithResolved<unknown>;
+export declare const ToolMessagePart: typeof ToolCallResultPart;
 /**
  * @since 1.0.0
- * @category models
+ * @category Models
  */
-export type AiInput = Chunk.Chunk<Message>;
-declare const SystemInstruction_base: Context.TagClass<SystemInstruction, "@effect/ai/AiInput/SystemInstruction", string>;
+export type ToolMessagePart = typeof ToolMessagePart.Type;
 /**
  * @since 1.0.0
- * @category system
+ * @category Guards
  */
-export declare class SystemInstruction extends SystemInstruction_base {
-}
+export declare const is: (u: unknown) => u is AiInput;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isMessage: (u: unknown) => u is Message;
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isPart: (u: unknown) => u is UserMessagePart | AssistantMessagePart | ToolMessagePart;
+/**
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const empty: AiInput;
+/**
+ * Constructs a new `AiInput` from raw user input.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const make: (input: Raw) => AiInput;
 /**
+ * Concatenates the messages of one `AiInput` onto the messages of another,
+ * creating a new `AiInput` with the messages from both.
+ *
  * @since 1.0.0
- * @category system
+ * @category Combination
  */
-export declare const provideSystem: {
+export declare const concat: {
     /**
+     * Concatenates the messages of one `AiInput` onto the messages of another,
+     * creating a new `AiInput` with the messages from both.
+     *
      * @since 1.0.0
-     * @category system
+     * @category Combination
      */
-    (input: string): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, SystemInstruction>>;
+    (other: AiInput): (self: AiInput) => AiInput;
     /**
+     * Concatenates the messages of one `AiInput` onto the messages of another,
+     * creating a new `AiInput` with the messages from both.
+     *
      * @since 1.0.0
-     * @category system
+     * @category Combination
      */
-    <A, E, R>(effect: Effect.Effect<A, E, R>, input: string): Effect.Effect<A, E, Exclude<R, SystemInstruction>>;
+    (self: AiInput, other: AiInput): AiInput;
 };
 export {};
 //# sourceMappingURL=AiInput.d.ts.map