stamp: cleaning & polishing

Author: kallebysantos

ext/ai/js/ai.ts

@@ -84,7 +84,6 @@ export class Session<T extends SessionType> {
     }
   }
 
-  //  /** @param {string | object} prompt Either a String (ollama) or an OpenAI chat completion body object (openaicompatible): https://platform.openai.com/docs/api-reference/chat/create */
   async run<O extends SessionInputOptions<T>>(
     input: SessionInput<T>,
     options: O,
@@ -117,7 +116,6 @@ export class Session<T extends SessionType> {
     const normalize = opts.normalize ?? true;
 
     const result = await core.ops.op_ai_run_model(
-      // @ts-ignore
       this.#model,
       prompt,
       mean_pool,

ext/ai/js/llm/llm_session.ts

@@ -1,9 +1,6 @@
 import { OllamaLLMSession } from "./providers/ollama.ts";
 import { OpenAILLMSession } from "./providers/openai.ts";
 
-// @ts-ignore deno_core environment
-const core = globalThis.Deno.core;
-
 export type LLMRunInput = {
   /**
    * Stream response from model. Applies only for LLMs like `mistral` (default: false)
@@ -45,8 +42,6 @@ export interface ILLMProviderOutput<T = object> {
 }
 
 export interface ILLMProvider {
-  // TODO:(kallebysantos) remove 'any'
-  // TODO: (kallebysantos) standardised output format
   getStream(
     input: ILLMProviderInput,
     signal: AbortSignal,

ext/ai/js/llm/providers/ollama.ts

@@ -45,8 +45,8 @@ export class OllamaLLMSession implements ILLMProvider, ILLMProviderMeta {
       true,
     ) as AsyncGenerator<OllamaMessage>;
 
+    // NOTE:(kallebysantos) we need to clone the lambda parser to avoid `this` conflicts inside the local function*
     const parser = this.parse;
-
     const stream = async function* () {
       for await (const message of generator) {
         if ("error" in message) {

ext/ai/js/llm/providers/openai.ts

@@ -11,10 +11,13 @@ export type OpenAIProviderOptions = ILLMProviderOptions & {
   apiKey?: string;
 };
 
+// NOTE:(kallebysantos) we define all types here for better development as well avoid `"npm:openai"` import
 // TODO:(kallebysantos) need to double check theses AI generated types
 export type OpenAIRequest = {
   model: string;
   messages: {
+    // NOTE:(kallebysantos) using role as union type is great for intellisense suggestions
+    // but at same time it forces users to `{} satisfies Supabase.ai.OpenAICompatibleInput`
     role: "system" | "user" | "assistant" | "tool";
     content: string;
     name?: string;
@@ -39,7 +42,7 @@ export type OpenAIRequest = {
     function: {
       name: string;
       description?: string;
-      parameters: any; // Can be refined based on your function definition
+      parameters: unknown;
     };
   }[];
   tool_choice?: "none" | "auto" | {
@@ -53,14 +56,14 @@ export type OpenAIResponseUsage = {
   completion_tokens: number;
   total_tokens: number;
   prompt_tokens_details: {
-    cached_tokens: 0;
-    audio_tokens: 0;
+    cached_tokens: number;
+    audio_tokens: number;
   };
   completion_tokens_details: {
-    reasoning_tokens: 0;
-    audio_tokens: 0;
-    accepted_prediction_tokens: 0;
-    rejected_prediction_tokens: 0;
+    reasoning_tokens: number;
+    audio_tokens: number;
+    accepted_prediction_tokens: number;
+    rejected_prediction_tokens: number;
   };
 };
 
@@ -117,12 +120,12 @@ export class OpenAILLMSession implements ILLMProvider, ILLMProviderMeta {
       prompt,
       signal,
       true,
-    ) as AsyncGenerator<any>; // TODO:(kallebysantos) remove any
+    ) as AsyncGenerator<OpenAIResponse>;
 
+    // NOTE:(kallebysantos) we need to clone the lambda parser to avoid `this` conflicts inside the local function*
     const parser = this.parse;
     const stream = async function* () {
       for await (const message of generator) {
-        // TODO:(kallebysantos) Simplify duplicated code for stream error checking
         if ("error" in message) {
           if (message.error instanceof Error) {
             throw message.error;
@@ -176,7 +179,7 @@ export class OpenAILLMSession implements ILLMProvider, ILLMProviderMeta {
       value: message.choices.at(0)?.message.content ?? undefined,
       inner: message,
       usage: {
-        // Usage maybe 'null' while streaming, but the final message will include it
+        // NOTE:(kallebysantos) usage maybe 'null' while streaming, but the final message will include it
         inputTokens: usage?.prompt_tokens ?? 0,
         outputTokens: usage?.completion_tokens ?? 0,
         totalTokens: usage?.total_tokens ?? 0,
@@ -218,7 +221,7 @@ export class OpenAILLMSession implements ILLMProvider, ILLMProviderMeta {
     }
 
     if (stream) {
-      return parseJSONOverEventStream(res.body, signal);
+      return parseJSONOverEventStream<OpenAIResponse>(res.body, signal);
     }
 
     const result: OpenAIResponse = await res.json();

ext/ai/js/llm/utils/json_parser.ts

@@ -1,14 +1,14 @@
-import EventSourceStream from './event_source_stream.mjs';
+import EventSourceStream from "./event_source_stream.mjs";
 
 // Adapted from https://github.com/ollama/ollama-js/blob/6a4bfe3ab033f611639dfe4249bdd6b9b19c7256/src/utils.ts#L262
 // TODO:(kallebysantos) need to simplify it
 export async function* parseJSON<T extends object>(
   itr: ReadableStream<Uint8Array>,
   signal: AbortSignal,
 ) {
-  let buffer = '';
+  let buffer = "";
 
-  const decoder = new TextDecoder('utf-8');
+  const decoder = new TextDecoder("utf-8");
   const reader = itr.getReader();
 
   while (true) {
@@ -27,9 +27,9 @@ export async function* parseJSON<T extends object>(
 
       buffer += decoder.decode(value);
 
-      const parts = buffer.split('\n');
+      const parts = buffer.split("\n");
 
-      buffer = parts.pop() ?? '';
+      buffer = parts.pop() ?? "";
 
       for (const part of parts) {
         yield JSON.parse(part) as T;
@@ -39,7 +39,7 @@ export async function* parseJSON<T extends object>(
     }
   }
 
-  for (const part of buffer.split('\n').filter((p) => p !== '')) {
+  for (const part of buffer.split("\n").filter((p) => p !== "")) {
     try {
       yield JSON.parse(part) as T;
     } catch (error) {
@@ -49,7 +49,7 @@ export async function* parseJSON<T extends object>(
 }
 
 // TODO:(kallebysantos) need to simplify it
-export async function* parseJSONOverEventStream(
+export async function* parseJSONOverEventStream<T extends object>(
   itr: ReadableStream<Uint8Array>,
   signal: AbortSignal,
 ) {
@@ -74,7 +74,7 @@ export async function* parseJSONOverEventStream(
         break;
       }
 
-      yield JSON.parse(value.data);
+      yield JSON.parse(value.data) as T;
     } catch (error) {
       yield { error };
     }