Class to parse the output of an LLM call to a list with a specific length and separator.

Hierarchy

Constructors

Properties

name?: string
re?: RegExp

Methods

  • Calls the parser with a given input and optional configuration options. If the input is a string, it creates a generation with the input as text and calls parseResult. If the input is a BaseMessage, it creates a generation with the input as a message and the content of the input as text, and then calls parseResult.

    Parameters

    • input: string | BaseMessage

      The input to the parser, which can be a string or a BaseMessage.

    • Optional options: RunnableConfig

      Optional configuration options.

    Returns Promise<string[]>

    A promise of the parsed output.

  • Parses the given text into an array of strings, using the specified separator. If the parsing fails or the number of items in the list doesn't match the expected length, throws an OutputParserException.

    Parameters

    • text: string

      The text to parse.

    Returns Promise<string[]>

    An array of strings obtained by splitting the input text at each occurrence of the specified separator.

  • Generate a stream of events emitted by the internal steps of the runnable.

    Use to create an iterator over StreamEvents that provide real-time information about the progress of the runnable, including StreamEvents from intermediate results.

    A StreamEvent is a dictionary with the following schema:

    • event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).
    • name: string - The name of the runnable that generated the event.
    • run_id: string - Randomly generated ID associated with the given execution of the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a parent runnable is assigned its own unique ID.
    • tags: string[] - The tags of the runnable that generated the event.
    • metadata: Record<string, any> - The metadata of the runnable that generated the event.
    • data: Record<string, any>

    Below is a table that illustrates some events that might be emitted by various chains. Metadata fields have been omitted from the table for brevity. Chain definitions have been included after the table.

    event name chunk input output
    on_llm_start [model name] {'input': 'hello'}
    on_llm_stream [model name] 'Hello' OR AIMessageChunk("hello")
    on_llm_end [model name] 'Hello human!'
    on_chain_start format_docs
    on_chain_stream format_docs "hello world!, goodbye world!"
    on_chain_end format_docs [Document(...)] "hello world!, goodbye world!"
    on_tool_start some_tool {"x": 1, "y": "2"}
    on_tool_stream some_tool {"x": 1, "y": "2"}
    on_tool_end some_tool {"x": 1, "y": "2"}
    on_retriever_start [retriever name] {"query": "hello"}
    on_retriever_chunk [retriever name] {documents: [...]}
    on_retriever_end [retriever name] {"query": "hello"} {documents: [...]}
    on_prompt_start [template_name] {"question": "hello"}
    on_prompt_end [template_name] {"question": "hello"} ChatPromptValue(messages: [SystemMessage, ...])

    Parameters

    Returns AsyncGenerator<StreamEvent, any, unknown>

  • 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

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Transforms an asynchronous generator of input into an asynchronous generator of parsed output.

    Parameters

    • inputGenerator: AsyncGenerator<string | BaseMessage, any, unknown>

      An asynchronous generator of input.

    • options: BaseCallbackConfig

      A configuration object.

    Returns AsyncGenerator<string[], any, unknown>

    An asynchronous generator of parsed output.

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

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

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<string | BaseMessage, string[], RunnableConfig>

Generated using TypeDoc