@effect/ai 0.14.1 → 0.16.0

package/dist/esm/AiInput.js

@@ -1,175 +1,167 @@
-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 Encoding from "effect/Encoding";
+/**
+ * @since 1.0.0
+ */
 import { dual } from "effect/Function";
-import * as Option from "effect/Option";
-import * as ParseResult from "effect/ParseResult";
 import * as Predicate from "effect/Predicate";
-import * as Schema_ from "effect/Schema";
-import { AiResponse, ToolCallId, WithResolved } from "./AiResponse.js";
-import * as AiRole from "./AiRole.js";
-const constDisableValidation = {
-  disableValidation: true
-};
+import * as Schema from "effect/Schema";
+import * as AiResponse from "./AiResponse.js";
+import * as InternalCommon from "./internal/common.js";
 /**
  * @since 1.0.0
- * @category parts
+ * @category Type Ids
  */
-export const PartTypeId = /*#__PURE__*/Symbol("@effect/ai/AiInput/Part");
+export const TypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiInput");
 /**
+ * Represents input to a large language model.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export class TextPart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/AiInput/TextPart")("Text", {
-  content: Schema_.String
+export class AiInput extends /*#__PURE__*/Schema.Class("@effect/ai/AiInput")({
+  messages: /*#__PURE__*/Schema.Array( /*#__PURE__*/Schema.suspend(() => Message))
 }) {
   /**
    * @since 1.0.0
    */
-  [PartTypeId] = PartTypeId;
+  [TypeId] = TypeId;
+}
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export const FromJson = /*#__PURE__*/Schema.parseJson(AiInput);
+// =============================================================================
+// Message
+// =============================================================================
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export const MessageTypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiInput/Message");
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export class UserMessage extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/Message/UserMessage")("UserMessage", {
+  parts: /*#__PURE__*/Schema.Array( /*#__PURE__*/Schema.suspend(() => UserMessagePart)),
+  userName: /*#__PURE__*/Schema.optional(Schema.String)
+}) {
   /**
    * @since 1.0.0
    */
-  static fromContent(content) {
-    return new TextPart({
-      content
-    }, constDisableValidation);
-  }
+  [MessageTypeId] = MessageTypeId;
 }
 /**
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export const ImageQuality = /*#__PURE__*/Schema_.Literal("low", "high", "auto");
+export class AssistantMessage extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/Message/AssistantMessage")("AssistantMessage", {
+  parts: /*#__PURE__*/Schema.Array( /*#__PURE__*/Schema.suspend(() => AssistantMessagePart))
+}) {
+  /**
+   * @since 1.0.0
+   */
+  [MessageTypeId] = MessageTypeId;
+}
 /**
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export class ImageUrlPart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/AiInput/ImageUrlPart")("ImageUrl", {
-  url: Schema_.String,
-  quality: /*#__PURE__*/ImageQuality.pipe(Schema_.propertySignature, /*#__PURE__*/Schema_.withConstructorDefault(() => "auto"))
+export class ToolMessage extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/Message/ToolMessage")("ToolMessage", {
+  parts: /*#__PURE__*/Schema.Array( /*#__PURE__*/Schema.suspend(() => ToolMessagePart))
 }) {
   /**
    * @since 1.0.0
    */
-  [PartTypeId] = PartTypeId;
+  [MessageTypeId] = MessageTypeId;
 }
-const base64ContentTypeRegex = /^data:(.*?);base64$/;
 /**
  * @since 1.0.0
- * @category base64
+ * @category Models
  */
