Skip to main content

skillAuditService

Workspace API

Workspace API / services/skillAuditService

services/skillAuditService

Interfaces​

SkillAuditEntry​

Defined in: services/skillAuditService.ts:20

Skill audit entry structure

Properties​

audit_id​

audit_id: string

Defined in: services/skillAuditService.ts:21

trace_id​

trace_id: string

Defined in: services/skillAuditService.ts:22

run_id​

run_id: string

Defined in: services/skillAuditService.ts:23

organization_id​

organization_id: string

Defined in: services/skillAuditService.ts:24

user_id​

user_id: string

Defined in: services/skillAuditService.ts:25

conversation_id?​

optional conversation_id: string

Defined in: services/skillAuditService.ts:26

skill_id​

skill_id: string

Defined in: services/skillAuditService.ts:27

skill_version_id​

skill_version_id: string

Defined in: services/skillAuditService.ts:28

manifest_hash​

manifest_hash: string

Defined in: services/skillAuditService.ts:29

idempotency_key?​

optional idempotency_key: string

Defined in: services/skillAuditService.ts:30

approval_timestamp​

approval_timestamp: string

Defined in: services/skillAuditService.ts:31

input_hash​

input_hash: string

Defined in: services/skillAuditService.ts:32

output_hash?​

optional output_hash: string

Defined in: services/skillAuditService.ts:33

step_hashes?​

optional step_hashes: object[]

Defined in: services/skillAuditService.ts:34

step_index​

step_index: number

output_hash​

output_hash: string

tool_calls?​

optional tool_calls: object[]

Defined in: services/skillAuditService.ts:35

tool​

tool: string

args_hash​

args_hash: string

result_hash​

result_hash: string

timestamp​

timestamp: string

status​

status: string

Defined in: services/skillAuditService.ts:41

error_code?​

optional error_code: string

Defined in: services/skillAuditService.ts:42

error_message?​

optional error_message: string

Defined in: services/skillAuditService.ts:43

duration_ms​

duration_ms: number

Defined in: services/skillAuditService.ts:44

metadata?​

optional metadata: Record<string, unknown>

Defined in: services/skillAuditService.ts:45

created_at​

created_at: string

Defined in: services/skillAuditService.ts:46

Functions​

createSkillAuditEntry()​

createSkillAuditEntry(data): SkillAuditEntry

Defined in: services/skillAuditService.ts:56

Create a new skill audit entry

Parameters​

data​
traceId​

string

runId​

string

organizationId​

string

userId​

string

skillId​

string

skillVersionId​

string

manifestHash​

string

input​

Record<string, unknown>

Returns​

SkillAuditEntry

writeSkillAuditLog()​

writeSkillAuditLog(entry): Promise<void>

Defined in: services/skillAuditService.ts:95

Write skill audit log entry

MVP: Writes to Postgres usage_events table (fire-and-forget). Post-MVP: Will also write to OpenSearch for compliance.

Parameters​

entry​

Partial<SkillAuditEntry>

Returns​

Promise<void>

completeSuccessAuditEntry()​

completeSuccessAuditEntry(entry, data): SkillAuditEntry

Defined in: services/skillAuditService.ts:202

Complete a successful audit entry

Parameters​

entry​

SkillAuditEntry

data​
output​

Record<string, unknown>

stepHashes?​

object[]

toolCalls?​

object[]

durationMs​

number

Returns​

SkillAuditEntry

completeErrorAuditEntry()​

completeErrorAuditEntry(entry, data): SkillAuditEntry

Defined in: services/skillAuditService.ts:236

Complete a failed audit entry

Parameters​

entry​

SkillAuditEntry

data​
errorCode​

string

durationMs​

number

Returns​

SkillAuditEntry

getRecentSkillRuns()​

getRecentSkillRuns(_userId, _organizationId, _limit): Promise<object[]>

Defined in: services/skillAuditService.ts:258

Get recent skill runs for a user

Parameters​

_userId​

string

_organizationId​

string

_limit​

number = 10

Returns​

Promise<object[]>

getSkillRunDetails()​

getSkillRunDetails(_runId, _userId, _organizationId): Promise<{ run: Record<string, unknown>; steps: Record<string, unknown>[]; } | null>

Defined in: services/skillAuditService.ts:278

Get skill run details by ID

Parameters​

_runId​

string

_userId​

string

_organizationId​

string

Returns​

Promise<{ run: Record<string, unknown>; steps: Record<string, unknown>[]; } | null>