From 01263c4cfddcf4b9a53d18d39c5fe0f25527c919 Mon Sep 17 00:00:00 2001
From: Fabian Wimmer <github@insightby.ai>
Date: Mon, 16 Sep 2024 16:55:59 +0200
Subject: [PATCH] docs: fix false params (#1211)
---
.../src/embeddings/MultiModalEmbedding.ts | 2 +-
packages/llamaindex/src/indices/BaseIndex.ts | 2 +-
packages/llamaindex/src/indices/keyword/index.ts | 7 ++++---
packages/llamaindex/src/readers/CSVReader.ts | 11 +++++------
packages/llamaindex/src/readers/HTMLReader.ts | 2 +-
packages/llamaindex/src/readers/ImageReader.ts | 3 +--
packages/llamaindex/src/storage/FileSystem.ts | 1 -
.../src/vector-store/AstraDBVectorStore.ts | 16 ++++++++--------
.../llamaindex/src/vector-store/PGVectorStore.ts | 1 -
.../src/vector-store/PineconeVectorStore.ts | 3 +--
packages/llm/openai/src/embedding.ts | 2 +-
11 files changed, 23 insertions(+), 27 deletions(-)
diff --git a/packages/llamaindex/src/embeddings/MultiModalEmbedding.ts b/packages/llamaindex/src/embeddings/MultiModalEmbedding.ts
index eb275ceab..6d2ed5bb2 100644
--- a/packages/llamaindex/src/embeddings/MultiModalEmbedding.ts
+++ b/packages/llamaindex/src/embeddings/MultiModalEmbedding.ts
@@ -19,7 +19,7 @@ export abstract class MultiModalEmbedding extends BaseEmbedding {
/**
* Optionally override this method to retrieve multiple image embeddings in a single request
- * @param texts
+ * @param images
*/
async getImageEmbeddings(images: ImageType[]): Promise<number[][]> {
return Promise.all(
diff --git a/packages/llamaindex/src/indices/BaseIndex.ts b/packages/llamaindex/src/indices/BaseIndex.ts
index 97ed43336..7515b7a63 100644
--- a/packages/llamaindex/src/indices/BaseIndex.ts
+++ b/packages/llamaindex/src/indices/BaseIndex.ts
@@ -71,7 +71,7 @@ export abstract class BaseIndex<T> {
/**
* Create a new retriever from the index.
- * @param retrieverOptions
+ * @param options
*/
abstract asRetriever(options?: any): BaseRetriever;
diff --git a/packages/llamaindex/src/indices/keyword/index.ts b/packages/llamaindex/src/indices/keyword/index.ts
index 4a6e99641..1e527fec0 100644
--- a/packages/llamaindex/src/indices/keyword/index.ts
+++ b/packages/llamaindex/src/indices/keyword/index.ts
@@ -265,8 +265,9 @@ export class KeywordTableIndex extends BaseIndex<KeywordTable> {
/**
* High level API: split documents, get keywords, and build index.
* @param documents
- * @param storageContext
- * @param serviceContext
+ * @param args
+ * @param args.storageContext
+ * @param args.serviceContext
* @returns
*/
static async fromDocuments(
@@ -298,8 +299,8 @@ export class KeywordTableIndex extends BaseIndex<KeywordTable> {
/**
* Get keywords for nodes and place them into the index.
* @param nodes
+ * @param docStore
* @param serviceContext
- * @param vectorStore
* @returns
*/
static async buildIndexFromNodes(
diff --git a/packages/llamaindex/src/readers/CSVReader.ts b/packages/llamaindex/src/readers/CSVReader.ts
index 7f3d584c4..122b5b08b 100644
--- a/packages/llamaindex/src/readers/CSVReader.ts
+++ b/packages/llamaindex/src/readers/CSVReader.ts
@@ -15,9 +15,9 @@ export class PapaCSVReader extends FileReader {
/**
* Constructs a new instance of the class.
- * @param {boolean} [concatRows=true] - whether to concatenate all rows into one document.If set to False, a Document will be created for each row.True by default.
- * @param {string} [colJoiner=', '] - Separator to use for joining cols per row. Set to ", " by default.
- * @param {string} [rowJoiner='\n'] - Separator to use for joining each row.Only used when `concat_rows=True`.Set to "\n" by default.
+ * @param concatRows - Whether to concatenate all rows into one document.If set to False, a Document will be created for each row. `True` by default.
+ * @param colJoiner - Separator to use for joining cols per row. Set to ", " by default.
+ * @param rowJoiner - Separator to use for joining each row.Only used when `concat_rows=True`.Set to "\n" by default.
*/
constructor(
concatRows: boolean = true,
@@ -34,9 +34,8 @@ export class PapaCSVReader extends FileReader {
/**
* Loads data from csv files
- * @param {string} file - The path to the file to load.
- * @param {GenericFileSystem} [fs=DEFAULT_FS] - The file system to use for reading the file.
- * @returns {Promise<Document[]>}
+ * @param fileContent - The content of the file.
+ * @returns An array of Documents.
*/
async loadDataAsContent(fileContent: Uint8Array): Promise<Document[]> {
const decoder = new TextDecoder("utf-8");
diff --git a/packages/llamaindex/src/readers/HTMLReader.ts b/packages/llamaindex/src/readers/HTMLReader.ts
index 6246bf8a4..916847eb6 100644
--- a/packages/llamaindex/src/readers/HTMLReader.ts
+++ b/packages/llamaindex/src/readers/HTMLReader.ts
@@ -10,7 +10,7 @@ export class HTMLReader extends FileReader {
/**
* Public method for this reader.
* Required by BaseReader interface.
- * @param file Path/name of the file to be loaded.
+ * @param fileContent - The content of the file.
* @returns Promise<Document[]> A Promise object, eventually yielding zero or one Document parsed from the HTML content of the specified file.
*/
async loadDataAsContent(fileContent: Uint8Array): Promise<Document[]> {
diff --git a/packages/llamaindex/src/readers/ImageReader.ts b/packages/llamaindex/src/readers/ImageReader.ts
index 6a681e83f..25658053a 100644
--- a/packages/llamaindex/src/readers/ImageReader.ts
+++ b/packages/llamaindex/src/readers/ImageReader.ts
@@ -8,8 +8,7 @@ export class ImageReader extends FileReader {
/**
* Public method for this reader.
* Required by BaseReader interface.
- * @param file Path/name of the file to be loaded.
- * @param fs fs wrapper interface for getting the file content.
+ * @param fileContent - The content of the file.
* @returns Promise<Document[]> A Promise object, eventually yielding zero or one ImageDocument of the specified file.
*/
async loadDataAsContent(fileContent: Uint8Array): Promise<Document[]> {
diff --git a/packages/llamaindex/src/storage/FileSystem.ts b/packages/llamaindex/src/storage/FileSystem.ts
index a268cfffb..3f23939aa 100644
--- a/packages/llamaindex/src/storage/FileSystem.ts
+++ b/packages/llamaindex/src/storage/FileSystem.ts
@@ -5,7 +5,6 @@ import { fs } from "@llamaindex/env";
/**
* Checks if a file exists.
* Analogous to the os.path.exists function from Python.
- * @param fs The filesystem to use.
* @param path The path to the file to check.
* @returns A promise that resolves to true if the file exists, false otherwise.
*/
diff --git a/packages/llamaindex/src/vector-store/AstraDBVectorStore.ts b/packages/llamaindex/src/vector-store/AstraDBVectorStore.ts
index 552b94f6c..6eda34a3f 100644
--- a/packages/llamaindex/src/vector-store/AstraDBVectorStore.ts
+++ b/packages/llamaindex/src/vector-store/AstraDBVectorStore.ts
@@ -68,8 +68,8 @@ export class AstraDBVectorStore
* Create a new collection in your Astra DB vector database and connects to it.
* You must call this method or `connect` before adding, deleting, or querying.
*
- * @param collection: your new colletion's name
- * @param options: CreateCollectionOptions used to set the number of vector dimensions and similarity metric
+ * @param collection - Your new collection's name
+ * @param options - CreateCollectionOptions used to set the number of vector dimensions and similarity metric
* @returns Promise that resolves if the creation did not throw an error.
*/
async createAndConnect(
@@ -86,7 +86,7 @@ export class AstraDBVectorStore
* Connect to an existing collection in your Astra DB vector database.
* You must call this method or `createAndConnect` before adding, deleting, or querying.
*
- * @param collection: your existing colletion's name
+ * @param collection - Your existing collection's name
* @returns Promise that resolves if the connection did not throw an error.
*/
async connect(collection: string): Promise<void> {
@@ -107,7 +107,7 @@ export class AstraDBVectorStore
/**
* Add your document(s) to your Astra DB collection.
*
- * @returns and array of node ids which were added
+ * @returns an array of node ids which were added
*/
async add(nodes: BaseNode[]): Promise<string[]> {
if (!this.collection) {
@@ -145,8 +145,8 @@ export class AstraDBVectorStore
/**
* Delete a document from your Astra DB collection.
*
- * @param refDocId: the id of the document to delete
- * @param deleteOptions: DeleteOneOptions to pass to the delete query
+ * @param refDocId - The id of the document to delete
+ * @param deleteOptions - DeleteOneOptions to pass to the delete query
* @returns Promise that resolves if the delete query did not throw an error.
*/
async delete(
@@ -171,8 +171,8 @@ export class AstraDBVectorStore
/**
* Query documents from your Astra DB collection to get the closest match to your embedding.
*
- * @param query: VectorStoreQuery
- * @param options: FindOptions
+ * @param query - VectorStoreQuery
+ * @param options - FindOptions
*/
async query(
query: VectorStoreQuery,
diff --git a/packages/llamaindex/src/vector-store/PGVectorStore.ts b/packages/llamaindex/src/vector-store/PGVectorStore.ts
index ce6cbdd0e..5f4be5852 100644
--- a/packages/llamaindex/src/vector-store/PGVectorStore.ts
+++ b/packages/llamaindex/src/vector-store/PGVectorStore.ts
@@ -472,7 +472,6 @@ export class PGVectorStore
/**
* Required by VectorStore interface. Currently ignored.
* @param persistPath
- * @param fs
* @returns Resolved Promise.
*/
persist(persistPath: string): Promise<void> {
diff --git a/packages/llamaindex/src/vector-store/PineconeVectorStore.ts b/packages/llamaindex/src/vector-store/PineconeVectorStore.ts
index af2c9b2e8..503c3b1b0 100644
--- a/packages/llamaindex/src/vector-store/PineconeVectorStore.ts
+++ b/packages/llamaindex/src/vector-store/PineconeVectorStore.ts
@@ -143,7 +143,7 @@ export class PineconeVectorStore
* Query the vector store for the closest matching data to the query embeddings
* @TODO QUERY TYPES
* @param query The VectorStoreQuery to be used
- * @param options Required by VectorStore interface. Currently ignored.
+ * @param _options Required by VectorStore interface. Currently ignored.
* @returns Zero or more Document instances with data from the vector store.
*/
async query(
@@ -191,7 +191,6 @@ export class PineconeVectorStore
/**
* Required by VectorStore interface. Currently ignored.
* @param persistPath
- * @param fs
* @returns Resolved Promise.
*/
persist(persistPath: string): Promise<void> {
diff --git a/packages/llm/openai/src/embedding.ts b/packages/llm/openai/src/embedding.ts
index e4b502448..91946eff8 100644
--- a/packages/llm/openai/src/embedding.ts
+++ b/packages/llm/openai/src/embedding.ts
@@ -144,7 +144,7 @@ export class OpenAIEmbedding extends BaseEmbedding {
/**
* Get embeddings for a single text
- * @param texts
+ * @param text
*/
async getTextEmbedding(text: string): Promise<number[]> {
return (await this.getOpenAIEmbedding([text]))[0]!;
--
GitLab