Skip to content

rulvar API reference


rulvar API reference / @rulvar/openai / mapOpenAiEffort

Function: mapOpenAiEffort()

ts
function mapOpenAiEffort(effort): {
  downmapped: boolean;
  wire: string;
};

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

Canonical-to-wire effort: low through xhigh pass through; canonical max downmaps to xhigh (documented lossy; recorded in providerMetadata); provider 'none' is reachable only via providerOptions.openai.reasoningEffort.

Parameters

ParameterType
effortEffort

Returns

ts
{
  downmapped: boolean;
  wire: string;
}
NameTypeDefined in
downmappedbooleanpackages/openai/src/wire.ts:63
wirestringpackages/openai/src/wire.ts:63