@nhtio/adk

Appearance

4 min read · 862 words

@nhtio/adk/batteries/llm/openai_responses ​

Native OpenAI Responses API adapter battery with swappable translation helpers and wire types.

Remarks ​

Opinionated cross-environment OpenAI Responses battery. Ships an OpenAIResponsesAdapter that targets the Responses API's flat input: Item[] wire shape via a hand-rolled fetch + SSE transport — no openai SDK dependency, mirroring openai_chat_completions's transport approach.

Unlocks capabilities the Chat Completions wire cannot express as directly: native reasoning-item replay (signed encrypted_content, prefix-fingerprinted and adjacency-enforced per the reasoning/output-item pairing constraint), document (input_file) media, and hosted server-side tool awareness.

Re-exports the adapter class, every translation helper (wire-shape-agnostic helpers are shared with the sibling Chat-family batteries via the internal chat_common submodule and re-exported here under their original names, each with a default* alias, plus this battery's own Responses-specific helpers), the option / wire-shape types, the validation schema + validateOptions wrapper, and the battery-scoped exception classes.

Interfaces ​

InterfaceDescription
ChatHelpersCommonThe wire-shape-agnostic subset of a Chat-family battery's translation helpers — every helper that produces a plain string (or JSON Schema / tool-definition wire, which is identical across the family) rather than a battery-specific message object.

Variables ​

VariableDescription
defaultCanonicalFingerprintDefault canonical-fingerprint primitive; alias of canonicalFingerprint.

Functions ​

FunctionDescription
canonicalFingerprintComputes a SHA-256 fingerprint of value via canonical canonicalisation, over its UTF-8 bytes, using globalThis.crypto.subtle.digest.

References ​

buildOpenAIResponsesInput ​

Re-exports buildOpenAIResponsesInput

ChatCompletionsBucketLabel ​

Re-exports ChatCompletionsBucketLabel

ChatCompletionsBucketOrder ​

Re-exports ChatCompletionsBucketOrder

ChatCompletionsRetryConfig ​

Re-exports ChatCompletionsRetryConfig

createResponsesOutputSlotMachine ​

Re-exports createResponsesOutputSlotMachine

defaultBuildOpenAIResponsesInput ​

Re-exports defaultBuildOpenAIResponsesInput

defaultCreateResponsesOutputSlotMachine ​

Re-exports defaultCreateResponsesOutputSlotMachine

defaultDescriptionToChatCompletionsJsonSchema ​

Re-exports defaultDescriptionToChatCompletionsJsonSchema

defaultFilterThoughts ​

Re-exports defaultFilterThoughts

defaultRenderArtifactHandleBody ​

Re-exports defaultRenderArtifactHandleBody

defaultRenderChatCompletionsSystemPrompt ​

Re-exports defaultRenderChatCompletionsSystemPrompt

defaultRenderFirstPartyRetrievables ​

Re-exports defaultRenderFirstPartyRetrievables

defaultRenderMemories ​

Re-exports defaultRenderMemories

defaultRenderOpenAIResponsesMediaBlocks ​

Re-exports defaultRenderOpenAIResponsesMediaBlocks

defaultRenderOpenAIResponsesReasoningItem ​

Re-exports defaultRenderOpenAIResponsesReasoningItem

defaultRenderOpenAIResponsesTimelineMessage ​

Re-exports defaultRenderOpenAIResponsesTimelineMessage

defaultRenderOpenAIResponsesToolCallResult ​

Re-exports defaultRenderOpenAIResponsesToolCallResult

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

defaultToolsToOpenAIResponsesTools ​

Re-exports defaultToolsToOpenAIResponsesTools

DescriptionLike ​

Re-exports DescriptionLike

descriptionToChatCompletionsJsonSchema ​

Re-exports descriptionToChatCompletionsJsonSchema

E_INVALID_OPENAI_RESPONSES_OPTIONS ​

Re-exports E_INVALID_OPENAI_RESPONSES_OPTIONS

E_OPENAI_RESPONSES_CONTEXT_OVERFLOW ​

Re-exports E_OPENAI_RESPONSES_CONTEXT_OVERFLOW

E_OPENAI_RESPONSES_HTTP_ERROR ​

Re-exports E_OPENAI_RESPONSES_HTTP_ERROR

E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS ​

Re-exports E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS

E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED ​

Re-exports E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED

E_OPENAI_RESPONSES_REQUEST_TIMEOUT ​

Re-exports E_OPENAI_RESPONSES_REQUEST_TIMEOUT

E_OPENAI_RESPONSES_STREAM_ERROR ​

Re-exports E_OPENAI_RESPONSES_STREAM_ERROR

E_OPENAI_RESPONSES_STREAM_STALLED ​

Re-exports E_OPENAI_RESPONSES_STREAM_STALLED

E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY ​

Re-exports E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY

filterThoughts ​

Re-exports filterThoughts

fingerprintOpenAIResponsesPrefix ​

Re-exports fingerprintOpenAIResponsesPrefix

floorTrustTier ​

Re-exports floorTrustTier

JsonSchema ​

Re-exports JsonSchema

MemoryAttrs ​

Re-exports MemoryAttrs

neutraliseDeveloperRulesTag ​

Re-exports neutraliseDeveloperRulesTag

normalizeOpenAIResponsesItemId ​

Re-exports normalizeOpenAIResponsesItemId

OpenAIResponsesAdapter ​

Re-exports OpenAIResponsesAdapter

OpenAIResponsesAdapterOptions ​

Re-exports OpenAIResponsesAdapterOptions

OpenAIResponsesCompletedEvent ​

Re-exports OpenAIResponsesCompletedEvent

OpenAIResponsesErrorEvent ​

Re-exports OpenAIResponsesErrorEvent

OpenAIResponsesFailedEvent ​

Re-exports OpenAIResponsesFailedEvent

OpenAIResponsesFunctionCallArgumentsDeltaEvent ​

Re-exports OpenAIResponsesFunctionCallArgumentsDeltaEvent

OpenAIResponsesFunctionCallArgumentsDoneEvent ​

Re-exports OpenAIResponsesFunctionCallArgumentsDoneEvent

OpenAIResponsesFunctionCallItem ​

Re-exports OpenAIResponsesFunctionCallItem

OpenAIResponsesFunctionCallOutputItem ​

Re-exports OpenAIResponsesFunctionCallOutputItem

OpenAIResponsesHelpers ​

Re-exports OpenAIResponsesHelpers

OpenAIResponsesIncludable ​

Re-exports OpenAIResponsesIncludable

OpenAIResponsesIncompleteEvent ​

Re-exports OpenAIResponsesIncompleteEvent

OpenAIResponsesInputContentBlock ​

Re-exports OpenAIResponsesInputContentBlock

OpenAIResponsesInputItem ​

Re-exports OpenAIResponsesInputItem

OpenAIResponsesMessageItem ​

Re-exports OpenAIResponsesMessageItem

OpenAIResponsesOpaqueOutputItem ​

Re-exports OpenAIResponsesOpaqueOutputItem

openAIResponsesOptionsSchema ​

Re-exports openAIResponsesOptionsSchema

OpenAIResponsesOutputItem ​

Re-exports OpenAIResponsesOutputItem

OpenAIResponsesOutputItemAddedEvent ​

Re-exports OpenAIResponsesOutputItemAddedEvent

OpenAIResponsesOutputItemDoneEvent ​

Re-exports OpenAIResponsesOutputItemDoneEvent

OpenAIResponsesOutputMessageContentPart ​

Re-exports OpenAIResponsesOutputMessageContentPart

OpenAIResponsesOutputMessageItem ​

Re-exports OpenAIResponsesOutputMessageItem

OpenAIResponsesOutputTextDeltaEvent ​

Re-exports OpenAIResponsesOutputTextDeltaEvent

OpenAIResponsesOutputTextDoneEvent ​

Re-exports OpenAIResponsesOutputTextDoneEvent

OpenAIResponsesReasoningContentPart ​

Re-exports OpenAIResponsesReasoningContentPart

OpenAIResponsesReasoningItem ​

Re-exports OpenAIResponsesReasoningItem

OpenAIResponsesReasoningReplayPayload ​

Re-exports OpenAIResponsesReasoningReplayPayload

OpenAIResponsesReasoningSummaryPart ​

Re-exports OpenAIResponsesReasoningSummaryPart

OpenAIResponsesReasoningSummaryTextDeltaEvent ​

Re-exports OpenAIResponsesReasoningSummaryTextDeltaEvent

OpenAIResponsesReasoningSummaryTextDoneEvent ​

Re-exports OpenAIResponsesReasoningSummaryTextDoneEvent

OpenAIResponsesReasoningTextDeltaEvent ​

Re-exports OpenAIResponsesReasoningTextDeltaEvent

OpenAIResponsesReasoningTextDoneEvent ​

Re-exports OpenAIResponsesReasoningTextDoneEvent

OpenAIResponsesRefusalDeltaEvent ​

Re-exports OpenAIResponsesRefusalDeltaEvent

OpenAIResponsesRefusalDoneEvent ​

Re-exports OpenAIResponsesRefusalDoneEvent

OpenAIResponsesRequestBody ​

Re-exports OpenAIResponsesRequestBody

OpenAIResponsesResponseObject ​

Re-exports OpenAIResponsesResponseObject

OpenAIResponsesStreamEvent ​

Re-exports OpenAIResponsesStreamEvent

OpenAIResponsesTool ​

Re-exports OpenAIResponsesTool

OpenAIResponsesToolChoice ​

Re-exports OpenAIResponsesToolChoice

OpenAIResponsesUsage ​

Re-exports OpenAIResponsesUsage

ReasoningReplayMode ​

Re-exports ReasoningReplayMode

renderArtifactHandleBody ​

Re-exports renderArtifactHandleBody

renderChatCompletionsSystemPrompt ​

Re-exports renderChatCompletionsSystemPrompt

renderFirstPartyRetrievables ​

Re-exports renderFirstPartyRetrievables

renderMemories ​

Re-exports renderMemories

renderOpenAIResponsesMediaBlocks ​

Re-exports renderOpenAIResponsesMediaBlocks

renderOpenAIResponsesReasoningItem ​

Re-exports renderOpenAIResponsesReasoningItem

renderOpenAIResponsesTimelineMessage ​

Re-exports renderOpenAIResponsesTimelineMessage

renderOpenAIResponsesToolCallResult ​

Re-exports renderOpenAIResponsesToolCallResult

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

ResponsesOutputSlot ​

Re-exports ResponsesOutputSlot

ResponsesOutputSlotMachine ​

Re-exports ResponsesOutputSlotMachine

ResponsesTextSlot ​

Re-exports ResponsesTextSlot

ResponsesThinkingSlot ​

Re-exports ResponsesThinkingSlot

ResponsesToolCallSlot ​

Re-exports ResponsesToolCallSlot

RetrievableAttrs ​

Re-exports RetrievableAttrs

sanitizeFilenameForDescription ​

Re-exports sanitizeFilenameForDescription

sanitizeMimeType ​

Re-exports sanitizeMimeType

StandingInstructionAttrs ​

Re-exports StandingInstructionAttrs

stripEnvelopeSpecialTokens ​

Re-exports stripEnvelopeSpecialTokens

SystemPromptChannel ​

Re-exports SystemPromptChannel

ThoughtAttrs ​

Re-exports ThoughtAttrs

ToolCallParserFn ​

Re-exports ToolCallParserFn

ToolCallParserName ​

Re-exports ToolCallParserName

toolsToChatCompletionsTools ​

Re-exports toolsToChatCompletionsTools

toolsToOpenAIResponsesTools ​

Re-exports toolsToOpenAIResponsesTools

TrustedContentAttrs ​

Re-exports TrustedContentAttrs

UnsupportedMediaPolicy ​

Re-exports UnsupportedMediaPolicy

UntrustedContentAttrs ​

Re-exports UntrustedContentAttrs

validateOptions ​

Re-exports validateOptions

Copyright © 2025-present New Horizon Technology LTD