@nhtio/adk

Appearance

6 min read · 1,288 words

@nhtio/adk ​

Root convenience barrel for the ADK's core runtime values and public TypeScript contracts.

Interfaces ​

InterfaceDescription
WarningEventA non-fatal warning surfaced on a runner's observability bus. Distinct from error (which ends the turn/dispatch): a warning means "something degraded but we continued." The first consumer is the token-estimation contract — when a real tokenizer throws inside a runner, the estimator degrades to a char-based guesstimate and emits this instead of throwing (see utils/estimation_context). The event shape mirrors LogEvent so consumers can render both uniformly, with dispatchId/iteration optional because a warning can also originate from a turn-level scope (no active dispatch).

Type Aliases ​

Type AliasDescription
TokenEncodingIdA recognised token-encoding identifier: one of the closed TokenEncoding built-ins, OR any other string registered via registerTokenEstimator.
TokenEstimatorFnA custom token-count function registered for a non-built-in TokenEncodingId via registerTokenEstimator.
TokenizableEvaluatorA DYNAMIC Tokenizable value: a function evaluated at prompt-ASSEMBLY time with the live dispatch context, so the wrapped content computes itself coherent with the dispatch it ships in (e.g. a citation instruction that adapts to whether the answer tool survived the subtractive-pass shed).

Variables ​

VariableDescription
versionThe current version of the package.

Functions ​

FunctionDescription
registerTokenEstimatorRegister (or replace) a TokenEstimatorFn for a custom TokenEncodingId, so Tokenizable.estimateTokens can measure it without a core code change.

References ​

ArtifactTool ​

Re-exports ArtifactTool

ArtifactToolHandler ​

Re-exports ArtifactToolHandler

BaseException ​

Re-exports BaseException

ConduitBytes ​

Re-exports ConduitBytes

DispatchContext ​

Re-exports DispatchContext

DispatchContextHookRegistrations ​

Re-exports DispatchContextHookRegistrations

DispatchContextHooks ​

Re-exports DispatchContextHooks

DispatchEndEvent ​

Re-exports DispatchEndEvent

DispatchExecutorFn ​

Re-exports DispatchExecutorFn

DispatchExecutorHelpers ​

Re-exports DispatchExecutorHelpers

DispatchExecutorLogChannel ​

Re-exports DispatchExecutorLogChannel

DispatchExecutorLogEntry ​

Re-exports DispatchExecutorLogEntry

DispatchExecutorLogLevel ​

Re-exports DispatchExecutorLogLevel

DispatchMediaBytesStoreFn ​

Re-exports DispatchMediaBytesStoreFn

DispatchMemoryDeleteFn ​

Re-exports DispatchMemoryDeleteFn

DispatchMemoryMutateFn ​

Re-exports DispatchMemoryMutateFn

DispatchMemoryRetrievalFn ​

Re-exports DispatchMemoryRetrievalFn

DispatchMemoryStoreFn ​

Re-exports DispatchMemoryStoreFn

DispatchMessageDeleteFn ​

Re-exports DispatchMessageDeleteFn

DispatchMessageMutateFn ​

Re-exports DispatchMessageMutateFn

DispatchMessageRetrievalFn ​

Re-exports DispatchMessageRetrievalFn

DispatchMessageStoreFn ​

Re-exports DispatchMessageStoreFn

DispatchPipelineMiddlewareFn ​

Re-exports DispatchPipelineMiddlewareFn

DispatchRetrievableBytesStoreFn ​

Re-exports DispatchRetrievableBytesStoreFn

DispatchRunner ​

Re-exports DispatchRunner

DispatchRunnerFunctionalHookRegistrations ​

Re-exports DispatchRunnerFunctionalHookRegistrations

DispatchRunnerFunctionalHooks ​

Re-exports DispatchRunnerFunctionalHooks

DispatchRunnerObservabilityHookRegistrations ​

Re-exports DispatchRunnerObservabilityHookRegistrations

DispatchRunnerObservabilityHooks ​

Re-exports DispatchRunnerObservabilityHooks

DispatchStandingInstructionDeleteFn ​

Re-exports DispatchStandingInstructionDeleteFn

DispatchStandingInstructionMutateFn ​

Re-exports DispatchStandingInstructionMutateFn

DispatchStandingInstructionsRefreshFn ​

Re-exports DispatchStandingInstructionsRefreshFn

DispatchStandingInstructionStoreFn ​

