quivr/backend/modules/brain/controller/brain_routes.py
Stan Girard 36b008e0eb
feat: Refactor get_question_context_for_brain endpoint (#1872)
to return a list of DocumentAnswer objects

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
2023-12-12 22:33:23 +01:00

234 lines
7.6 KiB
Python

from typing import Dict
from uuid import UUID
from fastapi import APIRouter, Depends, HTTPException
from logger import get_logger
from middlewares.auth.auth_bearer import AuthBearer, get_current_user
from models import UserUsage
from modules.brain.dto.inputs import (
BrainQuestionRequest,
BrainUpdatableProperties,
CreateBrainProperties,
)
from modules.brain.entity.brain_entity import PublicBrain, RoleEnum
from modules.brain.service.brain_authorization_service import has_brain_authorization
from modules.brain.service.brain_service import BrainService
from modules.brain.service.brain_user_service import BrainUserService
from modules.prompt.service.prompt_service import PromptService
from modules.user.entity.user_identity import UserIdentity
from repository.brain import get_question_context_from_brain
logger = get_logger(__name__)
brain_router = APIRouter()
prompt_service = PromptService()
brain_service = BrainService()
brain_user_service = BrainUserService()
@brain_router.get("/brains/", dependencies=[Depends(AuthBearer())], tags=["Brain"])
async def retrieve_all_brains_for_user(
current_user: UserIdentity = Depends(get_current_user),
):
"""Retrieve all brains for the current user."""
brains = brain_user_service.get_user_brains(current_user.id)
return {"brains": brains}
@brain_router.get(
"/brains/public", dependencies=[Depends(AuthBearer())], tags=["Brain"]
)
async def retrieve_public_brains() -> list[PublicBrain]:
"""Retrieve all Quivr public brains."""
return brain_service.get_public_brains()
@brain_router.get(
"/brains/default/", dependencies=[Depends(AuthBearer())], tags=["Brain"]
)
async def retrieve_default_brain(
current_user: UserIdentity = Depends(get_current_user),
):
"""Retrieve or create the default brain for the current user."""
brain = brain_user_service.get_default_user_brain_or_create_new(current_user)
return {"id": brain.brain_id, "name": brain.name, "rights": "Owner"}
@brain_router.get(
"/brains/{brain_id}/",
dependencies=[
Depends(AuthBearer()),
Depends(
has_brain_authorization(
required_roles=[RoleEnum.Owner, RoleEnum.Editor, RoleEnum.Viewer]
)
),
],
tags=["Brain"],
)
async def retrieve_brain_by_id(brain_id: UUID):
"""Retrieve details of a specific brain by its ID."""
brain_details = brain_service.get_brain_details(brain_id)
if brain_details is None:
raise HTTPException(status_code=404, detail="Brain details not found")
return brain_details
@brain_router.post("/brains/", dependencies=[Depends(AuthBearer())], tags=["Brain"])
async def create_new_brain(
brain: CreateBrainProperties, current_user: UserIdentity = Depends(get_current_user)
):
"""Create a new brain for the user."""
user_brains = brain_user_service.get_user_brains(current_user.id)
user_usage = UserUsage(
id=current_user.id,
email=current_user.email,
)
user_settings = user_usage.get_user_settings()
if len(user_brains) >= user_settings.get("max_brains", 5):
raise HTTPException(
status_code=429,
detail=f"Maximum number of brains reached ({user_settings.get('max_brains', 5)}).",
)
new_brain = brain_service.create_brain(
brain=brain,
user_id=current_user.id,
)
if brain_user_service.get_user_default_brain(current_user.id):
logger.info(f"Default brain already exists for user {current_user.id}")
brain_user_service.create_brain_user(
user_id=current_user.id,
brain_id=new_brain.brain_id,
rights=RoleEnum.Owner,
is_default_brain=False,
)
else:
logger.info(f"Creating default brain for user {current_user.id}.")
brain_user_service.create_brain_user(
user_id=current_user.id,
brain_id=new_brain.brain_id,
rights=RoleEnum.Owner,
is_default_brain=True,
)
return {"id": new_brain.brain_id, "name": brain.name, "rights": "Owner"}
@brain_router.put(
"/brains/{brain_id}/",
dependencies=[
Depends(AuthBearer()),
Depends(has_brain_authorization([RoleEnum.Editor, RoleEnum.Owner])),
],
tags=["Brain"],
)
async def update_existing_brain(
brain_id: UUID, brain_update_data: BrainUpdatableProperties
):
"""Update an existing brain's configuration."""
existing_brain = brain_service.get_brain_details(brain_id)
if existing_brain is None:
raise HTTPException(status_code=404, detail="Brain not found")
brain_service.update_brain_by_id(brain_id, brain_update_data)
if brain_update_data.prompt_id is None and existing_brain.prompt_id:
prompt = prompt_service.get_prompt_by_id(existing_brain.prompt_id)
if prompt and prompt.status == "private":
prompt_service.delete_prompt_by_id(existing_brain.prompt_id)
if brain_update_data.status == "private" and existing_brain.status == "public":
brain_user_service.delete_brain_users(brain_id)
return {"message": f"Brain {brain_id} has been updated."}
@brain_router.put(
"/brains/{brain_id}/secrets-values",
dependencies=[
Depends(AuthBearer()),
],
tags=["Brain"],
)
async def update_existing_brain_secrets(
brain_id: UUID,
secrets: Dict[str, str],
current_user: UserIdentity = Depends(get_current_user),
):
"""Update an existing brain's secrets."""
existing_brain = brain_service.get_brain_details(brain_id)
if existing_brain is None:
raise HTTPException(status_code=404, detail="Brain not found")
if (
existing_brain.brain_definition is None
or existing_brain.brain_definition.secrets is None
):
raise HTTPException(
status_code=400,
detail="This brain does not support secrets.",
)
is_brain_user = (
brain_user_service.get_brain_for_user(
user_id=current_user.id,
brain_id=brain_id,
)
is not None
)
if not is_brain_user:
raise HTTPException(
status_code=403,
detail="You are not authorized to update this brain.",
)
secrets_names = [secret.name for secret in existing_brain.brain_definition.secrets]
for key, value in secrets.items():
if key not in secrets_names:
raise HTTPException(
status_code=400,
detail=f"Secret {key} is not a valid secret.",
)
if value:
brain_service.update_secret_value(
user_id=current_user.id,
brain_id=brain_id,
secret_name=key,
secret_value=value,
)
return {"message": f"Brain {brain_id} has been updated."}
@brain_router.post(
"/brains/{brain_id}/default",
dependencies=[Depends(AuthBearer()), Depends(has_brain_authorization())],
tags=["Brain"],
)
async def set_brain_as_default(
brain_id: UUID, user: UserIdentity = Depends(get_current_user)
):
"""Set a brain as the default for the current user."""
brain_user_service.set_as_default_brain_for_user(user.id, brain_id)
return {"message": f"Brain {brain_id} has been set as default brain."}
@brain_router.post(
"/brains/{brain_id}/documents",
dependencies=[Depends(AuthBearer()), Depends(has_brain_authorization())],
tags=["Brain"],
)
async def get_question_context_for_brain(
brain_id: UUID, question: BrainQuestionRequest
):
# TODO: Move this endpoint to AnswerGenerator service
"""Retrieve the question context from a specific brain."""
context = get_question_context_from_brain(brain_id, question.question)
return {"docs": context}