Félix Malfait
6117a1d6c0
## Summary
The "AI" acronym was rendered inconsistently across the codebase. The
backend AI module had settled on PascalCase `Ai` (`AiAgentModule`,
`AiBillingService`, `AiChatModule`, `AiModelRegistryService`, etc.),
while frontend components, several DTOs, a few types, and shared
identifiers still used all-caps `AI` (`AIChatTab`,
`AISystemPromptPreviewDTO`, `SettingsPath.AIPrompts`, ...). CLAUDE.md
specifies PascalCase for classes; this PR normalizes everything internal
to `Ai`.
**This is a pure internal rename.** The GraphQL schema is untouched —
`@ObjectType` decorator string arguments, resolver method names (which
become Query/Mutation field names), gql template contents, and the
`generated-metadata/graphql.ts` file are preserved verbatim. The only
visible change is TypeScript identifiers and file names.
## Also folded in (adjacent cleanups)
- **`AgentModelConfigService` → `AiModelConfigService`**. Lives in
`ai-models/` and is used by multiple AI code paths, not just the Agent
entity. The "Agent" prefix was misleading.
- **`generate-text-input.dto.ts` → `generate-text.input.ts`**. The
`ai-agent/dtos/` folder already uses `<entity>.input.ts` convention for
Input classes (`create-agent.input.ts` etc.); the old path mixed
`.dto.ts` file extension with a class that has no DTO suffix. File
rename only; class stays `GenerateTextInput`.
- **Removed stale TODO** in `ai-model-config.type.ts` that asked for the
`AiModelConfig` rename that this PR performs.
## Rename methodology
Bulk rename via perl with anchored regex
`(?<!['"])(?<![A-Z.])AI([A-Z])(?=[a-z])/Ai$1/g`:
- **Lookbehind for non-uppercase** skips adjacent acronyms (`MOSAIC`,
`OIDCSSO`) and leaves `AIRBNB_ID` alone.
- **Lookbehind for non-quote** protects most string literals.
- **Lookahead for lowercase** restricts matches to PascalCase
identifiers (`AIChatTab`), leaving SCREAMING_SNAKE constants untouched.
Strict file-scope exclusions: `generated-metadata/**`, `generated/**`,
`locales/**`, `migrations/**`, `illustrations/**`, `halftone/**`, and
the two gql template files (`queries/getAISystemPromptPreview.ts`,
`mutations/uploadAIChatFile.ts`).
Post-rename reverts for identifiers where the regex was too eager:
- Backend resolver method names kept: `getAISystemPromptPreview`,
`uploadAIChatFile` (they are GraphQL field names).
- `@ObjectType('AdminAIModels')` / `('AISystemPromptPreview')` /
`('AISystemPromptSection')` kept as-is.
- Backend classes `ClientAIModelConfig` / `AdminAIModelConfig` kept
as-is (they use `@ObjectType()` with no argument, so the class name IS
the schema name).
- External-library symbols restored: `OpenAIProvider`,
`createOpenAICompatible`, `vercelAIIntegration`.
File renames use a two-step rename to work on macOS case-insensitive
filesystems: `git mv X.tsx X.tsx.tmp && git mv X.tsx.tmp renamed.tsx`.
## Diff audit
- 0 changes to migrations
- 0 changes to locale `.po` / `.ts` files
- 0 changes to `generated-metadata/graphql.ts`
- 0 changes to website illustration files (base64 blobs preserved)
- 0 renames inside user-facing translation strings (`t\`…\``,
`msg\`…\``, `<Trans>…</Trans>`)
## Test plan
- [x] `npx nx typecheck twenty-server` — PASS
- [x] `npx nx typecheck twenty-front` — PASS
- [x] `npx jest ai-model admin agent-role` — 79/79 PASS
- [x] `npx oxlint --type-aware` on 118 changed files — 0 errors
- [x] `npx prettier --check` on 118 changed files — clean
- [ ] CI
68 lines
2.4 KiB
TypeScript
68 lines
2.4 KiB
TypeScript
import { Body, Controller, Post, UseFilters, UseGuards } from '@nestjs/common';
|
|
|
|
import { generateText } from 'ai';
|
|
import { PermissionFlagType } from 'twenty-shared/constants';
|
|
|
|
import { RestApiExceptionFilter } from 'src/engine/api/rest/rest-api-exception.filter';
|
|
import type { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
|
|
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
|
|
import { JwtAuthGuard } from 'src/engine/guards/jwt-auth.guard';
|
|
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
|
|
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
|
|
import {
|
|
AiException,
|
|
AiExceptionCode,
|
|
} from 'src/engine/metadata-modules/ai/ai.exception';
|
|
import { AiRestApiExceptionFilter } from 'src/engine/metadata-modules/ai/filters/ai-api-exception.filter';
|
|
import { GenerateTextInput } from 'src/engine/metadata-modules/ai/ai-generate-text/dtos/generate-text.input';
|
|
import { AiModelRegistryService } from 'src/engine/metadata-modules/ai/ai-models/services/ai-model-registry.service';
|
|
|
|
@Controller('rest/ai')
|
|
@UseGuards(JwtAuthGuard, WorkspaceAuthGuard)
|
|
@UseFilters(AiRestApiExceptionFilter, RestApiExceptionFilter)
|
|
export class AiGenerateTextController {
|
|
constructor(
|
|
private readonly aiModelRegistryService: AiModelRegistryService,
|
|
) {}
|
|
|
|
@Post('generate-text')
|
|
@UseGuards(SettingsPermissionGuard(PermissionFlagType.AI))
|
|
async handleGenerateText(
|
|
@Body() body: GenerateTextInput,
|
|
@AuthWorkspace() workspace: WorkspaceEntity,
|
|
) {
|
|
if (this.aiModelRegistryService.getAvailableModels().length === 0) {
|
|
throw new AiException(
|
|
'No AI models are available. Please configure at least one AI provider API key.',
|
|
AiExceptionCode.API_KEY_NOT_CONFIGURED,
|
|
);
|
|
}
|
|
|
|
const resolvedModelId = body.modelId ?? workspace.fastModel;
|
|
|
|
this.aiModelRegistryService.validateModelAvailability(
|
|
resolvedModelId,
|
|
workspace,
|
|
);
|
|
|
|
const registeredModel =
|
|
await this.aiModelRegistryService.resolveModelForAgent({
|
|
modelId: resolvedModelId,
|
|
});
|
|
|
|
const result = await generateText({
|
|
model: registeredModel.model,
|
|
system: body.systemPrompt,
|
|
prompt: body.userPrompt,
|
|
});
|
|
|
|
return {
|
|
text: result.text,
|
|
usage: {
|
|
inputTokens: result.usage?.inputTokens ?? 0,
|
|
outputTokens: result.usage?.outputTokens ?? 0,
|
|
},
|
|
};
|
|
}
|
|
}
|