audit

Workspace API

---

Workspace API / types/audit

types/audit

Interfaces

AuditChunkSummary

Defined in: types/audit.ts:24

Retrieved chunk summary for audit logging

Properties

chunk_id

chunk_id: string

Defined in: types/audit.ts:25

document_id

document_id: string

Defined in: types/audit.ts:26

similarity

similarity: number

Defined in: types/audit.ts:27

classification?

optional classification: string

Defined in: types/audit.ts:28

---

AuditLogEntry

Defined in: types/audit.ts:34

Audit log entry for RAG queries

Properties

traceId

traceId: string

Defined in: types/audit.ts:35

userId

userId: string

Defined in: types/audit.ts:36

organizationId

organizationId: string

Defined in: types/audit.ts:37

query

query: string

Defined in: types/audit.ts:38

queryHash?

optional queryHash: string

Defined in: types/audit.ts:39

enhancedQuery?

optional enhancedQuery: string

Defined in: types/audit.ts:40

scope

scope: string

Defined in: types/audit.ts:41

scopeIds

scopeIds: string[]

Defined in: types/audit.ts:42

retrievedChunks

retrievedChunks: AuditChunkSummary[]

Defined in: types/audit.ts:43

responseText

responseText: string | null

Defined in: types/audit.ts:44

promptVersion

promptVersion: string

Defined in: types/audit.ts:46

agentId?

optional agentId: string

Defined in: types/audit.ts:47

domainKey?

optional domainKey: string

Defined in: types/audit.ts:49

Domain pack key used for system prompt (optional)

modelId

modelId: string

Defined in: types/audit.ts:50

retrievalTimeMs

retrievalTimeMs: number

Defined in: types/audit.ts:51

generationTimeMs

generationTimeMs: number

Defined in: types/audit.ts:52

totalTimeMs

totalTimeMs: number

Defined in: types/audit.ts:53

tokenCountInput

tokenCountInput: number

Defined in: types/audit.ts:54

tokenCountOutput

tokenCountOutput: number

Defined in: types/audit.ts:55

status

status: "error" | "success"

Defined in: types/audit.ts:56

errorCode?

optional errorCode: RAGErrorCode

Defined in: types/audit.ts:57

errorMessage?

optional errorMessage: string

Defined in: types/audit.ts:58

reasoningSteps?

optional reasoningSteps: any[]

Defined in: types/audit.ts:59

confidence?

optional confidence: RAGConfidenceMetrics

Defined in: types/audit.ts:61

Reranker confidence metrics (always present in RAG responses)

domainKeyRequested?

optional domainKeyRequested: string

Defined in: types/audit.ts:64

domain_pack_used

domain_pack_used: boolean

Defined in: types/audit.ts:65

domain_pack_fallback

domain_pack_fallback: boolean

Defined in: types/audit.ts:66

documentCount?

optional documentCount: number

Defined in: types/audit.ts:68

totalPages?

optional totalPages: number

Defined in: types/audit.ts:69

pagesSearched?

optional pagesSearched: number

Defined in: types/audit.ts:70

chunkCount?

optional chunkCount: number

Defined in: types/audit.ts:71

documentBucket?

optional documentBucket: "1-5" | "6-10" | "11-20" | "21+"

Defined in: types/audit.ts:72

pageBucket?

optional pageBucket: "0-100" | "101-300" | "301-500" | "501+"

Defined in: types/audit.ts:73

timestamp

timestamp: Date

Defined in: types/audit.ts:74

---

OpenSearchAuditRow

Defined in: types/audit.ts:83

OpenSearch document format for audit logs

Note: OpenSearch supports nested objects and arrays natively. JSON fields are stored as nested objects, not stringified.

Properties

trace_id

trace_id: string

Defined in: types/audit.ts:84

user_id

user_id: string

Defined in: types/audit.ts:85

organization_id

organization_id: string

Defined in: types/audit.ts:86

query

query: string

Defined in: types/audit.ts:87

query_hash

query_hash: string | null

Defined in: types/audit.ts:88

enhanced_query

enhanced_query: string | null

Defined in: types/audit.ts:89

scope

scope: string

Defined in: types/audit.ts:90

scope_ids

scope_ids: string[]

Defined in: types/audit.ts:91

retrieved_chunks

retrieved_chunks: AuditChunkSummary[] | null

Defined in: types/audit.ts:92

response_text

response_text: string | null

Defined in: types/audit.ts:93

prompt_version

prompt_version: string

Defined in: types/audit.ts:95

domain_pack_used

domain_pack_used: boolean

Defined in: types/audit.ts:97

domain_pack_fallback

domain_pack_fallback: boolean

Defined in: types/audit.ts:98

domain_key_used

domain_key_used: string | null

Defined in: types/audit.ts:100

domain_key_requested

domain_key_requested: string | null

Defined in: types/audit.ts:101

agent_id

agent_id: string | null

Defined in: types/audit.ts:102

domain_key

domain_key: string | null

Defined in: types/audit.ts:103

model_id

model_id: string

Defined in: types/audit.ts:104

retrieval_time_ms

retrieval_time_ms: number

Defined in: types/audit.ts:105

generation_time_ms

generation_time_ms: number

Defined in: types/audit.ts:106

total_time_ms

total_time_ms: number

Defined in: types/audit.ts:107

token_count_input

token_count_input: number

Defined in: types/audit.ts:108

token_count_output

token_count_output: number

Defined in: types/audit.ts:109

status

status: string

Defined in: types/audit.ts:110

error_code

error_code: string | null

Defined in: types/audit.ts:111

error_message

error_message: string | null

Defined in: types/audit.ts:112

reasoning_steps

reasoning_steps: any[] | null

Defined in: types/audit.ts:113

confidence

confidence: RAGConfidenceMetrics | null

Defined in: types/audit.ts:114

document_count

document_count: number | null

Defined in: types/audit.ts:116

total_pages

total_pages: number | null

Defined in: types/audit.ts:117

pages_searched

pages_searched: number | null

Defined in: types/audit.ts:118

chunk_count

chunk_count: number | null

Defined in: types/audit.ts:119

document_bucket

document_bucket: string | null

Defined in: types/audit.ts:120

page_bucket

page_bucket: string | null

Defined in: types/audit.ts:121

timestamp

timestamp: string

Defined in: types/audit.ts:122

Type Aliases

RAGErrorCode

RAGErrorCode = "permission_denied" | "no_chunks" | "model_error" | "context_overflow" | "stream_error" | "invalid_scope" | "rate_limit_exceeded" | "unknown"

Defined in: types/audit.ts:11

Standardized error codes for RAG queries

Functions

estimateTokens()

estimateTokens(text): number

Defined in: types/audit.ts:135

Estimate token count (rough approximation)

Parameters

text

string

Text to estimate tokens for

Returns

number

Estimated token count

Deprecated

Use estimateTokens from utils/tokenEstimation for new code. This function uses 4 chars/token for backwards compatibility with audit logs. The new utility uses configurable 3.5 chars/token (better for technical text).

---

classifyError()

classifyError(error): RAGErrorCode

Defined in: types/audit.ts:146

Classify error into standardized error code

Parameters

error

Error to classify

string | Error

Returns

RAGErrorCode

Standardized error code

---

getUserFriendlyErrorMessage()

getUserFriendlyErrorMessage(errorCode, originalError?): string

Defined in: types/audit.ts:189

Get user-friendly error message based on error code and original error

Parameters

errorCode

RAGErrorCode

Standardized error code

originalError?

Original error for additional context

string | Error

Returns

string

User-friendly error message