diff --git a/packages/core/src/NodeParser.ts b/packages/core/src/NodeParser.ts index 72c315bf958fa4424b929b231f080ec7097187b7..d95f72e2d4c89201156de62a526b3a8446f134ed 100644 --- a/packages/core/src/NodeParser.ts +++ b/packages/core/src/NodeParser.ts @@ -62,7 +62,7 @@ export function getNodesFromDocument( } /** - * Interface for classes that can generate nodes from documents. + * A node parser generates TextNodes from Documents */ export interface NodeParser { /** @@ -74,7 +74,7 @@ export interface NodeParser { } /** - * A simple implementation of the NodeParser interface. + * SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter */ export class SimpleNodeParser implements NodeParser { /** diff --git a/packages/core/src/callbacks/utility/handleOpenAIStream.ts b/packages/core/src/callbacks/utility/handleOpenAIStream.ts index 44694b354eb0c851166b053afe4b0c2f1ec0cecd..d86a6e67a0f3b47a18e6b478505cc367dbee0de9 100644 --- a/packages/core/src/callbacks/utility/handleOpenAIStream.ts +++ b/packages/core/src/callbacks/utility/handleOpenAIStream.ts @@ -6,7 +6,7 @@ import { Stream } from "openai/streaming"; import { MessageType } from "../../llm/LLM"; /** - * Handles the OpenAI stream. + * Handles the OpenAI streaming interface and pipes it to the callback function * @param response - The response from the OpenAI API. * @param onLLMStream - A callback function to handle the LLM stream. * @param parentEvent - An optional parent event.