agents/dist/schedule.d.ts

A home for your AI agents

import { z } from "zod";

//#region src/schedule.d.ts
/**
 * Get the schedule prompt for a given event
 * @param event - The event to get the schedule prompt for
 * @returns The schedule prompt
 */
declare function getSchedulePrompt(event: { date: Date }): string;
/**
 * @deprecated this has been renamed to getSchedulePrompt, and unstable_getSchedulePrompt will be removed in the next major version
 * @param event - The event to get the schedule prompt for
 * @returns The schedule prompt
 */
declare function unstable_getSchedulePrompt(event: { date: Date }): string;
/**
 * The schema for parsing natural language scheduling requests.
 *
 * @example
 * ```typescript
 * import { generateObject } from "ai";
 * import { scheduleSchema, getSchedulePrompt } from "agents/schedule";
 *
 * const result = await generateObject({
 *   model,
 *   prompt: `${getSchedulePrompt({ date: new Date() })} Input: "${userInput}"`,
 *   schema: scheduleSchema,
 *   // Required for OpenAI to avoid strict JSON schema validation errors
 *   providerOptions: {
 *     openai: { strictJsonSchema: false }
 *   }
 * });
 * ```
 *
 * @remarks
 * When using this schema with OpenAI models via the AI SDK, you must pass
 * `providerOptions: { openai: { strictJsonSchema: false } }` to `generateObject`.
 * This is because the schema uses a discriminated union which is not compatible
 * with OpenAI's strict structured outputs mode.
 */
declare const scheduleSchema: z.ZodObject<
  {
    description: z.ZodString;
    when: z.ZodDiscriminatedUnion<
      [
        z.ZodObject<
          {
            type: z.ZodLiteral<"scheduled">;
            date: z.ZodString;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"delayed">;
            delayInSeconds: z.ZodNumber;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"cron">;
            cron: z.ZodString;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"no-schedule">;
          },
          z.core.$strip
        >
      ],
      "type"
    >;
  },
  z.core.$strip
>;
/**
 * The type for the schedule prompt
 */
type Schedule = z.infer<typeof scheduleSchema>;
/**
 * @deprecated this has been renamed to scheduleSchema, and unstable_scheduleSchema will be removed in the next major version
 * @returns The schedule schema
 */
declare const unstable_scheduleSchema: z.ZodObject<
  {
    description: z.ZodString;
    when: z.ZodDiscriminatedUnion<
      [
        z.ZodObject<
          {
            type: z.ZodLiteral<"scheduled">;
            date: z.ZodString;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"delayed">;
            delayInSeconds: z.ZodNumber;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"cron">;
            cron: z.ZodString;
          },
          z.core.$strip
        >,
        z.ZodObject<
          {
            type: z.ZodLiteral<"no-schedule">;
          },
          z.core.$strip
        >
      ],
      "type"
    >;
  },
  z.core.$strip
>;
//#endregion
export {
  Schedule,
  getSchedulePrompt,
  scheduleSchema,
  unstable_getSchedulePrompt,
  unstable_scheduleSchema
};
//# sourceMappingURL=schedule.d.ts.map