Skip to main content

auditService

Workspace API

Workspace API / services/auditService

services/auditService

Functions​

calculateHash()​

calculateHash(text): string

Defined in: services/auditService.ts:41

Calculate SHA256 hash of text

Parameters​

text​

string

Text to hash

Returns​

string

SHA256 hash as hex string

toOpenSearchDocument()​

toOpenSearchDocument(entry): OpenSearchAuditRow

Defined in: services/auditService.ts:54

Convert AuditLogEntry to OpenSearch document format

OpenSearch supports nested objects and arrays natively. No need to stringify JSON fields - use native objects/arrays.

Parameters​

entry​

AuditLogEntry

Audit log entry

Returns​

OpenSearchAuditRow

OpenSearch document format

writeAuditLog()​

writeAuditLog(entry): Promise<void>

Defined in: services/auditService.ts:105

Write audit log entry to OpenSearch (fire-and-forget) This function does not throw errors to avoid blocking user requests

Parameters​

entry​

AuditLogEntry

Audit log entry to write

Returns​

Promise<void>

writeAuditLogSync()​

writeAuditLogSync(entry): Promise<void>

Defined in: services/auditService.ts:153

Write audit log entry to OpenSearch and wait for completion Use this when you need to ensure the log is written before proceeding

Parameters​

entry​

AuditLogEntry

Audit log entry to write

Returns​

Promise<void>

Promise that resolves when log is written

createAuditEntry()​

createAuditEntry(params): Partial<AuditLogEntry>

Defined in: services/auditService.ts:192

Create a partial audit log entry with common fields Use this to start building an audit entry at the beginning of a request

Parameters​

params​

Common parameters for audit entry

traceId​

string

userId​

string

organizationId​

string

query​

string

scope​

string

scopeIds​

string[]

agentId?​

string

domainKey?​

string

domainKeyRequested?​

string

Returns​

Partial<AuditLogEntry>

Partial audit log entry

completeSuccessAuditEntry()​

completeSuccessAuditEntry(partial, params): AuditLogEntry

Defined in: services/auditService.ts:225

Complete a partial audit entry for success case

Parameters​

partial​

Partial<AuditLogEntry>

Partial audit entry

params​

Success parameters

enhancedQuery?​

string

retrievedChunks​

AuditChunkSummary[]

responseText​

string

promptVersion​

string

modelId​

string

retrievalTimeMs​

number

generationTimeMs​

number

totalTimeMs​

number

tokenCountInput​

number

tokenCountOutput​

number

reasoningSteps?​

any[]

confidence?​

RAGConfidenceMetrics

documentCount?​

number

totalPages?​

number

pagesSearched?​

number

chunkCount?​

number

documentBucket?​

"1-5" | "6-10" | "11-20" | "21+"

pageBucket?​

"0-100" | "101-300" | "301-500" | "501+"

Returns​

AuditLogEntry

Complete audit log entry

completeErrorAuditEntry()​

completeErrorAuditEntry(partial, params): AuditLogEntry

Defined in: services/auditService.ts:288

Complete a partial audit entry for error case

Parameters​

partial​

Partial<AuditLogEntry>

Partial audit entry

params​

Error parameters

enhancedQuery?​

string

error​

string | Error

promptVersion​

string

modelId​

string

totalTimeMs​

number

confidence?​

RAGConfidenceMetrics

Returns​

AuditLogEntry

Complete audit log entry

calculateDocumentBucket()​

calculateDocumentBucket(documentCount): "1-5" | "6-10" | "11-20" | "21+"

Defined in: services/auditService.ts:328

Calculate document count bucket for aggregation

Parameters​

documentCount​

number

Number of documents

Returns​

"1-5" | "6-10" | "11-20" | "21+"

Bucket string

calculatePageBucket()​

calculatePageBucket(pageCount): "0-100" | "101-300" | "301-500" | "501+"

Defined in: services/auditService.ts:341

Calculate page count bucket for aggregation

Parameters​

pageCount​

number

Total page count

Returns​

"0-100" | "101-300" | "301-500" | "501+"

Bucket string

References​

estimateTokens​

Re-exports estimateTokens

classifyError​

Re-exports classifyError

getUserFriendlyErrorMessage​

Re-exports getUserFriendlyErrorMessage