@arizeai/phoenix-client/src/schemas/llm/openai/messageSchemas.ts

A client for the Phoenix API

import {
  openaiChatPartImageSchema,
  openaiChatPartTextSchema,
} from "./messagePartSchemas";
import { openAIToolCallSchema } from "./toolCallSchemas";

import z from "zod";

/*
 *
 * OpenAI Message Schemas
 *
 */

export const openAIMessageRoleSchema = z.enum([
  "system",
  "user",
  "assistant",
  "developer",
  "tool",
  // "function",
]);

export type OpenAIMessageRole = z.infer<typeof openAIMessageRoleSchema>;

export const openAIMessageSchema = z.discriminatedUnion("role", [
  z
    .object({
      role: z.literal("assistant"),
      content: z.union([openaiChatPartTextSchema.array(), z.string()]),
      name: z.string().optional(),
      tool_call_id: z.string().optional(),
      tool_calls: z.array(openAIToolCallSchema).optional(),
    })
    .passthrough(),
  z
    .object({
      role: z.literal("tool"),
      content: z.union([openaiChatPartTextSchema.array(), z.string()]),
      tool_call_id: z.string(),
    })
    .passthrough(),
  z
    .object({
      role: z.literal("function"),
      content: z.string().nullable(),
      name: z.string(),
    })
    .passthrough(),
  z
    .object({
      role: z.literal("user"),
      content: z.union([
        z.array(z.union([openaiChatPartTextSchema, openaiChatPartImageSchema])),
        z.string(),
      ]),
      name: z.string().optional(),
    })
    .passthrough(),
  z
    .object({
      role: z.literal("system"),
      content: z.union([openaiChatPartTextSchema.array(), z.string()]),
      name: z.string().optional(),
    })
    .passthrough(),
  z
    .object({
      role: z.literal("developer"),
      content: z.union([openaiChatPartTextSchema.array(), z.string()]),
      name: z.string().optional(),
    })
    .passthrough(),
]);

export type OpenAIMessage = z.infer<typeof openAIMessageSchema>;

export const openAIMessagesSchema = z.array(openAIMessageSchema);