Class WriteFileTool

Class for writing data to files on the disk. Extends the StructuredTool class.

Hierarchy

Constructors

Properties

description: string = "Write file from disk"
name: string = "write_file"
returnDirect: boolean
schema: ZodObject<{
    file_path: ZodString;
    text: ZodString;
}, "strip", ZodTypeAny, {
    file_path: string;
    text: string;
}, {
    file_path: string;
    text: string;
}> = ...

Type declaration

  • file_path: ZodString
  • text: ZodString

Type declaration

  • file_path: string
  • text: string

Type declaration

  • file_path: string
  • text: string
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
metadata?: Record<string, unknown>
tags?: string[]

Methods

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: (string | {})[]

      Array of inputs to each batch call.

    • Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<string[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(string | Error)[]>

  • Parameters

    Returns Promise<(string | Error)[]>

  • Calls the tool with the provided argument, configuration, and tags. It parses the input according to the schema, handles any errors, and manages callbacks.

    Parameters

    • arg: string | {}

      The input argument for the tool.

    • Optional configArg: BaseCallbackConfig | Callbacks

      Optional configuration or callbacks for the tool.

    • Optional tags: string[]

      Optional tags for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Invokes the tool with the provided input and configuration.

    Parameters

    • input: string | {}

      The input for the tool.

    • Optional config: BaseCallbackConfig

      Optional configuration for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<string, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<string | {}, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<string>>

    A readable stream that is also an iterable.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: string | {}
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    • generator: AsyncGenerator<string | {}, any, unknown>
    • options: Partial<BaseCallbackConfig>

    Returns AsyncGenerator<string, any, unknown>

Generated using TypeDoc