类 PregelNode<RunInput, RunOutput>

config

Optional configFactories

lc_kwargs

lc_namespace

lc_serializable

Optional name

lc_aliases

• get lc_aliases(): undefined | {
      [key: string]: string;
  }

• 构造函数参数别名映射。键是属性名称，例如 "foo"。值是将替换序列化中键的别名。这用于例如使参数名称与 Python 匹配。

  返回值 undefined | {
      [key: string]: string;
  }

lc_attributes

• get lc_attributes(): undefined | SerializedFields

• 要与构造函数参数合并的附加属性映射。键是属性名称，例如 "foo"。值是将被序列化的属性值。这些属性需要被构造函数接受为参数。

  返回值 undefined | SerializedFields

lc_id

• get lc_id(): string[]

• 模块的最终序列化标识符。

  返回值 string[]

lc_secrets

• get lc_secrets(): undefined | {
      [key: string]: string;
  }

• secrets 的映射，将从序列化中省略。键是构造函数参数中 secret 的路径，例如 "foo.bar.baz"。值是 secret id，将在反序列化时使用。

  返回值 undefined | {
      [key: string]: string;
  }

lc_serializable_keys

• get lc_serializable_keys(): undefined | string[]

• 应序列化的键的手动列表。如果未重写，则传递给构造函数的所有字段都将被序列化。

  返回值 undefined | string[]

_batchWithConfig

• _batchWithConfig<T>(func, inputs, options?, batchOptions?): Promise<(Error | RunOutput)[]>

• 处理 runnable 的批处理和配置的内部方法。它接受一个函数、输入值和可选配置，并返回一个解析为输出值的 Promise。

  类型参数

  • T

  参数

  • func: ((inputs, options?, runManagers?, batchOptions?) => Promise<(Error | RunOutput)[]>)

    要为每个输入值执行的函数。

    • • (inputs, options?, runManagers?, batchOptions?): Promise<(Error | RunOutput)[]>

      • 参数

        • inputs: T[]
        • Optional options: Partial<RunnableConfig<Record<string, any>>>[]
        • Optional runManagers: (undefined | CallbackManagerForChainRun)[]
        • Optional batchOptions: RunnableBatchOptions

        返回值 Promise<(Error | RunOutput)[]>

  • inputs: T[]
  • Optional options: Partial<RunnableConfig<Record<string, any>> & {
        runType?: string;
    }> | Partial<RunnableConfig<Record<string, any>> & {
        runType?: string;
    }>[]
  • Optional batchOptions: RunnableBatchOptions

  返回值 Promise<(Error | RunOutput)[]>

  一个解析为输出值的 Promise。

_mergeConfig

• _mergeConfig(...options): Promise<Partial<RunnableConfig<Record<string, any>>>>

• 参数

  • Rest ...options: (undefined | RunnableConfig<Record<string, any>> | Partial<RunnableConfig<Record<string, any>>>)[]

  返回值 Promise<Partial<RunnableConfig<Record<string, any>>>>

_streamIterator

• _streamIterator(input, options?): AsyncGenerator<Awaited<RunOutput>, void, unknown>

• 参数

  • input: RunInput
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回值 AsyncGenerator<Awaited<RunOutput>, void, unknown>

asTool

• asTool<T>(fields): RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, RunOutput>

• 将 runnable 转换为 tool。返回 RunnableToolLike 的新实例，其中包含 runnable、名称、描述和模式。

  类型参数

  • T = RunInput

  参数

  • fields: {
        description?: string;
        name?: string;
        schema: ZodType<T, ZodTypeDef, T>;
    }

    • 可选 description?: string

      tool 的描述。如果未提供，则回退到 Zod 模式上的描述；如果两者都未提供，则为 undefined。

    • 可选 name?: string

      tool 的名称。如果未提供，则默认为 runnable 的名称。

    • schema: ZodType<T, ZodTypeDef, T>

      tool 输入的 Zod 模式。从 runnable 的输入类型推断 Zod 类型。

  返回值 RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, RunOutput>

  RunnableToolLike 的实例，它是一个 runnable，可以用作 tool。

assign

• assign(mapping): Runnable<any, any, RunnableConfig<Record<string, any>>>

• 为此 runnable 的 dict 输出分配新字段。返回一个新的 runnable。

  参数

  • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

  返回值 Runnable<any, any, RunnableConfig<Record<string, any>>>

batch

• batch(inputs, options?, batchOptions?): Promise<RunOutput[]>

• 参数

  • inputs: RunInput[]
  • 可选 options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
  • 可选 batchOptions: RunnableBatchOptions & {
        returnExceptions?: false;
    }

  返回值 Promise<RunOutput[]>

• batch(inputs, options?, batchOptions?): Promise<(Error | RunOutput)[]>

• 参数

  • inputs: RunInput[]
  • 可选 options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
  • 可选 batchOptions: RunnableBatchOptions & {
        returnExceptions: true;
    }

  返回值 Promise<(Error | RunOutput)[]>

• batch(inputs, options?, batchOptions?): Promise<(Error | RunOutput)[]>

• 参数

  • inputs: RunInput[]
  • 可选 options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
  • Optional batchOptions: RunnableBatchOptions

  返回值 Promise<(Error | RunOutput)[]>

bind

• bind(kwargs): RunnableBinding<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

