SciPhi-AI · emrgnt-cmplxty · Sep 6, 2024 · Aug 30, 2024 · Aug 30, 2024 · Aug 30, 2024
diff --git a/.github/workflows/r2r-js-sdk-integration-tests.yml b/.github/workflows/r2r-js-sdk-integration-tests.yml
@@ -41,7 +41,7 @@ jobs:
           POSTGRES_VECS_COLLECTION: ${{ secrets.POSTGRES_VECS_COLLECTION }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
         run: |
-          r2r serve --port=8000 > r2r_server.log 2>&1 &
+          r2r serve --port=7272 > r2r_server.log 2>&1 &
           sleep 15
 
       - name: Use Node.js
@@ -54,7 +54,7 @@ jobs:
 
       - name: Check if R2R server is running
         run: |
-          curl http://localhost:8000/v2/health || echo "Server not responding"
+          curl http://localhost:7272/v2/health || echo "Server not responding"
 
       - name: Display R2R server logs if server not responding
         if: failure()

diff --git a/docs/README.md b/docs/README.md
@@ -24,7 +24,7 @@ mintlify dev
 
 ### Publishing Changes
 
-Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. 
+Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
 
 #### Troubleshooting
 

diff --git a/docs/api-reference.mdx b/docs/api-reference.mdx
@@ -4,4 +4,3 @@ description: 'Build, scale, and manage user-facing Retrieval-Augmented Generatio
 icon: 'message-code'
 redirect: api-reference/introduction
 ---
-
diff --git a/docs/api-reference/endpoint/add_user_to_group.mdx b/docs/api-reference/endpoint/add_user_to_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Add User to Group'
 openapi: 'POST /v2/add_user_to_group'
----
+---
diff --git a/docs/api-reference/endpoint/agent.mdx b/docs/api-reference/endpoint/agent.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Agent'
 openapi: 'POST /v2/agent'
----
+---
diff --git a/docs/api-reference/endpoint/analytics.mdx b/docs/api-reference/endpoint/analytics.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Analytics'
 openapi: 'GET /v2/analytics'
----
+---
diff --git a/docs/api-reference/endpoint/app_settings.mdx b/docs/api-reference/endpoint/app_settings.mdx
@@ -3,4 +3,4 @@ title: 'App Settings'
 openapi: 'GET /v2/app_settings'
 ---
 
-Gets the latest settings for the application logic.
+Gets the latest settings for the application logic.
diff --git a/docs/api-reference/endpoint/assign_document_to_group.mdx b/docs/api-reference/endpoint/assign_document_to_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Assign Document to Group'
 openapi: 'POST /v2/assign_document_to_group'
----
+---
diff --git a/docs/api-reference/endpoint/change_password.mdx b/docs/api-reference/endpoint/change_password.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Change Password'
 openapi: 'POST /v2/change_password'
----
+---
diff --git a/docs/api-reference/endpoint/create_graph.mdx b/docs/api-reference/endpoint/create_graph.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Create Graph'
+openapi: 'POST /v2/create_graph'
+---
diff --git a/docs/api-reference/endpoint/create_group.mdx b/docs/api-reference/endpoint/create_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Create Group'
 openapi: 'POST /v2/create_group'
----
+---
diff --git a/docs/api-reference/endpoint/delete.mdx b/docs/api-reference/endpoint/delete.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Delete'
 openapi: 'DELETE /v2/delete'
----
+---
diff --git a/docs/api-reference/endpoint/delete_group.mdx b/docs/api-reference/endpoint/delete_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Delete Group'
 openapi: 'DELETE /v2/delete_group/{group_id}'
----
+---
diff --git a/docs/api-reference/endpoint/delete_user_info.mdx b/docs/api-reference/endpoint/delete_user_info.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Delete User'
 openapi: 'DELETE /v2/user'
----
+---
diff --git a/docs/api-reference/endpoint/document_chunks.mdx b/docs/api-reference/endpoint/document_chunks.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Document Chunks'
-openapi: 'GET /v2/document_chunks'
----
+openapi: 'GET /v2/document_chunks/{document_id}'
+---
diff --git a/docs/api-reference/endpoint/documents_overview.mdx b/docs/api-reference/endpoint/documents_overview.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Documents Overview'
 openapi: 'GET /v2/documents_overview'
----
+---
diff --git a/docs/api-reference/endpoint/enrich_graph.mdx b/docs/api-reference/endpoint/enrich_graph.mdx
@@ -1,4 +1,4 @@
 ---
-title: 'enrich_graph'
+title: 'Enrich Graph'
 openapi: 'POST /v2/enrich_graph'
 ---
diff --git a/docs/api-reference/endpoint/get_document_groups.mdx b/docs/api-reference/endpoint/get_document_groups.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Get Document Groups'
 openapi: 'GET /v2/get_document_groups/{document_id}'
----
+---
diff --git a/docs/api-reference/endpoint/get_group.mdx b/docs/api-reference/endpoint/get_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Get Group'
 openapi: 'GET /v2/get_group/{group_id}'
----
+---
diff --git a/docs/api-reference/endpoint/get_groups_for_user.mdx b/docs/api-reference/endpoint/get_groups_for_user.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Get Groups for User'
 openapi: 'GET /v2/get_groups_for_user/{user_id}'
----
+---
diff --git a/docs/api-reference/endpoint/get_user_info.mdx b/docs/api-reference/endpoint/get_user_info.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Get User'
 openapi: 'GET /v2/user'
----
+---
diff --git a/docs/api-reference/endpoint/get_users_in_group.mdx b/docs/api-reference/endpoint/get_users_in_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Get Users in Group'
 openapi: 'GET /v2/get_users_in_group/{group_id}/{offset}/{limit}'
----
+---
diff --git a/docs/api-reference/endpoint/groups_overview.mdx b/docs/api-reference/endpoint/groups_overview.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Groups Overview'
 openapi: 'GET /v2/groups_overview'
----
+---
diff --git a/docs/api-reference/endpoint/health.mdx b/docs/api-reference/endpoint/health.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Health'
 openapi: 'GET /v2/health'
----
+---
diff --git a/docs/api-reference/endpoint/ingest_files.mdx b/docs/api-reference/endpoint/ingest_files.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Ingest Files'
 openapi: 'POST /v2/ingest_files'
----
+---
diff --git a/docs/api-reference/endpoint/list_groups.mdx b/docs/api-reference/endpoint/list_groups.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'List Groups'
 openapi: 'GET /v2/list_groups'
----
+---
diff --git a/docs/api-reference/endpoint/login.mdx b/docs/api-reference/endpoint/login.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Login'
 openapi: 'POST /v2/login'
----
+---
diff --git a/docs/api-reference/endpoint/logout.mdx b/docs/api-reference/endpoint/logout.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Logout'
 openapi: 'POST /v2/logout'
----
+---
diff --git a/docs/api-reference/endpoint/logs.mdx b/docs/api-reference/endpoint/logs.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Logs'
 openapi: 'GET /v2/logs'
----
+---
diff --git a/docs/api-reference/endpoint/put_user_info.mdx b/docs/api-reference/endpoint/put_user_info.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Update User'
 openapi: 'PUT /v2/user'
----
+---
diff --git a/docs/api-reference/endpoint/rag.mdx b/docs/api-reference/endpoint/rag.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'RAG'
 openapi: 'POST /v2/rag'
----
+---
diff --git a/docs/api-reference/endpoint/refresh_access_token.mdx b/docs/api-reference/endpoint/refresh_access_token.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Refresh Access Token'
 openapi: 'POST /v2/refresh_access_token'
----
+---
diff --git a/docs/api-reference/endpoint/register.mdx b/docs/api-reference/endpoint/register.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Register'
 openapi: 'POST /v2/register'
----
+---
diff --git a/docs/api-reference/endpoint/remove_document_from_group.mdx b/docs/api-reference/endpoint/remove_document_from_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Remove Document from Group'
 openapi: 'POST /v2/remove_document_from_group'
----
+---
diff --git a/docs/api-reference/endpoint/remove_user_from_group.mdx b/docs/api-reference/endpoint/remove_user_from_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Remove User from Group'
 openapi: 'POST /v2/remove_user_from_group'
----
+---
diff --git a/docs/api-reference/endpoint/request_password_reset.mdx b/docs/api-reference/endpoint/request_password_reset.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Password Reset'
 openapi: 'POST /v2/request_password_reset'
----
+---
diff --git a/docs/api-reference/endpoint/score_completion.mdx b/docs/api-reference/endpoint/score_completion.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Score Completion'
 openapi: 'POST /v2/score_completion'
----
+---
diff --git a/docs/api-reference/endpoint/search.mdx b/docs/api-reference/endpoint/search.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Search'
 openapi: 'POST /v2/search'
----
+---
diff --git a/docs/api-reference/endpoint/update_files.mdx b/docs/api-reference/endpoint/update_files.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Update Files'
 openapi: 'POST /v2/update_files'
----
+---
diff --git a/docs/api-reference/endpoint/update_group.mdx b/docs/api-reference/endpoint/update_group.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Update Group'
 openapi: 'GET /v2/update_group'
----
+---
diff --git a/docs/api-reference/endpoint/update_prompt.mdx b/docs/api-reference/endpoint/update_prompt.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Update Prompt'
 openapi: 'POST /v2/update_prompt'
----
+---
diff --git a/docs/api-reference/endpoint/users_overview.mdx b/docs/api-reference/endpoint/users_overview.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Users Overview'
 openapi: 'GET /v2/users_overview'
----
+---
diff --git a/docs/api-reference/endpoint/verify_email.mdx b/docs/api-reference/endpoint/verify_email.mdx
@@ -1,4 +1,4 @@
 ---
 title: 'Verify Email'
 openapi: 'POST /v2/verify_email/{verification_code}'
----
+---
diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx
@@ -36,4 +36,4 @@ To get started with the R2R API, you'll need to:
 1. Install R2R in your environment
 2. Run the server with `r2r serve`, or customize your FastAPI for production settings.
 
-For detailed installation and setup instructions, please refer to our [Installation Guide](/documentation/installation).
+For detailed installation and setup instructions, please refer to our [Installation Guide](/documentation/installation).
diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json
diff --git a/docs/cookbooks/advanced-rag.mdx b/docs/cookbooks/advanced-rag.mdx
@@ -100,16 +100,16 @@ The code above builds R2R with a custom factory which changes retrieval such tha
 
 Now, to serve it in non-production settings, we can run the following:
 
-```bash 
+```bash
 python $r2r_workdir/py/core/examples/scripts/serve_with_hyde.py
 ```
-This results in output like this - 
+This results in output like this -
 
 ```bash
 2024-08-22 10:06:01,563 - INFO - core.providers.prompts.r2r_prompts - Loading prompts from SciPhi/r2r/py/core/providers/prompts/defaults
 2024-08-22 10:06:01,584 - INFO - core.base.providers.prompt - Initializing PromptProvider with config extra_fields={} provider='r2r' default_system_name='default_system' default_task_name='default_rag' file_path=None.
 2024-08-22 10:06:01,584 - INFO - core.base.providers.embedding - Initializing EmbeddingProvider with config extra_fields={} provider='litellm' base_model='openai/text-embedding-3-small' base_dimension=512 rerank_model=None rerank_dimension=None rerank_transformer_type=None batch_size=128 prefixes=None add_title_as_prefix=False concurrent_request_limit=256 max_retries=2 initial_backoff=1.0 max_backoff=60.0.
-2024-08-22 10:06:01,584 - INFO - core.base.providers.llm - Initializing CompletionProvider with config: extra_fields={'concurrent_request_limit': 16} provider='litellm' generation_config=GenerationConfig(model='openai/gpt-4o', temperature=0.1, top_p=1.0, max_tokens_to_sample=1024, stream=False, functions=None, tools=None, add_generation_kwargs={}, api_base=None) concurrency_limit=16 max_retries=2 initial_backoff=1.0 max_backoff=60.0
+2024-08-22 10:06:01,584 - INFO - core.base.providers.llm - Initializing CompletionProvider with config: extra_fields={'concurrent_request_limit': 16} provider='litellm' generation_config=GenerationConfig(model='openai/gpt-4o', temperature=0.1, top_p=1.0, max_tokens_to_sample=1024, stream=False, functions=None, tools=None, add_generation_kwargs={}, api_base=None) concurrent_request_limit=16 max_retries=2 initial_backoff=1.0 max_backoff=60.0
 2024-08-22 10:06:02,115 - INFO - core.base.providers.database - Initializing DatabaseProvider with config extra_fields={} provider='postgres'.
 2024-08-22 10:06:02,115 - INFO - core.providers.database.vector - Using TCP connection
 2024-08-22 10:06:03,320 - INFO - core.providers.database.vector - Successfully initialized PGVectorDB with collection: hyde_cookbook
@@ -121,13 +121,13 @@ This results in output like this -
 INFO:     Started server process [42821]
 INFO:     Waiting for application startup.
 INFO:     Application startup complete.
-INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
+INFO:     Uvicorn running on http://0.0.0.0:7272 (Press CTRL+C to quit)
 
 ```
 
 The script above works by using a custom pipe factory, `R2RPipeFactoryWithMultiSearch` alongside the `R2RBuilder`. The custom factory overrides the default `create_vector_search_pipe` method of `R2RPipeFactory` to create a `MultiSearchPipe`. The `MultiSearchPipe` is a pre-built implementation in R2R which facilitates the conversion of an incoming query into multiple downstream queries. The implementation is actually rather simle, as we can see below:
 
-```python 
+```python
 class R2RPipeFactoryWithMultiSearch(R2RPipeFactory):
     ...
     def create_vector_search_pipe(self, *args, **kwargs):
@@ -154,7 +154,7 @@ class R2RPipeFactoryWithMultiSearch(R2RPipeFactory):
                 task_prompt=task_prompt_name,
             ),
         )
-        
+
         # Create search pipe override and pipes
         inner_search_pipe = kwargs.get(
             "multi_inner_search_pipe_override", None
@@ -166,7 +166,7 @@ class R2RPipeFactoryWithMultiSearch(R2RPipeFactory):
             config=multi_search_config,
         )
 
-        
+
 ```
 
 
@@ -273,7 +273,7 @@ if __name__ == "__main__":
 
 ### Running Web Search RAG
 
-Now that the server is running we perform search or RAG exactly as above, except now the results will be rooted in web sources. 
+Now that the server is running we perform search or RAG exactly as above, except now the results will be rooted in web sources.
 This will produce output similar to:
 
 ```
@@ -341,4 +341,3 @@ Where to go from here?
 1. Experiment with different HyDE prompts to optimize for your specific domain.
 2. Try combining HyDE with other R2R features like knowledge graph integration for even more powerful RAG systems.
 3. Dive into R2R's documentation to discover more advanced techniques and customization options. For more information, refer [here](/documentation/deep-dive/main/introduction).
-