-export const Base64DataUrl = /*#__PURE__*/Schema_.transformOrFail( /*#__PURE__*/Schema_.String.annotations({
-  title: "Base64 Data URL",
-  description: "A base64 data URL"
-}), /*#__PURE__*/Schema_.Struct({
-  data: Schema_.Uint8ArrayFromSelf,
-  contentType: Schema_.String
-}), {
-  decode(base64Url, _, ast) {
-    const commaIndex = base64Url.indexOf(",");
-    if (commaIndex === -1) {
-      return ParseResult.fail(new ParseResult.Type(ast, base64Url));
-    }
-    const header = base64Url.slice(0, commaIndex);
-    const data = base64Url.slice(commaIndex + 1);
-    const contentType = base64ContentTypeRegex.exec(header);
-    if (contentType === null) {
-      return ParseResult.fail(new ParseResult.Type(ast, base64Url));
-    }
-    return Encoding.decodeBase64(data).pipe(ParseResult.mapError(_ => new ParseResult.Type(ast, base64Url)), ParseResult.map(data => ({
-      data,
-      contentType: contentType[1]
-    })));
-  },
-  encode({
-    contentType,
-    data
-  }) {
-    const base64 = Encoding.encodeBase64(data);
-    return ParseResult.succeed(`data:${contentType};base64,${base64}`);
-  }
-});
+export const Message = /*#__PURE__*/Schema.Union(UserMessage, AssistantMessage, ToolMessage);
+// =============================================================================
+// Part
+// =============================================================================
+/**
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export const PartTypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiInput/Message/Part");
 /**
+ * Represents a text part of a message.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export class ImagePart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/AiInput/ImagePart")("Image", {
-  image: Base64DataUrl,
-  quality: /*#__PURE__*/ImageQuality.pipe(Schema_.propertySignature, /*#__PURE__*/Schema_.withConstructorDefault(() => "auto"))
+export class TextPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/TextPart")("TextPart", {
+  /**
+   * The text content.
+   */
+  text: Schema.String
 }) {
   /**
    * @since 1.0.0
    */
   [PartTypeId] = PartTypeId;
+}
+/**
+ * Represents an image part of a message with binary image data.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export class ImagePart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/ImagePart")("ImagePart", {
+  /**
+   * The binary image data.
+   */
+  data: Schema.Uint8ArrayFromBase64,
+  /**
+   * The optional MIME type for the image.
+   */
+  mediaType: /*#__PURE__*/Schema.optional(Schema.String)
+}) {
   /**
    * @since 1.0.0
    */
-  static fromPath(path, quality = "auto") {
-    return FileSystem.FileSystem.pipe(Effect.bindTo("fs"), Effect.bind("Path", () => Path.Path), Effect.bind("data", ({
-      fs
-    }) => fs.readFile(path)), Effect.map(({
-      Path,
-      data
-    }) => {
-      const ext = Path.extname(path);
-      let contentType;
-      switch (ext) {
-        case ".jpg":
-        case ".jpeg":
-          {
-            contentType = "image/jpeg";
-            break;
-          }
-        default:
-          {
-            if (ext.startsWith(".")) {
-              contentType = `image/${ext.slice(1)}`;
-            } else {
-              contentType = "image/png";
-            }
-            break;
-          }
-      }
-      return new ImagePart({
-        image: {
-          data,
-          contentType
-        },
-        quality
-      }, constDisableValidation);
-    }));
-  }
+  [PartTypeId] = PartTypeId;
+}
+/**
+ * Represents an image part of a message with a URL pointing to the image.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export class ImageUrlPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/ImageUrlPart")("ImageUrlPart", {
+  /**
+   * The URL that points to the image.
+   */
+  url: Schema.URL
+}) {
   /**
    * @since 1.0.0
    */
-  static fromBlob(blob, quality = "auto") {
-    return Effect.promise(() => blob.arrayBuffer()).pipe(Effect.map(buffer => new ImagePart({
-      image: {
-        contentType: blob.type,
-        data: new Uint8Array(buffer)
-      },
-      quality
-    })));
-  }
-  get asBase64() {
-    return Encoding.encodeBase64(this.image.data);
-  }
-  get asDataUri() {
-    return `data:${this.image.contentType};base64,${this.asBase64}`;
-  }
+  [PartTypeId] = PartTypeId;
 }
 /**
+ * Represents a file part of a message with binary file data.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export class ToolCallPart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/AiInput/ToolCallPart")("ToolCall", {
-  id: ToolCallId,
-  name: Schema_.String,
-  params: Schema_.Unknown
+export class FilePart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/FilePart")("FilePart", {
+  /**
+   * The binary file data.
+   */
+  data: Schema.Uint8ArrayFromBase64,
+  /**
+   * The optional name of the file.
+   */
+  name: /*#__PURE__*/Schema.optional(Schema.String),
+  /**
+   * The optional MIME type for the image.
+   */
+  mediaType: /*#__PURE__*/Schema.optional(Schema.String)
 }) {
   /**
    * @since 1.0.0
@@ -177,12 +169,16 @@ export class ToolCallPart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/A
   [PartTypeId] = PartTypeId;
 }
 /**
+ * Represents a file part of a message with a URL pointing to the file.
+ *
  * @since 1.0.0
- * @category parts
+ * @category Models
  */
-export class ToolCallResolvedPart extends /*#__PURE__*/Schema_.TaggedClass("@effect/ai/AiInput/ToolCallResolvedPart")("ToolCallResolved", {
-  toolCallId: ToolCallId,
-  value: Schema_.Unknown
+export class FileUrlPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/FileUrlPart")("FileUrlPart", {
+  /**
+   * The URL that points to the file.
+   */
+  url: Schema.URL
 }) {
   /**
    * @since 1.0.0
@@ -190,157 +186,239 @@ export class ToolCallResolvedPart extends /*#__PURE__*/Schema_.TaggedClass("@eff
   [PartTypeId] = PartTypeId;
 }
 /**
+ * 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 const isPart = u => Predicate.hasProperty(u, PartTypeId);
+export class ReasoningPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/ReasoningPart")("ReasoningPart", {
+  /**
+   * The reasoning text that the model used to return the output.
+   */
+  reasoningText: Schema.String,
+  /**
+   * An optional signature which verifies that the reasoning text was generated
+   * by the model.
+   */
+  signature: /*#__PURE__*/Schema.optional(Schema.String)
+}) {
+  /**
+   * @since 1.0.0
+   */
+  [PartTypeId] = PartTypeId;
+}
 /**
+ * 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 const Part = /*#__PURE__*/Schema_.Union(TextPart, ToolCallPart, ToolCallResolvedPart, ImagePart, ImageUrlPart);
+export class RedactedReasoningPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/RedactedReasoningPart")("RedactedReasoningPart", {
+  /**
+   * The content in the reasoning that was encrypted by the model provider for
+   * safety reasons.
+   */
+  redactedText: Schema.String
+}) {
+  /**
+   * @since 1.0.0
+   */
+  [PartTypeId] = PartTypeId;
+}
 /**
+ * Represents the identifier generated by a model when a tool call is requested.
+ *
  * @since 1.0.0
- * @category message
+ * @category Models
  */
