feat: expose model name (#41)

Author: mdjastrzebski

.changeset/hot-spoons-worry.md

@@ -0,0 +1,5 @@
+---
+'@callstack/byorg-core': minor
+---
+
+core: expose `ChatModel.name` property

packages/core/src/ai/types.ts

@@ -16,5 +16,6 @@ export type ModelUsage = {
 };
 
 export interface ChatModel {
+  name: string;
   generateResponse(context: RequestContext): Promise<AssistantResponse>;
 }

packages/core/src/ai/vercel.ts

@@ -29,7 +29,7 @@ const VERCEL_AI_SHARED_OPTIONS = {
   },
 };
 
-export type VercelChatModelAdapterOptions = {
+export type VercelChatModelAdapterConfig = {
   languageModel: LanguageModel;
   maxTokens?: number;
   maxSteps?: number;
@@ -51,7 +51,15 @@ type AiExecutionResult = {
 };
 
 export class VercelChatModelAdapter implements ChatModel {
-  constructor(private readonly _options: VercelChatModelAdapterOptions) {}
+  config: VercelChatModelAdapterConfig;
+
+  constructor(config: VercelChatModelAdapterConfig) {
+    this.config = config;
+  }
+
+  get name(): string {
+    return this.config.languageModel.modelId;
+  }
 
   async generateResponse(context: RequestContext): Promise<AssistantResponse> {
     let systemPrompt = context.systemPrompt();
@@ -123,10 +131,10 @@ export class VercelChatModelAdapter implements ChatModel {
     const startTime = performance.now();
     const result = await streamText({
       ...VERCEL_AI_SHARED_OPTIONS,
-      model: this._options.languageModel,
+      model: this.config.languageModel,
+      maxTokens: this.config.maxTokens,
+      maxSteps: this.config.maxSteps,
       messages: context.messages,
-      maxTokens: this._options.maxTokens,
-      maxSteps: this._options.maxSteps,
       tools: context.tools,
     });
 
@@ -156,10 +164,10 @@ export class VercelChatModelAdapter implements ChatModel {
     const startTime = performance.now();
     const result = await generateText({
       ...VERCEL_AI_SHARED_OPTIONS,
-      model: this._options.languageModel,
+      model: this.config.languageModel,
+      maxTokens: this.config.maxTokens,
+      maxSteps: this.config.maxSteps,
       messages: context.messages,
-      maxTokens: this._options.maxTokens,
-      maxSteps: this._options.maxSteps,
       tools: context.tools,
     });
     const responseTime = performance.now() - startTime;

packages/core/src/index.ts

@@ -23,7 +23,7 @@ export { createApp } from './application.js';
 export type { Middleware, NextFunction } from './middleware.js';
 
 export type { AssistantResponse, ChatModel, ModelUsage } from './ai/types.js';
-export type { VercelChatModelAdapterOptions } from './ai/vercel.js';
+export type { VercelChatModelAdapterConfig } from './ai/vercel.js';
 export { VercelChatModelAdapter } from './ai/vercel.js';
 
 export type { Command, CommandsPluginConfig } from './plugins/commands.js';

packages/core/src/mock/mock-model.ts

@@ -34,6 +34,7 @@ export function createMockChatModel(config?: MockChatModelConfig): MockChatModel
   let lastRandom = config?.seed ?? Date.now();
   return {
     calls,
+    name: 'mock',
     generateResponse: async (context: RequestContext): Promise<AssistantResponse> => {
       calls.push([context]);
       lastRandom = random(lastRandom);