@hyperbrowser/sdk/dist/tools/openai.d.ts

Node SDK for Hyperbrowser API

export type FunctionParameters = Record<string, unknown>;
export interface FunctionDefinition {
    /**
     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
     * underscores and dashes, with a maximum length of 64.
     */
    name: string;
    /**
     * A description of what the function does, used by the model to choose when and
     * how to call the function.
     */
    description?: string;
    /**
     * The parameters the functions accepts, described as a JSON Schema object. See the
     * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
     * and the
     * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
     * documentation about the format.
     *
     * Omitting `parameters` defines a function with an empty parameter list.
     */
    parameters?: FunctionParameters;
    /**
     * Whether to enable strict schema adherence when generating the function call. If
     * set to true, the model will follow the exact schema defined in the `parameters`
     * field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
     * more about Structured Outputs in the
     * [function calling guide](docs/guides/function-calling).
     */
    strict?: boolean | null;
}
export interface ChatCompletionTool {
    function: FunctionDefinition;
    /**
     * The type of the tool. Currently, only `function` is supported.
     */
    type: "function";
}
export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
export declare const SCREENSHOT_TOOL_OPENAI: ChatCompletionTool;
export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;
export declare const EXTRACT_TOOL_OPENAI: ChatCompletionTool;
export declare const BROWSER_USE_TOOL_OPENAI: ChatCompletionTool;