-export const MessageTypeId = /*#__PURE__*/Symbol("@effect/ai/AiInput/Message");
+export const ToolCallId = InternalCommon.ToolCallId;
 /**
+ * Represents a part of a message containing a tool call that the model has
+ * requested invocation of.
+ *
  * @since 1.0.0
- * @category message
+ * @category Models
  */
-export class Message extends /*#__PURE__*/Schema_.Class("@effect/ai/AiInput/Message")({
-  role: AiRole.AiRole,
-  parts: /*#__PURE__*/Schema_.Chunk(Part)
-}) {
+export class ToolCallPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/ToolCallPart")("ToolCallPart", {
   /**
-   * @since 1.0.0
+   * The identifier generated by a model when requesting a tool call.
    */
-  [MessageTypeId] = MessageTypeId;
+  id: ToolCallId,
   /**
-   * @since 1.0.0
+   * The name of the tool to call.
    */
-  static is(u) {
-    return Predicate.hasProperty(u, MessageTypeId);
-  }
+  name: 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, role = AiRole.user) {
-    if (typeof input === "string") {
-      return new Message({
-        role,
-        parts: Chunk.of(TextPart.fromContent(input))
-      }, constDisableValidation);
-    } else if (isPart(input)) {
-      return new Message({
-        role,
-        parts: Chunk.of(input)
-      }, constDisableValidation);
-    }
-    return new Message({
-      role,
-      parts: Chunk.fromIterable(input)
-    }, constDisableValidation);
-  }
+  params: Schema.Unknown
+}) {
   /**
    * @since 1.0.0
    */
-  static fromResponse(response) {
-    if (Chunk.isEmpty(response.parts)) {
-      return Option.none();
-    }
-    return Option.some(new Message({
-      role: response.role,
-      parts: Chunk.map(response.parts, part => {
-        switch (part._tag) {
-          case "Text":
-            {
-              return TextPart.fromContent(part.content);
-            }
-          case "ToolCall":
-            {
-              return new ToolCallPart(part, constDisableValidation);
-            }
-          case "ImageUrl":
-            {
-              return new ImageUrlPart(part, constDisableValidation);
-            }
-        }
-      })
-    }, constDisableValidation));
+  [PartTypeId] = PartTypeId;
+  constructor(props, options) {
+    super(props, options);
   }
+}
+/**
+ * Represents a part of a message containing the results of tool calls that the
+ * model requested invocation of.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export class ToolCallResultPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiInput/ToolCallResultPart")("ToolCallResultPart", {
+  /**
+   * The identifier generated by a model when requesting a tool call.
+   */
+  id: ToolCallId,
+  /**
+   * The result of the tool call as a JSON-serializable object.
+   */
+  result: Schema.Unknown
+}) {
   /**
    * @since 1.0.0
    */
-  static fromWithResolved(response) {
-    const toolParts = [];
-    for (const [toolCallId, value] of response.encoded) {
-      toolParts.push(new ToolCallResolvedPart({
-        toolCallId,
-        value
-      }, constDisableValidation));
-    }
-    const toolPartsChunk = Chunk.unsafeFromArray(toolParts);
-    return Option.match(Message.fromResponse(response.response), {
-      onNone: () => new Message({
-        role: AiRole.model,
-        parts: toolPartsChunk
-      }, constDisableValidation),
-      onSome: message => new Message({
-        role: message.role,
-        parts: Chunk.appendAll(message.parts, toolPartsChunk)
-      }, constDisableValidation)
-    });
-  }
+  [PartTypeId] = PartTypeId;
 }
 /**
+ * The valid parts of a user message.
+ *
  * @since 1.0.0
- * @category constructors
+ * @category Models
  */
