From 6b90e4c1b3be0b3a10ed0f3a36e686ab156a468f Mon Sep 17 00:00:00 2001
From: Yi Ding <yi.s.ding@gmail.com>
Date: Thu, 27 Jul 2023 20:56:59 -0700
Subject: [PATCH] updated docs
---
packages/core/src/NodeParser.ts | 4 ++--
packages/core/src/callbacks/utility/handleOpenAIStream.ts | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/packages/core/src/NodeParser.ts b/packages/core/src/NodeParser.ts
index 72c315bf9..d95f72e2d 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 44694b354..d86a6e67a 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.
--
GitLab