@codesoul-co/hypha-inference / reasoning
- 包索引:
@codesoul-co/hypha-inference - 源码:
packages/inference/src/reasoning.ts - 导出数: 13
模块用法
用于使用该功能边界的公共契约与操作。Reasoning 模块公开 1 类、6 接口、6 类型。
从包入口导入
ts
import {
ReasoningOrchestrator,
} from '@codesoul-co/hypha-inference';
import type {
ReasoningBudget,
ReasoningOptions,
ReasoningRequest,
ThoughtEdge,
ThoughtGraph,
ThoughtNode,
ReasoningAggregation,
ReasoningMethod,
} from '@codesoul-co/hypha-inference';
// 完整导出列表见下方。使用要点
- 12 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用
import type,运行时不应依赖它们。 - 1 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
ReasoningOrchestrator | 类 | new ReasoningOrchestrator(provider: InferenceProvider, id?: string, registry?: ReasoningStrategyRegistry): ReasoningOrchestrator | Reasoning Orchestrator 类,共公开 5 个构造函数或成员;精确签名见本条目的声明与成员表。 |
ReasoningBudget | 接口 | interface ReasoningBudget | Reasoning Budget 接口,共包含 3 个公开字段或方法。 |
ReasoningOptions | 接口 | interface ReasoningOptions | Reasoning Options 接口,共包含 14 个公开字段或方法。 |
ReasoningRequest | 接口 | interface ReasoningRequest extends InferenceRequest<TInput> | Reasoning Request 接口,共包含 19 个公开字段或方法。 |
ThoughtEdge | 接口 | interface ThoughtEdge | Thought Edge 接口,共包含 3 个公开字段或方法。 |
ThoughtGraph | 接口 | interface ThoughtGraph | Thought Graph 接口,共包含 5 个公开字段或方法。 |
ThoughtNode | 接口 | interface ThoughtNode | Thought Node 接口,共包含 9 个公开字段或方法。 |
ReasoningAggregation | 类型 | type ReasoningAggregation = 'first' | 'majority_vote' | 'score' | 'llm_judge' | Reasoning Aggregation 公共类型别名;完整类型表达式见声明。 |
ReasoningMethod | 类型 | type ReasoningMethod = 'direct' | 'cot' | 'tot' | 'got' | 'self_consistency' | Reasoning Method 公共类型别名;完整类型表达式见声明。 |
ReasoningTraceEvent | 类型 | type ReasoningTraceEvent = { type: 'reasoning.strategy.started'; method: ReasoningMethod; strategyId?: string; requestId: string; } | { type: 'reasoning.node.generated'; method: ReasoningMethod; node: ThoughtNode; } | { type: 'reasoning.node.evaluated'; method: ReasoningMethod; node: ThoughtNode; } | { type: 'reasoning.node.selected'; method: ReasoningMethod; node: ThoughtNode; } | { type: 'reasoning.strategy.comp... | Reasoning Trace Event 公共类型别名;完整类型表达式见声明。 |
ReasoningTraceSink | 类型 | type ReasoningTraceSink = (event: ReasoningTraceEvent) => Promise<void> | void | Reasoning Trace Sink 公共类型别名;完整类型表达式见声明。 |
ThoughtEdgeType | 类型 | type ThoughtEdgeType = 'expand' | 'merge' | 'refine' | 'criticize' | 'validate' | Thought Edge Type 公共类型别名;完整类型表达式见声明。 |
ThoughtNodeStatus | 类型 | type ThoughtNodeStatus = 'candidate' | 'evaluated' | 'selected' | 'rejected' | Thought Node Status 公共类型别名;完整类型表达式见声明。 |
ReasoningOrchestrator
Reasoning Orchestrator 类,共公开 5 个构造函数或成员;精确签名见本条目的声明与成员表。
- 种类: 类
- 导入:
import { ReasoningOrchestrator } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export declare class ReasoningOrchestrator implements InferenceProvider {
readonly id: string;
readonly registry: ReasoningStrategyRegistry;
constructor(provider: InferenceProvider, id?: string, registry?: ReasoningStrategyRegistry);
infer(request: ReasoningRequest): Promise<InferenceResponse>;
stream(request: ReasoningRequest): AsyncIterable<InferenceResponse>;
}公开成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
constructor | 构造函数 | (provider: InferenceProvider, id?: string, registry?: ReasoningStrategyRegistry): ReasoningOrchestrator | 创建该类的实例。 |
id | 属性 | readonly id: string | 公开属性;类型、只读和可选状态以签名列为准。 |
infer | 方法 | infer(request: ReasoningRequest): Promise<InferenceResponse> | 公开方法;参数与返回类型以签名列为准。 |
registry | 属性 | readonly registry: ReasoningStrategyRegistry | 公开属性;类型、只读和可选状态以签名列为准。 |
stream | 方法 | stream(request: ReasoningRequest): AsyncIterable<InferenceResponse> | 公开方法;参数与返回类型以签名列为准。 |
ReasoningBudget
Reasoning Budget 接口,共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ReasoningBudget } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ReasoningBudget {
maxModelCalls?: number;
maxNodes?: number;
timeoutMs?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
maxModelCalls | 属性 | maxModelCalls?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
maxNodes | 属性 | maxNodes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
timeoutMs | 属性 | timeoutMs?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
ReasoningOptions
Reasoning Options 接口,共包含 14 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ReasoningOptions } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ReasoningOptions {
method: ReasoningMethod;
strategyRef?: string;
branches?: number;
maxDepth?: number;
beamWidth?: number;
maxNodes?: number;
revealReasoning?: boolean;
aggregation?: ReasoningAggregation;
evaluatorRef?: string;
strategyVersion?: string;
budget?: ReasoningBudget;
evaluator?: (responses: InferenceResponse[]) => Promise<InferenceResponse>;
scorer?: (response: InferenceResponse, node: ThoughtNode) => Promise<number> | number;
trace?: ReasoningTraceSink;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
aggregation | 属性 | aggregation?: ReasoningAggregation | 公开属性;类型、只读和可选状态以签名列为准。 |
beamWidth | 属性 | beamWidth?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
branches | 属性 | branches?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
budget | 属性 | budget?: ReasoningBudget | 公开属性;类型、只读和可选状态以签名列为准。 |
evaluator | 方法 | evaluator?(responses: InferenceResponse[]): Promise<InferenceResponse> | 公开方法;参数与返回类型以签名列为准。 |
evaluatorRef | 属性 | evaluatorRef?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
maxDepth | 属性 | maxDepth?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
maxNodes | 属性 | maxNodes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
method | 属性 | method: ReasoningMethod | 公开属性;类型、只读和可选状态以签名列为准。 |
revealReasoning | 属性 | revealReasoning?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
scorer | 方法 | scorer?(response: InferenceResponse, node: ThoughtNode): Promise<number> | number | 公开方法;参数与返回类型以签名列为准。 |
strategyRef | 属性 | strategyRef?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
strategyVersion | 属性 | strategyVersion?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
trace | 方法 | trace?(event: ReasoningTraceEvent): Promise<void> | void | 公开方法;参数与返回类型以签名列为准。 |
ReasoningRequest
Reasoning Request 接口,共包含 19 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ReasoningRequest } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ReasoningRequest<TInput = unknown> extends InferenceRequest<TInput> {
reasoning?: ReasoningOptions;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
agentId | 属性 | agentId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
backendId | 属性 | backendId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
cachePolicy | 属性 | cachePolicy?: InferenceCachePolicy | 公开属性;类型、只读和可选状态以签名列为准。 |
cacheScope | 属性 | cacheScope?: InferenceCacheScope | 公开属性;类型、只读和可选状态以签名列为准。 |
input | 属性 | input: TInput | 公开属性;类型、只读和可选状态以签名列为准。 |
kvCache | 属性 | kvCache?: KvCacheRef | 公开属性;类型、只读和可选状态以签名列为准。 |
metadata | 属性 | metadata?: Record<string, unknown> | 公开属性;类型、只读和可选状态以签名列为准。 |
modelAlias | 属性 | modelAlias: string | 公开属性;类型、只读和可选状态以签名列为准。 |
options | 属性 | options?: InferenceGenerationOptions | 公开属性;类型、只读和可选状态以签名列为准。 |
prefix | 属性 | prefix?: PrefixCacheRef | 公开属性;类型、只读和可选状态以签名列为准。 |
providerId | 属性 | providerId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
reasoning | 属性 | reasoning?: ReasoningOptions | 公开属性;类型、只读和可选状态以签名列为准。 |
resolvedKvCacheValue | 属性 | resolvedKvCacheValue?: unknown | 公开属性;类型、只读和可选状态以签名列为准。 |
resolvedPrefixContent | 属性 | resolvedPrefixContent?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
runId | 属性 | runId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
sessionId | 属性 | sessionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
stepId | 属性 | stepId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
tools | 属性 | tools?: InferenceToolDescriptor[] | 公开属性;类型、只读和可选状态以签名列为准。 |
trace | 属性 | trace?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
ThoughtEdge
Thought Edge 接口,共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ThoughtEdge } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ThoughtEdge {
from: string;
to: string;
type: ThoughtEdgeType;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
from | 属性 | from: string | 公开属性;类型、只读和可选状态以签名列为准。 |
to | 属性 | to: string | 公开属性;类型、只读和可选状态以签名列为准。 |
type | 属性 | type: ThoughtEdgeType | 公开属性;类型、只读和可选状态以签名列为准。 |
ThoughtGraph
Thought Graph 接口,共包含 5 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ThoughtGraph } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ThoughtGraph {
id: string;
method: Extract<ReasoningMethod, 'tot' | 'got'>;
nodes: ThoughtNode[];
edges: ThoughtEdge[];
selectedNodeId?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
edges | 属性 | edges: ThoughtEdge[] | 公开属性;类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性;类型、只读和可选状态以签名列为准。 |
method | 属性 | method: "tot" | "got" | 公开属性;类型、只读和可选状态以签名列为准。 |
nodes | 属性 | nodes: ThoughtNode[] | 公开属性;类型、只读和可选状态以签名列为准。 |
selectedNodeId | 属性 | selectedNodeId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ThoughtNode
Thought Node 接口,共包含 9 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ThoughtNode } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export interface ThoughtNode {
id: string;
parentIds: string[];
depth: number;
branchIndex: number;
status: ThoughtNodeStatus;
score?: number;
outputHash?: string;
responseId?: string;
metadata?: Record<string, unknown>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
branchIndex | 属性 | branchIndex: number | 公开属性;类型、只读和可选状态以签名列为准。 |
depth | 属性 | depth: number | 公开属性;类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性;类型、只读和可选状态以签名列为准。 |
metadata | 属性 | metadata?: Record<string, unknown> | 公开属性;类型、只读和可选状态以签名列为准。 |
outputHash | 属性 | outputHash?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
parentIds | 属性 | parentIds: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
responseId | 属性 | responseId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
score | 属性 | score?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
status | 属性 | status: ThoughtNodeStatus | 公开属性;类型、只读和可选状态以签名列为准。 |
ReasoningAggregation
Reasoning Aggregation 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ReasoningAggregation } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ReasoningAggregation = 'first' | 'majority_vote' | 'score' | 'llm_judge';ReasoningMethod
Reasoning Method 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ReasoningMethod } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ReasoningMethod = 'direct' | 'cot' | 'tot' | 'got' | 'self_consistency';ReasoningTraceEvent
Reasoning Trace Event 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ReasoningTraceEvent } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ReasoningTraceEvent = {
type: 'reasoning.strategy.started';
method: ReasoningMethod;
strategyId?: string;
requestId: string;
} | {
type: 'reasoning.node.generated';
method: ReasoningMethod;
node: ThoughtNode;
} | {
type: 'reasoning.node.evaluated';
method: ReasoningMethod;
node: ThoughtNode;
} | {
type: 'reasoning.node.selected';
method: ReasoningMethod;
node: ThoughtNode;
} | {
type: 'reasoning.strategy.completed';
method: ReasoningMethod;
strategyId?: string;
requestId: string;
modelCalls: number;
nodeCount: number;
};ReasoningTraceSink
Reasoning Trace Sink 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ReasoningTraceSink } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ReasoningTraceSink = (event: ReasoningTraceEvent) => Promise<void> | void;ThoughtEdgeType
Thought Edge Type 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ThoughtEdgeType } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ThoughtEdgeType = 'expand' | 'merge' | 'refine' | 'criticize' | 'validate';ThoughtNodeStatus
Thought Node Status 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ThoughtNodeStatus } from '@codesoul-co/hypha-inference'; - 源码模块:
reasoning
声明
text
export type ThoughtNodeStatus = 'candidate' | 'evaluated' | 'selected' | 'rejected';