@browserbasehq/orca 3.0.9-alpha-4 → 3.1.0-headers

package/dist/esm/lib/v3/llm/OpenAIClient.d.ts

@@ -0,0 +1,15 @@
+import { ClientOptions } from "openai";
+import { LogLine } from "../types/public/logs.js";
+import { AvailableModel } from "../types/public/model.js";
+import { CreateChatCompletionOptions, LLMClient, LLMResponse } from "./LLMClient.js";
+export declare class OpenAIClient extends LLMClient {
+    type: "openai";
+    private client;
+    clientOptions: ClientOptions;
+    constructor({ modelName, clientOptions, }: {
+        logger: (message: LogLine) => void;
+        modelName: AvailableModel;
+        clientOptions?: ClientOptions;
+    });
+    createChatCompletion<T = LLMResponse>({ options: optionsInitial, logger, retries, }: CreateChatCompletionOptions): Promise<T>;
+}

package/dist/esm/lib/v3/llm/OpenAIClient.js

@@ -0,0 +1,329 @@
+import OpenAI from "openai";
+import { validateZodSchema } from "../../utils.js";
+import { LLMClient, } from "./LLMClient.js";
+import { CreateChatCompletionResponseError, StagehandError, ZodSchemaValidationError, } from "../types/public/sdkErrors.js";
+import { toJsonSchema } from "../zodCompat.js";
+export class OpenAIClient extends LLMClient {
+    type = "openai";
+    client;
+    constructor({ modelName, clientOptions, }) {
+        super(modelName);
+        this.clientOptions = clientOptions;
+        this.client = new OpenAI(clientOptions);
+        this.modelName = modelName;
+    }
+    async createChatCompletion({ options: optionsInitial, logger, retries = 3, }) {
+        let options = optionsInitial;
+        // O1 models do not support most of the options. So we override them.
+        // For schema and tools, we add them as user messages.
+        let isToolsOverridedForO1 = false;
+        if (this.modelName.startsWith("o1") || this.modelName.startsWith("o3")) {
+            /* eslint-disable */
+            // Remove unsupported options
+            let { tool_choice, top_p, frequency_penalty, presence_penalty, temperature, } = options;
+            ({
+                tool_choice,
+                top_p,
+                frequency_penalty,
+                presence_penalty,
+                temperature,
+                ...options
+            } = options);
+            /* eslint-enable */
+            // Remove unsupported options
+            options.messages = options.messages.map((message) => ({
+                ...message,
+                role: "user",
+            }));
+            if (options.tools && options.response_model) {
+                throw new StagehandError("Cannot use both tool and response_model for o1 models");
+            }
+            if (options.tools) {
+                // Remove unsupported options
+                const { tools, ...rest } = options;
+                options = rest;
+                isToolsOverridedForO1 = true;
+                options.messages.push({
+                    role: "user",
+                    content: `You have the following tools available to you:\n${JSON.stringify(tools)}
+
+          Respond with the following zod schema format to use a method: {
+            "name": "<tool_name>",
+            "arguments": <tool_args>
+          }
+          
+          Do not include any other text or formattings like \`\`\` in your response. Just the JSON object.`,
+                });
+            }
+        }
+        if (options.temperature &&
+            (this.modelName.startsWith("o1") || this.modelName.startsWith("o3"))) {
+            throw new StagehandError("Temperature is not supported for o1 models");
+        }
+        const { requestId, ...optionsWithoutImageAndRequestId } = options;
+        logger({
+            category: "openai",
+            message: "creating chat completion",
+            level: 2,
+            auxiliary: {
+                options: {
+                    value: JSON.stringify({
+                        ...optionsWithoutImageAndRequestId,
+                        requestId,
+                    }),
+                    type: "object",
+                },
+                modelName: {
+                    value: this.modelName,
+                    type: "string",
+                },
+            },
+        });
+        if (options.image) {
+            const screenshotMessage = {
+                role: "user",
+                content: [
+                    {
+                        type: "image_url",
+                        image_url: {
+                            url: `data:image/jpeg;base64,${options.image.buffer.toString("base64")}`,
+                        },
+                    },
+                    ...(options.image.description
+                        ? [{ type: "text", text: options.image.description }]
+                        : []),
+                ],
+            };
+            options.messages.push(screenshotMessage);
+        }
+        let responseFormat;
+        if (options.response_model) {
+            // For O1 models, we need to add the schema as a user message.
+            if (this.modelName.startsWith("o1") || this.modelName.startsWith("o3")) {
+                try {
+                    const parsedSchema = JSON.stringify(toJsonSchema(options.response_model.schema));
+                    options.messages.push({
+                        role: "user",
+                        content: `Respond in this zod schema format:\n${parsedSchema}\n
+
+          Do not include any other text, formatting or markdown in your output. Do not include \`\`\` or \`\`\`json in your response. Only the JSON object itself.`,
+                    });
+                }
+                catch (error) {
+                    logger({
+                        category: "openai",
+                        message: "Failed to parse response model schema",
+                        level: 0,
+                    });
+                    if (retries > 0) {
+                        // as-casting to account for o1 models not supporting all options
+                        return this.createChatCompletion({
+                            options: options,
+                            logger,
+                            retries: retries - 1,
+                        });
+                    }
+                    throw error;
+                }
+            }
+            else {
+                responseFormat = {
+                    type: "json_schema",
+                    json_schema: {
+                        name: options.response_model.name,
+                        schema: toJsonSchema(options.response_model.schema),
+                    },
+                };
+            }
+        }
+        /* eslint-disable */
+        // Remove unsupported options
+        const { response_model, ...openAiOptions } = {
+            ...optionsWithoutImageAndRequestId,
+            model: this.modelName,
+        };
+        /* eslint-enable */
+        logger({
+            category: "openai",
+            message: "creating chat completion",
+            level: 2,
+            auxiliary: {
+                openAiOptions: {
+                    value: JSON.stringify(openAiOptions),
+                    type: "object",
+                },
+            },
+        });
+        const formattedMessages = options.messages.map((message) => {
+            if (Array.isArray(message.content)) {
+                const contentParts = message.content.map((content) => {
+                    if ("image_url" in content) {
+                        const imageContent = {
+                            image_url: {
+                                url: content.image_url.url,
+                            },
+                            type: "image_url",
+                        };
+                        return imageContent;
+                    }
+                    else {
+                        const textContent = {
+                            text: content.text,
+                            type: "text",
+                        };
+                        return textContent;
+                    }
+                });
+                if (message.role === "system") {
+                    const formattedMessage = {
+                        ...message,
+                        role: "system",
+                        content: contentParts.filter((content) => content.type === "text"),
+                    };
+                    return formattedMessage;
+                }
+                else if (message.role === "user") {
+                    const formattedMessage = {
+                        ...message,
+                        role: "user",
+                        content: contentParts,
+                    };
+                    return formattedMessage;
+                }
+                else {
+                    const formattedMessage = {
+                        ...message,
+                        role: "assistant",
+                        content: contentParts.filter((content) => content.type === "text"),
+                    };
+                    return formattedMessage;
+                }
+            }
+            const formattedMessage = {
+                role: "user",
+                content: message.content,
+            };
+            return formattedMessage;
+        });
+        const body = {
+            ...openAiOptions,
+            model: this.modelName,
+            messages: formattedMessages,
+            response_format: responseFormat,
+            stream: false,
+            tools: options.tools?.map((tool) => ({
+                function: {
+                    name: tool.name,
+                    description: tool.description,
+                    parameters: tool.parameters,
+                },
+                type: "function",
+            })),
+        };
+        const response = await this.client.chat.completions.create(body);
+        // For O1 models, we need to parse the tool call response manually and add it to the response.
+        if (isToolsOverridedForO1) {
+            try {
+                const parsedContent = JSON.parse(response.choices[0].message.content);
+                response.choices[0].message.tool_calls = [
+                    {
+                        function: {
+                            name: parsedContent["name"],
+                            arguments: JSON.stringify(parsedContent["arguments"]),
+                        },
+                        type: "function",
+                        id: "-1",
+                    },
+                ];
+                response.choices[0].message.content = null;
+            }
+            catch (error) {
+                logger({
+                    category: "openai",
+                    message: "Failed to parse tool call response",
+                    level: 0,
+                    auxiliary: {
+                        error: {
+                            value: error.message,
+                            type: "string",
+                        },
+                        content: {
+                            value: response.choices[0].message.content,
+                            type: "string",
+                        },
+                    },
+                });
+                if (retries > 0) {
+                    // as-casting to account for o1 models not supporting all options
+                    return this.createChatCompletion({
+                        options: options,
+                        logger,
+                        retries: retries - 1,
+                    });
+                }
+                throw error;
+            }
+        }
+        logger({
+            category: "openai",
+            message: "response",
+            level: 2,
+            auxiliary: {
+                response: {
+                    value: JSON.stringify(response),
+                    type: "object",
+                },
+                requestId: {
+                    value: requestId,
+                    type: "string",
+                },
+            },
+        });
+        if (options.response_model) {
+            const extractedData = response.choices[0].message.content;
+            const parsedData = JSON.parse(extractedData);
+            try {
+                validateZodSchema(options.response_model.schema, parsedData);
+            }
+            catch (e) {
+                logger({
+                    category: "openai",
+                    message: "Response failed Zod schema validation",
+                    level: 0,
+                });
+                if (retries > 0) {
+                    // as-casting to account for o1 models not supporting all options
+                    return this.createChatCompletion({
+                        options: options,
+                        logger,
+                        retries: retries - 1,
+                    });
+                }
+                if (e instanceof ZodSchemaValidationError) {
+                    logger({
+                        category: "openai",
+                        message: `Error during OpenAI chat completion: ${e.message}`,
+                        level: 0,
+                        auxiliary: {
+                            errorDetails: {
+                                value: `Message: ${e.message}${e.stack ? "\nStack: " + e.stack : ""}`,
+                                type: "string",
+                            },
+                            requestId: { value: requestId, type: "string" },
+                        },
+                    });
+                    throw new CreateChatCompletionResponseError(e.message);
+                }
+                throw e;
+            }
+            return {
+                data: parsedData,
+                usage: response.usage,
+            };
+        }
+        // if the function was called with a response model, it would have returned earlier
+        // so we can safely cast here to T, which defaults to ChatCompletion
+        return response;
+    }
+}
+//# sourceMappingURL=OpenAIClient.js.map

