langchain.js
    Preparing search index...

    Class ReadFileTool

    Class for reading files from the disk. Extends the StructuredTool class.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    description name schema store

    Methods

    _call lc_name

    Constructors

    • Parameters

      • __namedParameters: ReadFileParams

      Returns ReadFileTool

    Properties

    description: string = "Read file from disk"
    name: string = "read_file"
    schema: ZodObject<
        { file_path: ZodString },
        "strip",
        ZodTypeAny,
        { file_path: string },
        { file_path: string },
    > = readSchema
    store: BaseFileStore

    Methods

    _call

    • _call(
          __namedParameters: InferInteropZodOutput<
              ZodObject<
                  { file_path: ZodString },
                  "strip",
                  ZodTypeAny,
                  { file_path: string },
                  { file_path: string },
              >,
          >,
      ): Promise<string>

      Parameters

      • __namedParameters: InferInteropZodOutput<
            ZodObject<
                { file_path: ZodString },
                "strip",
                ZodTypeAny,
                { file_path: string },
                { file_path: string },
            >,
        >

      Returns Promise<string>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods