1# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 2
 3from __future__ import annotations
 4
 5from typing import Optional
 6from typing_extensions import Literal, TypedDict
 7
 8from ..shared.reasoning_effort import ReasoningEffort
 9
10__all__ = ["Reasoning"]
11
12
13class Reasoning(TypedDict, total=False):
14    effort: Optional[ReasoningEffort]
15    """
16    Constrains effort on reasoning for
17    [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
18    supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`.
19    Reducing reasoning effort can result in faster responses and fewer tokens used
20    on reasoning in a response.
21
22    - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported
23      reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool
24      calls are supported for all reasoning values in gpt-5.1.
25    - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
26      support `none`.
27    - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
28    - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
29    """
30
31    generate_summary: Optional[Literal["auto", "concise", "detailed"]]
32    """**Deprecated:** use `summary` instead.
33
34    A summary of the reasoning performed by the model. This can be useful for
35    debugging and understanding the model's reasoning process. One of `auto`,
36    `concise`, or `detailed`.
37    """
38
39    summary: Optional[Literal["auto", "concise", "detailed"]]
40    """A summary of the reasoning performed by the model.
41
42    This can be useful for debugging and understanding the model's reasoning
43    process. One of `auto`, `concise`, or `detailed`.
44
45    `concise` is only supported for `computer-use-preview` models.
46    """