feat: better openai types

Author: ericc-ch

src/services/copilot/create-chat-completions.ts

@@ -9,14 +9,10 @@ export const createChatCompletions = async (
 ) => {
   if (!state.copilotToken) throw new Error("Copilot token not found")
 
-  for (const message of payload.messages) {
-    intoCopilotMessage(message)
-  }
-
   const visionEnable = payload.messages.some(
     (x) =>
       typeof x.content !== "string"
-      && x.content.some((x) => x.type === "image_url"),
+      && x.content?.some((x) => x.type === "image_url"),
   )
 
   const response = await fetch(`${copilotBaseUrl(state)}/chat/completions`, {
@@ -35,77 +31,126 @@ export const createChatCompletions = async (
   return (await response.json()) as ChatCompletionResponse
 }
 
-const intoCopilotMessage = (message: Message) => {
-  if (typeof message.content === "string") return false
-
-  for (const part of message.content) {
-    if (part.type === "input_image") part.type = "image_url"
-  }
-}
-
 // Streaming types
 
 export interface ChatCompletionChunk {
-  choices: [Choice]
-  created: number
-  object: "chat.completion.chunk"
   id: string
+  object: "chat.completion.chunk"
+  created: number
   model: string
+  choices: [Choice]
+  system_fingerprint?: string
 }
 
 interface Delta {
-  content?: string
-  role?: string
+  content?: string | null
+  role?: "user" | "assistant" | "system" | "tool"
+  tool_calls?: Array<{
+    index: number
+    id?: string
+    type?: "function"
+    function?: {
+      name?: string
+      arguments?: string
+    }
+  }>
 }
 
 interface Choice {
   index: number
   delta: Delta
-  finish_reason: "stop" | null
+  finish_reason: "stop" | "length" | "tool_calls" | "content_filter" | null
   logprobs: null
 }
 
 // Non-streaming types
 
 export interface ChatCompletionResponse {
   id: string
-  object: string
+  object: "chat.completion"
   created: number
   model: string
   choices: [ChoiceNonStreaming]
+  system_fingerprint?: string
+  usage?: {
+    prompt_tokens: number
+    completion_tokens: number
+    total_tokens: number
+  }
 }
 
 interface ChoiceNonStreaming {
   index: number
   message: Message
   logprobs: null
-  finish_reason: "stop"
+  finish_reason: "stop" | "length" | "tool_calls" | "content_filter"
 }
 
 // Payload types
 
 export interface ChatCompletionsPayload {
   messages: Array<Message>
   model: string
-  temperature?: number
-  top_p?: number
-  max_tokens?: number
-  stop?: Array<string>
-  n?: number
-  stream?: boolean
+  temperature?: number | null
+  top_p?: number | null
+  max_tokens?: number | null
+  stop?: string | Array<string> | null
+  n?: number | null
+  stream?: boolean | null
+
+  frequency_penalty?: number | null
+  presence_penalty?: number | null
+  logit_bias?: Record<string, number> | null
+  logprobs?: boolean | null
+  response_format?: { type: "json_object" } | null
+  seed?: number | null
+  tools?: Array<Tool> | null
+  tool_choice?:
+    | "none"
+    | "auto"
+    | { type: "function"; function: { name: string } }
+    | null
+  user?: string | null
+}
+
+export interface Tool {
+  type: "function"
+  function: {
+    name: string
+    description?: string
+    parameters: Record<string, unknown>
+  }
 }
 
 export interface Message {
-  role: "user" | "assistant" | "system"
-  content: string | Array<ContentPart>
+  role: "user" | "assistant" | "system" | "tool"
+  content: string | Array<ContentPart> | null
+
+  name?: string
+  tool_calls?: Array<ToolCall>
+  tool_call_id?: string
+}
+
+export interface ToolCall {
+  id: string
+  type: "function"
+  function: {
+    name: string
+    arguments: string
+  }
 }
 
-// https://platform.openai.com/docs/api-reference
+export type ContentPart = TextPart | ImagePart
 
-export interface ContentPart {
-  type: "input_image" | "input_text" | "image_url"
-  text?: string
-  image_url?: string
+export interface TextPart {
+  type: "text"
+  text: string
+}
+
+export interface ImagePart {
+  type: "image_url"
+  image_url: {
+    url: string
+    detail?: "low" | "high" | "auto"
+  }
 }
-// https://platform.openai.com/docs/guides/images-vision#giving-a-model-images-as-input
-// Note: copilot use "image_url", but openai use "input_image"