feat: add APIBrainQA #1606

mamadoudicko · 2023-11-07T15:24:40Z

vercel · 2023-11-07T15:24:47Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 8, 2023 0:26am
quivr-strapi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 8, 2023 0:26am
quivrapp	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 8, 2023 0:26am

github-actions · 2023-11-07T15:26:32Z

Risk Level 2 - /home/runner/work/quivr/quivr/backend/llm/api_brain_qa.py

The code seems to be well-structured and follows the SOLID principles. However, there are a few areas that could be improved for better error handling and readability:

The generate_stream method has multiple raise Exception statements. It would be better to raise more specific exceptions to provide clearer error messages.
The generate_stream method is quite long and does a lot of things. Consider breaking it down into smaller methods to improve readability and maintainability.
The use of **kwargs in the __init__ method could potentially lead to unexpected behavior if an unexpected keyword argument is passed. Consider explicitly listing out all the parameters that the method expects.

Risk Level 2 - /home/runner/work/quivr/quivr/backend/routes/chat/brainful_chat.py

The code is generally well-written, but there are a few areas that could be improved:

The get_answer_generator method could benefit from more specific error handling. Instead of raising a generic Exception when the brain is not found, consider raising a custom exception.
The get_answer_generator method is quite long and does a lot of things. Consider breaking it down into smaller methods to improve readability and maintainability.

Risk Level 2 - /home/runner/work/quivr/quivr/backend/llm/utils/call_brain_api.py

The code is generally well-written, but there are a few areas that could be improved:

The call_brain_api function could benefit from more specific error handling. Instead of raising a generic Exception when the brain definition is not found, consider raising a custom exception.
The function call_brain_api is quite long and does a lot of things. Consider breaking it down into smaller functions to improve readability and maintainability.

👍🔧📚

Powered by Code Review GPT

gozineb · 2023-11-08T14:32:00Z

backend/llm/utils/get_api_brain_definition_as_json_schema.py

+
+
+def get_api_brain_definition_as_json_schema(brain: BrainEntity):
+    if not brain:


How can it be "not brain" if the type is BrainEntity ?

gozineb · 2023-11-08T14:42:04Z

backend/llm/utils/get_api_brain_definition_as_json_schema.py

+
+    required = []
+    required.extend(api_brain_definition.params.required)
+    required.extend(api_brain_definition.search_params.required)


Nice use of the extend !

gozineb · 2023-11-08T14:42:53Z

backend/models/ApiBrainDefinition.py

+class ApiBrainDefinitionSchemaProperty(BaseModel):
+    type: str
+    description: str
+    enum: list


whats this enum for ?

gozineb · 2023-11-08T14:51:55Z

backend/routes/chat/brainful_chat.py

@@ -32,6 +32,7 @@ def get_answer_generator(
        user_openai_api_key,
        streaming,
        prompt_id,
+        user_id,
    ):


We should use the user_id and brain_id to be attributes of the class BrainlessChat and BrainfullChat

gozineb · 2023-11-08T14:53:31Z

backend/routes/chat/brainful_chat.py

@@ -7,6 +7,15 @@
 from routes.authorizations.types import RoleEnum
 from routes.chat.interface import ChatInterface

+models_supporting_function_calls = [


Very nice !

gozineb · 2023-11-08T15:02:34Z

backend/repository/external_api_secret/delete_secret.py

@@ -1,7 +1,8 @@
 from uuid import UUID

 from models import get_supabase_client
-from utils import build_secret_unique_name
+
+from repository.external_api_secret.utils import build_secret_unique_name


Suggested change

from repository.external_api_secret.utils import build_secret_unique_name

from utils import build_secret_unique_name

gozineb

Great work mamadz, just leaving a few comments to discuss later on :)

@mamadoudicko

🤖 I have created a release *beep* *boop* --- ## 0.0.109 (2023-11-13) ## What's Changed * feat: add APIBrainQA by @mamadoudicko in #1606 * feat: allow users to chat with apis by @mamadoudicko in #1612 * feat(docker): use multi-stage Docker builds for smaller images by @shidenkai0 in #1614 ## New Contributors * @shidenkai0 made their first contribution in #1614 **Full Changelog**: v0.0.108...v0.0.109 --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

@mamadoudicko

🤖 I have created a release *beep* *boop* --- ## 0.0.109 (2023-11-13) ## What's Changed * feat: add APIBrainQA by @mamadoudicko in QuivrHQ/quivr#1606 * feat: allow users to chat with apis by @mamadoudicko in QuivrHQ/quivr#1612 * feat(docker): use multi-stage Docker builds for smaller images by @shidenkai0 in QuivrHQ/quivr#1614 ## New Contributors * @shidenkai0 made their first contribution in QuivrHQ/quivr#1614 **Full Changelog**: QuivrHQ/quivr@v0.0.108...v0.0.109 --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

