Skip to content

knowledge_answer_bot

django_spire.knowledge.intelligence.bots.knowledge_answer_bot

BlockType

Bases: StrEnum

HEADING = 'HEADING' class-attribute instance-attribute

SUBHEADING = 'SUBHEADING' class-attribute instance-attribute

MarkerType

Bases: StrEnum

ARTICLE = 'ARTICLE' class-attribute instance-attribute

END_ARTICLE = 'END ARTICLE' class-attribute instance-attribute

KnowledgeAnswerBot

Bases: Bot

role = 'Knowledge Entry Search Assistant' class-attribute instance-attribute

task = 'Read through the knowledge and answer the users request.' class-attribute instance-attribute

guidelines = Prompt().list(['The answer that you provide must be relevant and reflect knowledge entries.', 'Do not use general knowledge to answer a question if it does not exist in the knowledge entries.', 'Do not attempt to extrapolate an answer if it does not exist in the knowledge entries', 'If you cannot provide a direct answer, then say "Sorry, I could not find any information on that."You should assume each response is independent and not always related to the previous context. Use your best judgement.', 'You should attempt to search the knowledge base for each response when a response does not seem relevant to the previous response', 'Do not make up information use the provided knowledge entries as a source of truth.', 'Use line breaks to separate sections of the answer and use 2 if you need to separate the section from the previous.', 'Use the conversation history to understand context and references like "before that", "my last query", etc.', 'When a user asks about an article or section by title, summarize the content of that article or section.', f'Content under a [{BlockType.HEADING}] or [{BlockType.SUBHEADING}] belongs to that section.', 'Set is_knowledge_based to true only if the answer directly references or is derived from the knowledge entries.', 'Set is_knowledge_based to false for greetings, small talk, conversational responses, or when the answer does not use knowledge entries.']) class-attribute instance-attribute

intel_class = AnswerIntel class-attribute instance-attribute

process

Source code in django_spire/knowledge/intelligence/bots/knowledge_answer_bot.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def process(
    self,
    user_input: str,
    entries: list[Entry],
    message_history: MessageHistory | None = None
) -> AnswerIntel:
    entry_prompt = Prompt()
    entry_prompt.sub_heading('User Request')
    entry_prompt.line_break()
    entry_prompt.text(f'{user_input}')
    entry_prompt.line_break()
    entry_prompt.sub_heading('Knowledge')
    entry_prompt.line_break()

    for entry in entries:
        entry_prompt.text(format_marker(MarkerType.ARTICLE, entry.name))

        for version_block in entry.current_version.blocks.all():
            text = version_block.render_to_text()

            if text and text != '\n':
                entry_prompt.text(f'[{version_block.type.upper()}] {text}')

        entry_prompt.text(format_marker(MarkerType.END_ARTICLE))
        entry_prompt.line_break()

    return self.llm.prompt_to_intel(
        prompt=entry_prompt,
        message_history=message_history,
    )

format_marker

Source code in django_spire/knowledge/intelligence/bots/knowledge_answer_bot.py 
26
27
28
29
30
def format_marker(marker: MarkerType, label: str | None = None) -> str:
    if label:
        return f'[{marker}: {label}]'

    return f'[{marker}]'