Added the desc for the tensorrt engine, fix the dtos

janhq · Jun 27, 2024 · 1494736 · 1494736
1 parent 0cde51e
commit 1494736
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 5 deletions.
diff --git a/cortex-js/src/infrastructure/controllers/chat.controller.ts b/cortex-js/src/infrastructure/controllers/chat.controller.ts
@@ -12,7 +12,7 @@ export class ChatController {
 
   @ApiOperation({
     summary: 'Create chat completion',
-    description: 'Creates a model response for the given conversation.',
+    description: 'Creates a model response for the given conversation. The following parameters are not working for the `TensorRT-LLM` engine:\n- `frequency_penalty`\n- `presence_penalty`\n- `top_p`',
   })
   @HttpCode(200)
   @ApiResponse({

diff --git a/cortex-js/src/infrastructure/dtos/chat/chat-completion-message.dto.ts b/cortex-js/src/infrastructure/dtos/chat/chat-completion-message.dto.ts
@@ -2,13 +2,12 @@ import { IsString } from 'class-validator';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class ChatCompletionMessage {
-  @ApiProperty({ description: 'The Content of the chat message.', example: 'Hello World', })
+  @ApiProperty({ description: 'The Content of the chat message.',  })
   @IsString()
   content: string;
 
   @ApiProperty({
     description: 'The role of the entity in the chat completion.',
-    example: 'user',
   })
   role: 'user' | 'assistant';
 }
diff --git a/cortex-js/src/infrastructure/dtos/chat/message.dto.ts b/cortex-js/src/infrastructure/dtos/chat/message.dto.ts
@@ -4,15 +4,13 @@ export class MessageDto {
   @ApiProperty({
     description:
       'The textual content of the chat message or completion generated by the model.',
-      example: 'Hello World',
     type: String,
   })
   content: string;
 
   @ApiProperty({
     description:
       "The role of the participant in the chat, such as 'user' or 'system', indicating who is the sender of the message.",
-      example: 'user',
     type: String,
   })
   role: string;