-export const make = (input, options) => {
-  if (typeof input !== "string" && Predicate.isIterable(input)) {
-    const chunk = Chunk.fromIterable(input);
-    if (Chunk.isEmpty(chunk)) {
-      return chunk;
-    } else if (Message.is(Chunk.unsafeHead(chunk))) {
-      return chunk;
-    }
-    return Chunk.of(Message.fromInput(chunk, options?.role));
-  } else if (AiResponse.is(input)) {
-    return Option.match(Message.fromResponse(input), {
-      onNone: Chunk.empty,
-      onSome: Chunk.of
-    });
-  } else if (WithResolved.is(input)) {
-    return Chunk.of(Message.fromWithResolved(input));
-  } else if (Message.is(input)) {
-    return Chunk.of(input);
-  }
-  return Chunk.of(Message.fromInput(input, options?.role));
-};
+export const UserMessagePart = /*#__PURE__*/Schema.Union(TextPart, ImagePart, ImageUrlPart, FilePart, FileUrlPart);
 /**
+ * The valid parts of an assistant message.
+ *
  * @since 1.0.0
- * @category constructors
+ * @category Models
  */
-export const empty = /*#__PURE__*/Chunk.empty();
+export const AssistantMessagePart = /*#__PURE__*/Schema.Union(TextPart, ReasoningPart, RedactedReasoningPart, ToolCallPart);
 /**
+ * The valid parts of a tool message.
+ *
  * @since 1.0.0
- * @category schemas
+ * @category Models
  */
