openai

Documentation

Index

• Constants
• func NormalizeReasoningEffort(effort string) string
• func ReasoningEncryptedContent(meta sdk.ProviderMetadata) string
• func ReasoningItemID(meta sdk.ProviderMetadata) string
• func ReasoningItemMetadata(itemID, encryptedContent string) sdk.ProviderMetadata

Constants

const (

	// IncludeReasoningEncryptedContent asks the API to return the encrypted
	// reasoning payload. It is required to replay reasoning when the
	// conversation is not stored server-side.
	IncludeReasoningEncryptedContent = "reasoning.encrypted_content"
)

The Responses reasoning dialect, shared by the public Responses API and the Codex backend: the same API behind a different base URL, producing byte-identical reasoning items.

Functions

func NormalizeReasoningEffort

func NormalizeReasoningEffort(effort string) string

NormalizeReasoningEffort returns effort unchanged.

Deprecated: this function no longer has any effect and will be removed in the next release. Callers should pass the effort straight through.

It previously rewrote "max" into "xhigh" for OpenAI-format endpoints. That rewrite encoded a guess about what OpenAI would accept rather than something a caller had declared: on the day "max" becomes supported, it would silently downgrade every such request, with no diagnostic and no obvious culprit. Effort is an open enum precisely so new tiers work without an SDK release, and no official provider SDK maintains a tier allow-list. An effort the endpoint does not accept is the provider's 400 to return, not the SDK's to predict.

The empty shell remains for one release because the symbol is exported.

func ReasoningEncryptedContent

func ReasoningEncryptedContent(meta sdk.ProviderMetadata) string

ReasoningEncryptedContent returns the encrypted reasoning payload.

func ReasoningItemID

func ReasoningItemID(meta sdk.ProviderMetadata) string

ReasoningItemID returns the reasoning item id a part must be replayed under.

func ReasoningItemMetadata

func ReasoningItemMetadata(itemID, encryptedContent string) sdk.ProviderMetadata

ReasoningItemMetadata records what a reasoning item needs on replay: the item id, which the API requires, and the encrypted content that carries the reasoning state when the conversation is not stored server-side.

The encrypted payload is scoped to the account and endpoint that issued it. Replaying it elsewhere fails verification even though the wire shape matches, so this metadata travels with the part rather than being reconstructed.