Skip to main content

enterprise_ai.llm.reasoning

Source: sdks/python/src/enterprise_ai/llm/reasoning/__init__.py. Back to the Python SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Enumeration Effort​

Normalized internal reasoning effort, ordered from none to max.

str, Enum

Values:

MemberValueDescription
NONE'none'No reasoning (none).
LOW'low'Low reasoning effort (low).
MEDIUM'medium'Medium reasoning effort (medium).
HIGH'high'High reasoning effort (high).
MAX'max'Highest reasoning effort (max).

Attributes:

NameTypeRequiredDescription
rankintyesPosition of the effort in the order none (0) to max (4).

Effort.parse​

parse(value: str | Effort | None) -> Effort

Parse a string (case insensitive). None means none.

NameTypeDefaultRequiredDescription
valuestr | Effort | NoneyesEffort as a string, an Effort (returned as is) or None; an unknown value raises EffortNotSupported.

Returns: Effort. A Effort: Normalized internal reasoning effort, ordered from none to max.

Raises: EffortNotSupported.

Model EffortResolution​

Result of :func:resolve_effort.

Fields:

NameTypeRequiredDescription
requestedEffortyesNormalized internal reasoning effort, ordered from none to max.
effectiveEffortyesNormalized internal reasoning effort, ordered from none to max.
native_parameterstrnoName of the provider reasoning parameter from spec.reasoning.native_parameter (default none).
nativedict[str, Any]noProvider parameters for the effective effort, such as {"reasoning_effort": "high"} or a thinking budget.
adjustedboolnoTrue when the requested effort was mapped to another level by the model policy.
reasonstr | NonenoWhy the action is taken. Written to the audit trail with the actor and the time.
reasoning_tokensintnoExplicit reasoning tokens, at least 0; overrides the reserve of reasoning_effort.

Functions​

supported_efforts​

supported_efforts(model: dict[str, Any]) -> list[Effort]

Efforts listed in reasoning_modes (none only when absent).

NameTypeDefaultRequiredDescription
modeldict[str, Any]yesModel Manifest or registry entry.

Returns: list[Effort]. A Effort: Normalized internal reasoning effort, ordered from none to max.

resolve_effort​

resolve_effort(model: dict[str, Any], effort: str | Effort | None) -> EffortResolution

Check effort against a model manifest (or registry entry) and translate it.

NameTypeDefaultRequiredDescription
modeldict[str, Any]yesModel Manifest or registry entry whose reasoning_modes and reasoning policy apply.
effortstr | Effort | NoneyesRequested reasoning effort; None takes spec.reasoning.default_effort.

Returns: EffortResolution. A EffortResolution: Result of :func:resolve_effort.

Raises: EffortNotSupported.

reasoning_reserve​

reasoning_reserve(model: dict[str, Any], effort: str | Effort | None) -> int

Tokens to reserve for reasoning when planning a context (0 for none).

NameTypeDefaultRequiredDescription
modeldict[str, Any]yesModel Manifest or registry entry.
effortstr | Effort | NoneyesRequested reasoning effort; None takes the model default effort.

Returns: int. The model budget_tokens for the effective effort, otherwise 1024 (low), 4096 (medium), 16384 (high) or 32768 (max).