-export const Schema = /*#__PURE__*/Schema_.Chunk(Message);
+export const ToolMessagePart = ToolCallResultPart;
 /**
  * @since 1.0.0
- * @category schemas
+ * @category Guards
  */
-export const SchemaJson = /*#__PURE__*/Schema_.parseJson(Schema);
+export const is = u => Predicate.hasProperty(u, TypeId);
 /**
  * @since 1.0.0
- * @category system
+ * @category Guards
  */
-export class SystemInstruction extends /*#__PURE__*/Context.Tag("@effect/ai/AiInput/SystemInstruction")() {}
+export const isMessage = u => Predicate.hasProperty(u, MessageTypeId);
+/**
+ * @since 1.0.0
+ * @category Guards
+ */
+export const isPart = u => Predicate.hasProperty(u, PartTypeId);
+/**
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const empty = /*#__PURE__*/new AiInput({
+  messages: []
+});
+/**
+ * Constructs a new `AiInput` from raw user input.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const make = input => {
+  if (Predicate.isString(input)) {
+    const textPart = new TextPart({
+      text: input
+    });
+    const message = new UserMessage({
+      parts: [textPart]
+    });
+    return new AiInput({
+      messages: [message]
+    });
+  }
+  if (isMessage(input)) {
+    return new AiInput({
+      messages: [input]
+    });
+  }
+  if (Predicate.isIterable(input)) {
+    return new AiInput({
+      messages: Array.from(input)
+    });
+  }
+  if (is(input)) {
+    return input;
+  }
+  if (AiResponse.isStructured(input)) {
+    const assistantMessages = fromResponse(input).messages;
+    const toolPart = new ToolCallResultPart({
+      id: input.id,
+      result: input.value
+    });
+    const toolMessage = new ToolMessage({
+      parts: [toolPart]
+    });
+    return new AiInput({
+      messages: [...assistantMessages, toolMessage]
+    });
+  }
+  if (AiResponse.hasToolCallResults(input)) {
+    const assistantMessages = fromResponse(input).messages;
+    const toolParts = [];
+    for (const [id, result] of input.encodedResults) {
+      toolParts.push(new ToolCallResultPart({
+        id,
+        result
+      }));
+    }
+    const toolMessage = new ToolMessage({
+      parts: toolParts
+    });
+    return new AiInput({
+      messages: [...assistantMessages, toolMessage]
+    });
+  }
+  return fromResponse(input);
+};
+const EXCLUDED_RESPONSE_PARTS = ["MetadataPart", "ReasoningPart", "RedactedReasoningPart", "FinishPart"];
+const validResponseParts = part => !EXCLUDED_RESPONSE_PARTS.includes(part._tag);
+const fromResponse = response => {
+  if (response.parts.length === 0) {
+    return empty;
+  }
+  const parts = response.parts.filter(validResponseParts).map(part => part._tag === "TextPart" ? new TextPart({
+    text: part.text
+  }) : new ToolCallPart({
+    id: part.id,
+    name: part.name,
+    params: part.params
+  }));
+  const message = new AssistantMessage({
+    parts
+  });
+  return new AiInput({
+    messages: [message]
+  });
+};
 /**
+ * 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 const provideSystem = /*#__PURE__*/dual(2, (effect, input) => Effect.provideService(effect, SystemInstruction, input));
+export const concat = /*#__PURE__*/dual(2, (self, other) => AiInput.make({
+  messages: [...self.messages, ...other.messages]
+}));
 //# sourceMappingURL=AiInput.js.map