package/dist/esm/lib/v3/llm/OpenAIClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAIClient.js","sourceRoot":"","sources":["../../../../../lib/v3/llm/OpenAIClient.ts"],"names":[],"mappings":"AAAA,OAAO,MAAyB,MAAM,QAAQ,CAAC;AAY/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAIL,SAAS,GAEV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,iCAAiC,EACjC,cAAc,EACd,wBAAwB,GACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,OAAO,YAAa,SAAQ,SAAS;IAClC,IAAI,GAAG,QAAiB,CAAC;IACxB,MAAM,CAAS;IAGvB,YAAY,EACV,SAAS,EACT,aAAa,GAKd;QACC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAkB,EAC1C,OAAO,EAAE,cAAc,EACvB,MAAM,EACN,OAAO,GAAG,CAAC,GACiB;QAC5B,IAAI,OAAO,GAAmC,cAAc,CAAC;QAE7D,qEAAqE;QACrE,sDAAsD;QACtD,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACvE,oBAAoB;YACpB,6BAA6B;YAC7B,IAAI,EACF,WAAW,EACX,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,GACZ,GAAG,OAAO,CAAC;YACZ,CAAC;gBACC,WAAW;gBACX,KAAK;gBACL,iBAAiB;gBACjB,gBAAgB;gBAChB,WAAW;gBACX,GAAG,OAAO;aACX,GAAG,OAAO,CAAC,CAAC;YACb,mBAAmB;YACnB,6BAA6B;YAC7B,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBACpD,GAAG,OAAO;gBACV,IAAI,EAAE,MAAM;aACb,CAAC,CAAC,CAAC;YACJ,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5C,MAAM,IAAI,cAAc,CACtB,uDAAuD,CACxD,CAAC;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,6BAA6B;gBAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;gBACnC,OAAO,GAAG,IAAI,CAAC;gBACf,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACpB,IAAI,EAAE,MAAM;oBACZ,OAAO,EAAE,mDAAmD,IAAI,CAAC,SAAS,CACxE,KAAK,CACN;;;;;;;2GAOgG;iBAClG,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,IACE,OAAO,CAAC,WAAW;YACnB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EACpE,CAAC;YACD,MAAM,IAAI,cAAc,CAAC,4CAA4C,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,+BAA+B,EAAE,GAAG,OAAO,CAAC;QAElE,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,OAAO,EAAE;oBACP,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,GAAG,+BAA+B;wBAClC,SAAS;qBACV,CAAC;oBACF,IAAI,EAAE,QAAQ;iBACf;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,IAAI,CAAC,SAAS;oBACrB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,iBAAiB,GAAgB;gBACrC,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,WAAW;wBACjB,SAAS,EAAE;4BACT,GAAG,EAAE,0BAA0B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;yBACzE;qBACF;oBACD,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW;wBAC3B,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;wBACrD,CAAC,CAAC,EAAE,CAAC;iBACR;aACF,CAAC;YAEF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,cAES,CAAC;QACd,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,8DAA8D;YAC9D,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC;oBACH,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CACjC,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAC5C,CAAC;oBACF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACpB,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE,uCAAuC,YAAY;;mKAE2F;qBACxJ,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC;wBACL,QAAQ,EAAE,QAAQ;wBAClB,OAAO,EAAE,uCAAuC;wBAChD,KAAK,EAAE,CAAC;qBACT,CAAC,CAAC;oBAEH,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;wBAChB,iEAAiE;wBACjE,OAAO,IAAI,CAAC,oBAAoB,CAAC;4BAC/B,OAAO,EAAE,OAAgC;4BACzC,MAAM;4BACN,OAAO,EAAE,OAAO,GAAG,CAAC;yBACrB,CAAC,CAAC;oBACL,CAAC;oBAED,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,cAAc,GAAG;oBACf,IAAI,EAAE,aAAa;oBACnB,WAAW,EAAE;wBACX,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI;wBACjC,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC;qBACpD;iBACF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,oBAAoB;QACpB,6BAA6B;QAC7B,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE,GAAG;YAC3C,GAAG,+BAA+B;YAClC,KAAK,EAAE,IAAI,CAAC,SAAS;SACtB,CAAC;QACF,mBAAmB;QAEnB,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,aAAa,EAAE;oBACb,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;oBACpC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,MAAM,iBAAiB,GACrB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;oBACnD,IAAI,WAAW,IAAI,OAAO,EAAE,CAAC;wBAC3B,MAAM,YAAY,GAAmC;4BACnD,SAAS,EAAE;gCACT,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;6BAC3B;4BACD,IAAI,EAAE,WAAW;yBAClB,CAAC;wBACF,OAAO,YAAY,CAAC;oBACtB,CAAC;yBAAM,CAAC;wBACN,MAAM,WAAW,GAAkC;4BACjD,IAAI,EAAE,OAAO,CAAC,IAAI;4BAClB,IAAI,EAAE,MAAM;yBACb,CAAC;wBACF,OAAO,WAAW,CAAC;oBACrB,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC9B,MAAM,gBAAgB,GAAqC;wBACzD,GAAG,OAAO;wBACV,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,YAAY,CAAC,MAAM,CAC1B,CAAC,OAAO,EAA4C,EAAE,CACpD,OAAO,CAAC,IAAI,KAAK,MAAM,CAC1B;qBACF,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;qBAAM,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBACnC,MAAM,gBAAgB,GAAmC;wBACvD,GAAG,OAAO;wBACV,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE,YAAY;qBACtB,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,MAAM,gBAAgB,GAAwC;wBAC5D,GAAG,OAAO;wBACV,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,YAAY,CAAC,MAAM,CAC1B,CAAC,OAAO,EAA4C,EAAE,CACpD,OAAO,CAAC,IAAI,KAAK,MAAM,CAC1B;qBACF,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,MAAM,gBAAgB,GAAmC;gBACvD,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;YAEF,OAAO,gBAAgB,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEL,MAAM,IAAI,GAA2C;YACnD,GAAG,aAAa;YAChB,KAAK,EAAE,IAAI,CAAC,SAAS;YACrB,QAAQ,EAAE,iBAAiB;YAC3B,eAAe,EAAE,cAAc;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACnC,QAAQ,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,WAAW,EAAE,IAAI,CAAC,WAAW;oBAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;iBAC5B;gBACD,IAAI,EAAE,UAAU;aACjB,CAAC,CAAC;SACJ,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEjE,8FAA8F;QAC9F,IAAI,qBAAqB,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACH,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAEtE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,GAAG;oBACvC;wBACE,QAAQ,EAAE;4BACR,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;4BAC3B,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;yBACtD;wBACD,IAAI,EAAE,UAAU;wBAChB,EAAE,EAAE,IAAI;qBACT;iBACF,CAAC;gBACF,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;YAC7C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC;oBACL,QAAQ,EAAE,QAAQ;oBAClB,OAAO,EAAE,oCAAoC;oBAC7C,KAAK,EAAE,CAAC;oBACR,SAAS,EAAE;wBACT,KAAK,EAAE;4BACL,KAAK,EAAE,KAAK,CAAC,OAAO;4BACpB,IAAI,EAAE,QAAQ;yBACf;wBACD,OAAO,EAAE;4BACP,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO;4BAC1C,IAAI,EAAE,QAAQ;yBACf;qBACF;iBACF,CAAC,CAAC;gBAEH,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;oBAChB,iEAAiE;oBACjE,OAAO,IAAI,CAAC,oBAAoB,CAAC;wBAC/B,OAAO,EAAE,OAAgC;wBACzC,MAAM;wBACN,OAAO,EAAE,OAAO,GAAG,CAAC;qBACrB,CAAC,CAAC;gBACL,CAAC;gBAED,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,QAAQ,EAAE;oBACR,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE7C,IAAI,CAAC;gBACH,iBAAiB,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAC/D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC;oBACL,QAAQ,EAAE,QAAQ;oBAClB,OAAO,EAAE,uCAAuC;oBAChD,KAAK,EAAE,CAAC;iBACT,CAAC,CAAC;gBACH,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;oBAChB,iEAAiE;oBACjE,OAAO,IAAI,CAAC,oBAAoB,CAAC;wBAC/B,OAAO,EAAE,OAAgC;wBACzC,MAAM;wBACN,OAAO,EAAE,OAAO,GAAG,CAAC;qBACrB,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,YAAY,wBAAwB,EAAE,CAAC;oBAC1C,MAAM,CAAC;wBACL,QAAQ,EAAE,QAAQ;wBAClB,OAAO,EAAE,wCAAwC,CAAC,CAAC,OAAO,EAAE;wBAC5D,KAAK,EAAE,CAAC;wBACR,SAAS,EAAE;4BACT,YAAY,EAAE;gCACZ,KAAK,EAAE,YAAY,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gCACrE,IAAI,EAAE,QAAQ;6BACf;4BACD,SAAS,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;yBAChD;qBACF,CAAC,CAAC;oBACH,MAAM,IAAI,iCAAiC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACzD,CAAC;gBACD,MAAM,CAAC,CAAC;YACV,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE,QAAQ,CAAC,KAAK;aACjB,CAAC;QACT,CAAC;QAED,mFAAmF;QACnF,oEAAoE;QACpE,OAAO,QAAa,CAAC;IACvB,CAAC;CACF","sourcesContent":["import OpenAI, { ClientOptions } from \"openai\";\nimport {\n  ChatCompletionAssistantMessageParam,\n  ChatCompletionContentPartImage,\n  ChatCompletionContentPartText,\n  ChatCompletionCreateParamsNonStreaming,\n  ChatCompletionMessageParam,\n  ChatCompletionSystemMessageParam,\n  ChatCompletionUserMessageParam,\n} from \"openai/resources/chat\";\nimport { LogLine } from \"../types/public/logs.js\";\nimport { AvailableModel } from \"../types/public/model.js\";\nimport { validateZodSchema } from \"../../utils.js\";\nimport {\n  ChatCompletionOptions,\n  ChatMessage,\n  CreateChatCompletionOptions,\n  LLMClient,\n  LLMResponse,\n} from \"./LLMClient.js\";\nimport {\n  CreateChatCompletionResponseError,\n  StagehandError,\n  ZodSchemaValidationError,\n} from \"../types/public/sdkErrors.js\";\nimport { toJsonSchema } from \"../zodCompat.js\";\n\nexport class OpenAIClient extends LLMClient {\n  public type = \"openai\" as const;\n  private client: OpenAI;\n  declare public clientOptions: ClientOptions;\n\n  constructor({\n    modelName,\n    clientOptions,\n  }: {\n    logger: (message: LogLine) => void;\n    modelName: AvailableModel;\n    clientOptions?: ClientOptions;\n  }) {\n    super(modelName);\n    this.clientOptions = clientOptions;\n    this.client = new OpenAI(clientOptions);\n    this.modelName = modelName;\n  }\n\n  async createChatCompletion<T = LLMResponse>({\n    options: optionsInitial,\n    logger,\n    retries = 3,\n  }: CreateChatCompletionOptions): Promise<T> {\n    let options: Partial<ChatCompletionOptions> = optionsInitial;\n\n    // O1 models do not support most of the options. So we override them.\n    // For schema and tools, we add them as user messages.\n    let isToolsOverridedForO1 = false;\n    if (this.modelName.startsWith(\"o1\") || this.modelName.startsWith(\"o3\")) {\n      /* eslint-disable */\n      // Remove unsupported options\n      let {\n        tool_choice,\n        top_p,\n        frequency_penalty,\n        presence_penalty,\n        temperature,\n      } = options;\n      ({\n        tool_choice,\n        top_p,\n        frequency_penalty,\n        presence_penalty,\n        temperature,\n        ...options\n      } = options);\n      /* eslint-enable */\n      // Remove unsupported options\n      options.messages = options.messages.map((message) => ({\n        ...message,\n        role: \"user\",\n      }));\n      if (options.tools && options.response_model) {\n        throw new StagehandError(\n          \"Cannot use both tool and response_model for o1 models\",\n        );\n      }\n\n      if (options.tools) {\n        // Remove unsupported options\n        const { tools, ...rest } = options;\n        options = rest;\n        isToolsOverridedForO1 = true;\n        options.messages.push({\n          role: \"user\",\n          content: `You have the following tools available to you:\\n${JSON.stringify(\n            tools,\n          )}\n\n          Respond with the following zod schema format to use a method: {\n            \"name\": \"<tool_name>\",\n            \"arguments\": <tool_args>\n          }\n          \n          Do not include any other text or formattings like \\`\\`\\` in your response. Just the JSON object.`,\n        });\n      }\n    }\n    if (\n      options.temperature &&\n      (this.modelName.startsWith(\"o1\") || this.modelName.startsWith(\"o3\"))\n    ) {\n      throw new StagehandError(\"Temperature is not supported for o1 models\");\n    }\n\n    const { requestId, ...optionsWithoutImageAndRequestId } = options;\n\n    logger({\n      category: \"openai\",\n      message: \"creating chat completion\",\n      level: 2,\n      auxiliary: {\n        options: {\n          value: JSON.stringify({\n            ...optionsWithoutImageAndRequestId,\n            requestId,\n          }),\n          type: \"object\",\n        },\n        modelName: {\n          value: this.modelName,\n          type: \"string\",\n        },\n      },\n    });\n\n    if (options.image) {\n      const screenshotMessage: ChatMessage = {\n        role: \"user\",\n        content: [\n          {\n            type: \"image_url\",\n            image_url: {\n              url: `data:image/jpeg;base64,${options.image.buffer.toString(\"base64\")}`,\n            },\n          },\n          ...(options.image.description\n            ? [{ type: \"text\", text: options.image.description }]\n            : []),\n        ],\n      };\n\n      options.messages.push(screenshotMessage);\n    }\n\n    let responseFormat:\n      | ChatCompletionCreateParamsNonStreaming[\"response_format\"]\n      | undefined;\n    if (options.response_model) {\n      // For O1 models, we need to add the schema as a user message.\n      if (this.modelName.startsWith(\"o1\") || this.modelName.startsWith(\"o3\")) {\n        try {\n          const parsedSchema = JSON.stringify(\n            toJsonSchema(options.response_model.schema),\n          );\n          options.messages.push({\n            role: \"user\",\n            content: `Respond in this zod schema format:\\n${parsedSchema}\\n\n\n          Do not include any other text, formatting or markdown in your output. Do not include \\`\\`\\` or \\`\\`\\`json in your response. Only the JSON object itself.`,\n          });\n        } catch (error) {\n          logger({\n            category: \"openai\",\n            message: \"Failed to parse response model schema\",\n            level: 0,\n          });\n\n          if (retries > 0) {\n            // as-casting to account for o1 models not supporting all options\n            return this.createChatCompletion({\n              options: options as ChatCompletionOptions,\n              logger,\n              retries: retries - 1,\n            });\n          }\n\n          throw error;\n        }\n      } else {\n        responseFormat = {\n          type: \"json_schema\",\n          json_schema: {\n            name: options.response_model.name,\n            schema: toJsonSchema(options.response_model.schema),\n          },\n        };\n      }\n    }\n\n    /* eslint-disable */\n    // Remove unsupported options\n    const { response_model, ...openAiOptions } = {\n      ...optionsWithoutImageAndRequestId,\n      model: this.modelName,\n    };\n    /* eslint-enable */\n\n    logger({\n      category: \"openai\",\n      message: \"creating chat completion\",\n      level: 2,\n      auxiliary: {\n        openAiOptions: {\n          value: JSON.stringify(openAiOptions),\n          type: \"object\",\n        },\n      },\n    });\n\n    const formattedMessages: ChatCompletionMessageParam[] =\n      options.messages.map((message) => {\n        if (Array.isArray(message.content)) {\n          const contentParts = message.content.map((content) => {\n            if (\"image_url\" in content) {\n              const imageContent: ChatCompletionContentPartImage = {\n                image_url: {\n                  url: content.image_url.url,\n                },\n                type: \"image_url\",\n              };\n              return imageContent;\n            } else {\n              const textContent: ChatCompletionContentPartText = {\n                text: content.text,\n                type: \"text\",\n              };\n              return textContent;\n            }\n          });\n\n          if (message.role === \"system\") {\n            const formattedMessage: ChatCompletionSystemMessageParam = {\n              ...message,\n              role: \"system\",\n              content: contentParts.filter(\n                (content): content is ChatCompletionContentPartText =>\n                  content.type === \"text\",\n              ),\n            };\n            return formattedMessage;\n          } else if (message.role === \"user\") {\n            const formattedMessage: ChatCompletionUserMessageParam = {\n              ...message,\n              role: \"user\",\n              content: contentParts,\n            };\n            return formattedMessage;\n          } else {\n            const formattedMessage: ChatCompletionAssistantMessageParam = {\n              ...message,\n              role: \"assistant\",\n              content: contentParts.filter(\n                (content): content is ChatCompletionContentPartText =>\n                  content.type === \"text\",\n              ),\n            };\n            return formattedMessage;\n          }\n        }\n\n        const formattedMessage: ChatCompletionUserMessageParam = {\n          role: \"user\",\n          content: message.content,\n        };\n\n        return formattedMessage;\n      });\n\n    const body: ChatCompletionCreateParamsNonStreaming = {\n      ...openAiOptions,\n      model: this.modelName,\n      messages: formattedMessages,\n      response_format: responseFormat,\n      stream: false,\n      tools: options.tools?.map((tool) => ({\n        function: {\n          name: tool.name,\n          description: tool.description,\n          parameters: tool.parameters,\n        },\n        type: \"function\",\n      })),\n    };\n\n    const response = await this.client.chat.completions.create(body);\n\n    // For O1 models, we need to parse the tool call response manually and add it to the response.\n    if (isToolsOverridedForO1) {\n      try {\n        const parsedContent = JSON.parse(response.choices[0].message.content);\n\n        response.choices[0].message.tool_calls = [\n          {\n            function: {\n              name: parsedContent[\"name\"],\n              arguments: JSON.stringify(parsedContent[\"arguments\"]),\n            },\n            type: \"function\",\n            id: \"-1\",\n          },\n        ];\n        response.choices[0].message.content = null;\n      } catch (error) {\n        logger({\n          category: \"openai\",\n          message: \"Failed to parse tool call response\",\n          level: 0,\n          auxiliary: {\n            error: {\n              value: error.message,\n              type: \"string\",\n            },\n            content: {\n              value: response.choices[0].message.content,\n              type: \"string\",\n            },\n          },\n        });\n\n        if (retries > 0) {\n          // as-casting to account for o1 models not supporting all options\n          return this.createChatCompletion({\n            options: options as ChatCompletionOptions,\n            logger,\n            retries: retries - 1,\n          });\n        }\n\n        throw error;\n      }\n    }\n\n    logger({\n      category: \"openai\",\n      message: \"response\",\n      level: 2,\n      auxiliary: {\n        response: {\n          value: JSON.stringify(response),\n          type: \"object\",\n        },\n        requestId: {\n          value: requestId,\n          type: \"string\",\n        },\n      },\n    });\n\n    if (options.response_model) {\n      const extractedData = response.choices[0].message.content;\n      const parsedData = JSON.parse(extractedData);\n\n      try {\n        validateZodSchema(options.response_model.schema, parsedData);\n      } catch (e) {\n        logger({\n          category: \"openai\",\n          message: \"Response failed Zod schema validation\",\n          level: 0,\n        });\n        if (retries > 0) {\n          // as-casting to account for o1 models not supporting all options\n          return this.createChatCompletion({\n            options: options as ChatCompletionOptions,\n            logger,\n            retries: retries - 1,\n          });\n        }\n\n        if (e instanceof ZodSchemaValidationError) {\n          logger({\n            category: \"openai\",\n            message: `Error during OpenAI chat completion: ${e.message}`,\n            level: 0,\n            auxiliary: {\n              errorDetails: {\n                value: `Message: ${e.message}${e.stack ? \"\\nStack: \" + e.stack : \"\"}`,\n                type: \"string\",\n              },\n              requestId: { value: requestId, type: \"string\" },\n            },\n          });\n          throw new CreateChatCompletionResponseError(e.message);\n        }\n        throw e;\n      }\n\n      return {\n        data: parsedData,\n        usage: response.usage,\n      } as T;\n    }\n\n    // if the function was called with a response model, it would have returned earlier\n    // so we can safely cast here to T, which defaults to ChatCompletion\n    return response as T;\n  }\n}\n"]}

package/dist/esm/lib/v3/llm/aisdk.d.ts

@@ -0,0 +1,15 @@
+import type { LanguageModelV2 } from "@ai-sdk/provider";
+import { ChatCompletion } from "openai/resources";
+import { LogLine } from "../types/public/logs.js";
+import { CreateChatCompletionOptions, LLMClient } from "./LLMClient.js";
+export declare class AISdkClient extends LLMClient {
+    type: "aisdk";
+    private model;
+    private logger?;
+    constructor({ model, logger, }: {
+        model: LanguageModelV2;
+        logger?: (message: LogLine) => void;
+    });
+    getLanguageModel(): LanguageModelV2;
+    createChatCompletion<T = ChatCompletion>({ options, }: CreateChatCompletionOptions): Promise<T>;
+}