allow free modelclientoptions

Author: sameelarif

lib/index.ts

@@ -595,14 +595,11 @@ export class Stagehand {
         // Temporary add for legacy providers
         modelApiKey =
           LLMProvider.getModelProvider(this.modelName) === "openai"
-            ? process.env.OPENAI_API_KEY ||
-              this.llmClient?.clientOptions?.apiKey
+            ? process.env.OPENAI_API_KEY
             : LLMProvider.getModelProvider(this.modelName) === "anthropic"
-              ? process.env.ANTHROPIC_API_KEY ||
-                this.llmClient?.clientOptions?.apiKey
+              ? process.env.ANTHROPIC_API_KEY
               : LLMProvider.getModelProvider(this.modelName) === "google"
-                ? process.env.GOOGLE_API_KEY ||
-                  this.llmClient?.clientOptions?.apiKey
+                ? process.env.GOOGLE_API_KEY
                 : undefined;
       }
       this.modelClientOptions = {

lib/llm/AnthropicClient.ts

@@ -1,3 +1,4 @@
+import { CreateChatCompletionResponseError } from "@/types/stagehandErrors";
 import Anthropic, { ClientOptions } from "@anthropic-ai/sdk";
 import {
   ImageBlockParam,
@@ -14,14 +15,13 @@ import {
   LLMClient,
   LLMResponse,
 } from "./LLMClient";
-import { CreateChatCompletionResponseError } from "@/types/stagehandErrors";
 
 export class AnthropicClient extends LLMClient {
   public type = "anthropic" as const;
   private client: Anthropic;
   private cache: LLMCache | undefined;
   private enableCaching: boolean;
-  public clientOptions: ClientOptions;
+  public clientOptions?: ClientOptions;
 
   constructor({
     enableCaching = false,

lib/llm/CerebrasClient.ts

@@ -1,5 +1,6 @@
-import OpenAI from "openai";
+import { CreateChatCompletionResponseError } from "@/types/stagehandErrors";
 import type { ClientOptions } from "openai";
+import OpenAI from "openai";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { LogLine } from "../../types/log";
 import { AvailableModel } from "../../types/model";
@@ -10,14 +11,13 @@ import {
   LLMClient,
   LLMResponse,
 } from "./LLMClient";
-import { CreateChatCompletionResponseError } from "@/types/stagehandErrors";
 
 export class CerebrasClient extends LLMClient {
   public type = "cerebras" as const;
   private client: OpenAI;
   private cache: LLMCache | undefined;
   private enableCaching: boolean;
-  public clientOptions: ClientOptions;
+  public clientOptions?: ClientOptions;
   public hasVision = false;
 
   constructor({
@@ -31,7 +31,7 @@ export class CerebrasClient extends LLMClient {
     enableCaching?: boolean;
     cache?: LLMCache;
     modelName: AvailableModel;
-    clientOptions?: ClientOptions;
+    clientOptions?: OpenAI.ClientOptions;
     userProvidedInstructions?: string;
   }) {
     super(modelName, userProvidedInstructions);

lib/llm/LLMClient.ts

@@ -1,18 +1,18 @@
-import { ZodType } from "zod/v3";
-import { LLMTool } from "../../types/llm";
-import { LogLine } from "../../types/log";
-import { AvailableModel, ClientOptions } from "../../types/model";
 import {
-  generateObject,
-  generateText,
-  streamText,
-  streamObject,
-  experimental_generateImage,
   embed,
   embedMany,
-  experimental_transcribe,
+  experimental_generateImage,
   experimental_generateSpeech,
+  experimental_transcribe,
+  generateObject,
+  generateText,
+  streamObject,
+  streamText,
 } from "ai";
+import { ZodType } from "zod/v3";
+import { LLMTool } from "../../types/llm";
+import { LogLine } from "../../types/log";
+import { AvailableModel } from "../../types/model";
 
 export interface ChatMessage {
   role: "system" | "user" | "assistant";
@@ -100,7 +100,6 @@ export abstract class LLMClient {
   public type: "openai" | "anthropic" | "cerebras" | "groq" | (string & {});
   public modelName: AvailableModel | (string & {});
   public hasVision: boolean;
-  public clientOptions: ClientOptions;
   public userProvidedInstructions?: string;
 
   constructor(modelName: AvailableModel, userProvidedInstructions?: string) {

lib/llm/LLMProvider.ts

@@ -97,18 +97,18 @@ const modelToProviderMap: { [key in AvailableModel]: ModelProvider } = {
 export function getAISDKLanguageModel(
   subProvider: string,
   subModelName: string,
-  apiKey?: string,
+  modelClientOptions?: ClientOptions,
 ) {
-  if (apiKey) {
+  if (modelClientOptions && Object.keys(modelClientOptions).length > 0) {
     const creator = AISDKProvidersWithAPIKey[subProvider];
     if (!creator) {
       throw new UnsupportedAISDKModelProviderError(
         subProvider,
         Object.keys(AISDKProvidersWithAPIKey),
       );
     }
-    // Create the provider instance with the API key
-    const provider = creator({ apiKey });
+    // Create the provider instance with the custom configuration options
+    const provider = creator(modelClientOptions);
     // Get the specific model from the provider
     return provider(subModelName);
   } else {
@@ -165,7 +165,7 @@ export class LLMProvider {
       const languageModel = getAISDKLanguageModel(
         subProvider,
         subModelName,
-        clientOptions?.apiKey,
+        clientOptions,
       );
 
       return new AISdkClient({

lib/llm/OpenAIClient.ts

@@ -1,3 +1,8 @@
+import {
+  CreateChatCompletionResponseError,
+  StagehandError,
+  ZodSchemaValidationError,
+} from "@/types/stagehandErrors";
 import OpenAI, { ClientOptions } from "openai";
 import { zodResponseFormat } from "openai/helpers/zod";
 import {
@@ -21,11 +26,6 @@ import {
   LLMClient,
   LLMResponse,
 } from "./LLMClient";
-import {
-  CreateChatCompletionResponseError,
-  StagehandError,
-  ZodSchemaValidationError,
-} from "@/types/stagehandErrors";
 
 export class OpenAIClient extends LLMClient {
   public type = "openai" as const;

types/llm.ts

@@ -1,4 +1,5 @@
 import { LanguageModel } from "ai";
+import { ClientOptions } from "./model";
 
 export interface LLMTool {
   type: "function";
@@ -9,6 +10,4 @@ export interface LLMTool {
 
 export type AISDKProvider = (modelName: string) => LanguageModel;
 // Represents a function that takes options (like apiKey) and returns an AISDKProvider
-export type AISDKCustomProvider = (options: {
-  apiKey: string;
-}) => AISDKProvider;
+export type AISDKCustomProvider = (options: ClientOptions) => AISDKProvider;

types/model.ts

@@ -44,7 +44,10 @@ export type ModelProvider =
   | "google"
   | "aisdk";
 
-export type ClientOptions = OpenAIClientOptions | AnthropicClientOptions;
+export type ClientOptions =
+  | Record<string, string>
+  | OpenAIClientOptions
+  | AnthropicClientOptions;
 
 export interface AnthropicJsonSchemaObject {
   definitions?: {