@codesoul-co/hypha-inference / types

• Package index: @codesoul-co/hypha-inference
• Source: packages/inference/src/types.ts
• Exports: 41

Using this module

Use the Types module for declaring and runtime-validating contracts. It exports 34 interfaces, 7 types.

Import from the package entrypoint

import type {
  CompiledPrompt,
  InferenceBackend,
  InferenceBackendCapabilities,
  InferenceBackendRegistryEntry,
  InferenceBackendRequest,
  InferenceBackendResponse,
  InferenceCacheIssue,
  InferenceCachePolicy,
} from '@codesoul-co/hypha-inference';

// The complete export list is documented below.

Usage patterns

• Use the 41 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

Symbol	Kind	Signature	Description
CompiledPrompt	interface	interface CompiledPrompt	Compiled Prompt interface with 4 public fields or methods.
InferenceBackend	interface	interface InferenceBackend	Inference Backend interface with 5 public fields or methods.
InferenceBackendCapabilities	interface	interface InferenceBackendCapabilities	Inference Backend Capabilities interface with 6 public fields or methods.
InferenceBackendRegistryEntry	interface	interface InferenceBackendRegistryEntry	Inference Backend Registry Entry interface with 3 public fields or methods.
InferenceBackendRequest	interface	interface InferenceBackendRequest	Inference Backend Request interface with 14 public fields or methods.
InferenceBackendResponse	interface	interface InferenceBackendResponse	Inference Backend Response interface with 6 public fields or methods.
InferenceCacheIssue	interface	interface InferenceCacheIssue	Inference Cache Issue interface with 4 public fields or methods.
InferenceCachePolicy	interface	interface InferenceCachePolicy	Inference Cache Policy interface with 3 public fields or methods.
InferenceCacheScope	interface	interface InferenceCacheScope	Inference Cache Scope interface with 3 public fields or methods.
InferenceCacheUsage	interface	interface InferenceCacheUsage	Inference Cache Usage interface with 11 public fields or methods.
InferenceGenerationOptions	interface	interface InferenceGenerationOptions	Inference Generation Options interface with 9 public fields or methods.
InferenceManagerOptions	interface	interface InferenceManagerOptions	Inference Manager Options interface with 8 public fields or methods.
InferenceProvider	interface	interface InferenceProvider	Inference Provider interface with 3 public fields or methods.
InferenceRequest	interface	interface InferenceRequest	Inference Request interface with 18 public fields or methods.
InferenceResponse	interface	interface InferenceResponse	Inference Response interface with 7 public fields or methods.
InferenceToolDescriptor	interface	interface InferenceToolDescriptor	Inference Tool Descriptor interface with 4 public fields or methods.
InferenceUsage	interface	interface InferenceUsage	Inference Usage interface with 3 public fields or methods.
KvCacheProvider	interface	interface KvCacheProvider	Kv Cache Provider interface with 3 public fields or methods.
KvCacheRef	interface	interface KvCacheRef	Kv Cache Ref interface with 7 public fields or methods.
KvCacheWritePolicy	interface	interface KvCacheWritePolicy	Kv Cache Write Policy interface with 3 public fields or methods.
PlasmodCacheMetadata	interface	interface PlasmodCacheMetadata	Plasmod Cache Metadata interface with 10 public fields or methods.
PlasmodHotLayer	interface	interface PlasmodHotLayer	Plasmod Hot Layer interface with 4 public fields or methods.
PlasmodHotLayerPrepareInput	interface	interface PlasmodHotLayerPrepareInput	Plasmod Hot Layer Prepare Input interface with 12 public fields or methods.
PlasmodHotLayerPrepareResult	interface	interface PlasmodHotLayerPrepareResult	Plasmod Hot Layer Prepare Result interface with 6 public fields or methods.
PlasmodReusePolicy	interface	interface PlasmodReusePolicy	Plasmod Reuse Policy interface with 5 public fields or methods.
PlasmodSessionState	interface	interface PlasmodSessionState	Plasmod Session State interface with 10 public fields or methods.
PrefixCacheProvider	interface	interface PrefixCacheProvider	Prefix Cache Provider interface with 3 public fields or methods.
PrefixCacheRef	interface	interface PrefixCacheRef	Prefix Cache Ref interface with 6 public fields or methods.
PrefixSegment	interface	interface PrefixSegment	Prefix Segment interface with 9 public fields or methods.
PrefixSegmentationResult	interface	interface PrefixSegmentationResult	Prefix Segmentation Result interface with 5 public fields or methods.
PrefixSegmenter	interface	interface PrefixSegmenter	Prefix Segmenter interface with 1 public fields or methods.
PromptCompileInput	interface	interface PromptCompileInput	Prompt Compile Input interface with 11 public fields or methods.
PromptCompiler	interface	interface PromptCompiler	Prompt Compiler interface with 1 public fields or methods.
PromptMessage	interface	interface PromptMessage	Prompt Message interface with 4 public fields or methods.
InferenceBackendKind	type	type InferenceBackendKind = 'ollama' | 'sglang' | 'vllm' | 'llama.cpp' | 'openai-api'	Public type alias for Inference Backend Kind; the declaration contains its complete type expression.
InferenceCacheMissReason	type	type InferenceCacheMissReason = 'missing' | 'expired' | 'not_configured' | 'error'	Public type alias for Inference Cache Miss Reason; the declaration contains its complete type expression.
KvCacheScope	type	type KvCacheScope = 'run' | 'session' | 'workspace'	Public type alias for Kv Cache Scope; the declaration contains its complete type expression.
KvCacheWriteMode	type	type KvCacheWriteMode = 'write_through' | 'write_if_missing' | 'refresh'	Public type alias for Kv Cache Write Mode; the declaration contains its complete type expression.
PrefixSegmentKind	type	type PrefixSegmentKind = 'system' | 'developer' | 'context' | 'memory' | 'tool' | 'user' | 'assistant'	Public type alias for Prefix Segment Kind; the declaration contains its complete type expression.
PrefixSegmentScope	type	type PrefixSegmentScope = 'global' | 'agent' | 'session' | 'run' | 'dynamic'	Public type alias for Prefix Segment Scope; the declaration contains its complete type expression.
PromptRole	type	type PromptRole = 'system' | 'developer' | 'user' | 'assistant' | 'tool' | 'context' | 'memory'	Public type alias for Prompt Role; the declaration contains its complete type expression.

