From a8180bddadf8efd40c355c593a6760161719fc83 Mon Sep 17 00:00:00 2001 From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com> Date: Sun, 8 Oct 2023 18:02:54 +0530 Subject: [PATCH 1/5] Update API-docs.md done all the changes proposed in issue #508 --- docs/pages/Developing/API-docs.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md index eabd29c0..4171f17f 100644 --- a/docs/pages/Developing/API-docs.md +++ b/docs/pages/Developing/API-docs.md @@ -91,7 +91,7 @@ Response: ### /api/task_status Gets task status (`task_id`) from `/api/upload`: ```js -// Task status (Get http://127.0.0.1:5000/api/task_status) +// Find task status (Get http://127.0.0.1:5000/api/task_status) fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", { "method": "GET", "headers": { @@ -104,7 +104,7 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f Responses: There are two types of responses: -1. while task it still running, where "current" will show progress from 0 to 100 +1. While the task is still running, the 'current' value will show progress from 0 to 100. ```json { "result": { @@ -134,6 +134,9 @@ There are two types of responses: ### /api/delete_old Deletes old vectorstores: + +In this section, you may come across the term "vectorstores". If you're unfamiliar with what Vector Stores are, you can find more information in this [article](https://python.langchain.com/docs/modules/data_connection/vectorstores/) that provides a detailed explanation. + ```js // Task status (GET http://127.0.0.1:5000/api/docs_check) fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", { @@ -144,7 +147,6 @@ fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4f }) .then((res) => res.text()) .then(console.log.bind(console)) -``` Response: From e1dc0a576dcad0813891b4880e1e224d42052168 Mon Sep 17 00:00:00 2001 From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:45:50 +0530 Subject: [PATCH 2/5] Update API-docs.md --- docs/pages/Developing/API-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md index 4171f17f..d9e2edf0 100644 --- a/docs/pages/Developing/API-docs.md +++ b/docs/pages/Developing/API-docs.md @@ -91,7 +91,7 @@ Response: ### /api/task_status Gets task status (`task_id`) from `/api/upload`: ```js -// Find task status (Get http://127.0.0.1:5000/api/task_status) +// Task status (Get http://127.0.0.1:5000/api/task_status) fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", { "method": "GET", "headers": { From c21e0755b3404e9d4f67904fe953e09110cb1a1f Mon Sep 17 00:00:00 2001 From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:55:41 +0530 Subject: [PATCH 3/5] Update API-docs.md --- docs/pages/Developing/API-docs.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md index d9e2edf0..dd820f48 100644 --- a/docs/pages/Developing/API-docs.md +++ b/docs/pages/Developing/API-docs.md @@ -114,7 +114,7 @@ There are two types of responses: } ``` -2. When task is completed +2. When task is completed: ```json { "result": { @@ -133,9 +133,7 @@ There are two types of responses: ``` ### /api/delete_old -Deletes old vectorstores: - -In this section, you may come across the term "vectorstores". If you're unfamiliar with what Vector Stores are, you can find more information in this [article](https://python.langchain.com/docs/modules/data_connection/vectorstores/) that provides a detailed explanation. +Deletes old [Vector Stores]('https://python.langchain.com/docs/modules/data_connection/vectorstores/'): ```js // Task status (GET http://127.0.0.1:5000/api/docs_check) From 11cd02296567bbfaa0d6b9897ba757f355717046 Mon Sep 17 00:00:00 2001 From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com> Date: Tue, 10 Oct 2023 23:22:11 +0530 Subject: [PATCH 4/5] Update API-docs.md --- docs/pages/Developing/API-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md index dd820f48..a95f3e1f 100644 --- a/docs/pages/Developing/API-docs.md +++ b/docs/pages/Developing/API-docs.md @@ -133,7 +133,7 @@ There are two types of responses: ``` ### /api/delete_old -Deletes old [Vector Stores]('https://python.langchain.com/docs/modules/data_connection/vectorstores/'): +Deletes old [Vector Stores](): ```js // Task status (GET http://127.0.0.1:5000/api/docs_check) From 58b13ae69a3af22f3c2a0a6f3c2319a857a06a5c Mon Sep 17 00:00:00 2001 From: Harsh Mahajan <127186841+HarshMN2345@users.noreply.github.com> Date: Thu, 12 Oct 2023 17:31:41 +0530 Subject: [PATCH 5/5] Update API-docs.md --- docs/pages/Developing/API-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Developing/API-docs.md b/docs/pages/Developing/API-docs.md index a95f3e1f..f1413a3c 100644 --- a/docs/pages/Developing/API-docs.md +++ b/docs/pages/Developing/API-docs.md @@ -133,7 +133,7 @@ There are two types of responses: ``` ### /api/delete_old -Deletes old [Vector Stores](): +Deletes old Vector Stores: ```js // Task status (GET http://127.0.0.1:5000/api/docs_check)