From 078c552c8539043ebe8875ece10b1508fe89f551 Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:40:43 +0530 Subject: [PATCH 1/4] Update llms.md --- docs/docs/gpt-researcher/llms/llms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/gpt-researcher/llms/llms.md b/docs/docs/gpt-researcher/llms/llms.md index 0ff2dcb2b..3587976e1 100644 --- a/docs/docs/gpt-researcher/llms/llms.md +++ b/docs/docs/gpt-researcher/llms/llms.md @@ -7,7 +7,7 @@ Current supported LLMs are `openai`, `anthropic`, `azure_openai`, `cohere`, `goo Using any model will require updating the `SMART_LLM` and `FAST_LLM` env vars. You might also need to include the LLM provider API Key. To learn more about support customization options see [here](/gpt-researcher/config). -**Please note**: GPT Researcher is optimized and heavily tested on GPT models. Some other models might run intro context limit errors, and unexpected responses. +**Please note**: GPT Researcher is optimized and heavily tested on GPT models. Some other models might run into context limit errors, and unexpected responses. Please provide any feedback in our [Discord community](https://discord.gg/DUmbTebB) channel, so we can better improve the experience and performance. Below you can find examples for how to configure the various supported LLMs. From d09f781e875662792fa37a70db84d9ff242a5b51 Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:46:48 +0530 Subject: [PATCH 2/4] Update local-docs.md --- docs/docs/gpt-researcher/context/local-docs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/gpt-researcher/context/local-docs.md b/docs/docs/gpt-researcher/context/local-docs.md index 59265eeb7..3fa9a4852 100644 --- a/docs/docs/gpt-researcher/context/local-docs.md +++ b/docs/docs/gpt-researcher/context/local-docs.md @@ -11,7 +11,7 @@ export DOC_PATH="./my-docs" ``` Step 2: - - If you're running the frontend app on localhost:8000, simply select "My Documents" from the the "Report Source" Dropdown Options. + - If you're running the frontend app on localhost:8000, simply select "My Documents" from the "Report Source" Dropdown Options. - If you're running GPT Researcher with the [PIP package](https://docs.tavily.com/docs/gpt-researcher/gptr/pip-package), pass the `report_source` argument as "local" when you instantiate the `GPTResearcher` class [code sample here](https://docs.gptr.dev/docs/gpt-researcher/context/tailored-research). ## Local Docs + Web (Hybrid) @@ -19,4 +19,4 @@ Step 2: ![GPT Researcher hybrid research](./gptr-hybrid.png) Check out the blog post on [Hybrid Research](https://docs.gptr.dev/blog/gptr-hybrid) to learn more about how to combine local documents with web research. -``` \ No newline at end of file +``` From c7ffabc0b5fd961a58467911b3c8323a6782688f Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:47:24 +0530 Subject: [PATCH 3/4] Update tailored-research.md --- docs/docs/gpt-researcher/context/tailored-research.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/gpt-researcher/context/tailored-research.md b/docs/docs/gpt-researcher/context/tailored-research.md index 2ff32faed..d6972652d 100644 --- a/docs/docs/gpt-researcher/context/tailored-research.md +++ b/docs/docs/gpt-researcher/context/tailored-research.md @@ -89,7 +89,7 @@ You can combine the above methods to conduct hybrid research. For example, you c Simply provide the sources and set the `report_source` argument as `"hybrid"` and watch the magic happen. Please note! You should set the proper retrievers for the web sources and doc path for local documents for this to work. -To lean more about retrievers check out the [Retrievers](https://docs.gptr.dev/docs/gpt-researcher/search-engines/retrievers) documentation. +To learn more about retrievers check out the [Retrievers](https://docs.gptr.dev/docs/gpt-researcher/search-engines/retrievers) documentation. ### Research on LangChain Documents 🦜️🔗 From 63fe89572eb9b51e07cad59b60e9dd1b06d37c3a Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:48:13 +0530 Subject: [PATCH 4/4] Update vector-stores.md --- docs/docs/gpt-researcher/context/vector-stores.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/gpt-researcher/context/vector-stores.md b/docs/docs/gpt-researcher/context/vector-stores.md index cf998c39f..6aeb52892 100644 --- a/docs/docs/gpt-researcher/context/vector-stores.md +++ b/docs/docs/gpt-researcher/context/vector-stores.md @@ -68,7 +68,7 @@ query = """ Summarize the essay into 3 or 4 succinct sections. Make sure to include key points regarding wealth creation. - Include some recommendations for entrepeneurs in the conclusion. + Include some recommendations for entrepreneurs in the conclusion. """ @@ -145,11 +145,11 @@ researcher = GPTResearcher( vector_store=vector_store, ) -# Conduct research, the context will be chunked and store in the vector_store +# Conduct research, the context will be chunked and stored in the vector_store await researcher.conduct_research() # Query the 5 most relevant context in our vector store related_contexts = await vector_store.asimilarity_search("GPT-4", k = 5) print(related_contexts) print(len(related_contexts)) #Should be 5 -``` \ No newline at end of file +```