CompiledPrompt

Compiled Prompt interface with 4 public fields or methods.

• Kind: interface
• Import: import type { CompiledPrompt } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface CompiledPrompt {
    id: string;
    messages: PromptMessage[];
    text: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages: PromptMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
text	property	text: string	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceBackend

Inference Backend interface with 5 public fields or methods.

• Kind: interface
• Import: import type { InferenceBackend } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceBackend {
    id: string;
    kind: InferenceBackendKind;
    capabilities(): InferenceBackendCapabilities;
    infer(request: InferenceBackendRequest): Promise<InferenceBackendResponse>;
    stream?(request: InferenceBackendRequest): AsyncIterable<InferenceBackendResponse>;
}

Contract members

Member	Kind	Signature	Description
capabilities	method	capabilities(): InferenceBackendCapabilities	Public method; parameters and return type are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
infer	method	infer(request: InferenceBackendRequest): Promise<InferenceBackendResponse>	Public method; parameters and return type are shown in the signature.
kind	property	kind: InferenceBackendKind	Public property; its type, readonly modifier and optionality are shown in the signature.
stream	method	stream?(request: InferenceBackendRequest): AsyncIterable<InferenceBackendResponse>	Public method; parameters and return type are shown in the signature.

InferenceBackendCapabilities

Inference Backend Capabilities interface with 6 public fields or methods.

• Kind: interface
• Import: import type { InferenceBackendCapabilities } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceBackendCapabilities {
    streaming: boolean;
    chatCompletions: boolean;
    textCompletions: boolean;
    prefixCaching: boolean;
    kvCaching: boolean;
    cacheInvalidation: boolean;
}

Contract members

Member	Kind	Signature	Description
cacheInvalidation	property	cacheInvalidation: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
chatCompletions	property	chatCompletions: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCaching	property	kvCaching: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixCaching	property	prefixCaching: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
streaming	property	streaming: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
textCompletions	property	textCompletions: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceBackendRegistryEntry

Inference Backend Registry Entry interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceBackendRegistryEntry } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceBackendRegistryEntry {
    id: string;
    backend: InferenceBackend;
    default?: boolean;
}

Contract members

Member	Kind	Signature	Description
backend	property	backend: InferenceBackend	Public property; its type, readonly modifier and optionality are shown in the signature.
default	property	default?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceBackendRequest

Inference Backend Request interface with 14 public fields or methods.

