Files
simstudioai--sim/apps/sim/lib/api/contracts/providers.ts
T
wehub-resource-sync d25d482dc2
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
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

338 lines
9.1 KiB
TypeScript

import { z } from 'zod'
import { defineRouteContract } from '@/lib/api/contracts/types'
export const openRouterModelInfoSchema = z.object({
id: z.string(),
contextLength: z.number().optional(),
supportsStructuredOutputs: z.boolean().optional(),
supportsTools: z.boolean().optional(),
pricing: z
.object({
input: z.number(),
output: z.number(),
})
.optional(),
})
export const providerModelsResponseSchema = z.object({
models: z.array(z.string()),
modelInfo: z.record(z.string(), openRouterModelInfoSchema).optional(),
})
export type ProviderModelsResponse = z.output<typeof providerModelsResponseSchema>
export const fireworksProviderModelsQuerySchema = z.object({
workspaceId: z.string().min(1).optional(),
})
export const ollamaCloudProviderModelsQuerySchema = z.object({
workspaceId: z.string().min(1).optional(),
})
export const togetherProviderModelsQuerySchema = z.object({
workspaceId: z.string().min(1).optional(),
})
export const basetenProviderModelsQuerySchema = z.object({
workspaceId: z.string().min(1).optional(),
})
export const openRouterUpstreamResponseSchema = z.object({
data: z
.array(
z
.object({
id: z.string(),
context_length: z.number().optional(),
supported_parameters: z.array(z.string()).optional(),
pricing: z
.object({
prompt: z.string().optional(),
completion: z.string().optional(),
})
.passthrough()
.optional(),
})
.passthrough()
)
.default([]),
})
export const vllmUpstreamResponseSchema = z.object({
data: z
.array(
z
.object({
id: z.string(),
})
.passthrough()
)
.default([]),
})
export const fireworksUpstreamResponseSchema = z.object({
data: z
.array(
z
.object({
id: z.string(),
object: z.string().optional(),
created: z.number().optional(),
owned_by: z.string().optional(),
})
.passthrough()
)
.default([]),
object: z.string().optional(),
})
const togetherModelObjectSchema = z
.object({
id: z.string(),
object: z.string().optional(),
created: z.number().optional(),
type: z.string().optional(),
display_name: z.string().optional(),
organization: z.string().optional(),
context_length: z.number().optional(),
})
.passthrough()
/** Together's `GET /v1/models` returns a bare top-level array of model objects. */
export const togetherUpstreamResponseSchema = z.array(togetherModelObjectSchema)
export const basetenUpstreamResponseSchema = z.object({
data: z
.array(
z
.object({
id: z.string(),
object: z.string().optional(),
created: z.number().optional(),
owned_by: z.string().optional(),
})
.passthrough()
)
.default([]),
object: z.string().optional(),
})
// Shared by the local Ollama and Ollama Cloud /api/tags endpoints — same `{ models: [{ name }] }` shape.
export const ollamaUpstreamResponseSchema = z.object({
models: z
.array(
z
.object({
name: z.string(),
})
.passthrough()
)
.default([]),
})
const providerToolSchema = z
.object({
id: z.string(),
name: z.string(),
description: z.string(),
params: z.record(z.string(), z.unknown()),
parameters: z
.object({
type: z.string(),
properties: z.record(z.string(), z.unknown()),
required: z.array(z.string()),
})
.passthrough(),
usageControl: z.enum(['auto', 'force', 'none']).optional(),
})
.passthrough()
const providerMessageSchema = z
.object({
role: z.enum(['system', 'user', 'assistant', 'function', 'tool']),
content: z.string().nullable(),
name: z.string().optional(),
function_call: z
.object({
name: z.string(),
arguments: z.string(),
})
.optional(),
tool_calls: z
.array(
z.object({
id: z.string(),
type: z.literal('function'),
function: z.object({
name: z.string(),
arguments: z.string(),
}),
})
)
.optional(),
tool_call_id: z.string().optional(),
})
.passthrough()
const providerResponseFormatSchema = z
.object({
name: z.string(),
// untyped-response: caller-supplied JSON Schema (request body field, not a route response)
schema: z.unknown(),
strict: z.boolean().optional(),
})
.passthrough()
export const providerApiRequestBodySchema = z
.object({
provider: z.string().min(1),
model: z.string().min(1),
systemPrompt: z.string().optional(),
context: z.string().optional(),
tools: z.array(providerToolSchema).optional(),
temperature: z.number().optional(),
maxTokens: z.number().optional(),
apiKey: z.string().optional(),
azureEndpoint: z.string().optional(),
azureApiVersion: z.string().optional(),
vertexProject: z.string().optional(),
vertexLocation: z.string().optional(),
vertexCredential: z.string().optional(),
bedrockAccessKeyId: z.string().optional(),
bedrockSecretKey: z.string().optional(),
bedrockRegion: z.string().optional(),
responseFormat: providerResponseFormatSchema.optional(),
workflowId: z.string().optional(),
workspaceId: z.string().optional(),
stream: z.boolean().optional(),
messages: z.array(providerMessageSchema).optional(),
environmentVariables: z.record(z.string(), z.string()).optional(),
workflowVariables: z.record(z.string(), z.unknown()).optional(),
blockData: z.record(z.string(), z.unknown()).optional(),
blockNameMapping: z.record(z.string(), z.string()).optional(),
reasoningEffort: z.string().optional(),
verbosity: z.string().optional(),
})
.passthrough()
export type ProviderApiRequestBody = z.input<typeof providerApiRequestBodySchema>
export const getBaseProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/base/models',
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getOllamaProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/ollama/models',
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getVllmProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/vllm/models',
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getOpenRouterProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/openrouter/models',
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getLitellmProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/litellm/models',
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getFireworksProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/fireworks/models',
query: fireworksProviderModelsQuerySchema,
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getOllamaCloudProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/ollama-cloud/models',
query: ollamaCloudProviderModelsQuerySchema,
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getTogetherProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/together/models',
query: togetherProviderModelsQuerySchema,
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
export const getBasetenProviderModelsContract = defineRouteContract({
method: 'GET',
path: '/api/providers/baseten/models',
query: basetenProviderModelsQuerySchema,
response: {
mode: 'json',
schema: providerModelsResponseSchema,
},
})
/**
* `POST /api/providers` returns either a streamed response (handled at the
* runtime level — this contract models only the JSON case) or a JSON provider
* payload. The JSON case mirrors the canonical `ProviderResponse` shape from
* `@/providers/types`, but provider-specific fields are tolerated via
* passthrough so raw provider output flows through without contract drift.
*/
const executeProviderResponseSchema = z
.object({
content: z.string(),
model: z.string(),
tokens: z
.object({
input: z.number().optional(),
output: z.number().optional(),
total: z.number().optional(),
})
.optional(),
toolCalls: z.array(z.record(z.string(), z.unknown())).optional(),
toolResults: z.array(z.record(z.string(), z.unknown())).optional(),
timing: z.record(z.string(), z.unknown()).optional(),
cost: z.record(z.string(), z.unknown()).optional(),
interactionId: z.string().optional(),
})
.passthrough()
export const executeProviderContract = defineRouteContract({
method: 'POST',
path: '/api/providers',
body: providerApiRequestBodySchema,
response: {
mode: 'json',
schema: executeProviderResponseSchema,
},
})