[easy][ts] 2/n Set run output type to be Output[] instead of Union

## What Updating the types in the ts sdk to return `Output[]` instead of `Output | Output[]` ## Why Run method should always return a array of outputs, even if its just one output. The Prompt schema already refers to `outputs` as `outputs?: Output[];` anyways ## Testplan Ran tests without errors. No type errors on compilation either
lastmile-ai · Dec 26, 2023 · 83d63eb · 83d63eb
1 parent 534ee8e
commit 83d63eb
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/extensions/HuggingFace/typescript/hf.ts b/extensions/HuggingFace/typescript/hf.ts
@@ -184,7 +184,7 @@ export class HuggingFaceTextGenerationModelParserExtension extends Parameterized
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions | undefined,
     params?: JSONObject | undefined
-  ): Promise<Output | Output[]> {
+  ): Promise<Output[]> {
     const startEvent = {
       name: "on_run_start",
       file: __filename,

diff --git a/extensions/llama/typescript/llama.ts b/extensions/llama/typescript/llama.ts
@@ -351,7 +351,7 @@ export class LlamaModelParser extends ParameterizedModelParser<LlamaCompletionPa
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions | undefined,
     params?: JSONObject | undefined
-  ): Promise<Output | Output[]> {
+  ): Promise<Output[]> {
     const startEvent = {
       name: "on_run_start",
       file: __filename,

diff --git a/typescript/lib/config.ts b/typescript/lib/config.ts
@@ -398,7 +398,7 @@ export class AIConfigRuntime implements AIConfig {
     promptName: string,
     params: JSONObject = {},
     options?: InferenceOptions
-  ) {
+  ): Promise<Output[]> {
     const startEvent = {
       name: "on_run_start",
       file: __filename,
@@ -452,7 +452,7 @@ export class AIConfigRuntime implements AIConfig {
     promptName: string,
     params: JSONObject = {},
     options?: InferenceOptions
-  ) {
+  ): Promise<Output[]> {
     const prompt = this.getPrompt(promptName);
     if (!prompt) {
       throw new Error(

diff --git a/typescript/lib/modelParser.ts b/typescript/lib/modelParser.ts
@@ -89,7 +89,7 @@ export abstract class ModelParser<T = JSONObject, R = T> {
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions,
     params?: JSONObject
-  ): Promise<Output | Output[]>;
+  ): Promise<Output[]>;
 
   /**
    * Get the string representing the output from a prompt.

diff --git a/typescript/lib/parameterizedModelParser.ts b/typescript/lib/parameterizedModelParser.ts
@@ -63,17 +63,23 @@ export abstract class ParameterizedModelParser<
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions,
     params: JSONObject = {}
-  ) {
+  ): Promise<Output[]> {
     const dependencyGraph = getDependencyGraph(aiConfig);
 
-    return await this.runWithDependenciesInternal(
+    const result =  await this.runWithDependenciesInternal(
       promptName,
       aiConfig,
       params,
       dependencyGraph,
       /*alreadyExecutedPrompts*/ new Set<string>(),
       options
     );
+    if (result === undefined) {
+      // Should never happen. If it does, it's a bug. This check is to help define the return type of this function.
+      throw new Error(`runWithDependencies() for Prompt ${promptName} returned undefined, something went wrong`);
+    }
+
+    return result;
   }
 
   private async runWithDependenciesInternal(

diff --git a/typescript/lib/parsers/hf.ts b/typescript/lib/parsers/hf.ts
@@ -176,7 +176,7 @@ export class HuggingFaceTextGenerationParser extends ParameterizedModelParser<Te
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions | undefined,
     params?: JSONObject | undefined
-  ): Promise<Output | Output[]> {
+  ): Promise<Output[]> {
     const startEvent = {
       name: "on_run_start",
       file: __filename,

diff --git a/typescript/lib/parsers/openai.ts b/typescript/lib/parsers/openai.ts
@@ -150,7 +150,7 @@ export class OpenAIModelParser extends ParameterizedModelParser<CompletionCreate
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions,
     params?: JSONObject | undefined
-  ): Promise<Output | Output[]> {
+  ): Promise<Output[]> {
     if (!this.openai) {
       const apiKey = getAPIKeyFromEnv("OPENAI_API_KEY");
       this.openai = new OpenAI({ apiKey, ...(this.openaiOptions || {}) });
@@ -505,7 +505,7 @@ export class OpenAIChatModelParser extends ParameterizedModelParser<Chat.ChatCom
     aiConfig: AIConfigRuntime,
     options?: InferenceOptions,
     params?: JSONObject | undefined
-  ): Promise<Output | Output[]> {
+  ): Promise<Output[]> {
     const startEvent = {
       name: "on_run_start",
       file: __filename,