@openrouter/sdk 0.10.2 → 0.11.2

package/esm/models/chatusermessage.d.ts

@@ -0,0 +1,35 @@
+import * as z from "zod/v4";
+import { ChatContentItems, ChatContentItems$Outbound } from "./chatcontentitems.js";
+/**
+ * User message content
+ */
+export type ChatUserMessageContent = string | Array<ChatContentItems>;
+/**
+ * User message
+ */
+export type ChatUserMessage = {
+    role: "user";
+    /**
+     * User message content
+     */
+    content: string | Array<ChatContentItems>;
+    /**
+     * Optional name for the user
+     */
+    name?: string | undefined;
+};
+/** @internal */
+export type ChatUserMessageContent$Outbound = string | Array<ChatContentItems$Outbound>;
+/** @internal */
+export declare const ChatUserMessageContent$outboundSchema: z.ZodType<ChatUserMessageContent$Outbound, ChatUserMessageContent>;
+export declare function chatUserMessageContentToJSON(chatUserMessageContent: ChatUserMessageContent): string;
+/** @internal */
+export type ChatUserMessage$Outbound = {
+    role: "user";
+    content: string | Array<ChatContentItems$Outbound>;
+    name?: string | undefined;
+};
+/** @internal */
+export declare const ChatUserMessage$outboundSchema: z.ZodType<ChatUserMessage$Outbound, ChatUserMessage>;
+export declare function chatUserMessageToJSON(chatUserMessage: ChatUserMessage): string;
+//# sourceMappingURL=chatusermessage.d.ts.map

package/esm/models/chatusermessage.js

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: bc892e4ebadf
+ */
+import * as z from "zod/v4";
+import { ChatContentItems$outboundSchema, } from "./chatcontentitems.js";
+/** @internal */
+export const ChatUserMessageContent$outboundSchema = z.union([z.string(), z.array(ChatContentItems$outboundSchema)]);
+export function chatUserMessageContentToJSON(chatUserMessageContent) {
+    return JSON.stringify(ChatUserMessageContent$outboundSchema.parse(chatUserMessageContent));
+}
+/** @internal */
+export const ChatUserMessage$outboundSchema = z.object({
+    role: z.literal("user"),
+    content: z.union([z.string(), z.array(ChatContentItems$outboundSchema)]),
+    name: z.string().optional(),
+});
+export function chatUserMessageToJSON(chatUserMessage) {
+    return JSON.stringify(ChatUserMessage$outboundSchema.parse(chatUserMessage));
+}
+//# sourceMappingURL=chatusermessage.js.map

package/esm/models/chatwebsearchservertool.d.ts

