Files
simstudioai--sim/apps/sim/tools/knowledge/upload_chunk.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

121 lines
3.7 KiB
TypeScript

import type { KnowledgeUploadChunkResponse } from '@/tools/knowledge/types'
import type { ToolConfig } from '@/tools/types'
export const knowledgeUploadChunkTool: ToolConfig<any, KnowledgeUploadChunkResponse> = {
id: 'knowledge_upload_chunk',
name: 'Knowledge Upload Chunk',
description: 'Upload a new chunk to a document in a knowledge base',
version: '1.0.0',
params: {
knowledgeBaseId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'ID of the knowledge base containing the document',
},
documentId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'ID of the document to upload the chunk to',
},
content: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Content of the chunk to upload',
},
},
request: {
url: (params) =>
`/api/knowledge/${params.knowledgeBaseId}/documents/${params.documentId}/chunks`,
method: 'POST',
headers: () => ({
'Content-Type': 'application/json',
}),
body: (params) => {
const workflowId = params._context?.workflowId
const requestBody = {
content: params.content,
enabled: true,
...(workflowId && { workflowId }),
}
return requestBody
},
},
transformResponse: async (response): Promise<KnowledgeUploadChunkResponse> => {
const result = await response.json()
const data = result.data || result
// Restructure cost: extract tokens/model to top level for logging
let costFields: Record<string, unknown> = {}
if (data.cost && typeof data.cost === 'object') {
const { tokens, model, input, output: outputCost, total } = data.cost
costFields = {
cost: { input, output: outputCost, total },
...(tokens && { tokens }),
...(model && { model }),
}
}
return {
success: true,
output: {
message: `Successfully uploaded chunk to document`,
data: {
chunkId: data.id,
chunkIndex: data.chunkIndex || 0,
content: data.content,
contentLength: data.contentLength || data.content?.length || 0,
tokenCount: data.tokenCount || 0,
enabled: data.enabled !== undefined ? data.enabled : true,
createdAt: data.createdAt,
updatedAt: data.updatedAt,
},
documentId: data.documentId,
documentName: data.documentName,
...costFields,
},
}
},
outputs: {
data: {
type: 'object',
description: 'Information about the uploaded chunk',
properties: {
chunkId: { type: 'string', description: 'Chunk ID' },
chunkIndex: { type: 'number', description: 'Index of the chunk within the document' },
content: { type: 'string', description: 'Content of the chunk' },
contentLength: { type: 'number', description: 'Length of the content in characters' },
tokenCount: { type: 'number', description: 'Number of tokens in the chunk' },
enabled: { type: 'boolean', description: 'Whether the chunk is enabled' },
createdAt: { type: 'string', description: 'Creation timestamp' },
updatedAt: { type: 'string', description: 'Last update timestamp' },
},
},
message: {
type: 'string',
description: 'Success or error message describing the operation result',
},
documentId: {
type: 'string',
description: 'ID of the document the chunk was added to',
},
documentName: {
type: 'string',
description: 'Name of the document the chunk was added to',
},
cost: {
type: 'object',
description: 'Cost information for the upload operation',
optional: true,
},
},
}