类 PregelNode<RunInput, RunOutput>

类型参数

  • RunInput = PregelNodeInputType
  • RunOutput = PregelNodeOutputType

继承关系

构造函数

属性

bound: Runnable<RunInput, RunOutput, RunnableConfig<Record<string, any>>>
cachePolicy?: CachePolicy
channels: string[] | Record<string, string>
config: RunnableConfig<Record<string, any>>
configFactories?: ((config) => RunnableConfig<Record<string, any>> | Promise<RunnableConfig<Record<string, any>>>)[]

类型声明

    • (config): RunnableConfig<Record<string, any>> | Promise<RunnableConfig<Record<string, any>>>
    • 参数

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

      返回 RunnableConfig<Record<string, any>> | Promise<RunnableConfig<Record<string, any>>>

ends?: string[]
kwargs: Record<string, any>
lc_graph_name: string
lc_kwargs: SerializedFields
lc_namespace: string[]
lc_runnable: boolean
lc_serializable: boolean
mapper?: ((args) => any)

类型声明

    • (args): any
    • 参数

      • args: any

      返回 any

metadata: Record<string, unknown>
name?: string
retryPolicy?: RetryPolicy
subgraphs?: Runnable<any, any, RunnableConfig<Record<string, any>>>[]
tags: string[]
triggers: string[]
writers: Runnable<any, any, RunnableConfig<Record<string, any>>>[]

访问器

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • 构造函数参数的别名映射。键是属性名,例如“foo”。值是序列化时将替换该键的别名。这用于例如使参数名与 Python 匹配。

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

  • get lc_attributes(): undefined | SerializedFields
  • 要与构造函数参数合并的额外属性映射。键是属性名,例如“foo”。值是属性值,将被序列化。这些属性需要作为参数被构造函数接受。

    返回 undefined | SerializedFields

  • get lc_id(): string[]
  • 模块的最终序列化标识符。

    返回 string[]

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • 秘密的映射,这些秘密将从序列化中省略。键是构造函数参数中秘密的路径,例如“foo.bar.baz”。值是秘密 ID,将在反序列化时使用。

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

  • get lc_serializable_keys(): undefined | string[]
  • 应该被序列化的键的手动列表。如果未被覆盖,所有传入构造函数的字段都将被序列化。

    返回 undefined | string[]

方法

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

    类型参数

    • T

    参数

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

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

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

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

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

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

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

    解析为输出值的 Promise。

  • 类型参数

    • T

    参数

    • func: ((input) => Promise<RunOutput>) | ((input, config?, runManager?) => Promise<RunOutput>)
    • input: T
    • 可选 options: Partial<RunnableConfig<Record<string, any>>> & {
          runType?: string;
      }

    返回 Promise<RunOutput>

  • 类型参数

    • O extends RunnableConfig<Record<string, any>> & {
          runType?: string;
      }

    参数

    • options: Partial<O> | Partial<O>[]
    • 可选 length: number

    返回 Partial<O>[]

  • 参数

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

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

  • 参数

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

    返回 [RunnableConfig<Record<string, any>>, Omit<Partial<RunnableConfig<Record<string, any>>>, keyof RunnableConfig<Record<string, any>>>]

  • 参数

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

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

  • 参数

    • input: RunInput
    • logStreamCallbackHandler: LogStreamCallbackHandler
    • config: Partial<RunnableConfig<Record<string, any>>>

    返回 AsyncGenerator<RunLogPatch, any, any>

  • 用于将输入值迭代器转换为带有回调的输出值迭代器的辅助方法。使用此方法在 Runnable 子类中实现 stream()transform()

    类型参数

    • I
    • O

    参数

    • inputGenerator: AsyncGenerator<I, any, any>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, any>)
        • generator: AsyncGenerator<I, any, any>
        • 参数

          • 可选 runManager: CallbackManagerForChainRun
          • 返回 AsyncGenerator<O, any, any>
          • 可选 options: Partial<RunnableConfig<Record<string, any>>>

          继承自 RunnableBinding._transformStreamWithConfig

    • 可选 options: Partial<RunnableConfig<Record<string, any>>> & {
          runType?: string;
      }

    继承自 RunnableBinding._transformStreamWithConfig

  • 类型参数

    • fields: {

    参数

    •     description?: string;
          name?: string;
          schema: ZodType<T, ZodTypeDef, T>;
      可选 description?: string
      }
      • 工具的描述。如果未提供,则回退到 Zod 模式上的描述,如果两者都未提供,则为 undefined。

        可选 name?: string

      • 工具的名称。如果未提供,则默认为可运行对象的名称。

        schema: ZodType<T, ZodTypeDef, T>

      • 工具输入的 Zod 模式。从可运行对象的输入类型推断 Zod 类型。

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

    RunnableToolLike 的实例,它是一个可用作工具的可运行对象。

    继承自 RunnableBinding.asTool

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

    参数

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

    继承自 RunnableBinding.assign

  • 参数

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

    继承自 RunnableBinding.batch

  • 参数

    • 可选 options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
    • 可选 batchOptions: RunnableBatchOptions & {
    •     returnExceptions?: false;
      定义于 node_modules/@langchain/core/dist/runnables/base.d.ts:378
      }

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

  • 参数

    • 可选 options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
    • 可选 batchOptions: RunnableBatchOptions & {
    • 可选 batchOptions: RunnableBatchOptions

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

  • 参数

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

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

  • 参数

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

    返回 Graph

  • 参数

    • 可选 suffix: string

    返回 string

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

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

  • 参数

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

    返回 Promise<RunOutput>

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

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

  • 从此可运行对象的字典输出中选择键。返回一个新的可运行对象。

    参数

    • keys: string | string[]

    继承自 RunnableBinding.assign

  • 参数

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

    返回 Promise<IterableReadableStream<RunOutput>>

  • 参数

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

    返回 IterableReadableStream<StreamEvent>

  • 参数

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

    返回 IterableReadableStream<Uint8Array<ArrayBufferLike>>

  • 从可运行对象中流式传输所有输出,这些输出将报告给回调系统。这包括LLM、检索器、工具等所有内部运行。输出以日志对象形式流式传输,日志对象包含一个jsonpatch操作列表,这些操作描述了运行状态在每个步骤中如何变化,以及运行的最终状态。可以应用jsonpatch操作来构建状态。

    参数

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

    返回 AsyncGenerator<RunLogPatch, any, any>

  • 返回 Serialized

  • 返回 SerializedNotImplemented

  • 参数

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

    返回 AsyncGenerator<RunOutput, any, any>

  • 参数

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

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

  • 从当前可运行对象创建一个新的可运行对象,如果初始调用失败,该新对象将尝试调用其他传入的备用可运行对象。

    参数

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

    返回 RunnableWithFallbacks<RunInput, RunOutput>

    一个新的RunnableWithFallbacks对象。

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

    参数

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

      包含回调函数的对象。

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

        在可运行对象完成运行后调用,并传入Run对象。

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

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

            返回 void | Promise<void>

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

        如果可运行对象抛出错误,则调用此函数,并传入Run对象。

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

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

            返回 void | Promise<void>

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

        在可运行对象开始运行前调用,并传入Run对象。

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

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

            返回 void | Promise<void>

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

  • 参数

    • 可选 fields: {
          onFailedAttempt?: RunnableRetryFailedAttemptHandler;
          stopAfterAttempt?: number;
      }
      • 可选 onFailedAttempt?: RunnableRetryFailedAttemptHandler
      • 可选 stopAfterAttempt?: number

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

  • 参数

    • thing: any

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

  • 参数

    • thing: any

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

  • 返回 string