assistant.dto.ts

assistant.dto.tsapps/api/src/modules/ai/assistant/assistant.dto.tsraw ← assistant2,261 B← Back to the app
1/**
2 * T-172…T-175 (A-010) — AI Knowledge Assistant request DTOs.
3 *
4 * Five capabilities, one route family (`POST /workspaces/:id/ai/assistant/:capability`).
5 * Hard caps that map to 4xx are checked in-service (the codebase convention —
6 * see ai-writing.dto.ts: caps are not zod refines).
7 */
8import { z } from "zod";
9 
10/** Raw meeting notes for extract-actions. */
11export const AiExtractActionsDto = z.object({
12  text: z.string().trim().min(1).max(100_000),
13});
14export type AiExtractActionsInput = z.infer<typeof AiExtractActionsDto>;
15 
16/** Explicit page ids for generate-faqs (the caller's own visible pages). */
17export const AiGenerateFaqsDto = z.object({
18  pageIds: z.array(z.string().min(1)).min(1).max(50),
19});
20export type AiGenerateFaqsInput = z.infer<typeof AiGenerateFaqsDto>;
21 
22/**
23 * find-duplicates: an optional query narrows the candidate pool (BM25 over the
24 * caller's visible pages); omitted → the most recently updated pages (the pool
25 * cap is enforced in-service).
26 */
27export const AiFindDuplicatesDto = z.object({
28  query: z.string().trim().min(1).max(200).optional(),
29  limit: z.number().int().min(10).max(200).optional(),
30});
31export type AiFindDuplicatesInput = z.infer<typeof AiFindDuplicatesDto>;
32 
33/** find-stale: look back N days of updates (server-side cap 365). */
34export const AiFindStaleDto = z.object({
35  days: z.number().int().min(1).max(365).default(90),
36  limit: z.number().int().min(10).max(200).optional(),
37});
38export type AiFindStaleInput = z.infer<typeof AiFindStaleDto>;
39 
40/** suggest-metadata: the single page to re-title / re-describe. */
41export const AiSuggestMetadataDto = z.object({
42  pageId: z.string().min(1),
43});
44export type AiSuggestMetadataInput = z.infer<typeof AiSuggestMetadataDto>;
45 
46/** Applying a metadata suggestion: a subset of what the call suggested. */
47export const AiApplyMetadataDto = z.object({
48  suggestionId: z.string().min(1),
49  fields: z
50    .object({
51      title: z.string().trim().min(1).max(200).optional(),
52      description: z.string().trim().min(1).max(2000).optional(),
53    })
54    .refine((f) => f.title !== undefined || f.description !== undefined, { message: "fields: provide title and/or description" }),
55});
56export type AiApplyMetadataInput = z.infer<typeof AiApplyMetadataDto>;
57