dosubot bot added the area: backend Related to backend functionality or under the /backend directory label Nov 7, 2023

mamadoudicko temporarily deployed to preview November 7, 2023 15:24 — with GitHub Actions Inactive

mamadoudicko had a problem deploying to preview November 7, 2023 15:24 — with GitHub Actions Failure

mamadoudicko force-pushed the feat/brain-as-api/4 branch from 3017dfe to a028c32 Compare November 7, 2023 15:25

mamadoudicko had a problem deploying to preview November 7, 2023 15:25 — with GitHub Actions Failure

mamadoudicko temporarily deployed to preview November 7, 2023 15:25 — with GitHub Actions Inactive

vercel bot deployed to Preview – docs November 7, 2023 15:29 View deployment

vercel bot deployed to Preview – quivrapp November 7, 2023 15:33 View deployment

vercel bot deployed to Preview – quivr-strapi November 7, 2023 15:35 View deployment

mamadoudicko force-pushed the feat/brain-as-api/4 branch from a028c32 to 5afed15 Compare November 8, 2023 12:12

mamadoudicko temporarily deployed to preview November 8, 2023 12:12 — with GitHub Actions Inactive

mamadoudicko had a problem deploying to preview November 8, 2023 12:12 — with GitHub Actions Failure

vercel bot deployed to Preview – docs November 8, 2023 12:12 View deployment

mamadoudicko added 3 commits November 8, 2023 13:13

feat: add APIBrainQA

f214d6d

feat: conditionally call API

99696f2

chore: update secrets util imports path

8b66b61

mamadoudicko force-pushed the feat/brain-as-api/4 branch from 5afed15 to 8b66b61 Compare November 8, 2023 12:13

mamadoudicko temporarily deployed to preview November 8, 2023 12:13 — with GitHub Actions Inactive

mamadoudicko had a problem deploying to preview November 8, 2023 12:13 — with GitHub Actions Failure

vercel bot deployed to Preview – docs November 8, 2023 12:13 View deployment

vercel bot deployed to Preview – quivr-strapi November 8, 2023 12:14 View deployment

vercel bot deployed to Preview – quivrapp November 8, 2023 12:16 View deployment

feat: ensure functions are used with models supporting it

1b1dfb4

mamadoudicko had a problem deploying to preview November 8, 2023 12:23 — with GitHub Actions Failure

mamadoudicko temporarily deployed to preview November 8, 2023 12:23 — with GitHub Actions Inactive

vercel bot deployed to Preview – docs November 8, 2023 12:23 View deployment

vercel bot deployed to Preview – quivrapp November 8, 2023 12:25 View deployment

vercel bot deployed to Preview – quivr-strapi November 8, 2023 12:26 View deployment

gozineb reviewed Nov 8, 2023

View reviewed changes

gozineb approved these changes Nov 8, 2023

View reviewed changes

gozineb merged commit addcd27 into main Nov 8, 2023

StanGirard mentioned this pull request Nov 8, 2023

chore(main): release 0.0.109 #1609

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add APIBrainQA #1606

feat: add APIBrainQA #1606

mamadoudicko commented Nov 7, 2023 •

edited

Loading

vercel bot commented Nov 7, 2023 •

edited

Loading

github-actions bot commented Nov 7, 2023 •

edited

Loading

gozineb Nov 8, 2023

gozineb Nov 8, 2023

gozineb Nov 8, 2023

gozineb Nov 8, 2023

gozineb Nov 8, 2023

gozineb Nov 8, 2023

gozineb left a comment



		def get_api_brain_definition_as_json_schema(brain: BrainEntity):
		if not brain:

	from repository.external_api_secret.utils import build_secret_unique_name
	from utils import build_secret_unique_name

feat: add APIBrainQA #1606

feat: add APIBrainQA #1606

Conversation

mamadoudicko commented Nov 7, 2023 • edited Loading

vercel bot commented Nov 7, 2023 • edited Loading

github-actions bot commented Nov 7, 2023 • edited Loading

Powered by Code Review GPT

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb Nov 8, 2023

Choose a reason for hiding this comment

gozineb left a comment

Choose a reason for hiding this comment

mamadoudicko commented Nov 7, 2023 •

edited

Loading

vercel bot commented Nov 7, 2023 •

edited

Loading

github-actions bot commented Nov 7, 2023 •

edited

Loading