Re-exports DispatchStandingInstructionStoreFn

DispatchStartEvent ​

Re-exports DispatchStartEvent

DispatchThoughtDeleteFn ​

Re-exports DispatchThoughtDeleteFn

DispatchThoughtMutateFn ​

Re-exports DispatchThoughtMutateFn

DispatchThoughtRetrievalFn ​

Re-exports DispatchThoughtRetrievalFn

DispatchThoughtStoreFn ​

Re-exports DispatchThoughtStoreFn

DispatchToolCallDeleteFn ​

Re-exports DispatchToolCallDeleteFn

DispatchToolCallMutateFn ​

Re-exports DispatchToolCallMutateFn

DispatchToolCallRetrievalFn ​

Re-exports DispatchToolCallRetrievalFn

DispatchToolCallStoreFn ​

Re-exports DispatchToolCallStoreFn

DispatchToolsRetrievalFn ​

Re-exports DispatchToolsRetrievalFn

E_ARTIFACT_ID_COLLISION ​

Re-exports E_ARTIFACT_ID_COLLISION

E_DISPATCH_PIPELINE_ERROR ​

Re-exports E_DISPATCH_PIPELINE_ERROR

E_INPUT_PIPELINE_ERROR ​

Re-exports E_INPUT_PIPELINE_ERROR

E_INVALID_INITIAL_IDENTITY_VALUE ​

Re-exports E_INVALID_INITIAL_IDENTITY_VALUE

E_INVALID_INITIAL_MEMORY_VALUE ​

Re-exports E_INVALID_INITIAL_MEMORY_VALUE

E_INVALID_INITIAL_MESSAGE_VALUE ​

Re-exports E_INVALID_INITIAL_MESSAGE_VALUE

E_INVALID_INITIAL_REGISTRY_VALUE ​

Re-exports E_INVALID_INITIAL_REGISTRY_VALUE

E_INVALID_INITIAL_THOUGHT_VALUE ​

Re-exports E_INVALID_INITIAL_THOUGHT_VALUE

E_INVALID_INITIAL_TOOL_CALL_VALUE ​

Re-exports E_INVALID_INITIAL_TOOL_CALL_VALUE

E_INVALID_INITIAL_TOOL_VALUE ​

Re-exports E_INVALID_INITIAL_TOOL_VALUE

E_INVALID_INITIAL_TURN_GATE_VALUE ​

Re-exports E_INVALID_INITIAL_TURN_GATE_VALUE

E_INVALID_LLM_DISPATCH_INPUT ​

Re-exports E_INVALID_LLM_DISPATCH_INPUT

E_INVALID_LLM_EXECUTION_CONTEXT ​

Re-exports E_INVALID_LLM_EXECUTION_CONTEXT

E_INVALID_TOOL_ARGS ​

Re-exports E_INVALID_TOOL_ARGS

E_INVALID_TURN_CONTEXT ​

Re-exports E_INVALID_TURN_CONTEXT

E_INVALID_TURN_GATE_RESOLUTION ​

Re-exports E_INVALID_TURN_GATE_RESOLUTION

E_INVALID_TURN_RUNNER_CONFIG ​

Re-exports E_INVALID_TURN_RUNNER_CONFIG

E_LLM_EXECUTION_ALREADY_SIGNALLED ​

Re-exports E_LLM_EXECUTION_ALREADY_SIGNALLED

E_LLM_EXECUTION_EXECUTOR_ERROR ​

Re-exports E_LLM_EXECUTION_EXECUTOR_ERROR

E_LLM_EXECUTION_GATE_NOT_SUPPORTED ​

Re-exports E_LLM_EXECUTION_GATE_NOT_SUPPORTED

E_NO_READER_RESOLVER ​

Re-exports E_NO_READER_RESOLVER

E_NOT_A_SPOOL_READER ​

Re-exports E_NOT_A_SPOOL_READER

E_OUTPUT_PIPELINE_ERROR ​

Re-exports E_OUTPUT_PIPELINE_ERROR

E_PIPELINE_SHORT_CIRCUITED ​

Re-exports E_PIPELINE_SHORT_CIRCUITED

E_READER_NOT_DESCRIBABLE ​

Re-exports E_READER_NOT_DESCRIBABLE

E_TOKEN_ESTIMATOR_SHADOWS_BUILTIN ​

Re-exports E_TOKEN_ESTIMATOR_SHADOWS_BUILTIN

