d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
538 lines
14 KiB
TypeScript
538 lines
14 KiB
TypeScript
import { createLogger } from '@sim/logger'
|
|
import type OpenAI from 'openai'
|
|
import { buildOpenAIMessageContent } from '@/providers/attachments'
|
|
import type { Message } from '@/providers/types'
|
|
|
|
const logger = createLogger('ResponsesUtils')
|
|
|
|
export interface ResponsesUsageTokens {
|
|
promptTokens: number
|
|
completionTokens: number
|
|
totalTokens: number
|
|
cachedTokens: number
|
|
reasoningTokens: number
|
|
}
|
|
|
|
export interface ResponsesToolCall {
|
|
id: string
|
|
name: string
|
|
arguments: string
|
|
}
|
|
|
|
export type ResponsesInputItem =
|
|
| {
|
|
role: 'system' | 'user' | 'assistant'
|
|
content: string | OpenAI.Responses.ResponseInputContent[]
|
|
}
|
|
| {
|
|
type: 'function_call'
|
|
call_id: string
|
|
name: string
|
|
arguments: string
|
|
}
|
|
| {
|
|
type: 'function_call_output'
|
|
call_id: string
|
|
output: string
|
|
}
|
|
|
|
export interface ResponsesToolDefinition {
|
|
type: 'function'
|
|
name: string
|
|
description?: string
|
|
parameters?: Record<string, unknown>
|
|
}
|
|
|
|
/**
|
|
* Converts chat-style messages into Responses API input items.
|
|
*/
|
|
export function buildResponsesInputFromMessages(
|
|
messages: Message[],
|
|
providerId = 'openai'
|
|
): ResponsesInputItem[] {
|
|
const input: ResponsesInputItem[] = []
|
|
|
|
for (const message of messages) {
|
|
if (message.role === 'tool' && message.tool_call_id) {
|
|
input.push({
|
|
type: 'function_call_output',
|
|
call_id: message.tool_call_id,
|
|
output: message.content ?? '',
|
|
})
|
|
continue
|
|
}
|
|
|
|
if (message.role === 'system' || message.role === 'user' || message.role === 'assistant') {
|
|
const content =
|
|
message.role === 'user'
|
|
? buildOpenAIMessageContent(message.content, message.files, providerId)
|
|
: (message.content ?? '')
|
|
if (
|
|
(typeof content === 'string' && !content) ||
|
|
(Array.isArray(content) && content.length === 0)
|
|
) {
|
|
continue
|
|
}
|
|
|
|
input.push({
|
|
role: message.role,
|
|
content,
|
|
})
|
|
}
|
|
|
|
if (message.tool_calls?.length) {
|
|
for (const toolCall of message.tool_calls) {
|
|
input.push({
|
|
type: 'function_call',
|
|
call_id: toolCall.id,
|
|
name: toolCall.function.name,
|
|
arguments: toolCall.function.arguments,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
return input
|
|
}
|
|
|
|
/**
|
|
* Converts tool definitions to the Responses API format.
|
|
*/
|
|
export function convertToolsToResponses(
|
|
tools: Array<{
|
|
type?: string
|
|
name?: string
|
|
description?: string
|
|
parameters?: Record<string, unknown>
|
|
function?: { name: string; description?: string; parameters?: Record<string, unknown> }
|
|
}>
|
|
): ResponsesToolDefinition[] {
|
|
return tools
|
|
.map((tool) => {
|
|
const name = tool.function?.name ?? tool.name
|
|
if (!name) {
|
|
return null
|
|
}
|
|
|
|
return {
|
|
type: 'function' as const,
|
|
name,
|
|
description: tool.function?.description ?? tool.description,
|
|
parameters: tool.function?.parameters ?? tool.parameters,
|
|
}
|
|
})
|
|
.filter(Boolean) as ResponsesToolDefinition[]
|
|
}
|
|
|
|
/**
|
|
* Converts tool_choice to the Responses API format.
|
|
*/
|
|
export function toResponsesToolChoice(
|
|
toolChoice:
|
|
| 'auto'
|
|
| 'none'
|
|
| { type: 'function'; function?: { name: string }; name?: string }
|
|
| { type: 'tool'; name: string }
|
|
| { type: 'any'; any: { model: string; name: string } }
|
|
| undefined
|
|
): 'auto' | 'none' | { type: 'function'; name: string } | undefined {
|
|
if (!toolChoice) {
|
|
return undefined
|
|
}
|
|
|
|
if (typeof toolChoice === 'string') {
|
|
return toolChoice
|
|
}
|
|
|
|
if (toolChoice.type === 'function') {
|
|
const name = toolChoice.name ?? toolChoice.function?.name
|
|
return name ? { type: 'function', name } : undefined
|
|
}
|
|
|
|
return 'auto'
|
|
}
|
|
|
|
function isRecord(value: unknown): value is Record<string, unknown> {
|
|
return typeof value === 'object' && value !== null
|
|
}
|
|
|
|
function extractTextFromMessageItem(item: unknown): string {
|
|
if (!isRecord(item)) {
|
|
return ''
|
|
}
|
|
|
|
if (typeof item.content === 'string') {
|
|
return item.content
|
|
}
|
|
|
|
if (!Array.isArray(item.content)) {
|
|
return ''
|
|
}
|
|
|
|
const textParts: string[] = []
|
|
for (const part of item.content) {
|
|
if (!isRecord(part)) {
|
|
continue
|
|
}
|
|
|
|
if ((part.type === 'output_text' || part.type === 'text') && typeof part.text === 'string') {
|
|
textParts.push(part.text)
|
|
continue
|
|
}
|
|
|
|
if (part.type === 'output_json') {
|
|
if (typeof part.text === 'string') {
|
|
textParts.push(part.text)
|
|
} else if (part.json !== undefined) {
|
|
textParts.push(JSON.stringify(part.json))
|
|
}
|
|
}
|
|
}
|
|
|
|
return textParts.join('')
|
|
}
|
|
|
|
/**
|
|
* Extracts plain text from Responses API output items.
|
|
*/
|
|
export function extractResponseText(output: OpenAI.Responses.ResponseOutputItem[]): string {
|
|
if (!Array.isArray(output)) {
|
|
return ''
|
|
}
|
|
|
|
const textParts: string[] = []
|
|
for (const item of output) {
|
|
if (item?.type !== 'message') {
|
|
continue
|
|
}
|
|
|
|
const text = extractTextFromMessageItem(item)
|
|
if (text) {
|
|
textParts.push(text)
|
|
}
|
|
}
|
|
|
|
return textParts.join('')
|
|
}
|
|
|
|
/**
|
|
* Extracts reasoning summary text from Responses API output items. Reasoning
|
|
* items (emitted by o1/o3/gpt-5) carry a `summary[]` of `{ type, text }` entries
|
|
* — we join the text for trace display. The raw `encrypted_content` is left
|
|
* alone; it's opaque plumbing for round-tripping across turns.
|
|
*/
|
|
export function extractResponseReasoning(output: OpenAI.Responses.ResponseOutputItem[]): string {
|
|
if (!Array.isArray(output)) return ''
|
|
|
|
const parts: string[] = []
|
|
for (const item of output) {
|
|
if (!item || item.type !== 'reasoning') continue
|
|
const summary = (item as unknown as { summary?: Array<{ text?: string | null } | null> })
|
|
.summary
|
|
if (!Array.isArray(summary)) continue
|
|
for (const entry of summary) {
|
|
const text = entry?.text
|
|
if (typeof text === 'string' && text.length > 0) parts.push(text)
|
|
}
|
|
}
|
|
return parts.join('\n\n')
|
|
}
|
|
|
|
/**
|
|
* Converts Responses API output items into input items for subsequent calls.
|
|
*/
|
|
export function convertResponseOutputToInputItems(
|
|
output: OpenAI.Responses.ResponseOutputItem[]
|
|
): ResponsesInputItem[] {
|
|
if (!Array.isArray(output)) {
|
|
return []
|
|
}
|
|
|
|
const items: ResponsesInputItem[] = []
|
|
for (const item of output) {
|
|
if (!isRecord(item)) {
|
|
continue
|
|
}
|
|
|
|
if (item.type === 'message') {
|
|
const text = extractTextFromMessageItem(item)
|
|
if (text) {
|
|
items.push({
|
|
role: 'assistant',
|
|
content: text,
|
|
})
|
|
}
|
|
|
|
// Handle Chat Completions-style tool_calls nested under message items
|
|
const toolCalls = Array.isArray(item.tool_calls) ? item.tool_calls : []
|
|
for (const toolCall of toolCalls) {
|
|
const tc = toolCall as Record<string, unknown>
|
|
const fn = tc.function as Record<string, unknown> | undefined
|
|
const callId = tc.id as string | undefined
|
|
const name = (fn?.name ?? tc.name) as string | undefined
|
|
if (!callId || !name) {
|
|
continue
|
|
}
|
|
|
|
const argumentsValue =
|
|
typeof fn?.arguments === 'string' ? fn.arguments : JSON.stringify(fn?.arguments ?? {})
|
|
|
|
items.push({
|
|
type: 'function_call',
|
|
call_id: callId,
|
|
name,
|
|
arguments: argumentsValue,
|
|
})
|
|
}
|
|
|
|
continue
|
|
}
|
|
|
|
if (item.type === 'function_call') {
|
|
const fc = item as OpenAI.Responses.ResponseFunctionToolCall
|
|
const callId = fc.call_id ?? (typeof item.id === 'string' ? item.id : undefined)
|
|
const name =
|
|
fc.name ??
|
|
(isRecord(item.function) && typeof item.function.name === 'string'
|
|
? item.function.name
|
|
: undefined)
|
|
if (!callId || !name) {
|
|
continue
|
|
}
|
|
|
|
const argumentsValue =
|
|
typeof fc.arguments === 'string' ? fc.arguments : JSON.stringify(fc.arguments ?? {})
|
|
|
|
items.push({
|
|
type: 'function_call',
|
|
call_id: callId,
|
|
name,
|
|
arguments: argumentsValue,
|
|
})
|
|
}
|
|
}
|
|
|
|
return items
|
|
}
|
|
|
|
/**
|
|
* Extracts tool calls from Responses API output items.
|
|
*/
|
|
export function extractResponseToolCalls(
|
|
output: OpenAI.Responses.ResponseOutputItem[]
|
|
): ResponsesToolCall[] {
|
|
if (!Array.isArray(output)) {
|
|
return []
|
|
}
|
|
|
|
const toolCalls: ResponsesToolCall[] = []
|
|
|
|
for (const item of output) {
|
|
if (!isRecord(item)) {
|
|
continue
|
|
}
|
|
|
|
if (item.type === 'function_call') {
|
|
const fc = item as OpenAI.Responses.ResponseFunctionToolCall
|
|
const callId = fc.call_id ?? (typeof item.id === 'string' ? item.id : undefined)
|
|
const name =
|
|
fc.name ??
|
|
(isRecord(item.function) && typeof item.function.name === 'string'
|
|
? item.function.name
|
|
: undefined)
|
|
if (!callId || !name) {
|
|
continue
|
|
}
|
|
|
|
const argumentsValue =
|
|
typeof fc.arguments === 'string' ? fc.arguments : JSON.stringify(fc.arguments ?? {})
|
|
|
|
toolCalls.push({
|
|
id: callId,
|
|
name,
|
|
arguments: argumentsValue,
|
|
})
|
|
continue
|
|
}
|
|
|
|
// Handle Chat Completions-style tool_calls nested under message items
|
|
if (item.type === 'message' && Array.isArray(item.tool_calls)) {
|
|
for (const toolCall of item.tool_calls) {
|
|
const tc = toolCall as Record<string, unknown>
|
|
const fn = tc.function as Record<string, unknown> | undefined
|
|
const callId = tc.id as string | undefined
|
|
const name = (fn?.name ?? tc.name) as string | undefined
|
|
if (!callId || !name) {
|
|
continue
|
|
}
|
|
|
|
const argumentsValue =
|
|
typeof fn?.arguments === 'string' ? fn.arguments : JSON.stringify(fn?.arguments ?? {})
|
|
|
|
toolCalls.push({
|
|
id: callId,
|
|
name,
|
|
arguments: argumentsValue,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
return toolCalls
|
|
}
|
|
|
|
/**
|
|
* Maps Responses API usage data to prompt/completion token counts.
|
|
*
|
|
* Note: output_tokens is expected to include reasoning tokens; fall back to reasoning_tokens
|
|
* when output_tokens is missing or zero.
|
|
*/
|
|
export function parseResponsesUsage(
|
|
usage: OpenAI.Responses.ResponseUsage | undefined
|
|
): ResponsesUsageTokens | undefined {
|
|
if (!usage) {
|
|
return undefined
|
|
}
|
|
|
|
const inputTokens = usage.input_tokens ?? 0
|
|
const outputTokens = usage.output_tokens ?? 0
|
|
const cachedTokens = usage.input_tokens_details?.cached_tokens ?? 0
|
|
const reasoningTokens = usage.output_tokens_details?.reasoning_tokens ?? 0
|
|
const completionTokens = Math.max(outputTokens, reasoningTokens)
|
|
const totalTokens = inputTokens + completionTokens
|
|
|
|
return {
|
|
promptTokens: inputTokens,
|
|
completionTokens,
|
|
totalTokens,
|
|
cachedTokens,
|
|
reasoningTokens,
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a ReadableStream from a Responses API SSE stream.
|
|
*/
|
|
export function createReadableStreamFromResponses(
|
|
response: Response,
|
|
onComplete?: (content: string, usage?: ResponsesUsageTokens) => void
|
|
): ReadableStream<Uint8Array> {
|
|
let fullContent = ''
|
|
let finalUsage: ResponsesUsageTokens | undefined
|
|
let activeEventType: string | undefined
|
|
const encoder = new TextEncoder()
|
|
|
|
return new ReadableStream<Uint8Array>({
|
|
async start(controller) {
|
|
const reader = response.body?.getReader()
|
|
if (!reader) {
|
|
controller.close()
|
|
return
|
|
}
|
|
|
|
const decoder = new TextDecoder()
|
|
let buffer = ''
|
|
|
|
try {
|
|
while (true) {
|
|
const { done, value } = await reader.read()
|
|
if (done) {
|
|
break
|
|
}
|
|
|
|
buffer += decoder.decode(value, { stream: true })
|
|
const lines = buffer.split('\n')
|
|
buffer = lines.pop() || ''
|
|
|
|
for (const line of lines) {
|
|
const trimmed = line.trim()
|
|
if (!trimmed) {
|
|
continue
|
|
}
|
|
|
|
if (trimmed.startsWith('event:')) {
|
|
activeEventType = trimmed.slice(6).trim()
|
|
continue
|
|
}
|
|
|
|
if (!trimmed.startsWith('data:')) {
|
|
continue
|
|
}
|
|
|
|
const data = trimmed.slice(5).trim()
|
|
if (data === '[DONE]') {
|
|
continue
|
|
}
|
|
|
|
let event: Record<string, unknown>
|
|
try {
|
|
event = JSON.parse(data)
|
|
} catch (error) {
|
|
logger.debug('Skipping non-JSON response stream chunk', {
|
|
data: data.slice(0, 200),
|
|
error,
|
|
})
|
|
continue
|
|
}
|
|
|
|
const eventType = event?.type ?? activeEventType
|
|
|
|
if (
|
|
eventType === 'response.error' ||
|
|
eventType === 'error' ||
|
|
eventType === 'response.failed'
|
|
) {
|
|
const errorObj = event.error as Record<string, unknown> | undefined
|
|
const message = (errorObj?.message as string) || 'Responses API stream error'
|
|
controller.error(new Error(message))
|
|
return
|
|
}
|
|
|
|
if (
|
|
eventType === 'response.output_text.delta' ||
|
|
eventType === 'response.output_json.delta'
|
|
) {
|
|
let deltaText = ''
|
|
const delta = event.delta as string | Record<string, unknown> | undefined
|
|
if (typeof delta === 'string') {
|
|
deltaText = delta
|
|
} else if (delta && typeof delta.text === 'string') {
|
|
deltaText = delta.text
|
|
} else if (delta && delta.json !== undefined) {
|
|
deltaText = JSON.stringify(delta.json)
|
|
} else if (event.json !== undefined) {
|
|
deltaText = JSON.stringify(event.json)
|
|
} else if (typeof event.text === 'string') {
|
|
deltaText = event.text
|
|
}
|
|
|
|
if (deltaText.length > 0) {
|
|
fullContent += deltaText
|
|
controller.enqueue(encoder.encode(deltaText))
|
|
}
|
|
}
|
|
|
|
if (eventType === 'response.completed') {
|
|
const responseObj = event.response as Record<string, unknown> | undefined
|
|
const usageData = (responseObj?.usage ?? event.usage) as
|
|
| OpenAI.Responses.ResponseUsage
|
|
| undefined
|
|
finalUsage = parseResponsesUsage(usageData)
|
|
}
|
|
}
|
|
}
|
|
|
|
if (onComplete) {
|
|
onComplete(fullContent, finalUsage)
|
|
}
|
|
|
|
controller.close()
|
|
} catch (error) {
|
|
controller.error(error)
|
|
} finally {
|
|
reader.releaseLock()
|
|
}
|
|
},
|
|
})
|
|
}
|