import {z} from 'zod' export type GetApiV1AnalyticsKnowledgeDashboardArgs = {granularity?: string | undefined, knowledge_base_id?: (string | null) | undefined, source_type?: (string | null) | undefined, hash_method?: (string | null) | undefined, start_date: string, end_date: string}; export type GetApiV1AnalyticsKnowledgeDashboardOptions = {baseUrl: string, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const kbAdoptionRow = z.object({knowledge_base_id: z.string(), documents_active: z.number().int(), documents_failed: z.number().int(), documents_attempted: z.number().int(), adoption_rate_pct: z.number(), unique_documents: z.number().int()}); export const documentIngestionTimeseriesRow = z.object({time_bucket: z.string(), created: z.number().int(), completed: z.number().int(), failed: z.number().int(), success_rate_pct: z.number()}); export const documentProcessingLatencyRow = z.object({time_bucket: z.string(), terminal_events: z.number().int(), p50_ms: z.number(), p90_ms: z.number(), p95_ms: z.number(), p99_ms: z.number(), avg_ms: z.number(), max_ms: z.number()}); export const documentCleanupSummaryRow = z.object({time_bucket: z.string(), failed: z.number().int(), archived: z.number().int(), cleaned_up: z.number().int(), recovered: z.number().int(), net_unrecovered_failures: z.number().int(), cleanup_rate_pct: z.number()}); export const documentRetrievalTimeseriesRow = z.object({time_bucket: z.string(), total: z.number().int(), hits: z.number().int(), misses: z.number().int(), reranked: z.number().int(), errors: z.number().int(), hit_rate_pct: z.number(), avg_results: z.number(), avg_duration_ms: z.number(), p50_ms: z.number(), p90_ms: z.number(), p95_ms: z.number(), p99_ms: z.number()}); export const kbInventoryRow = z.object({total_documents: z.number().int(), total_chunks: z.number().int(), total_tokens: z.number().int(), normalized_pct: z.number(), documents_failed_now: z.number().int(), documents_processing_now: z.number().int(), documents_quarantined_now: z.number().int(), knowledge_bases_count: z.number().int()}); export const inventoryBySourceTypeRow = z.object({source_type: z.string(), documents: z.number().int(), chunks: z.number().int(), tokens: z.number().int()}); export const inventoryByHashMethodRow = z.object({hash_method: z.string(), documents: z.number().int(), chunks: z.number().int(), tokens: z.number().int()}); export const inventoryGrowthRow = z.object({created_24h: z.number().int(), created_7d: z.number().int(), created_30d: z.number().int(), failed_7d: z.number().int(), cleaned_up_7d: z.number().int()}); export const inventoryEnvelope = z.object({summary: kbInventoryRow, by_source_type: z.array(inventoryBySourceTypeRow), by_hash_method: z.array(inventoryByHashMethodRow), growth: inventoryGrowthRow}); export const connectorFreshnessRow = z.object({knowledge_base_source_id: z.string(), knowledge_base_id: z.string(), provider: z.string(), last_status: z.string(), last_event_type: z.string(), last_sync_started_at: z.string().nullable().optional(), last_sync_completed_at: z.string().nullable().optional(), last_duration_ms: z.number().nullable().optional(), last_items_processed: z.number().int(), last_items_succeeded: z.number().int(), last_items_failed: z.number().int(), last_items_unchanged: z.number().int(), last_error_message: z.string().nullable().optional(), last_event_at: z.string(), time_since_last_event_seconds: z.number().int()}); export const knowledgeDashboardEnvelope = z.object({adoption: z.array(kbAdoptionRow), ingestion: z.array(documentIngestionTimeseriesRow), latency: z.array(documentProcessingLatencyRow), cleanup: z.array(documentCleanupSummaryRow), retrieval: z.array(documentRetrievalTimeseriesRow), inventory: inventoryEnvelope, freshness: z.array(connectorFreshnessRow)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * One-shot envelope of every knowledge analytics pipe * * GET /v1/analytics/knowledge/dashboard */ export const getApiV1AnalyticsKnowledgeDashboard = async (args: GetApiV1AnalyticsKnowledgeDashboardArgs, options: GetApiV1AnalyticsKnowledgeDashboardOptions) => { const {baseUrl, fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.granularity != null) query.append("granularity", String(args.granularity)) if (args.knowledge_base_id != null) query.append("knowledge_base_id", String(args.knowledge_base_id)) if (args.source_type != null) query.append("source_type", String(args.source_type)) if (args.hash_method != null) query.append("hash_method", String(args.hash_method)) if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (APIKeyHeader !== undefined) headers.set("x-api-key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/v1/analytics/knowledge/dashboard${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(knowledgeDashboardEnvelope, await res.json()) };