Files
simstudioai--sim/apps/sim/executor/handlers/shared/response-format.ts
T
wehub-resource-sync 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
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

108 lines
3.2 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type { BlockOutput } from '@/blocks/types'
import { REFERENCE } from '@/executor/constants'
const logger = createLogger('SharedResponseFormat')
/**
* Parse a raw responseFormat value (string or object) into a usable schema.
*
* Handles:
* - Empty / falsy → undefined
* - Already an object → wraps bare schemas with `{ name, schema, strict }`
* - JSON string → parsed, then same wrapping logic
* - Unresolved block references (`<block.field>`) → undefined
*/
export function parseResponseFormat(responseFormat?: string | object): any {
if (!responseFormat || responseFormat === '') return undefined
if (typeof responseFormat === 'object' && responseFormat !== null) {
const formatObj = responseFormat as any
if (!formatObj.schema && !formatObj.name) {
return { name: 'response_schema', schema: responseFormat, strict: true }
}
return responseFormat
}
if (typeof responseFormat === 'string') {
const trimmed = responseFormat.trim()
if (!trimmed) return undefined
if (trimmed.startsWith(REFERENCE.START) && trimmed.includes(REFERENCE.END)) {
return undefined
}
try {
const parsed = JSON.parse(trimmed)
if (parsed && typeof parsed === 'object' && !parsed.schema && !parsed.name) {
return { name: 'response_schema', schema: parsed, strict: true }
}
return parsed
} catch (error: any) {
logger.warn('Failed to parse response format as JSON', {
error: error.message,
preview: trimmed.slice(0, 100),
})
return undefined
}
}
return undefined
}
/**
* Validate and extract messages from a raw input value.
*
* Accepts a JSON string or an array. Each entry must have
* `role` (string) and `content` (string).
*/
export function resolveMessages(raw: unknown): Array<{ role: string; content: string }> {
if (!raw) {
throw new Error('Messages input is required')
}
let messages: unknown[]
if (typeof raw === 'string') {
try {
messages = JSON.parse(raw)
} catch {
throw new Error('Messages must be a valid JSON array')
}
} else if (Array.isArray(raw)) {
messages = raw
} else {
throw new Error('Messages must be an array of {role, content} objects')
}
return messages.map((msg: any, i: number) => {
if (!msg.role || typeof msg.content !== 'string') {
throw new Error(`Message at index ${i} must have "role" (string) and "content" (string)`)
}
return { role: String(msg.role), content: msg.content }
})
}
/**
* Try to parse the LLM response content as structured JSON and spread
* the fields into the block output. Falls back to returning raw content.
*/
export function processStructuredResponse(
result: { content?: string; model?: string; tokens?: any },
defaultModel: string
): BlockOutput {
const content = result.content ?? ''
try {
const parsed = JSON.parse(content.trim())
return {
...parsed,
model: result.model || defaultModel,
tokens: result.tokens || {},
}
} catch {
logger.warn('Failed to parse structured response, returning raw content')
return {
content,
model: result.model || defaultModel,
tokens: result.tokens || {},
}
}
}