E_TOKENIZABLE_EVALUATOR_INVALID ​

Re-exports E_TOKENIZABLE_EVALUATOR_INVALID

E_TOOL_ALREADY_REGISTERED ​

Re-exports E_TOOL_ALREADY_REGISTERED

E_TOOL_DOWNSTREAM_ERROR ​

Re-exports E_TOOL_DOWNSTREAM_ERROR

E_TURN_GATE_ABORTED ​

Re-exports E_TURN_GATE_ABORTED

E_TURN_GATE_TIMEOUT ​

Re-exports E_TURN_GATE_TIMEOUT

EmitMessageFn ​

Re-exports EmitMessageFn

EmitThoughtFn ​

Re-exports EmitThoughtFn

EmitToolCallFn ​

Re-exports EmitToolCallFn

EmitToolExecutionEndFn ​

Re-exports EmitToolExecutionEndFn

EmitToolExecutionStartFn ​

Re-exports EmitToolExecutionStartFn

fromFetch ​

Re-exports fromFetch

fromWebFile ​

Re-exports fromWebFile

Identity ​

Re-exports Identity

implementsMediaReader ​

Re-exports implementsMediaReader

implementsSpoolReader ​

Re-exports implementsSpoolReader

inMemoryMediaReader ​

Re-exports inMemoryMediaReader

isArtifactTool ​

Re-exports isArtifactTool

isBaseException ​

Re-exports isBaseException

isDispatchContext ​

Re-exports isDispatchContext

isDispatchRunner ​

Re-exports isDispatchRunner

isError ​

Re-exports isError

isIdentity ​

Re-exports isIdentity

isInstanceOf ​

Re-exports isInstanceOf

isMedia ​

Re-exports isMedia

isMemory ​

Re-exports isMemory

isMessage ​

Re-exports isMessage

isObject ​

Re-exports isObject

isRegistry ​

Re-exports isRegistry

isSpooledArtifact ​

Re-exports isSpooledArtifact

isSpooledArtifactConstructor ​

Re-exports isSpooledArtifactConstructor

isSpooledJsonArtifact ​

Re-exports isSpooledJsonArtifact

isSpooledMarkdownArtifact ​

Re-exports isSpooledMarkdownArtifact

isThought ​

Re-exports isThought

isTokenizable ​

Re-exports isTokenizable

isTool ​

Re-exports isTool

isToolCall ​

Re-exports isToolCall

isToolRegistry ​

Re-exports isToolRegistry

isTurnContext ​

Re-exports isTurnContext

isTurnGate ​

Re-exports isTurnGate

isTurnRunner ​

Re-exports isTurnRunner

IterationEndEvent ​

Re-exports IterationEndEvent

IterationStartEvent ​

Re-exports IterationStartEvent

JsonArtifactFormat ​

Re-exports JsonArtifactFormat

LogEvent ​

Re-exports LogEvent

MarkdownCodeEntry ​

Re-exports MarkdownCodeEntry

MarkdownHeadingEntry ​

Re-exports MarkdownHeadingEntry

MarkdownSection ​

Re-exports MarkdownSection

Media ​

Re-exports Media

MediaBytesStoreFn ​

Re-exports MediaBytesStoreFn

MediaKind ​

Re-exports MediaKind

MediaModalityHazard ​

Re-exports MediaModalityHazard

MediaReader ​

Re-exports MediaReader

mediaReaderSchema ​

Re-exports mediaReaderSchema

MediaStashEntry ​

Re-exports MediaStashEntry

MediaTrustTier ​

Re-exports MediaTrustTier

Memory ​

Re-exports Memory

MemoryDeleteFn ​

Re-exports MemoryDeleteFn

MemoryMutateFn ​

Re-exports MemoryMutateFn

MemoryRetrievalFn ​

Re-exports MemoryRetrievalFn

MemoryStoreFn ​

Re-exports MemoryStoreFn

MergeOptions ​

Re-exports MergeOptions

Message ​

Re-exports Message

MessageDeleteFn ​

Re-exports MessageDeleteFn

MessageMutateFn ​

Re-exports MessageMutateFn

MessageRetrievalFn ​

Re-exports MessageRetrievalFn

MessageRole ​

Re-exports MessageRole

MessageStoreFn ​

Re-exports MessageStoreFn

OpenGateFn ​

Re-exports OpenGateFn

RawArtifactTool ​

Re-exports RawArtifactTool

RawDispatchContext ​

