@effect/ai 0.26.0 → 0.27.0

package/dist/dts/Prompt.d.ts

@@ -0,0 +1,1119 @@
+import * as Schema from "effect/Schema";
+import type * as Response from "./Response.js";
+/**
+ * Schema for provider-specific options which can be attached to both content
+ * parts and messages, enabling provider-specific behavior.
+ *
+ * Provider-specific options are namespaced by provider and have the structure:
+ *
+ * ```
+ * {
+ *   "<provider-specific-key>": {
+ *     // Provider-specific options
+ *   }
+ * }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export declare const ProviderOptions: Schema.Record$<typeof Schema.String, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type ProviderOptions = typeof ProviderOptions.Type;
+/**
+ * Unique identifier for Part instances.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const PartTypeId = "~effect/ai/Prompt/Part";
+/**
+ * Type-level representation of the Part identifier.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type PartTypeId = typeof PartTypeId;
+/**
+ * Type guard to check if a value is a Part.
+ *
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isPart: (u: unknown) => u is Part;
+/**
+ * Union type representing all possible content parts within messages.
+ *
+ * Parts are the building blocks of message content, supporting text, files,
+ * reasoning, tool calls, and tool results.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type Part = TextPart | ReasoningPart | FilePart | ToolCallPart | ToolResultPart;
+/**
+ * Encoded representation of a Part.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type PartEncoded = TextPartEncoded | ReasoningPartEncoded | FilePartEncoded | ToolCallPartEncoded | ToolResultPartEncoded;
+/**
+ * Base interface for all content parts.
+ *
+ * Provides common structure including type and provider options.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BasePart<Type extends string, Options extends ProviderOptions> {
+    readonly [PartTypeId]: PartTypeId;
+    /**
+     * The type of this content part.
+     */
+    readonly type: Type;
+    /**
+     * Provider-specific options for this part.
+     */
+    readonly options: Options;
+}
+/**
+ * Base interface for encoded content parts.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BasePartEncoded<Type extends string, Options extends ProviderOptions> {
+    /**
+     * The type of this content part.
+     */
+    readonly type: Type;
+    /**
+     * Provider-specific options for this part.
+     */
+    readonly options?: Options | undefined;
+}
+/**
+ * Creates a new content part of the specified type.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const textPart = Prompt.makePart("text", {
+ *   text: "Hello, world!"
+ * })
+ *
+ * const filePart = Prompt.makePart("file", {
+ *   mediaType: "image/png",
+ *   fileName: "screenshot.png",
+ *   data: new Uint8Array([1, 2, 3])
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const makePart: <const Type extends Part["type"]>(
+/**
+ * The type of part to create.
+ */
+type: Type, 
+/**
+ * Parameters specific to the part type being created.
+ */
+params: Omit<Extract<Part, {
+    type: Type;
+}>, PartTypeId | "type" | "options"> & {
+    /**
+     * Optional provider-specific options for this part.
+     */
+    readonly options?: Extract<Part, {
+        type: Type;
+    }>["options"] | undefined;
+}) => Extract<Part, {
+    type: Type;
+}>;
+/**
+ * Content part representing plain text.
+ *
+ * The most basic content type used for textual information in messages.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const textPart: Prompt.TextPart = Prompt.makePart("text", {
+ *   text: "Hello, how can I help you today?",
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface TextPart extends BasePart<"text", TextPartOptions> {
+    /**
+     * 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", TextPartOptions> {
+    /**
+     * The text content.
+     */
+    readonly text: string;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `TextPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface TextPartOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of text parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const TextPart: Schema.Schema<TextPart, TextPartEncoded>;
+/**
+ * Content part representing reasoning or chain-of-thought.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const reasoningPart: Prompt.ReasoningPart = Prompt.makePart("reasoning", {
+ *   text: "Let me think step by step: First I need to understand the user's question...",
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ReasoningPart extends BasePart<"reasoning", ReasoningPartOptions> {
+    /**
+     * 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", ReasoningPartOptions> {
+    /**
+     * The reasoning or thought process text.
+     */
+    readonly text: string;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `ReasoningPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ReasoningPartOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of reasoning parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ReasoningPart: Schema.Schema<ReasoningPart, ReasoningPartEncoded>;
+/**
+ * Content part representing a file attachment. Files can be provided as base64
+ * strings of data, byte arrays, or URLs.
+ *
+ * Supports various file types including images, documents, and binary data.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const imagePart: Prompt.FilePart = Prompt.makePart("file", {
+ *   mediaType: "image/jpeg",
+ *   fileName: "photo.jpg",
+ *   data: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."
+ * })
+ *
+ * const documentPart: Prompt.FilePart = Prompt.makePart("file", {
+ *   mediaType: "application/pdf",
+ *   fileName: "report.pdf",
+ *   data: new Uint8Array([1, 2, 3])
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FilePart extends BasePart<"file", FilePartOptions> {
+    /**
+     * MIME type of the file (e.g., "image/jpeg", "application/pdf").
+     */
+    readonly mediaType: string;
+    /**
+     * Optional filename for the file.
+     */
+    readonly fileName?: string | undefined;
+    /**
+     * File data as base64 string of data, a byte array, or a URL.
+     */
+    readonly data: string | Uint8Array | URL;
+}
+/**
+ * Encoded representation of file parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface FilePartEncoded extends BasePartEncoded<"file", FilePartOptions> {
+    /**
+     * MIME type of the file (e.g., "image/jpeg", "application/pdf").
+     */
+    readonly mediaType: string;
+    /**
+     * Optional filename for the file.
+     */
+    readonly fileName?: string | undefined;
+    /**
+     * File data as base64 string of data, a byte array, or a URL.
+     */
+    readonly data: string | Uint8Array | URL;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `FilePart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface FilePartOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of file parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const FilePart: Schema.Schema<FilePart, FilePartEncoded>;
+/**
+ * Content part representing a tool call request.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const toolCallPart: Prompt.ToolCallPart = Prompt.makePart("tool-call", {
+ *   id: "call_123",
+ *   name: "get_weather",
+ *   params: { city: "San Francisco", units: "celsius" },
+ *   providerExecuted: false,
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolCallPart extends BasePart<"tool-call", ToolCallPartOptions> {
+    /**
+     * Unique identifier for this tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool to invoke.
+     */
+    readonly name: string;
+    /**
+     * Parameters to pass to the tool.
+     */
+    readonly params: unknown;
+    /**
+     * 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", ToolCallPartOptions> {
+    /**
+     * Unique identifier for this tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool to invoke.
+     */
+    readonly name: string;
+    /**
+     * Parameters to pass to the tool.
+     */
+    readonly params: unknown;
+    /**
+     * Whether the tool was executed by the provider (true) or framework (false).
+     */
+    readonly providerExecuted?: boolean | undefined;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `ToolCallPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolCallPartOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of tool call parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolCallPart: Schema.Schema<ToolCallPart, ToolCallPartEncoded>;
+/**
+ * Content part representing the result of a tool call.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const toolResultPart: Prompt.ToolResultPart = Prompt.makePart("tool-result", {
+ *   id: "call_123",
+ *   name: "get_weather",
+ *   result: {
+ *     temperature: 22,
+ *     condition: "sunny",
+ *     humidity: 65
+ *   }
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolResultPart extends BasePart<"tool-result", ToolResultPartOptions> {
+    /**
+     * Unique identifier matching the original tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool that was executed.
+     */
+    readonly name: string;
+    /**
+     * The result returned by the tool execution.
+     */
+    readonly result: unknown;
+}
+/**
+ * Encoded representation of tool result parts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolResultPartEncoded extends BasePartEncoded<"tool-result", ToolResultPartOptions> {
+    /**
+     * Unique identifier matching the original tool call.
+     */
+    readonly id: string;
+    /**
+     * Name of the tool that was executed.
+     */
+    readonly name: string;
+    /**
+     * The result returned by the tool execution.
+     */
+    readonly result: unknown;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `ToolResultPart` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolResultPartOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of tool result parts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolResultPart: Schema.Schema<ToolResultPart, ToolResultPartEncoded>;
+/**
+ * Unique identifier for Message instances.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const MessageTypeId = "~effect/ai/Prompt/Message";
+/**
+ * Type-level representation of the Message identifier.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type MessageTypeId = typeof MessageTypeId;
+/**
+ * Type guard to check if a value is a Message.
+ *
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isMessage: (u: unknown) => u is Message;
+/**
+ * Base interface for all message types.
+ *
+ * Provides common structure including role and provider options.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BaseMessage<Role extends string, Options extends ProviderOptions> {
+    readonly [MessageTypeId]: MessageTypeId;
+    /**
+     * The role of the message participant.
+     */
+    readonly role: Role;
+    /**
+     * Provider-specific options for this message.
+     */
+    readonly options: Options;
+}
+/**
+ * Base interface for encoded message types.
+ *
+ * @template Role - String literal type for the message role
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface BaseMessageEncoded<Role extends string, Options extends ProviderOptions> {
+    /**
+     * The role of the message participant.
+     */
+    readonly role: Role;
+    /**
+     * Provider-specific options for this message.
+     */
+    readonly options?: Options | undefined;
+}
+/**
+ * Creates a new message with the specified role.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const textPart = Prompt.makePart("text", {
+ *   text: "Hello, world!"
+ * })
+ *
+ * const filePart = Prompt.makeMessage("user", {
+ *   content: [textPart]
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const makeMessage: <const Role extends Message["role"]>(role: Role, params: Omit<Extract<Message, {
+    role: Role;
+}>, MessageTypeId | "role" | "options"> & {
+    readonly options?: Extract<Message, {
+        role: Role;
+    }>["options"];
+}) => Extract<Message, {
+    role: Role;
+}>;
+/**
+ * Message representing system instructions or context.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const systemMessage: Prompt.SystemMessage = Prompt.makeMessage("system", {
+ *   content: "You are a helpful assistant specialized in mathematics. " +
+ *    "Always show your work step by step."
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface SystemMessage extends BaseMessage<"system", SystemMessageOptions> {
+    /**
+     * The system instruction or context as plain text.
+     */
+    readonly content: string;
+}
+/**
+ * Encoded representation of system messages for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface SystemMessageEncoded extends BaseMessageEncoded<"system", SystemMessageOptions> {
+    /**
+     * The system instruction or context as plain text.
+     */
+    readonly content: string;
+}
+/**
+ * Represents provider-specific options that can be associated with a
+ * `SystemMessage` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface SystemMessageOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of system messages.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const SystemMessage: Schema.Schema<SystemMessage, SystemMessageEncoded>;
+/**
+ * Message representing user input or questions.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const textUserMessage: Prompt.UserMessage = Prompt.makeMessage("user", {
+ *   content: [
+ *     Prompt.makePart("text", {
+ *       text: "Can you analyze this image for me?"
+ *     })
+ *   ]
+ * })
+ *
+ * const multimodalUserMessage: Prompt.UserMessage = Prompt.makeMessage("user", {
+ *   content: [
+ *     Prompt.makePart("text", {
+ *       text: "What do you see in this image?"
+ *     }),
+ *     Prompt.makePart("file", {
+ *       mediaType: "image/jpeg",
+ *       fileName: "vacation.jpg",
+ *       data: "data:image/jpeg;base64,..."
+ *     })
+ *   ]
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface UserMessage extends BaseMessage<"user", UserMessageOptions> {
+    /**
+     * Array of content parts that make up the user's message.
+     */
+    readonly content: ReadonlyArray<UserMessagePart>;
+}
+/**
+ * Union type of content parts allowed in user messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type UserMessagePart = TextPart | FilePart;
+/**
+ * Encoded representation of user messages for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface UserMessageEncoded extends BaseMessageEncoded<"user", UserMessageOptions> {
+    /**
+     * Array of content parts that make up the user's message.
+     */
+    readonly content: ReadonlyArray<UserMessagePartEncoded>;
+}
+/**
+ * Union type of encoded content parts for user messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type UserMessagePartEncoded = TextPartEncoded | FilePartEncoded;
+/**
+ * Represents provider-specific options that can be associated with a
+ * `UserMessage` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface UserMessageOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of user messages.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const UserMessage: Schema.Schema<UserMessage, UserMessageEncoded>;
+/**
+ * Message representing large language model assistant responses.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const assistantMessage: Prompt.AssistantMessage = Prompt.makeMessage("assistant", {
+ *   content: [
+ *     Prompt.makePart("text", {
+ *       text: "The user is asking about the weather. I should use the weather tool."
+ *     }),
+ *     Prompt.makePart("tool-call", {
+ *       id: "call_123",
+ *       name: "get_weather",
+ *       params: { city: "San Francisco" },
+ *       providerExecuted: false
+ *     }),
+ *     Prompt.makePart("tool-result", {
+ *       id: "call_123",
+ *       name: "get_weather",
+ *       result: { temperature: 72, condition: "sunny" }
+ *     }),
+ *     Prompt.makePart("text", {
+ *       text: "The weather in San Francisco is currently 72°F and sunny."
+ *     })
+ *   ]
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface AssistantMessage extends BaseMessage<"assistant", AssistantMessageOptions> {
+    /**
+     * Array of content parts that make up the assistant's response.
+     */
+    readonly content: ReadonlyArray<AssistantMessagePart>;
+}
+/**
+ * Union type of content parts allowed in assistant messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AssistantMessagePart = TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart;
+/**
+ * Encoded representation of assistant messages for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface AssistantMessageEncoded extends BaseMessageEncoded<"assistant", AssistantMessageOptions> {
+    readonly content: ReadonlyArray<AssistantMessagePartEncoded>;
+}
+/**
+ * Union type of encoded content parts for assistant messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type AssistantMessagePartEncoded = TextPartEncoded | FilePartEncoded | ReasoningPartEncoded | ToolCallPartEncoded | ToolResultPartEncoded;
+/**
+ * Represents provider-specific options that can be associated with a
+ * `AssistantMessage` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface AssistantMessageOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of assistant messages.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const AssistantMessage: Schema.Schema<AssistantMessage, AssistantMessageEncoded>;
+/**
+ * Message representing tool execution results.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const toolMessage: Prompt.ToolMessage = Prompt.makeMessage("tool", {
+ *   content: [
+ *     Prompt.makePart("tool-result", {
+ *       id: "call_123",
+ *       name: "search_web",
+ *       result: {
+ *         query: "TypeScript best practices",
+ *         results: [
+ *           { title: "TypeScript Handbook", url: "https://..." },
+ *           { title: "Effective TypeScript", url: "https://..." }
+ *         ]
+ *       }
+ *     })
+ *   ]
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolMessage extends BaseMessage<"tool", ToolMessageOptions> {
+    /**
+     * Array of tool result parts.
+     */
+    readonly content: ReadonlyArray<ToolMessagePart>;
+}
+/**
+ * Union type of content parts allowed in tool messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type ToolMessagePart = ToolResultPart;
+/**
+ * Encoded representation of tool messages for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ToolMessageEncoded extends BaseMessageEncoded<"tool", ToolMessageOptions> {
+    /**
+     * Array of tool result parts.
+     */
+    readonly content: ReadonlyArray<ToolMessagePartEncoded>;
+}
+/**
+ * Union type of encoded content parts for tool messages.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type ToolMessagePartEncoded = ToolResultPartEncoded;
+/**
+ * Represents provider-specific options that can be associated with a
+ * `ToolMessage` through module augmentation.
+ *
+ * @since 1.0.0
+ * @category ProviderOptions
+ */
+export interface ToolMessageOptions extends ProviderOptions {
+}
+/**
+ * Schema for validation and encoding of tool messages.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const ToolMessage: Schema.Schema<ToolMessage, ToolMessageEncoded>;
+/**
+ * A type representing all possible message types in a conversation.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type Message = SystemMessage | UserMessage | AssistantMessage | ToolMessage;
+/**
+ * A type representing all possible encoded message types for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type MessageEncoded = SystemMessageEncoded | UserMessageEncoded | AssistantMessageEncoded | ToolMessageEncoded;
+/**
+ * Schema for validation and encoding of messages.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const Message: Schema.Schema<Message, MessageEncoded>;
+/**
+ * Unique identifier for Prompt instances.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export declare const TypeId = "~@effect/ai/Prompt";
+/**
+ * Type-level representation of the Prompt identifier.
+ *
+ * @since 1.0.0
+ * @category Type Ids
+ */
+export type TypeId = typeof TypeId;
+/**
+ * Type guard to check if a value is a Prompt.
+ *
+ * @since 1.0.0
+ * @category Guards
+ */
+export declare const isPrompt: (u: unknown) => u is Prompt;
+/**
+ * A Prompt contains a sequence of messages that form the context of a
+ * conversation with a large language model.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface Prompt {
+    readonly [TypeId]: TypeId;
+    /**
+     * Array of messages that make up the conversation.
+     */
+    readonly content: ReadonlyArray<Message>;
+}
+/**
+ * Encoded representation of prompts for serialization.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface PromptEncoded {
+    /**
+     * Array of messages that make up the conversation.
+     */
+    readonly content: ReadonlyArray<MessageEncoded>;
+}
+/**
+ * Schema for validation and encoding of prompts.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const Prompt: Schema.Schema<Prompt, PromptEncoded>;
+/**
+ * Schema for parsing a Prompt from JSON strings.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const FromJson: Schema.transform<Schema.SchemaClass<unknown, string, never>, Schema.Schema<Prompt, PromptEncoded, never>>;
+/**
+ * Raw input types that can be converted into a Prompt.
+ *
+ * Supports various input formats for convenience, including simple strings,
+ * message arrays, response parts, and existing prompts.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * // String input - creates a user message
+ * const stringInput: Prompt.RawInput = "Hello, world!"
+ *
+ * // Message array input
+ * const messagesInput: Prompt.RawInput = [
+ *   { role: "system", content: "You are helpful." },
+ *   { role: "user", content: [{ type: "text", text: "Hi!" }] }
+ * ]
+ *
+ * // Existing prompt
+ * declare const existingPrompt: Prompt.Prompt
+ * const promptInput: Prompt.RawInput = existingPrompt
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type RawInput = string | Iterable<MessageEncoded> | Prompt;
+/**
+ * An empty prompt with no messages.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const emptyPrompt = Prompt.empty
+ * console.log(emptyPrompt.content) // []
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const empty: Prompt;
+/**
+ * Creates a Prompt from an input.
+ *
+ * This is the primary constructor for creating prompts, supporting multiple
+ * input formats for convenience and flexibility.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * // From string - creates a user message
+ * const textPrompt = Prompt.make("Hello, how are you?")
+ *
+ * // From messages array
+ * const structuredPrompt = Prompt.make([
+ *   { role: "system", content: "You are a helpful assistant." },
+ *   { role: "user", content: [{ type: "text", text: "Hi!" }] }
+ * ])
+ *
+ * // From existing prompt
+ * declare const existingPrompt: Prompt.Prompt
+ * const copiedPrompt = Prompt.make(existingPrompt)
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const make: (input: RawInput) => Prompt;
+/**
+ * Creates a Prompt from an array of messages.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const messages: ReadonlyArray<Prompt.Message> = [
+ *   Prompt.makeMessage("system", {
+ *     content: "You are a coding assistant."
+ *   }),
+ *   Prompt.makeMessage("user", {
+ *     content: [Prompt.makePart("text", { text: "Help me with TypeScript" })]
+ *   })
+ * ]
+ *
+ * const prompt = Prompt.fromMessages(messages)
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const fromMessages: (messages: ReadonlyArray<Message>) => Prompt;
+/**
+ * Creates a Prompt from the response parts of a previous interaction with a
+ * large language model.
+ *
+ * Converts streaming or non-streaming AI response parts into a structured
+ * prompt, typically for use in conversation history or further processing.
+ *
+ * @example
+ * ```ts
+ * import { Prompt, Response } from "@effect/ai"
+ *
+ * const responseParts: ReadonlyArray<Response.AnyPart> = [
+ *   Response.makePart("text", {
+ *     text: "Hello there!"
+ *   }),
+ *   Response.makePart("tool-call", {
+ *     id: "call_1",
+ *     name: "get_time",
+ *     params: {},
+ *     providerExecuted: false
+ *   }),
+ *   Response.makePart("tool-result", {
+ *     id: "call_1",
+ *     name: "get_time",
+ *     result: "10:30 AM",
+ *     encodedResult: "10:30 AM",
+ *     providerExecuted: false
+ *   })
+ * ]
+ *
+ * const prompt = Prompt.fromResponseParts(responseParts)
+ * // Creates an assistant message with the response content
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const fromResponseParts: (parts: ReadonlyArray<Response.AnyPart>) => Prompt;
+/**
+ * Merges two prompts by concatenating their messages.
+ *
+ * Creates a new prompt containing all messages from both prompts, maintaining
+ * the order of messages within each prompt.
+ *
+ * @example
+ * ```ts
+ * import { Prompt } from "@effect/ai"
+ *
+ * const systemPrompt = Prompt.make([{
+ *   role: "system",
+ *   content: "You are a helpful assistant."
+ * }])
+ *
+ * const userPrompt = Prompt.make("Hello, world!")
+ *
+ * const merged = Prompt.merge(systemPrompt, userPrompt)
+ * ```
+ *
+ * @since 1.0.0
+ * @category Combinators
+ */
+export declare const merge: {
+    /**
+     * Merges two prompts by concatenating their messages.
+     *
+     * Creates a new prompt containing all messages from both prompts, maintaining
+     * the order of messages within each prompt.
+     *
+     * @example
+     * ```ts
+     * import { Prompt } from "@effect/ai"
+     *
+     * const systemPrompt = Prompt.make([{
+     *   role: "system",
+     *   content: "You are a helpful assistant."
+     * }])
+     *
+     * const userPrompt = Prompt.make("Hello, world!")
+     *
+     * const merged = Prompt.merge(systemPrompt, userPrompt)
+     * ```
+     *
+     * @since 1.0.0
+     * @category Combinators
+     */
+    (other: Prompt): (self: Prompt) => Prompt;
+    /**
+     * Merges two prompts by concatenating their messages.
+     *
+     * Creates a new prompt containing all messages from both prompts, maintaining
+     * the order of messages within each prompt.
+     *
+     * @example
+     * ```ts
+     * import { Prompt } from "@effect/ai"
+     *
+     * const systemPrompt = Prompt.make([{
+     *   role: "system",
+     *   content: "You are a helpful assistant."
+     * }])
+     *
+     * const userPrompt = Prompt.make("Hello, world!")
+     *
+     * const merged = Prompt.merge(systemPrompt, userPrompt)
+     * ```
+     *
+     * @since 1.0.0
+     * @category Combinators
+     */
+    (self: Prompt, other: Prompt): Prompt;
+};
+//# sourceMappingURL=Prompt.d.ts.map