Merge pull request #670 from janhq/feat/add-message-apis

feat: add update message api

Author: namchuai

cortex-js/src/infrastructure/commanders/usecases/chat.cli.usecases.ts

@@ -1,4 +1,3 @@
-import { ChatUsecases } from '@/usecases/chat/chat.usecases';
 import {
   ChatCompletionRole,
   ContentType,
@@ -8,7 +7,6 @@ import { exit, stdin, stdout } from 'node:process';
 import * as readline from 'node:readline/promises';
 import { ChatCompletionMessage } from '@/infrastructure/dtos/chat/chat-completion-message.dto';
 import { CreateChatCompletionDto } from '@/infrastructure/dtos/chat/create-chat-completion.dto';
-import { CortexUsecases } from '@/usecases/cortex/cortex.usecases';
 import { Injectable } from '@nestjs/common';
 import { ThreadsUsecases } from '@/usecases/threads/threads.usecases';
 import { Thread } from '@/domain/models/thread.interface';
@@ -20,6 +18,7 @@ import stream from 'stream';
 import { CreateMessageDto } from '@/infrastructure/dtos/messages/create-message.dto';
 import { MessagesUsecases } from '@/usecases/messages/messages.usecases';
 import { ModelParameterParser } from '../utils/model-parameter.parser';
+import { ChatUsecases } from '@/usecases/chat/chat.usecases';
 
 @Injectable()
 export class ChatCliUsecases {
@@ -31,7 +30,6 @@ export class ChatCliUsecases {
     private readonly assistantUsecases: AssistantsUsecases,
     private readonly threadUsecases: ThreadsUsecases,
     private readonly chatUsecases: ChatUsecases,
-    private readonly cortexUsecases: CortexUsecases,
     private readonly modelsUsecases: ModelsUsecases,
     private readonly messagesUsecases: MessagesUsecases,
   ) {}
@@ -268,7 +266,6 @@ export class ChatCliUsecases {
     };
 
     const createThreadDto: CreateThreadDto = {
-      title: 'New Thread',
       assistants: [assistantDto],
     };
 

cortex-js/src/infrastructure/controllers/assistants.controller.ts

@@ -1,10 +1,12 @@
 import {
   Body,
   Controller,
+  DefaultValuePipe,
   Delete,
   Get,
   Param,
   Post,
+  Query,
   UseInterceptors,
 } from '@nestjs/common';
 import { AssistantsUsecases } from '@/usecases/assistants/assistants.usecases';
@@ -17,6 +19,7 @@ import {
   ApiParam,
   ApiTags,
   ApiResponse,
+  ApiQuery,
 } from '@nestjs/swagger';
 import { AssistantEntity } from '../entities/assistant.entity';
 import { TransformInterceptor } from '../interceptors/transform.interceptor';
@@ -41,16 +44,48 @@ export class AssistantsController {
 
   @ApiOperation({
     summary: 'List assistants',
-    description:
-      'Retrieves all the available assistants along with their settings.',
+    description: 'Returns a list of assistants.',
   })
   @ApiOkResponse({
     description: 'Ok',
     type: [AssistantEntity],
   })
+  @ApiQuery({
+    name: 'limit',
+    type: Number,
+    required: false,
+    description:
+      'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.',
+  })
+  @ApiQuery({
+    name: 'order',
+    type: String,
+    required: false,
+    description:
+      'Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.',
+  })
+  @ApiQuery({
+    name: 'after',
+    type: String,
+    required: false,
+    description:
+      'A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.',
+  })
+  @ApiQuery({
+    name: 'before',
+    type: String,
+    required: false,
+    description:
+      'A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.',
+  })
   @Get()
-  findAll() {
-    return this.assistantsService.findAll();
+  findAll(
+    @Query('limit', new DefaultValuePipe(20)) limit: number,
+    @Query('order', new DefaultValuePipe('desc')) order: 'asc' | 'desc',
+    @Query('after') after?: string,
+    @Query('before') before?: string,
+  ) {
+    return this.assistantsService.listAssistants(limit, order, after, before);
   }
 
   @ApiOperation({

cortex-js/src/infrastructure/controllers/threads.controller.ts

@@ -25,20 +25,22 @@ import {
 } from '@nestjs/swagger';
 import { TransformInterceptor } from '../interceptors/transform.interceptor';
 import { ListMessagesResponseDto } from '../dtos/messages/list-message.dto';
+import { CreateMessageDto } from '../dtos/threads/create-message.dto';
+import { UpdateMessageDto } from '../dtos/threads/update-message.dto';
 
 @ApiTags('Threads')
 @Controller('threads')
 @UseInterceptors(TransformInterceptor)
 export class ThreadsController {
-  constructor(private readonly threadsService: ThreadsUsecases) {}
+  constructor(private readonly threadsUsecases: ThreadsUsecases) {}
 
   @ApiOperation({
     summary: 'Create thread',
     description: 'Creates a new thread.',
   })
   @Post()
   create(@Body() createThreadDto: CreateThreadDto) {
-    return this.threadsService.create(createThreadDto);
+    return this.threadsUsecases.create(createThreadDto);
   }
 
   @ApiOperation({
@@ -48,7 +50,7 @@ export class ThreadsController {
   })
   @Get()
   findAll() {
-    return this.threadsService.findAll();
+    return this.threadsUsecases.findAll();
   }
 
   @HttpCode(200)
@@ -109,7 +111,7 @@ export class ThreadsController {
     @Query('before') before?: string,
     @Query('run_id') runId?: string,
   ) {
-    return this.threadsService.getMessagesOfThread(
+    return this.threadsUsecases.getMessagesOfThread(
       id,
       limit,
       order,
@@ -119,6 +121,58 @@ export class ThreadsController {
     );
   }
 
+  @ApiOperation({
+    summary: 'Modifies a message.',
+    description: 'Modifies a message.',
+  })
+  @ApiResponse({
+    status: 201,
+    description: 'A message object.',
+  })
+  @ApiOperation({
+    summary: 'Create a message',
+    description: 'Create a message.',
+  })
+  @ApiParam({
+    name: 'id',
+    required: true,
+    description: 'The ID of the thread to create a message for.',
+  })
+  @Post(':id/messages')
+  createMessageInThread(
+    @Param('id') id: string,
+    @Body() createMessageDto: CreateMessageDto,
+  ) {
+    return this.threadsUsecases.createMessageInThread(id, createMessageDto);
+  }
+
+  @ApiResponse({
+    status: 200,
+    description: 'The modified message object.',
+  })
+  @ApiParam({
+    name: 'thread_id',
+    required: true,
+    description: 'The ID of the thread to which this message belongs.',
+  })
+  @ApiParam({
+    name: 'message_id',
+    required: true,
+    description: 'The ID of the message to modify.',
+  })
+  @Post(':thread_id/messages/:message_id')
+  updateMessage(
+    @Param('thread_id') threadId: string,
+    @Param('message_id') messageId: string,
+    @Body() updateMessageDto: UpdateMessageDto,
+  ) {
+    return this.threadsUsecases.updateMessage(
+      threadId,
+      messageId,
+      updateMessageDto,
+    );
+  }
+
   @ApiResponse({
     status: 200,
     description: 'Ok',
@@ -135,7 +189,7 @@ export class ThreadsController {
   })
   @Get(':id')
   findOne(@Param('id') id: string) {
-    return this.threadsService.findOne(id);
+    return this.threadsUsecases.findOne(id);
   }
 
   @ApiResponse({
@@ -154,7 +208,7 @@ export class ThreadsController {
   })
   @Patch(':id')
   update(@Param('id') id: string, @Body() updateThreadDto: UpdateThreadDto) {
-    return this.threadsService.update(id, updateThreadDto);
+    return this.threadsUsecases.update(id, updateThreadDto);
   }
 
   @ApiResponse({
@@ -173,6 +227,6 @@ export class ThreadsController {
   })
   @Delete(':id')
   remove(@Param('id') id: string) {
-    return this.threadsService.remove(id);
+    return this.threadsUsecases.remove(id);
   }
 }

cortex-js/src/infrastructure/dtos/assistants/assistant-tool.dto.ts

@@ -15,7 +15,6 @@ export class AssistantToolDto implements AssistantTool {
   @IsBoolean()
   enabled: boolean;
 
-  // TODO: NamH make a type for this
   @ApiProperty({
     description: "The setting of the assistant's tool.",
   })

cortex-js/src/infrastructure/dtos/threads/create-message.dto.ts

@@ -0,0 +1,18 @@
+import { ChatCompletionRole } from '@/domain/models/message.interface';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsEnum } from 'class-validator';
+
+export class CreateMessageDto {
+  @ApiProperty({
+    description: `The role of the entity that is creating the message. Allowed values include:
+      - user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.
+      - assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.`,
+  })
+  @IsEnum(ChatCompletionRole)
+  role: ChatCompletionRole;
+
+  @ApiProperty({
+    description: 'The text contents of the message.',
+  })
+  content: string;
+}

cortex-js/src/infrastructure/dtos/threads/create-thread.dto.ts

@@ -1,15 +1,10 @@
-import { IsArray, IsOptional, IsString, ValidateNested } from 'class-validator';
+import { IsArray, ValidateNested } from 'class-validator';
 import { Thread } from '@/domain/models/thread.interface';
 import { CreateThreadAssistantDto } from './create-thread-assistant.dto';
 import { Type } from 'class-transformer';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class CreateThreadDto implements Partial<Thread> {
-  @ApiProperty({ description: 'The title of the thread.' })
-  @IsOptional()
-  @IsString()
-  title: string;
-
   @ApiProperty({ description: "The details of the thread's settings." })
   @IsArray()
   @ValidateNested({ each: true })

cortex-js/src/infrastructure/dtos/threads/update-message.dto.ts

@@ -0,0 +1,4 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { MessageEntity } from '@/infrastructure/entities/message.entity';
+
+export class UpdateMessageDto extends PartialType(MessageEntity) {}

cortex-js/src/infrastructure/entities/message.entity.ts

@@ -45,4 +45,7 @@ export class MessageEntity implements Message {
 
   @Column({ nullable: true })
   error_code?: ErrorCode;
+
+  @Column({ type: 'simple-json', nullable: true })
+  attachments?: any[];
 }

cortex-js/src/usecases/assistants/assistants.usecases.ts

@@ -3,6 +3,7 @@ import { AssistantEntity } from '@/infrastructure/entities/assistant.entity';
 import { Repository } from 'typeorm';
 import { CreateAssistantDto } from '@/infrastructure/dtos/assistants/create-assistant.dto';
 import { Assistant } from '@/domain/models/assistant.interface';
+import { PageDto } from '@/infrastructure/dtos/page.dto';
 
 @Injectable()
 export class AssistantsUsecases {
@@ -20,6 +21,43 @@ export class AssistantsUsecases {
     this.assistantRepository.insert(assistant);
   }
 
+  async listAssistants(
+    limit: number,
+    order: 'asc' | 'desc',
+    after?: string,
+    before?: string,
+  ) {
+    const queryBuilder = this.assistantRepository.createQueryBuilder();
+    const normalizedOrder = order === 'asc' ? 'ASC' : 'DESC';
+
+    queryBuilder.orderBy('created_at', normalizedOrder).take(limit + 1);
+
+    if (after) {
+      queryBuilder.andWhere('id > :after', { after });
+    }
+
+    if (before) {
+      queryBuilder.andWhere('id < :before', { before });
+    }
+
+    const { entities: assistants } = await queryBuilder.getRawAndEntities();
+
+    if (assistants.length === 0) {
+      assistants.push(this.janAssistant);
+    }
+
+    let hasMore = false;
+    if (assistants.length > limit) {
+      hasMore = true;
+      assistants.pop();
+    }
+
+    const firstId = assistants[0]?.id ?? undefined;
+    const lastId = assistants[assistants.length - 1]?.id ?? undefined;
+
+    return new PageDto(assistants, hasMore, firstId, lastId);
+  }
+
   async findAll(): Promise<Assistant[]> {
     return this.assistantRepository.find();
   }

cortex-js/src/usecases/models/models.usecases.ts

@@ -209,7 +209,6 @@ export class ModelsUsecases {
     });
   }
 
-  // TODO: NamH move to a helper or utils
   private isValidUrl(input: string | undefined): boolean {
     if (!input) return false;
     try {