refactor: reorganize chat job types and introduce ChatTool class

Author: wangzuo

src/jobs/chat/job.ts

@@ -1,11 +1,13 @@
 import { z, ZodSchema } from "zod";
-import zodToJsonSchema from "zod-to-json-schema";
 import { Job } from "../job";
 import type {
   ChatJobSchemaType,
   ChatJobParams,
   ChatResultSchema,
+  ChatStreamOptions,
+  ResponseFormat,
 } from "./schema";
+import { ChatTool } from "./tool";
 
 export function systemPrompt(content: string) {
   return { role: "system", content };
@@ -64,81 +66,6 @@ export function tool(name: string) {
   return new ChatTool(name);
 }
 
-export class ChatTool {
-  public params: {
-    name: string;
-    description?: string;
-    parameters?: ZodSchema;
-  };
-
-  constructor(name: string) {
-    this.params = { name };
-  }
-
-  description(description: string) {
-    this.params.description = description;
-    return this;
-  }
-
-  parameters(parameters: ZodSchema) {
-    this.params.parameters = parameters;
-    return this;
-  }
-
-  toJSON() {
-    return {
-      type: "function",
-      function: {
-        name: this.params.name,
-        description: this.params.description,
-        parameters: zodToJsonSchema(this.params.parameters!),
-      },
-    };
-  }
-}
-
-export interface ChatUsage {
-  input_tokens: number;
-  output_tokens: number;
-}
-
-export interface ChatTextResponse {
-  usage?: ChatUsage;
-  text?: string;
-}
-
-export interface ChatObjectResponse {
-  usage?: ChatUsage;
-  object?: any;
-}
-
-export interface StreamOptions {
-  includeUsage?: boolean;
-}
-
-export interface ResponseFormat {
-  type: "json_object" | "json_schema";
-  json_schema?: ZodSchema;
-}
-
-export type MessageContent =
-  | string
-  | { text: string; type: "text" }[]
-  | {
-      type: "image";
-      image_url?: string;
-      source?: {
-        type: "base64";
-        data: string;
-        media_type: "image/jpeg" | "image/png" | "image/webp" | "image/gif";
-      };
-    }[];
-
-export interface Message {
-  role: "system" | "user" | "assistant";
-  content: MessageContent;
-}
-
 export class ChatJob<T extends ChatJobSchemaType> extends Job<T> {
   model: string;
   params: ChatJobParams;
@@ -218,7 +145,7 @@ export class ChatJob<T extends ChatJobSchemaType> extends Job<T> {
     return this;
   }
 
-  stream(streamOptions?: StreamOptions) {
+  stream(streamOptions?: ChatStreamOptions) {
     this.params.stream = true;
     if (streamOptions) {
       this.params.streamOptions = streamOptions;

src/jobs/chat/schema.ts

@@ -34,15 +34,21 @@ export const MessageSchema = z.object({
   content: MessageContentSchema,
 });
 
-export const StreamOptionsSchema = z.object({
+export type Message = z.infer<typeof MessageContentSchema>;
+
+export const ChatStreamOptionsSchema = z.object({
   includeUsage: z.boolean().optional(),
 });
 
+export type ChatStreamOptions = z.infer<typeof ChatStreamOptionsSchema>;
+
 export const ResponseFormatSchema = z.object({
   type: z.enum(["json_object", "json_schema"]),
   json_schema: z.any().optional(),
 });
 
+export type ResponseFormat = z.infer<typeof ResponseFormatSchema>;
+
 export const ChatToolSchema = z.object({
   params: z.object({
     name: z.string(),
@@ -61,7 +67,7 @@ export const JsonSchemaDefSchema = z.object({
 export const ChatJobParamsSchema = z.object({
   temperature: z.number().optional(),
   stream: z.boolean().optional(),
-  streamOptions: StreamOptionsSchema.optional(),
+  streamOptions: ChatStreamOptionsSchema.optional(),
   maxTokens: z.number().optional(),
   messages: z.array(MessageSchema),
   tools: z.array(ChatToolSchema).optional(),

src/jobs/chat/tool.ts

@@ -0,0 +1,35 @@
+import { ZodSchema } from "zod";
+import zodToJsonSchema from "zod-to-json-schema";
+
+export class ChatTool {
+  public params: {
+    name: string;
+    description?: string;
+    parameters?: ZodSchema;
+  };
+
+  constructor(name: string) {
+    this.params = { name };
+  }
+
+  description(description: string) {
+    this.params.description = description;
+    return this;
+  }
+
+  parameters(parameters: ZodSchema) {
+    this.params.parameters = parameters;
+    return this;
+  }
+
+  toJSON() {
+    return {
+      type: "function",
+      function: {
+        name: this.params.name,
+        description: this.params.description,
+        parameters: zodToJsonSchema(this.params.parameters!),
+      },
+    };
+  }
+}