@nhtio/adk/batteries/llm/openai_responses/helpers

Swappable translation helpers for rendering ADK state into OpenAI Responses requests.

Remarks

The swappable translation helpers that turn ADK primitives into OpenAI Responses wire shapes. Each helper is exported under its unprefixed name AND under a default* alias so consumers can compose partial overrides. Helpers that compose other helpers receive their dependents via explicit input arguments — never via module-level closure — so a swap at any layer propagates correctly.

The wire-shape-AGNOSTIC helpers (renderUntrustedContent, renderMemories, renderChatCompletionsSystemPrompt, descriptionToChatCompletionsJsonSchema, canonicalFingerprint, …) live in the shared, internal ../chat_common/helpers submodule and are re-exported here under their original names so every existing import keeps resolving. Only the Responses-WIRE-SPECIFIC helpers (media mapping, timeline-message rendering, tool-call-result rendering, the buildOpenAIResponsesInput assembler, the reasoning-replay machinery, the fingerprint wrapper, the tool-declaration translator, and the streaming output-slot state machine) are defined here.

Variables

Variable	Description
defaultBuildOpenAIResponsesInput	Default history assembler; alias of buildOpenAIResponsesInput.
defaultCreateResponsesOutputSlotMachine	Default output-slot state machine factory; alias of createResponsesOutputSlotMachine.
defaultRenderOpenAIResponsesMediaBlocks	Default OpenAI Responses media renderer; alias of renderOpenAIResponsesMediaBlocks.
defaultRenderOpenAIResponsesReasoningItem	Default reasoning-item renderer; alias of renderOpenAIResponsesReasoningItem.
defaultRenderOpenAIResponsesTimelineMessage	Default timeline-message renderer; alias of renderOpenAIResponsesTimelineMessage.
defaultRenderOpenAIResponsesToolCallResult	Default tool-call-result renderer; alias of renderOpenAIResponsesToolCallResult.
defaultToolsToOpenAIResponsesTools	Default tool-translation helper; alias of toolsToOpenAIResponsesTools.

Functions

Function	Description
buildOpenAIResponsesInput	Implements OpenAIResponsesHelpers.buildOpenAIResponsesInput.
createResponsesOutputSlotMachine	Implements OpenAIResponsesHelpers.createResponsesOutputSlotMachine.
fingerprintOpenAIResponsesPrefix	Implements OpenAIResponsesHelpers.fingerprintOpenAIResponsesPrefix.
normalizeOpenAIResponsesItemId	Normalises an ADK-authored id to the Responses item-id charset, and hashes+truncates ids over the 64-character limit (Known Gotcha #5) rather than sending an oversized id verbatim.
renderOpenAIResponsesMediaBlocks	Implements OpenAIResponsesHelpers.renderOpenAIResponsesMediaBlocks.
renderOpenAIResponsesReasoningItem	Implements OpenAIResponsesHelpers.renderOpenAIResponsesReasoningItem.
renderOpenAIResponsesTimelineMessage	Implements OpenAIResponsesHelpers.renderOpenAIResponsesTimelineMessage.
renderOpenAIResponsesToolCallResult	Implements OpenAIResponsesHelpers.renderOpenAIResponsesToolCallResult.
toolsToOpenAIResponsesTools	Implements OpenAIResponsesHelpers.toolsToOpenAIResponsesTools.

References

canonicalFingerprint

Re-exports canonicalFingerprint

---

defaultCanonicalFingerprint

Re-exports defaultCanonicalFingerprint

---

defaultDescriptionToChatCompletionsJsonSchema

Re-exports defaultDescriptionToChatCompletionsJsonSchema

---

defaultFilterThoughts

Re-exports defaultFilterThoughts

---

defaultRenderArtifactHandleBody

Re-exports defaultRenderArtifactHandleBody

---

defaultRenderChatCompletionsSystemPrompt

Re-exports defaultRenderChatCompletionsSystemPrompt

---

defaultRenderFirstPartyRetrievables

Re-exports defaultRenderFirstPartyRetrievables

---

defaultRenderMemories

Re-exports defaultRenderMemories

---

defaultRenderRetrievableHandleBody

Re-exports defaultRenderRetrievableHandleBody

---

defaultRenderRetrievables

Re-exports defaultRenderRetrievables

---

defaultRenderRetrievableSafetyDirective

Re-exports defaultRenderRetrievableSafetyDirective

---

defaultRenderStandingInstructions

Re-exports defaultRenderStandingInstructions

---

defaultRenderThirdPartyPrivateRetrievables

Re-exports defaultRenderThirdPartyPrivateRetrievables

---

defaultRenderThirdPartyPublicRetrievables

Re-exports defaultRenderThirdPartyPublicRetrievables

---

defaultRenderThought

Re-exports defaultRenderThought

---

defaultRenderTrustedContent

Re-exports defaultRenderTrustedContent

---

defaultRenderUntrustedContent

Re-exports defaultRenderUntrustedContent

---

defaultToolsToChatCompletionsTools

Re-exports defaultToolsToChatCompletionsTools

---

descriptionToChatCompletionsJsonSchema

Re-exports descriptionToChatCompletionsJsonSchema

---

filterThoughts

Re-exports filterThoughts

---

floorTrustTier

Re-exports floorTrustTier

---

looksLikeSpooledArtifact

Re-exports looksLikeSpooledArtifact

---

neutraliseDeveloperRulesTag

Re-exports neutraliseDeveloperRulesTag

---

renderArtifactHandleBody

Re-exports renderArtifactHandleBody

---

renderChatCompletionsSystemPrompt

Re-exports renderChatCompletionsSystemPrompt

---

renderFirstPartyRetrievables

Re-exports renderFirstPartyRetrievables

---

renderMemories

Re-exports renderMemories

---

renderRetrievableHandleBody

Re-exports renderRetrievableHandleBody

---

renderRetrievables

Re-exports renderRetrievables

---

renderRetrievableSafetyDirective

Re-exports renderRetrievableSafetyDirective

---

renderStandingInstructions

Re-exports renderStandingInstructions

---

renderThirdPartyPrivateRetrievables

Re-exports renderThirdPartyPrivateRetrievables

---

renderThirdPartyPublicRetrievables

Re-exports renderThirdPartyPublicRetrievables

---

renderThought

Re-exports renderThought

---

renderTrustedContent

Re-exports renderTrustedContent

---

renderUntrustedContent

Re-exports renderUntrustedContent

---

sanitizeFilenameForDescription

Re-exports sanitizeFilenameForDescription

---

sanitizeMimeType

Re-exports sanitizeMimeType

---

stripEnvelopeSpecialTokens

Re-exports stripEnvelopeSpecialTokens

---

toolsToChatCompletionsTools

Re-exports toolsToChatCompletionsTools