hexabot/api/src/nlp/dto/nlp-entity.dto.ts
2024-09-29 13:02:28 +01:00

49 lines
1.4 KiB
TypeScript

/*
* Copyright © 2024 Hexastack. All rights reserved.
*
* Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
* 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
* 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
*/
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import {
IsString,
IsOptional,
IsBoolean,
IsArray,
Matches,
IsIn,
IsNotEmpty,
} from 'class-validator';
export type Lookup = 'keywords' | 'trait' | 'free-text';
export class NlpEntityCreateDto {
@ApiProperty({ description: 'Name of the nlp entity', type: String })
@Matches(/^[a-zA-Z0-9_]+$/, {
message: 'Only alphanumeric characters and underscores are allowed.',
})
@IsNotEmpty()
name: string;
@ApiPropertyOptional({
isArray: true,
enum: ['keywords', 'trait', 'free-text'],
})
@IsArray()
@IsIn(['keywords', 'trait', 'free-text'], { each: true })
@IsOptional()
lookups?: Lookup[];
@ApiPropertyOptional({ type: String })
@IsString()
@IsOptional()
doc?: string;
@ApiPropertyOptional({ description: 'Nlp entity is builtin', type: Boolean })
@IsBoolean()
@IsOptional()
builtin?: boolean;
}