• 参数

  • kwargs: Partial<RunnableConfig<Record<string, any>>>

  返回值 RunnableBinding<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

getGraph

• getGraph(_?): Graph

• 参数

  • 可选 _: RunnableConfig<Record<string, any>>

  返回值 Graph

getName

• getName(suffix?): string

• 参数

  • 可选 suffix: string

  返回值 string

invoke

• invoke(input, options?): Promise<RunOutput>

• 参数

  • input: RunInput
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回值 Promise<RunOutput>

map

• map(): Runnable<RunInput[], RunOutput[], RunnableConfig<Record<string, any>>>

• 返回一个新的 Runnable，它通过对每个输入调用 invoke()，将输入列表映射到输出列表。

  返回 Runnable<RunInput[], RunOutput[], RunnableConfig<Record<string, any>>>

pick

• pick(keys): Runnable<any, any, RunnableConfig<Record<string, any>>>

• 从此 runnable 的字典输出中选择键。返回一个新的 runnable。

  参数

  • keys: string | string[]

  返回值 Runnable<any, any, RunnableConfig<Record<string, any>>>

stream

• stream(input, options?): Promise<IterableReadableStream<RunOutput>>

• 参数

  • input: RunInput
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回 Promise<IterableReadableStream<RunOutput>>

streamEvents

• streamEvents(input, options, streamOptions?): IterableReadableStream<StreamEvent>

• 参数

  • input: RunInput
  • options: Partial<RunnableConfig<Record<string, any>>> & {
        version: "v1" | "v2";
    }
  • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

  返回 IterableReadableStream<StreamEvent>

• streamEvents(input, options, streamOptions?): IterableReadableStream<Uint8Array>

• 参数

  • input: RunInput
  • options: Partial<RunnableConfig<Record<string, any>>> & {
        encoding: "text/event-stream";
        version: "v1" | "v2";
    }
  • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

  返回 IterableReadableStream<Uint8Array>

streamLog

• streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>

• 流式传输来自 runnable 的所有输出，如回调系统报告的那样。 这包括 LLM、检索器、工具等的所有内部运行。 输出以 Log 对象的形式流式传输，其中包括 jsonpatch 操作列表，这些操作描述了运行状态在每个步骤中的变化方式以及运行的最终状态。 可以应用 jsonpatch 操作来构建状态。

  参数

  • input: RunInput
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>
  • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

  返回值 AsyncGenerator<RunLogPatch, any, unknown>

toJSON

• toJSON(): Serialized

• 返回 Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• 返回 SerializedNotImplemented

transform

• transform(generator, options?): AsyncGenerator<RunOutput, any, unknown>

• 参数

  • generator: AsyncGenerator<RunInput, any, unknown>
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回 AsyncGenerator<RunOutput, any, unknown>

withConfig

• withConfig(config): Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

• 参数

  • config: RunnableConfig<Record<string, any>>

  返回 Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

withFallbacks

• withFallbacks(fields): RunnableWithFallbacks<RunInput, RunOutput>

• 从当前 runnable 创建一个新的 runnable，如果初始调用失败，它将尝试调用其他传递的回退 runnable。

  参数

  • fields: {
        fallbacks: Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>[];
    } | Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>[]

  返回 RunnableWithFallbacks<RunInput, RunOutput>

  一个新的 RunnableWithFallbacks。

withListeners

• withListeners(params): Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

• 将生命周期监听器绑定到 Runnable，返回一个新的 Runnable。 Run 对象包含有关运行的信息，包括其 ID、类型、输入、输出、错误、开始时间、结束时间以及添加到运行的任何标签或元数据。

  参数

  • params: {
        onEnd?: ((run, config?) => void | Promise<void>);
        onError?: ((run, config?) => void | Promise<void>);
        onStart?: ((run, config?) => void | Promise<void>);
    }

    包含回调函数的对象。

    • Optional onEnd?: ((run, config?) => void | Promise<void>)

      在 runnable 完成运行后调用，带有 Run 对象。

      • • (run, config?): void | Promise<void>

        • 参数

          • run: Run
          • Optional config: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

    • Optional onError?: ((run, config?) => void | Promise<void>)

      如果 runnable 抛出错误时调用，带有 Run 对象。

      • • (run, config?): void | Promise<void>

        • 参数

          • run: Run
          • Optional config: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

    • Optional onStart?: ((run, config?) => void | Promise<void>)

      在 runnable 开始运行之前调用，带有 Run 对象。

      • • (run, config?): void | Promise<void>

        • 参数

          • run: Run
          • Optional config: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

  返回 Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

withRetry

• withRetry(fields?): RunnableRetry<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

• 参数

  • Optional fields: {
        onFailedAttempt?: RunnableRetryFailedAttemptHandler;
        stopAfterAttempt?: number;
    }

    • Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler

    • Optional stopAfterAttempt?: number

  返回 RunnableRetry<RunInput, RunOutput, RunnableConfig<Record<string, any>>>

Static isRunnable

• isRunnable(thing): thing is Runnable<any, any, RunnableConfig<Record<string, any>>>

• 参数

  • thing：any

  返回值 thing is Runnable<any, any, RunnableConfig<Record<string, any>>>

Static isRunnableBinding

• isRunnableBinding(thing): thing is RunnableBinding<any, any, any>

• 参数

  • thing：any

  返回值 thing is RunnableBinding<any, any, any>

Static lc_name

• lc_name(): string

• 返回值 string