ff997f48b5
<!-- .github/pull_request_template.md --> ## Description <!-- Provide a clear description of the changes in this PR --> ## DCO Affirmation I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin. Co-authored-by: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
118 lines
3.9 KiB
Python
118 lines
3.9 KiB
Python
from typing import Any, Optional, List
|
|
from cognee.shared.logging_utils import get_logger
|
|
|
|
from cognee.infrastructure.entities.BaseEntityExtractor import BaseEntityExtractor
|
|
from cognee.infrastructure.context.BaseContextProvider import BaseContextProvider
|
|
from cognee.modules.retrieval.base_retriever import BaseRetriever
|
|
from cognee.modules.retrieval.utils.completion import generate_completion
|
|
|
|
|
|
logger = get_logger("entity_completion_retriever")
|
|
|
|
|
|
class EntityCompletionRetriever(BaseRetriever):
|
|
"""
|
|
Retriever that uses entity-based completion for generating responses.
|
|
|
|
Public methods:
|
|
|
|
- get_context
|
|
- get_completion
|
|
|
|
Instance variables:
|
|
|
|
- extractor
|
|
- context_provider
|
|
- user_prompt_path
|
|
- system_prompt_path
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
extractor: BaseEntityExtractor,
|
|
context_provider: BaseContextProvider,
|
|
user_prompt_path: str = "context_for_question.txt",
|
|
system_prompt_path: str = "answer_simple_question.txt",
|
|
):
|
|
self.extractor = extractor
|
|
self.context_provider = context_provider
|
|
self.user_prompt_path = user_prompt_path
|
|
self.system_prompt_path = system_prompt_path
|
|
|
|
async def get_context(self, query: str) -> Any:
|
|
"""
|
|
Get context using entity extraction and context provider.
|
|
|
|
Logs the processing of the query and retrieves entities. If entities are extracted, it
|
|
attempts to retrieve the corresponding context using the context provider. Returns None
|
|
if no entities or context are found, or logs the error if an exception occurs.
|
|
|
|
Parameters:
|
|
-----------
|
|
|
|
- query (str): The query string for which context is being retrieved.
|
|
|
|
Returns:
|
|
--------
|
|
|
|
- Any: The context retrieved from the context provider or None if not found or an
|
|
error occurred.
|
|
"""
|
|
try:
|
|
logger.info(f"Processing query: {query[:100]}")
|
|
|
|
entities = await self.extractor.extract_entities(query)
|
|
if not entities:
|
|
logger.info("No entities extracted")
|
|
return None
|
|
|
|
context = await self.context_provider.get_context(entities, query)
|
|
if not context:
|
|
logger.info("No context retrieved")
|
|
return None
|
|
|
|
return context
|
|
|
|
except Exception as e:
|
|
logger.error(f"Context retrieval failed: {str(e)}")
|
|
return None
|
|
|
|
async def get_completion(self, query: str, context: Optional[Any] = None) -> List[str]:
|
|
"""
|
|
Generate completion using provided context or fetch new context.
|
|
|
|
If context is not provided, it fetches context using the query. If no context is
|
|
available, it returns an error message. Logs an error if completion generation fails due
|
|
to an exception.
|
|
|
|
Parameters:
|
|
-----------
|
|
|
|
- query (str): The query string for which completion is being generated.
|
|
- context (Optional[Any]): Optional context to be used for generating completion;
|
|
fetched if not provided. (default None)
|
|
|
|
Returns:
|
|
--------
|
|
|
|
- List[str]: A list containing the generated completion or an error message if no
|
|
relevant entities were found.
|
|
"""
|
|
try:
|
|
if context is None:
|
|
context = await self.get_context(query)
|
|
|
|
if context is None:
|
|
return ["No relevant entities found for the query."]
|
|
|
|
completion = await generate_completion(
|
|
query=query,
|
|
context=context,
|
|
user_prompt_path=self.user_prompt_path,
|
|
system_prompt_path=self.system_prompt_path,
|
|
)
|
|
return [completion]
|
|
|
|
except Exception as e:
|
|
logger.error(f"Completion generation failed: {str(e)}")
|
|
return ["Completion generation failed"]
|