@@ -0,0 +1,124 @@
+import * as z from "zod/v4";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
+export declare const ChatWebSearchServerToolTypeOpenrouterWebSearch: {
+    readonly OpenrouterWebSearch: "openrouter:web_search";
+};
+export type ChatWebSearchServerToolTypeOpenrouterWebSearch = ClosedEnum<typeof ChatWebSearchServerToolTypeOpenrouterWebSearch>;
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export declare const ChatWebSearchServerToolEngine: {
+    readonly Auto: "auto";
+    readonly Native: "native";
+    readonly Exa: "exa";
+    readonly Firecrawl: "firecrawl";
+    readonly Parallel: "parallel";
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export type ChatWebSearchServerToolEngine = OpenEnum<typeof ChatWebSearchServerToolEngine>;
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export declare const ChatWebSearchServerToolSearchContextSize: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export type ChatWebSearchServerToolSearchContextSize = OpenEnum<typeof ChatWebSearchServerToolSearchContextSize>;
+export declare const ChatWebSearchServerToolParametersType: {
+    readonly Approximate: "approximate";
+};
+export type ChatWebSearchServerToolParametersType = ClosedEnum<typeof ChatWebSearchServerToolParametersType>;
+/**
+ * Approximate user location for location-biased results.
+ */
+export type ChatWebSearchServerToolUserLocation = {
+    type?: ChatWebSearchServerToolParametersType | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+export type ChatWebSearchServerToolParameters = {
+    /**
+     * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+     */
+    engine?: ChatWebSearchServerToolEngine | undefined;
+    /**
+     * Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.
+     */
+    maxResults?: number | undefined;
+    /**
+     * Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops.
+     */
+    maxTotalResults?: number | undefined;
+    /**
+     * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+     */
+    searchContextSize?: ChatWebSearchServerToolSearchContextSize | undefined;
+    /**
+     * Approximate user location for location-biased results.
+     */
+    userLocation?: ChatWebSearchServerToolUserLocation | undefined;
+    /**
+     * Limit search results to these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    allowedDomains?: Array<string> | undefined;
+    /**
+     * Exclude search results from these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    excludedDomains?: Array<string> | undefined;
+};
+/**
+ * OpenRouter built-in server tool: searches the web for current information
+ */
+export type ChatWebSearchServerTool = {
+    type: ChatWebSearchServerToolTypeOpenrouterWebSearch;
+    parameters?: ChatWebSearchServerToolParameters | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema: z.ZodEnum<typeof ChatWebSearchServerToolTypeOpenrouterWebSearch>;
+/** @internal */
+export declare const ChatWebSearchServerToolEngine$outboundSchema: z.ZodType<string, ChatWebSearchServerToolEngine>;
+/** @internal */
+export declare const ChatWebSearchServerToolSearchContextSize$outboundSchema: z.ZodType<string, ChatWebSearchServerToolSearchContextSize>;
+/** @internal */
+export declare const ChatWebSearchServerToolParametersType$outboundSchema: z.ZodEnum<typeof ChatWebSearchServerToolParametersType>;
+/** @internal */
+export type ChatWebSearchServerToolUserLocation$Outbound = {
+    type?: string | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchServerToolUserLocation$outboundSchema: z.ZodType<ChatWebSearchServerToolUserLocation$Outbound, ChatWebSearchServerToolUserLocation>;
+export declare function chatWebSearchServerToolUserLocationToJSON(chatWebSearchServerToolUserLocation: ChatWebSearchServerToolUserLocation): string;
+/** @internal */
+export type ChatWebSearchServerToolParameters$Outbound = {
+    engine?: string | undefined;
+    max_results?: number | undefined;
+    max_total_results?: number | undefined;
+    search_context_size?: string | undefined;
+    user_location?: ChatWebSearchServerToolUserLocation$Outbound | undefined;
+    allowed_domains?: Array<string> | undefined;
+    excluded_domains?: Array<string> | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchServerToolParameters$outboundSchema: z.ZodType<ChatWebSearchServerToolParameters$Outbound, ChatWebSearchServerToolParameters>;
+export declare function chatWebSearchServerToolParametersToJSON(chatWebSearchServerToolParameters: ChatWebSearchServerToolParameters): string;
+/** @internal */
+export type ChatWebSearchServerTool$Outbound = {
+    type: string;
+    parameters?: ChatWebSearchServerToolParameters$Outbound | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchServerTool$outboundSchema: z.ZodType<ChatWebSearchServerTool$Outbound, ChatWebSearchServerTool>;
+export declare function chatWebSearchServerToolToJSON(chatWebSearchServerTool: ChatWebSearchServerTool): string;
+//# sourceMappingURL=chatwebsearchservertool.d.ts.map

package/esm/models/chatwebsearchservertool.js

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ae822f875178
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../lib/primitives.js";
+import * as openEnums from "../types/enums.js";
+export const ChatWebSearchServerToolTypeOpenrouterWebSearch = {
+    OpenrouterWebSearch: "openrouter:web_search",
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export const ChatWebSearchServerToolEngine = {
+    Auto: "auto",
+    Native: "native",
+    Exa: "exa",
+    Firecrawl: "firecrawl",
+    Parallel: "parallel",
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export const ChatWebSearchServerToolSearchContextSize = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+export const ChatWebSearchServerToolParametersType = {
+    Approximate: "approximate",
+};
+/** @internal */
+export const ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema = z.enum(ChatWebSearchServerToolTypeOpenrouterWebSearch);
+/** @internal */
+export const ChatWebSearchServerToolEngine$outboundSchema = openEnums.outboundSchema(ChatWebSearchServerToolEngine);
+/** @internal */
+export const ChatWebSearchServerToolSearchContextSize$outboundSchema = openEnums.outboundSchema(ChatWebSearchServerToolSearchContextSize);
+/** @internal */
+export const ChatWebSearchServerToolParametersType$outboundSchema = z.enum(ChatWebSearchServerToolParametersType);
+/** @internal */
+export const ChatWebSearchServerToolUserLocation$outboundSchema = z.object({
+    type: ChatWebSearchServerToolParametersType$outboundSchema.optional(),
+    city: z.string().optional(),
+    region: z.string().optional(),
+    country: z.string().optional(),
+    timezone: z.string().optional(),
+});
+export function chatWebSearchServerToolUserLocationToJSON(chatWebSearchServerToolUserLocation) {
+    return JSON.stringify(ChatWebSearchServerToolUserLocation$outboundSchema.parse(chatWebSearchServerToolUserLocation));
+}
+/** @internal */
+export const ChatWebSearchServerToolParameters$outboundSchema = z.object({
+    engine: ChatWebSearchServerToolEngine$outboundSchema.optional(),
+    maxResults: z.number().optional(),
+    maxTotalResults: z.number().optional(),
+    searchContextSize: ChatWebSearchServerToolSearchContextSize$outboundSchema
+        .optional(),
+    userLocation: z.lazy(() => ChatWebSearchServerToolUserLocation$outboundSchema)
+        .optional(),
+    allowedDomains: z.array(z.string()).optional(),
+    excludedDomains: z.array(z.string()).optional(),
+}).transform((v) => {
+    return remap$(v, {
+        maxResults: "max_results",
+        maxTotalResults: "max_total_results",
+        searchContextSize: "search_context_size",
+        userLocation: "user_location",
+        allowedDomains: "allowed_domains",
+        excludedDomains: "excluded_domains",
+    });
+});
+export function chatWebSearchServerToolParametersToJSON(chatWebSearchServerToolParameters) {
+    return JSON.stringify(ChatWebSearchServerToolParameters$outboundSchema.parse(chatWebSearchServerToolParameters));
+}
+/** @internal */
+export const ChatWebSearchServerTool$outboundSchema = z.object({
+    type: ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema,
+    parameters: z.lazy(() => ChatWebSearchServerToolParameters$outboundSchema)
+        .optional(),
+});
+export function chatWebSearchServerToolToJSON(chatWebSearchServerTool) {
+    return JSON.stringify(ChatWebSearchServerTool$outboundSchema.parse(chatWebSearchServerTool));
+}
+//# sourceMappingURL=chatwebsearchservertool.js.map

package/esm/models/chatwebsearchshorthand.d.ts

@@ -0,0 +1,219 @@
+import * as z from "zod/v4";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
+export declare const ChatWebSearchShorthandType: {
+    readonly WebSearch: "web_search";
+    readonly WebSearchPreview: "web_search_preview";
+    readonly WebSearchPreview20250311: "web_search_preview_2025_03_11";
+    readonly WebSearch20250826: "web_search_2025_08_26";
+};
+export type ChatWebSearchShorthandType = OpenEnum<typeof ChatWebSearchShorthandType>;
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export declare const ChatWebSearchShorthandEngine: {
+    readonly Auto: "auto";
+    readonly Native: "native";
+    readonly Exa: "exa";
+    readonly Firecrawl: "firecrawl";
+    readonly Parallel: "parallel";
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export type ChatWebSearchShorthandEngine = OpenEnum<typeof ChatWebSearchShorthandEngine>;
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export declare const ChatWebSearchShorthandSearchContextSize: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export type ChatWebSearchShorthandSearchContextSize = OpenEnum<typeof ChatWebSearchShorthandSearchContextSize>;
+export declare const ChatWebSearchShorthandTypeApproximate: {
+    readonly Approximate: "approximate";
+};
+export type ChatWebSearchShorthandTypeApproximate = ClosedEnum<typeof ChatWebSearchShorthandTypeApproximate>;
+/**
+ * Approximate user location for location-biased results.
+ */
+export type ChatWebSearchShorthandUserLocation = {
+    type?: ChatWebSearchShorthandTypeApproximate | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export declare const ChatWebSearchShorthandParametersEngine: {
+    readonly Auto: "auto";
+    readonly Native: "native";
+    readonly Exa: "exa";
+    readonly Firecrawl: "firecrawl";
+    readonly Parallel: "parallel";
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export type ChatWebSearchShorthandParametersEngine = OpenEnum<typeof ChatWebSearchShorthandParametersEngine>;
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export declare const ChatWebSearchShorthandParametersSearchContextSize: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export type ChatWebSearchShorthandParametersSearchContextSize = OpenEnum<typeof ChatWebSearchShorthandParametersSearchContextSize>;
+export declare const ChatWebSearchShorthandParametersType: {
+    readonly Approximate: "approximate";
+};
+export type ChatWebSearchShorthandParametersType = ClosedEnum<typeof ChatWebSearchShorthandParametersType>;
+/**
+ * Approximate user location for location-biased results.
+ */
+export type ChatWebSearchShorthandParametersUserLocation = {
+    type?: ChatWebSearchShorthandParametersType | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+export type ChatWebSearchShorthandParameters = {
+    /**
+     * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+     */
+    engine?: ChatWebSearchShorthandParametersEngine | undefined;
+    /**
+     * Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.
+     */
+    maxResults?: number | undefined;
+    /**
+     * Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops.
+     */
+    maxTotalResults?: number | undefined;
+    /**
+     * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+     */
+    searchContextSize?: ChatWebSearchShorthandParametersSearchContextSize | undefined;
+    /**
+     * Approximate user location for location-biased results.
+     */
+    userLocation?: ChatWebSearchShorthandParametersUserLocation | undefined;
+    /**
+     * Limit search results to these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    allowedDomains?: Array<string> | undefined;
+    /**
+     * Exclude search results from these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    excludedDomains?: Array<string> | undefined;
+};
+/**
+ * Web search tool using OpenAI Responses API syntax. Automatically converted to openrouter:web_search.
+ */
+export type ChatWebSearchShorthand = {
+    type: ChatWebSearchShorthandType;
+    /**
+     * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+     */
+    engine?: ChatWebSearchShorthandEngine | undefined;
+    /**
+     * Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.
+     */
+    maxResults?: number | undefined;
+    /**
+     * Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops.
+     */
+    maxTotalResults?: number | undefined;
+    /**
+     * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+     */
+    searchContextSize?: ChatWebSearchShorthandSearchContextSize | undefined;
+    /**
+     * Approximate user location for location-biased results.
+     */
+    userLocation?: ChatWebSearchShorthandUserLocation | undefined;
+    /**
+     * Limit search results to these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    allowedDomains?: Array<string> | undefined;
+    /**
+     * Exclude search results from these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
+     */
+    excludedDomains?: Array<string> | undefined;
+    parameters?: ChatWebSearchShorthandParameters | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchShorthandType$outboundSchema: z.ZodType<string, ChatWebSearchShorthandType>;
+/** @internal */
+export declare const ChatWebSearchShorthandEngine$outboundSchema: z.ZodType<string, ChatWebSearchShorthandEngine>;
+/** @internal */
+export declare const ChatWebSearchShorthandSearchContextSize$outboundSchema: z.ZodType<string, ChatWebSearchShorthandSearchContextSize>;
+/** @internal */
+export declare const ChatWebSearchShorthandTypeApproximate$outboundSchema: z.ZodEnum<typeof ChatWebSearchShorthandTypeApproximate>;
+/** @internal */
+export type ChatWebSearchShorthandUserLocation$Outbound = {
+    type?: string | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchShorthandUserLocation$outboundSchema: z.ZodType<ChatWebSearchShorthandUserLocation$Outbound, ChatWebSearchShorthandUserLocation>;
+export declare function chatWebSearchShorthandUserLocationToJSON(chatWebSearchShorthandUserLocation: ChatWebSearchShorthandUserLocation): string;
+/** @internal */
+export declare const ChatWebSearchShorthandParametersEngine$outboundSchema: z.ZodType<string, ChatWebSearchShorthandParametersEngine>;
+/** @internal */
+export declare const ChatWebSearchShorthandParametersSearchContextSize$outboundSchema: z.ZodType<string, ChatWebSearchShorthandParametersSearchContextSize>;
+/** @internal */
+export declare const ChatWebSearchShorthandParametersType$outboundSchema: z.ZodEnum<typeof ChatWebSearchShorthandParametersType>;
+/** @internal */
+export type ChatWebSearchShorthandParametersUserLocation$Outbound = {
+    type?: string | undefined;
+    city?: string | undefined;
+    region?: string | undefined;
+    country?: string | undefined;
+    timezone?: string | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchShorthandParametersUserLocation$outboundSchema: z.ZodType<ChatWebSearchShorthandParametersUserLocation$Outbound, ChatWebSearchShorthandParametersUserLocation>;
+export declare function chatWebSearchShorthandParametersUserLocationToJSON(chatWebSearchShorthandParametersUserLocation: ChatWebSearchShorthandParametersUserLocation): string;
+/** @internal */
+export type ChatWebSearchShorthandParameters$Outbound = {
+    engine?: string | undefined;
+    max_results?: number | undefined;
+    max_total_results?: number | undefined;
+    search_context_size?: string | undefined;
+    user_location?: ChatWebSearchShorthandParametersUserLocation$Outbound | undefined;
+    allowed_domains?: Array<string> | undefined;
+    excluded_domains?: Array<string> | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchShorthandParameters$outboundSchema: z.ZodType<ChatWebSearchShorthandParameters$Outbound, ChatWebSearchShorthandParameters>;
+export declare function chatWebSearchShorthandParametersToJSON(chatWebSearchShorthandParameters: ChatWebSearchShorthandParameters): string;
+/** @internal */
+export type ChatWebSearchShorthand$Outbound = {
+    type: string;
+    engine?: string | undefined;
+    max_results?: number | undefined;
+    max_total_results?: number | undefined;
+    search_context_size?: string | undefined;
+    user_location?: ChatWebSearchShorthandUserLocation$Outbound | undefined;
+    allowed_domains?: Array<string> | undefined;
+    excluded_domains?: Array<string> | undefined;
+    parameters?: ChatWebSearchShorthandParameters$Outbound | undefined;
+};
+/** @internal */
+export declare const ChatWebSearchShorthand$outboundSchema: z.ZodType<ChatWebSearchShorthand$Outbound, ChatWebSearchShorthand>;
+export declare function chatWebSearchShorthandToJSON(chatWebSearchShorthand: ChatWebSearchShorthand): string;
+//# sourceMappingURL=chatwebsearchshorthand.d.ts.map

package/esm/models/chatwebsearchshorthand.js

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a67d6bbce478
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../lib/primitives.js";
+import * as openEnums from "../types/enums.js";
+export const ChatWebSearchShorthandType = {
+    WebSearch: "web_search",
+    WebSearchPreview: "web_search_preview",
+    WebSearchPreview20250311: "web_search_preview_2025_03_11",
+    WebSearch20250826: "web_search_2025_08_26",
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export const ChatWebSearchShorthandEngine = {
+    Auto: "auto",
+    Native: "native",
+    Exa: "exa",
+    Firecrawl: "firecrawl",
+    Parallel: "parallel",
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export const ChatWebSearchShorthandSearchContextSize = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+export const ChatWebSearchShorthandTypeApproximate = {
+    Approximate: "approximate",
+};
+/**
+ * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
+ */
+export const ChatWebSearchShorthandParametersEngine = {
+    Auto: "auto",
+    Native: "native",
+    Exa: "exa",
+    Firecrawl: "firecrawl",
+    Parallel: "parallel",
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export const ChatWebSearchShorthandParametersSearchContextSize = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+export const ChatWebSearchShorthandParametersType = {
+    Approximate: "approximate",
+};
+/** @internal */
+export const ChatWebSearchShorthandType$outboundSchema = openEnums.outboundSchema(ChatWebSearchShorthandType);
+/** @internal */
+export const ChatWebSearchShorthandEngine$outboundSchema = openEnums.outboundSchema(ChatWebSearchShorthandEngine);
+/** @internal */
+export const ChatWebSearchShorthandSearchContextSize$outboundSchema = openEnums.outboundSchema(ChatWebSearchShorthandSearchContextSize);
+/** @internal */
+export const ChatWebSearchShorthandTypeApproximate$outboundSchema = z.enum(ChatWebSearchShorthandTypeApproximate);
+/** @internal */
+export const ChatWebSearchShorthandUserLocation$outboundSchema = z.object({
+    type: ChatWebSearchShorthandTypeApproximate$outboundSchema.optional(),
+    city: z.string().optional(),
+    region: z.string().optional(),
+    country: z.string().optional(),
+    timezone: z.string().optional(),
+});
+export function chatWebSearchShorthandUserLocationToJSON(chatWebSearchShorthandUserLocation) {
+    return JSON.stringify(ChatWebSearchShorthandUserLocation$outboundSchema.parse(chatWebSearchShorthandUserLocation));
+}
+/** @internal */
+export const ChatWebSearchShorthandParametersEngine$outboundSchema = openEnums.outboundSchema(ChatWebSearchShorthandParametersEngine);
+/** @internal */
+export const ChatWebSearchShorthandParametersSearchContextSize$outboundSchema = openEnums.outboundSchema(ChatWebSearchShorthandParametersSearchContextSize);
+/** @internal */
+export const ChatWebSearchShorthandParametersType$outboundSchema = z.enum(ChatWebSearchShorthandParametersType);
+/** @internal */
+export const ChatWebSearchShorthandParametersUserLocation$outboundSchema = z.object({
+    type: ChatWebSearchShorthandParametersType$outboundSchema.optional(),
+    city: z.string().optional(),
+    region: z.string().optional(),
+    country: z.string().optional(),
+    timezone: z.string().optional(),
+});
+export function chatWebSearchShorthandParametersUserLocationToJSON(chatWebSearchShorthandParametersUserLocation) {
+    return JSON.stringify(ChatWebSearchShorthandParametersUserLocation$outboundSchema.parse(chatWebSearchShorthandParametersUserLocation));
+}
+/** @internal */
+export const ChatWebSearchShorthandParameters$outboundSchema = z.object({
+    engine: ChatWebSearchShorthandParametersEngine$outboundSchema.optional(),
+    maxResults: z.number().optional(),
+    maxTotalResults: z.number().optional(),
+    searchContextSize: ChatWebSearchShorthandParametersSearchContextSize$outboundSchema.optional(),
+    userLocation: z.lazy(() => ChatWebSearchShorthandParametersUserLocation$outboundSchema).optional(),
+    allowedDomains: z.array(z.string()).optional(),
+    excludedDomains: z.array(z.string()).optional(),
+}).transform((v) => {
+    return remap$(v, {
+        maxResults: "max_results",
+        maxTotalResults: "max_total_results",
+        searchContextSize: "search_context_size",
+        userLocation: "user_location",
+        allowedDomains: "allowed_domains",
+        excludedDomains: "excluded_domains",
+    });
+});
+export function chatWebSearchShorthandParametersToJSON(chatWebSearchShorthandParameters) {
+    return JSON.stringify(ChatWebSearchShorthandParameters$outboundSchema.parse(chatWebSearchShorthandParameters));
+}
+/** @internal */
+export const ChatWebSearchShorthand$outboundSchema = z.object({
+    type: ChatWebSearchShorthandType$outboundSchema,
+    engine: ChatWebSearchShorthandEngine$outboundSchema.optional(),
+    maxResults: z.number().optional(),
+    maxTotalResults: z.number().optional(),
+    searchContextSize: ChatWebSearchShorthandSearchContextSize$outboundSchema
+        .optional(),
+    userLocation: z.lazy(() => ChatWebSearchShorthandUserLocation$outboundSchema)
+        .optional(),
+    allowedDomains: z.array(z.string()).optional(),
+    excludedDomains: z.array(z.string()).optional(),
+    parameters: z.lazy(() => ChatWebSearchShorthandParameters$outboundSchema)
+        .optional(),
+}).transform((v) => {
+    return remap$(v, {
+        maxResults: "max_results",
+        maxTotalResults: "max_total_results",
+        searchContextSize: "search_context_size",
+        userLocation: "user_location",
+        allowedDomains: "allowed_domains",
+        excludedDomains: "excluded_domains",
+    });
+});
+export function chatWebSearchShorthandToJSON(chatWebSearchShorthand) {
+    return JSON.stringify(ChatWebSearchShorthand$outboundSchema.parse(chatWebSearchShorthand));
+}
+//# sourceMappingURL=chatwebsearchshorthand.js.map

package/esm/models/{openresponsescodeinterpretertool.d.ts → codeinterpreterservertool.d.ts}

@@ -22,7 +22,7 @@ export type Container = ContainerAuto | string;
 /**
  * Code interpreter tool configuration
  */
-export type OpenResponsesCodeInterpreterTool = {
+export type CodeInterpreterServerTool = {
     type: "code_interpreter";
     container: ContainerAuto | string;
 };
@@ -55,14 +55,14 @@ export declare const Container$outboundSchema: z.ZodType<Container$Outbound, Con
 export declare function containerToJSON(container: Container): string;
 export declare function containerFromJSON(jsonString: string): SafeParseResult<Container, SDKValidationError>;
 /** @internal */
-export declare const OpenResponsesCodeInterpreterTool$inboundSchema: z.ZodType<OpenResponsesCodeInterpreterTool, unknown>;
+export declare const CodeInterpreterServerTool$inboundSchema: z.ZodType<CodeInterpreterServerTool, unknown>;
 /** @internal */
-export type OpenResponsesCodeInterpreterTool$Outbound = {
+export type CodeInterpreterServerTool$Outbound = {
     type: "code_interpreter";
     container: ContainerAuto$Outbound | string;
 };
 /** @internal */
-export declare const OpenResponsesCodeInterpreterTool$outboundSchema: z.ZodType<OpenResponsesCodeInterpreterTool$Outbound, OpenResponsesCodeInterpreterTool>;
-export declare function openResponsesCodeInterpreterToolToJSON(openResponsesCodeInterpreterTool: OpenResponsesCodeInterpreterTool): string;
-export declare function openResponsesCodeInterpreterToolFromJSON(jsonString: string): SafeParseResult<OpenResponsesCodeInterpreterTool, SDKValidationError>;
-//# sourceMappingURL=openresponsescodeinterpretertool.d.ts.map
+export declare const CodeInterpreterServerTool$outboundSchema: z.ZodType<CodeInterpreterServerTool$Outbound, CodeInterpreterServerTool>;
+export declare function codeInterpreterServerToolToJSON(codeInterpreterServerTool: CodeInterpreterServerTool): string;
+export declare function codeInterpreterServerToolFromJSON(jsonString: string): SafeParseResult<CodeInterpreterServerTool, SDKValidationError>;
+//# sourceMappingURL=codeinterpreterservertool.d.ts.map