Re-exports RawDispatchContext

RawDispatchRunnerInput ​

Re-exports RawDispatchRunnerInput

RawIdentity ​

Re-exports RawIdentity

RawMedia ​

Re-exports RawMedia

RawMemory ​

Re-exports RawMemory

RawMessage ​

Re-exports RawMessage

RawThought ​

Re-exports RawThought

RawTool ​

Re-exports RawTool

RawToolCall ​

Re-exports RawToolCall

RawTurnContext ​

Re-exports RawTurnContext

RawTurnGate ​

Re-exports RawTurnGate

Registry ​

Re-exports Registry

ResolvedTurnContext ​

Re-exports ResolvedTurnContext

ResolvedTurnRunnerConfig ​

Re-exports ResolvedTurnRunnerConfig

Retrievable ​

Re-exports Retrievable

RetrievableBytesStoreFn ​

Re-exports RetrievableBytesStoreFn

RetrievableDeleteFn ​

Re-exports RetrievableDeleteFn

RetrievableMutateFn ​

Re-exports RetrievableMutateFn

RetrievableRetrievalFn ​

Re-exports RetrievableRetrievalFn

RetrievableStoreFn ​

Re-exports RetrievableStoreFn

SerializedMedia ​

Re-exports SerializedMedia

SpooledArtifact ​

Re-exports SpooledArtifact

SpooledArtifactConstructor ​

Re-exports SpooledArtifactConstructor

SpooledJsonArtifact ​

Re-exports SpooledJsonArtifact

SpooledMarkdownArtifact ​

Re-exports SpooledMarkdownArtifact

SpoolReader ​

Re-exports SpoolReader

StandingInstructionDeleteFn ​

Re-exports StandingInstructionDeleteFn

StandingInstructionMutateFn ​

Re-exports StandingInstructionMutateFn

StandingInstructionsRefreshFn ​

Re-exports StandingInstructionsRefreshFn

StandingInstructionStoreFn ​

Re-exports StandingInstructionStoreFn

Thought ​

Re-exports Thought

ThoughtDeleteFn ​

Re-exports ThoughtDeleteFn

ThoughtMutateFn ​

Re-exports ThoughtMutateFn

ThoughtRetrievalFn ​

Re-exports ThoughtRetrievalFn

ThoughtStoreFn ​

Re-exports ThoughtStoreFn

TokenEncoding ​

Re-exports TokenEncoding

Tokenizable ​

Re-exports Tokenizable

Tool ​

Re-exports Tool

ToolCall ​

Re-exports ToolCall

ToolCallDeleteFn ​

Re-exports ToolCallDeleteFn

ToolCallMutateFn ​

Re-exports ToolCallMutateFn

ToolCallRetrievalFn ​

Re-exports ToolCallRetrievalFn

ToolCallStoreFn ​

Re-exports ToolCallStoreFn

ToolExecutionEndEvent ​

Re-exports ToolExecutionEndEvent

ToolExecutionStartEvent ​

Re-exports ToolExecutionStartEvent

ToolHandler ​

Re-exports ToolHandler

ToolMethodDescriptor ​

Re-exports ToolMethodDescriptor

ToolRegistry ​

Re-exports ToolRegistry

ToolsRetrievalFn ​

Re-exports ToolsRetrievalFn

TurnContext ​

Re-exports TurnContext

TurnEndEvent ​

Re-exports TurnEndEvent

TurnEvent ​

Re-exports TurnEvent

TurnEventListener ​

Re-exports TurnEventListener

TurnEvents ​

Re-exports TurnEvents

TurnGate ​

Re-exports TurnGate

TurnGateClosedEvent ​

Re-exports TurnGateClosedEvent

TurnObservabilityEvent ​

Re-exports TurnObservabilityEvent

TurnObservabilityEventListener ​

Re-exports TurnObservabilityEventListener

TurnObservabilityEvents ​

Re-exports TurnObservabilityEvents

TurnPipelineMiddlewareFn ​

Re-exports TurnPipelineMiddlewareFn

TurnRunner ​

Re-exports TurnRunner

TurnRunnerConfig ​

Re-exports TurnRunnerConfig

TurnStartEvent ​

Re-exports TurnStartEvent

TurnStreamableContent ​

Re-exports TurnStreamableContent

TurnToolCallContent ​

Re-exports TurnToolCallContent

ValidationException ​

Re-exports ValidationException

Copyright © 2025-present New Horizon Technology LTD