--- url: >- https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/interfaces/ChatHelpersCommon.md description: >- The 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. --- # Interface: ChatHelpersCommon Defined in: [batteries/llm/chat\_common/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L278) The 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. ## Remarks Both `ChatCompletionsHelpers` (OpenAI battery) and `OllamaHelpers` (Ollama battery) extend this contract and add their own wire-specific members (timeline-message rendering, tool-call-result rendering, history assembly, and — for OpenAI — streaming tool-call delta accumulation). Helpers that compose other helpers receive their dependents via explicit `deps` arguments typed against THIS contract (never against a battery-specific bag), so the shared implementations carry no import edge back to any individual battery. ## Extended by * [`ChatCompletionsHelpers`](../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md) * [`OllamaHelpers`](../types/interfaces/OllamaHelpers.md) ## Properties | Property | Type | Description | Defined in | | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [batteries/llm/chat\_common/types.ts:280](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L280) | | `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../common/classes/Thought.md)>, `mode`: `"all-self"` | `"latest-self"` | `"all"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\[]) => [`Thought`](../../../../common/classes/Thought.md)\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [batteries/llm/chat\_common/types.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L322) | | `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md). | [batteries/llm/chat\_common/types.ts:334](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L334) | | `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [batteries/llm/chat\_common/types.ts:295](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L295) | | `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [batteries/llm/chat\_common/types.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L291) | | `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [batteries/llm/chat\_common/types.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L309) | | `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [batteries/llm/chat\_common/types.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L293) | | `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [batteries/llm/chat\_common/types.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L286) | | `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [batteries/llm/chat\_common/types.ts:304](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L304) | | `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../common/classes/Retrievable.md); }>, `deps`: { `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [batteries/llm/chat\_common/types.ts:299](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L299) | | `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [batteries/llm/chat\_common/types.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L320) | | `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [batteries/llm/chat\_common/types.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L284) | | `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [batteries/llm/chat\_common/types.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L282) | | `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../forge/classes/ArtifactTool.md))\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../interfaces/ChatCompletionsTool.md)\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [batteries/llm/chat\_common/types.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260609.0/src/batteries/llm/chat_common/types.ts#L329) |