Files
simstudioai--sim/apps/sim/tools/databricks/run_job.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

118 lines
3.3 KiB
TypeScript

import { getErrorMessage } from '@sim/utils/errors'
import type { DatabricksRunJobParams, DatabricksRunJobResponse } from '@/tools/databricks/types'
import type { ToolConfig } from '@/tools/types'
export const runJobTool: ToolConfig<DatabricksRunJobParams, DatabricksRunJobResponse> = {
id: 'databricks_run_job',
name: 'Databricks Run Job',
description:
'Trigger an existing Databricks job to run immediately with optional job-level or notebook parameters.',
version: '1.0.0',
params: {
host: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Databricks workspace host (e.g., dbc-abc123.cloud.databricks.com)',
},
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Databricks Personal Access Token',
},
jobId: {
type: 'number',
required: true,
visibility: 'user-or-llm',
description: 'The ID of the job to trigger',
},
jobParameters: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Job-level parameter overrides as a JSON object (e.g., {"key": "value"})',
},
notebookParams: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Notebook task parameters as a JSON object (e.g., {"param1": "value1"})',
},
idempotencyToken: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Idempotency token to prevent duplicate runs (max 64 characters)',
},
},
request: {
url: (params) => {
const host = params.host
.trim()
.replace(/^https?:\/\//, '')
.replace(/\/$/, '')
return `https://${host}/api/2.1/jobs/run-now`
},
method: 'POST',
headers: (params) => ({
'Content-Type': 'application/json',
Authorization: `Bearer ${params.apiKey}`,
}),
body: (params) => {
const body: Record<string, unknown> = {
job_id: params.jobId,
}
if (params.jobParameters) {
try {
body.job_parameters = JSON.parse(params.jobParameters)
} catch (error) {
throw new Error(
`Invalid JSON in jobParameters: ${getErrorMessage(error, 'unknown error')}`
)
}
}
if (params.notebookParams) {
try {
body.notebook_params = JSON.parse(params.notebookParams)
} catch (error) {
throw new Error(
`Invalid JSON in notebookParams: ${getErrorMessage(error, 'unknown error')}`
)
}
}
if (params.idempotencyToken) body.idempotency_token = params.idempotencyToken
return body
},
},
transformResponse: async (response: Response) => {
const data = await response.json()
if (!response.ok) {
throw new Error(data.message || data.error?.message || 'Failed to trigger job run')
}
return {
success: true,
output: {
runId: data.run_id ?? 0,
numberInJob: data.number_in_job ?? 0,
},
}
},
outputs: {
runId: {
type: 'number',
description: 'The globally unique ID of the triggered run',
},
numberInJob: {
type: 'number',
description: 'The sequence number of this run among all runs of the job',
},
},
}