hyperparam-cli/bin/types.d.ts at c9b94a0aeb809c875e227933b98ca978824823c2 · hyparam/hyperparam-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Model Input
export interface ChatInput {
  model: string
  instructions?: string // system prompt
  messages: Message[][]
  tools?: ResponseTool[]
  reasoning?: {
    effort?: 'minimal' | 'low' | 'medium' | 'high'
    summary?: 'auto' | 'concise' | 'detailed'
  }
  parallel_tool_calls?: boolean
}

export type Message =
  | EasyInputMessage
  | ResponseFunctionToolCall
  | FunctionCallOutput
  | ReasoningItem
  | WebSearchItem

// Input message types
interface EasyInputMessage {
  type?: 'message'
  content: string
  role: 'user' | 'assistant' | 'system' | 'developer'
  id?: string // msg_123
}
interface ResponseFunctionToolCall {
  type: 'function_call'
  arguments: string
  call_id: string
  name: string
  id?: string
}

export interface FunctionCallOutput {
  type: 'function_call_output'
  call_id: string // call_123
  output: string
}

export interface ReasoningItem {
  type: 'reasoning'
  summary: {
    type: 'summary_text'
    text: string
  }[]
  id: string
}

export interface WebSearchItem {
  type: 'web_search_call'
  id: string // ws_123
  status: 'in_progress' | 'completed' | 'failed'
  action?: {
    type: 'search'
  }
}

// Tool Handlers
export interface ToolHandler {
  emoji: string
  tool: ResponseFunction // TODO: change to ResponseTool if web search is needed
  handleToolCall(args: Record<string, unknown>): Promise<string>
}
// Tool Description
type ResponseTool =
  | ResponseFunction
  | WebSearchTool

interface ResponseFunction {
  type: 'function'
  name: string
  description: string
  parameters?: ToolParameters
  strict?: boolean
}

export interface WebSearchTool {
  type: 'web_search'
  search_context_size?: 'low' | 'medium' | 'high'
  user_location?: object
}

// Types of tool parameters
export interface ToolParameters {
  type: 'object'
  properties: Record<string, ToolProperty>
  required?: string[]
  additionalProperties?: boolean
}
interface BaseToolProperty {
  description?: string
}
interface StringToolProperty extends BaseToolProperty {
  type: 'string'
  enum?: string[]
}
interface NumberToolProperty extends BaseToolProperty {
  type: 'number'
}
interface BooleanToolProperty extends BaseToolProperty {
  type: 'boolean'
}
interface ArrayToolProperty extends BaseToolProperty {
  type: 'array'
  items: ToolProperty
}
export type ToolProperty = StringToolProperty | NumberToolProperty | ArrayToolProperty | BooleanToolProperty