Rulvar API reference

---

Rulvar API reference / @rulvar/openai / mapOpenAiEffort

Function: mapOpenAiEffort()

function mapOpenAiEffort(effort, options?): {
  downmapped: boolean;
  wire: string;
};

Defined in: packages/openai/src/wire.ts:65

Canonical-to-wire effort: low through xhigh pass through. Canonical max passes through unchanged on models whose caps declare wire max support (the whole GPT-5.6 family, each sibling verified live 2026-07-18; v1.20.0 review P2-3); elsewhere it downmaps to xhigh (documented lossy; recorded in providerMetadata). Provider 'none' is reachable only via providerOptions.openai.reasoningEffort.

Parameters

Parameter	Type
effort	Effort
options?	{ wireMaxEffort?: boolean; }
options.wireMaxEffort?	boolean

Returns

{
  downmapped: boolean;
  wire: string;
}

Name	Type	Defined in
downmapped	boolean	packages/openai/src/wire.ts:68
wire	string	packages/openai/src/wire.ts:68