• Kind: interface
• Import: import type { InferenceBackendRequest } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceBackendRequest {
    runId: string;
    stepId: string;
    sessionId?: string;
    agentId?: string;
    modelAlias: string;
    compiledPrompt: CompiledPrompt;
    segmentation: PrefixSegmentationResult;
    prefixRefs: PrefixCacheRef[];
    kvCache?: KvCacheRef;
    resolvedKvCacheValue?: unknown;
    physicalKvCache?: unknown;
    options?: InferenceGenerationOptions;
    tools?: InferenceToolDescriptor[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
compiledPrompt	property	compiledPrompt: CompiledPrompt	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCache	property	kvCache?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
options	property	options?: InferenceGenerationOptions	Public property; its type, readonly modifier and optionality are shown in the signature.
physicalKvCache	property	physicalKvCache?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixRefs	property	prefixRefs: PrefixCacheRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
resolvedKvCacheValue	property	resolvedKvCacheValue?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
segmentation	property	segmentation: PrefixSegmentationResult	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tools	property	tools?: InferenceToolDescriptor[]	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceBackendResponse

Inference Backend Response interface with 6 public fields or methods.

• Kind: interface
• Import: import type { InferenceBackendResponse } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceBackendResponse<TOutput = unknown> {
    id: string;
    output: TOutput;
    usage?: InferenceUsage;
    physicalKvCache?: unknown;
    metadata?: Record<string, unknown>;
    raw?: unknown;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output: TOutput	Public property; its type, readonly modifier and optionality are shown in the signature.
physicalKvCache	property	physicalKvCache?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
raw	property	raw?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
usage	property	usage?: InferenceUsage	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceCacheIssue

Inference Cache Issue interface with 4 public fields or methods.

• Kind: interface
• Import: import type { InferenceCacheIssue } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceCacheIssue {
    operation: 'prefix_read' | 'kv_read' | 'kv_write' | 'invalidate';
    code: string;
    message: string;
    bypassed: boolean;
}

Contract members

Member	Kind	Signature	Description
bypassed	property	bypassed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
code	property	code: string	Public property; its type, readonly modifier and optionality are shown in the signature.
message	property	message: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: "prefix_read" | "kv_read" | "kv_write" | "invalidate"	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceCachePolicy

Inference Cache Policy interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceCachePolicy } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceCachePolicy {
    prefix?: PrefixCacheRef;
    kvCache?: KvCacheRef;
    writeKvCache?: KvCacheWritePolicy;
}

Contract members

Member	Kind	Signature	Description
kvCache	property	kvCache?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
prefix	property	prefix?: PrefixCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
writeKvCache	property	writeKvCache?: KvCacheWritePolicy	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceCacheScope

Inference Cache Scope interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceCacheScope } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceCacheScope {
    tenantId?: string;
    userId: string;
    workspaceId?: string;
}

Contract members

Member	Kind	Signature	Description
tenantId	property	tenantId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
userId	property	userId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceId	property	workspaceId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceCacheUsage

Inference Cache Usage interface with 11 public fields or methods.

• Kind: interface
• Import: import type { InferenceCacheUsage } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceCacheUsage {
    prefixHit?: boolean;
    kvCacheHit?: boolean;
    servingCache?: Record<string, unknown>;
    prefixRef?: PrefixCacheRef;
    kvCacheRef?: KvCacheRef;
    kvCacheMissReason?: InferenceCacheMissReason;
    kvCacheWritten?: boolean;
    kvCacheWriteRef?: KvCacheRef;
    reusedTokens?: number;
    bypassed?: boolean;
    issues?: InferenceCacheIssue[];
}

Contract members

Member	Kind	Signature	Description
bypassed	property	bypassed?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
issues	property	issues?: InferenceCacheIssue[]	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheHit	property	kvCacheHit?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheMissReason	property	kvCacheMissReason?: InferenceCacheMissReason	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheRef	property	kvCacheRef?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheWriteRef	property	kvCacheWriteRef?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheWritten	property	kvCacheWritten?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixHit	property	prefixHit?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixRef	property	prefixRef?: PrefixCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
reusedTokens	property	reusedTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
servingCache	property	servingCache?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceGenerationOptions

Inference Generation Options interface with 9 public fields or methods.

• Kind: interface
• Import: import type { InferenceGenerationOptions } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceGenerationOptions {
    temperature?: number;
    maxTokens?: number;
    topP?: number;
    topK?: number;
    stop?: string[];
    seed?: number;
    stream?: boolean;
    responseFormat?: 'text' | 'json_object' | {
        type: string;
        schema?: unknown;
    };
    extra?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
extra	property	extra?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTokens	property	maxTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
responseFormat	property	responseFormat?: "text" | "json_object" | { type: string; schema?: unknown; }	Public property; its type, readonly modifier and optionality are shown in the signature.
seed	property	seed?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
stop	property	stop?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
stream	property	stream?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
temperature	property	temperature?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
topK	property	topK?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
topP	property	topP?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceManagerOptions

Inference Manager Options interface with 8 public fields or methods.

• Kind: interface
• Import: import type { InferenceManagerOptions } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceManagerOptions {
    prefixCache?: PrefixCacheProvider;
    kvCache?: KvCacheProvider;
    cacheFailureMode?: 'bypass' | 'strict';
    cacheOperationTimeoutMs?: number;
    providerRevision?: string;
    policyRevision?: string;
    specRevision?: string;
    onRecoveryFailure?: (failure: RecoveryFailure) => void | Promise<void>;
}

Contract members

Member	Kind	Signature	Description
cacheFailureMode	property	cacheFailureMode?: "strict" | "bypass"	Public property; its type, readonly modifier and optionality are shown in the signature.
cacheOperationTimeoutMs	property	cacheOperationTimeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCache	property	kvCache?: KvCacheProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
onRecoveryFailure	method	onRecoveryFailure?(failure: RecoveryFailure): void | Promise<void>	Public method; parameters and return type are shown in the signature.
policyRevision	property	policyRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixCache	property	prefixCache?: PrefixCacheProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
providerRevision	property	providerRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
specRevision	property	specRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceProvider

Inference Provider interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceProvider } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceProvider {
    id: string;
    infer(request: InferenceRequest): Promise<InferenceResponse>;
    stream?(request: InferenceRequest): AsyncIterable<InferenceResponse>;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
infer	method	infer(request: InferenceRequest): Promise<InferenceResponse>	Public method; parameters and return type are shown in the signature.
stream	method	stream?(request: InferenceRequest): AsyncIterable<InferenceResponse>	Public method; parameters and return type are shown in the signature.

InferenceRequest

Inference Request interface with 18 public fields or methods.

• Kind: interface
• Import: import type { InferenceRequest } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceRequest<TInput = unknown> {
    runId: string;
    stepId: string;
    sessionId?: string;
    agentId?: string;
    modelAlias: string;
    providerId?: string;
    backendId?: string;
    input: TInput;
    options?: InferenceGenerationOptions;
    tools?: InferenceToolDescriptor[];
    cachePolicy?: InferenceCachePolicy;
    cacheScope?: InferenceCacheScope;
    prefix?: PrefixCacheRef;
    resolvedPrefixContent?: string;
    kvCache?: KvCacheRef;
    resolvedKvCacheValue?: unknown;
    trace?: boolean;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
backendId	property	backendId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
cachePolicy	property	cachePolicy?: InferenceCachePolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
cacheScope	property	cacheScope?: InferenceCacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: TInput	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCache	property	kvCache?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
options	property	options?: InferenceGenerationOptions	Public property; its type, readonly modifier and optionality are shown in the signature.
prefix	property	prefix?: PrefixCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
resolvedKvCacheValue	property	resolvedKvCacheValue?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
resolvedPrefixContent	property	resolvedPrefixContent?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tools	property	tools?: InferenceToolDescriptor[]	Public property; its type, readonly modifier and optionality are shown in the signature.
trace	property	trace?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceResponse

Inference Response interface with 7 public fields or methods.

• Kind: interface
• Import: import type { InferenceResponse } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceResponse<TOutput = unknown> {
    id: string;
    output: TOutput;
    usage?: InferenceUsage;
    cache?: InferenceCacheUsage;
    nextKvCacheValue?: unknown;
    metadata?: Record<string, unknown>;
    raw?: unknown;
}

Contract members

Member	Kind	Signature	Description
cache	property	cache?: InferenceCacheUsage	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
nextKvCacheValue	property	nextKvCacheValue?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output: TOutput	Public property; its type, readonly modifier and optionality are shown in the signature.
raw	property	raw?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
usage	property	usage?: InferenceUsage	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceToolDescriptor

Inference Tool Descriptor interface with 4 public fields or methods.

• Kind: interface
• Import: import type { InferenceToolDescriptor } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceToolDescriptor {
    id: string;
    name: string;
    description?: string;
    inputSchema: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
description	property	description?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
inputSchema	property	inputSchema: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name: string	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceUsage

Inference Usage interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InferenceUsage } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface InferenceUsage {
    inputTokens?: number;
    outputTokens?: number;
    totalTokens?: number;
}

Contract members

Member	Kind	Signature	Description
inputTokens	property	inputTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
outputTokens	property	outputTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
totalTokens	property	totalTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

KvCacheProvider

Kv Cache Provider interface with 3 public fields or methods.

• Kind: interface
• Import: import type { KvCacheProvider } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface KvCacheProvider {
    get(ref: KvCacheRef): Promise<unknown | null>;
    put(ref: KvCacheRef, value: unknown): Promise<void>;
    invalidate(ref: KvCacheRef, reason: string): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
get	method	get(ref: KvCacheRef): Promise<unknown | null>	Public method; parameters and return type are shown in the signature.
invalidate	method	invalidate(ref: KvCacheRef, reason: string): Promise<void>	Public method; parameters and return type are shown in the signature.
put	method	put(ref: KvCacheRef, value: unknown): Promise<void>	Public method; parameters and return type are shown in the signature.

KvCacheRef

Kv Cache Ref interface with 7 public fields or methods.

• Kind: interface
• Import: import type { KvCacheRef } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface KvCacheRef {
    id: string;
    provider: string;
    modelAlias: string;
    scope: KvCacheScope;
    cacheScope?: InferenceCacheScope;
    expiresAt?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
cacheScope	property	cacheScope?: InferenceCacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
provider	property	provider: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: KvCacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.

KvCacheWritePolicy

Kv Cache Write Policy interface with 3 public fields or methods.

• Kind: interface
• Import: import type { KvCacheWritePolicy } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface KvCacheWritePolicy {
    ref: KvCacheRef;
    value?: unknown;
    mode?: KvCacheWriteMode;
}

Contract members

Member	Kind	Signature	Description
mode	property	mode?: KvCacheWriteMode	Public property; its type, readonly modifier and optionality are shown in the signature.
ref	property	ref: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
value	property	value?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.

PlasmodCacheMetadata

Plasmod Cache Metadata interface with 10 public fields or methods.

• Kind: interface
• Import: import type { PlasmodCacheMetadata } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodCacheMetadata {
    segmentId: string;
    contentHash: string;
    backendId: string;
    modelAlias: string;
    scope: PrefixSegmentScope;
    tokenCount?: number;
    reused: boolean;
    createdAt: string;
    updatedAt: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
backendId	property	backendId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reused	property	reused: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: PrefixSegmentScope	Public property; its type, readonly modifier and optionality are shown in the signature.
segmentId	property	segmentId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tokenCount	property	tokenCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PlasmodHotLayer

Plasmod Hot Layer interface with 4 public fields or methods.

• Kind: interface
• Import: import type { PlasmodHotLayer } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodHotLayer {
    prepare(input: PlasmodHotLayerPrepareInput): Promise<PlasmodHotLayerPrepareResult>;
    invalidateSegment(segmentId: string, reason: string): Promise<void>;
    getSessionState(stateId: string): PlasmodSessionState | null;
    getCacheMetadata(segmentId: string): PlasmodCacheMetadata | null;
}

Contract members

Member	Kind	Signature	Description
getCacheMetadata	method	getCacheMetadata(segmentId: string): PlasmodCacheMetadata | null	Public method; parameters and return type are shown in the signature.
getSessionState	method	getSessionState(stateId: string): PlasmodSessionState | null	Public method; parameters and return type are shown in the signature.
invalidateSegment	method	invalidateSegment(segmentId: string, reason: string): Promise<void>	Public method; parameters and return type are shown in the signature.
prepare	method	prepare(input: PlasmodHotLayerPrepareInput): Promise<PlasmodHotLayerPrepareResult>	Public method; parameters and return type are shown in the signature.

PlasmodHotLayerPrepareInput

Plasmod Hot Layer Prepare Input interface with 12 public fields or methods.

• Kind: interface
• Import: import type { PlasmodHotLayerPrepareInput } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodHotLayerPrepareInput {
    runId: string;
    stepId: string;
    sessionId?: string;
    agentId?: string;
    modelAlias: string;
    backendId: string;
    cacheScope?: InferenceCacheScope;
    segmentation: PrefixSegmentationResult;
    kvCache?: KvCacheRef;
    resolvedKvCacheValue?: unknown;
    reusePolicy?: PlasmodReusePolicy;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
backendId	property	backendId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
cacheScope	property	cacheScope?: InferenceCacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCache	property	kvCache?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
resolvedKvCacheValue	property	resolvedKvCacheValue?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
reusePolicy	property	reusePolicy?: PlasmodReusePolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
segmentation	property	segmentation: PrefixSegmentationResult	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PlasmodHotLayerPrepareResult

Plasmod Hot Layer Prepare Result interface with 6 public fields or methods.

• Kind: interface
• Import: import type { PlasmodHotLayerPrepareResult } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodHotLayerPrepareResult {
    prefixRefs: PrefixCacheRef[];
    kvCacheRef?: KvCacheRef;
    physicalKvCache?: unknown;
    reusedSegmentIds: string[];
    invalidatedSegmentIds: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
invalidatedSegmentIds	property	invalidatedSegmentIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheRef	property	kvCacheRef?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
physicalKvCache	property	physicalKvCache?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixRefs	property	prefixRefs: PrefixCacheRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
reusedSegmentIds	property	reusedSegmentIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

PlasmodReusePolicy

Plasmod Reuse Policy interface with 5 public fields or methods.

• Kind: interface
• Import: import type { PlasmodReusePolicy } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodReusePolicy {
    allowCrossSession?: boolean;
    allowCrossAgent?: boolean;
    minTokenCount?: number;
    requireExactHash?: boolean;
    maxPrefixRefs?: number;
}

Contract members

Member	Kind	Signature	Description
allowCrossAgent	property	allowCrossAgent?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowCrossSession	property	allowCrossSession?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPrefixRefs	property	maxPrefixRefs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
minTokenCount	property	minTokenCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
requireExactHash	property	requireExactHash?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

PlasmodSessionState

Plasmod Session State interface with 10 public fields or methods.

• Kind: interface
• Import: import type { PlasmodSessionState } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PlasmodSessionState {
    id: string;
    sessionId?: string;
    runId: string;
    agentId?: string;
    modelAlias: string;
    backendId: string;
    prefixRefs: PrefixCacheRef[];
    kvCacheRef?: KvCacheRef;
    updatedAt: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
backendId	property	backendId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
kvCacheRef	property	kvCacheRef?: KvCacheRef	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixRefs	property	prefixRefs: PrefixCacheRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PrefixCacheProvider

Prefix Cache Provider interface with 3 public fields or methods.

• Kind: interface
• Import: import type { PrefixCacheProvider } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PrefixCacheProvider {
    get(ref: PrefixCacheRef): Promise<string | null>;
    put(ref: PrefixCacheRef, content: string): Promise<void>;
    invalidate(ref: PrefixCacheRef, reason: string): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
get	method	get(ref: PrefixCacheRef): Promise<string | null>	Public method; parameters and return type are shown in the signature.
invalidate	method	invalidate(ref: PrefixCacheRef, reason: string): Promise<void>	Public method; parameters and return type are shown in the signature.
put	method	put(ref: PrefixCacheRef, content: string): Promise<void>	Public method; parameters and return type are shown in the signature.

PrefixCacheRef

Prefix Cache Ref interface with 6 public fields or methods.

• Kind: interface
• Import: import type { PrefixCacheRef } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PrefixCacheRef {
    id: string;
    version: string;
    contentHash: string;
    tokenCount?: number;
    cacheScope?: InferenceCacheScope;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
cacheScope	property	cacheScope?: InferenceCacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
tokenCount	property	tokenCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PrefixSegment

Prefix Segment interface with 9 public fields or methods.

• Kind: interface
• Import: import type { PrefixSegment } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PrefixSegment {
    id: string;
    kind: PrefixSegmentKind;
    scope: PrefixSegmentScope;
    content: string;
    contentHash: string;
    tokenCount?: number;
    cacheable: boolean;
    dependencies?: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
cacheable	property	cacheable: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
content	property	content: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
dependencies	property	dependencies?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
kind	property	kind: PrefixSegmentKind	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: PrefixSegmentScope	Public property; its type, readonly modifier and optionality are shown in the signature.
tokenCount	property	tokenCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

PrefixSegmentationResult

Prefix Segmentation Result interface with 5 public fields or methods.

• Kind: interface
• Import: import type { PrefixSegmentationResult } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PrefixSegmentationResult {
    compiled: CompiledPrompt;
    segments: PrefixSegment[];
    stablePrefix: string;
    dynamicPrompt: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
compiled	property	compiled: CompiledPrompt	Public property; its type, readonly modifier and optionality are shown in the signature.
dynamicPrompt	property	dynamicPrompt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
segments	property	segments: PrefixSegment[]	Public property; its type, readonly modifier and optionality are shown in the signature.
stablePrefix	property	stablePrefix: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PrefixSegmenter

Prefix Segmenter interface with 1 public fields or methods.

• Kind: interface
• Import: import type { PrefixSegmenter } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PrefixSegmenter {
    segment(prompt: CompiledPrompt): Promise<PrefixSegmentationResult>;
}

Contract members

Member	Kind	Signature	Description
segment	method	segment(prompt: CompiledPrompt): Promise<PrefixSegmentationResult>	Public method; parameters and return type are shown in the signature.

PromptCompileInput

Prompt Compile Input interface with 11 public fields or methods.

• Kind: interface
• Import: import type { PromptCompileInput } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PromptCompileInput<TInput = unknown> {
    runId: string;
    stepId: string;
    sessionId?: string;
    agentId?: string;
    modelAlias: string;
    instructions?: string;
    messages?: PromptMessage[];
    input: TInput;
    context?: Record<string, unknown>;
    resolvedPrefixContent?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
context	property	context?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: TInput	Public property; its type, readonly modifier and optionality are shown in the signature.
instructions	property	instructions?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages?: PromptMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
resolvedPrefixContent	property	resolvedPrefixContent?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PromptCompiler

Prompt Compiler interface with 1 public fields or methods.

• Kind: interface
• Import: import type { PromptCompiler } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PromptCompiler {
    compile<TInput = unknown>(input: PromptCompileInput<TInput>): Promise<CompiledPrompt>;
}

Contract members

Member	Kind	Signature	Description
compile	method	compile<TInput = unknown>(input: PromptCompileInput<TInput>): Promise<CompiledPrompt>	Public method; parameters and return type are shown in the signature.

PromptMessage

Prompt Message interface with 4 public fields or methods.

• Kind: interface
• Import: import type { PromptMessage } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export interface PromptMessage {
    role: PromptRole;
    content: string;
    name?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
content	property	content: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
role	property	role: PromptRole	Public property; its type, readonly modifier and optionality are shown in the signature.

InferenceBackendKind

Public type alias for Inference Backend Kind; the declaration contains its complete type expression.

• Kind: type
• Import: import type { InferenceBackendKind } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type InferenceBackendKind = 'ollama' | 'sglang' | 'vllm' | 'llama.cpp' | 'openai-api';

InferenceCacheMissReason

Public type alias for Inference Cache Miss Reason; the declaration contains its complete type expression.

• Kind: type
• Import: import type { InferenceCacheMissReason } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type InferenceCacheMissReason = 'missing' | 'expired' | 'not_configured' | 'error';

KvCacheScope

Public type alias for Kv Cache Scope; the declaration contains its complete type expression.

• Kind: type
• Import: import type { KvCacheScope } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type KvCacheScope = 'run' | 'session' | 'workspace';

KvCacheWriteMode

Public type alias for Kv Cache Write Mode; the declaration contains its complete type expression.

• Kind: type
• Import: import type { KvCacheWriteMode } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type KvCacheWriteMode = 'write_through' | 'write_if_missing' | 'refresh';

PrefixSegmentKind

Public type alias for Prefix Segment Kind; the declaration contains its complete type expression.

• Kind: type
• Import: import type { PrefixSegmentKind } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type PrefixSegmentKind = 'system' | 'developer' | 'context' | 'memory' | 'tool' | 'user' | 'assistant';

PrefixSegmentScope

Public type alias for Prefix Segment Scope; the declaration contains its complete type expression.

• Kind: type
• Import: import type { PrefixSegmentScope } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type PrefixSegmentScope = 'global' | 'agent' | 'session' | 'run' | 'dynamic';

PromptRole

Public type alias for Prompt Role; the declaration contains its complete type expression.

• Kind: type
• Import: import type { PromptRole } from '@codesoul-co/hypha-inference';
• Source module: types

Declaration

export type PromptRole = 'system' | 'developer' | 'user' | 'assistant' | 'tool' | 'context' | 'memory';