mirror of
https://github.com/danswer-ai/danswer.git
synced 2025-04-07 19:38:19 +02:00
Merge branch 'main' of https://github.com/onyx-dot-app/onyx into feature/no_scan_iter
This commit is contained in:
Richard Kuo (Danswer)
commit
675d2f3539
@ -124,7 +124,7 @@ There are two editions of Onyx:
|
||||
To try the Onyx Enterprise Edition:
|
||||
|
||||
1. Checkout our [Cloud product](https://cloud.onyx.app/signup).
|
||||
2. For self-hosting, contact us at [founders@onyx.app](mailto:founders@onyx.app) or book a call with us on our [Cal](https://cal.com/team/danswer/founders).
|
||||
2. For self-hosting, contact us at [founders@onyx.app](mailto:founders@onyx.app) or book a call with us on our [Cal](https://cal.com/team/onyx/founders).
|
||||
|
||||
## 💡 Contributing
|
||||
|
||||
|
||||
@ -53,8 +53,8 @@ Answer:
|
||||
# Step/Utility Prompts
|
||||
# Note this one should always be used with the ENTITY_TERM_EXTRACTION_PROMPT_JSON_EXAMPLE
|
||||
ENTITY_TERM_EXTRACTION_PROMPT = f"""
|
||||
Based on the original question and some context retrieved from a dataset, please generate a list of
|
||||
entities (e.g. companies, organizations, industries, products, locations, etc.), terms and concepts
|
||||
Based on the original question and some context retrieved from a dataset, please generate a list of \
|
||||
entities (e.g. companies, organizations, industries, products, locations, etc.), terms and concepts \
|
||||
(e.g. sales, revenue, etc.) that are relevant for the question, plus their relations to each other.
|
||||
|
||||
Here is the original question:
|
||||
@ -98,445 +98,541 @@ ENTITY_TERM_EXTRACTION_PROMPT_JSON_EXAMPLE = """
|
||||
""".strip()
|
||||
|
||||
|
||||
HISTORY_CONTEXT_SUMMARY_PROMPT = (
|
||||
"{persona_specification}\n\n"
|
||||
"Your task now is to summarize the key parts of the history of a conversation between a user and an agent."
|
||||
" The summary has two purposes:\n"
|
||||
" 1) providing the suitable context for a new question, and\n"
|
||||
" 2) To capture the key information that was discussed and that the user may have a follow-up question about.\n\n"
|
||||
"Here is the question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here is the history:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{history}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please provide a summarized context from the history so that the question makes sense and can"
|
||||
" - with suitable extra information - be answered.\n\n"
|
||||
"Do not use more than three or four sentences.\n\n"
|
||||
"History summary:"
|
||||
).strip()
|
||||
HISTORY_CONTEXT_SUMMARY_PROMPT = f"""
|
||||
{{persona_specification}}
|
||||
|
||||
Your task now is to summarize the key parts of the history of a conversation between a user and an agent. \
|
||||
The summary has two purposes:
|
||||
1) providing the suitable context for a new question, and
|
||||
2) To capture the key information that was discussed and that the user may have a follow-up question about.
|
||||
|
||||
Here is the question:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here is the history:
|
||||
{SEPARATOR_LINE}
|
||||
{{history}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please provide a summarized context from the history so that the question makes sense and can \
|
||||
- with suitable extra information - be answered.
|
||||
|
||||
Do not use more than three or four sentences.
|
||||
|
||||
History summary:
|
||||
""".strip()
|
||||
|
||||
|
||||
# INITIAL PHASE
|
||||
# Sub-question
|
||||
# Intentionally left a copy in case we want to modify this one differently
|
||||
INITIAL_QUESTION_DECOMPOSITION_PROMPT = (
|
||||
"Decompose the initial user question into no more than 3 appropriate sub-questions that help to answer the"
|
||||
" original question. The purpose for this decomposition may be to:\n"
|
||||
" 1) isolate individual entities (i.e., 'compare sales of company A and company B' ->"
|
||||
" ['what are sales for company A', 'what are sales for company B'])\n"
|
||||
" 2) clarify or disambiguate ambiguous terms (i.e., 'what is our success with company A' ->"
|
||||
" ['what are our sales with company A','what is our market share with company A',"
|
||||
" 'is company A a reference customer for us', etc.])\n"
|
||||
" 3) if a term or a metric is essentially clear, but it could relate to various components of an entity and you"
|
||||
" are generally familiar with the entity, then you can decompose the question into sub-questions that are more"
|
||||
" specific to components (i.e., 'what do we do to improve scalability of product X', 'what do we to to improve"
|
||||
" scalability of product X', 'what do we do to improve stability of product X', ...])\n"
|
||||
" 4) research an area that could really help to answer the question.\n\n"
|
||||
"Here is the initial question to decompose:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"{history}\n\n"
|
||||
"Do NOT include any text in your answer outside of the list of sub-questions!"
|
||||
"Please formulate your answer as a newline-separated list of questions like so:\n"
|
||||
" <sub-question>\n"
|
||||
" <sub-question>\n"
|
||||
" <sub-question>\n"
|
||||
" ...\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
INITIAL_QUESTION_DECOMPOSITION_PROMPT = f"""
|
||||
Decompose the initial user question into no more than 3 appropriate sub-questions that help to answer the \
|
||||
original question. The purpose for this decomposition may be to:
|
||||
1) isolate individual entities (i.e., 'compare sales of company A and company B' -> \
|
||||
['what are sales for company A', 'what are sales for company B'])
|
||||
2) clarify or disambiguate ambiguous terms (i.e., 'what is our success with company A' -> \
|
||||
['what are our sales with company A','what is our market share with company A', \
|
||||
'is company A a reference customer for us', etc.])
|
||||
3) if a term or a metric is essentially clear, but it could relate to various components of an entity and you \
|
||||
are generally familiar with the entity, then you can decompose the question into sub-questions that are more \
|
||||
specific to components (i.e., 'what do we do to improve scalability of product X', 'what do we to to improve \
|
||||
scalability of product X', 'what do we do to improve stability of product X', ...])
|
||||
4) research an area that could really help to answer the question.
|
||||
|
||||
Here is the initial question to decompose:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
{{history}}
|
||||
|
||||
Do NOT include any text in your answer outside of the list of sub-questions!
|
||||
Please formulate your answer as a newline-separated list of questions like so:
|
||||
<sub-question>
|
||||
<sub-question>
|
||||
<sub-question>
|
||||
...
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
# TODO: combine shared pieces with INITIAL_QUESTION_DECOMPOSITION_PROMPT
|
||||
INITIAL_DECOMPOSITION_PROMPT_QUESTIONS_AFTER_SEARCH = (
|
||||
"Decompose the initial user question into no more than 3 appropriate sub-questions that help to answer the"
|
||||
" original question. The purpose for this decomposition may be to:\n"
|
||||
" 1) isolate individual entities (i.e., 'compare sales of company A and company B' ->"
|
||||
" ['what are sales for company A', 'what are sales for company B'])\n"
|
||||
" 2) clarify or disambiguate ambiguous terms (i.e., 'what is our success with company A' ->"
|
||||
" ['what are our sales with company A','what is our market share with company A',"
|
||||
" 'is company A a reference customer for us', etc.])\n"
|
||||
" 3) if a term or a metric is essentially clear, but it could relate to various components of an entity and you"
|
||||
" are generally familiar with the entity, then you can decompose the question into sub-questions that are more"
|
||||
" specific to components (i.e., 'what do we do to improve scalability of product X', 'what do we to to improve"
|
||||
" scalability of product X', 'what do we do to improve stability of product X', ...])\n"
|
||||
" 4) research an area that could really help to answer the question.\n\n"
|
||||
"To give you some context, you will see below also some documents that may relate to the question. Please only"
|
||||
" use this information to learn what the question is approximately asking about, but do not focus on the details"
|
||||
" to construct the sub-questions! Also, some of the entities, relationships and terms that are in the dataset may"
|
||||
" not be in these few documents, so DO NOT focussed too much on the documents when constructing the sub-questions!"
|
||||
" Decomposition and disambiguations are most important!\n\n"
|
||||
"Here are the sample docs to give you some context:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{sample_doc_str}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here is the initial question to decompose:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"{history}\n\n"
|
||||
"Do NOT include any text in your answer outside of the list of sub-questions!"
|
||||
"Please formulate your answer as a newline-separated list of questions like so:\n"
|
||||
" <sub-question>\n"
|
||||
" <sub-question>\n"
|
||||
" <sub-question>\n"
|
||||
" ...\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
INITIAL_DECOMPOSITION_PROMPT_QUESTIONS_AFTER_SEARCH = f"""
|
||||
Decompose the initial user question into no more than 3 appropriate sub-questions that help to answer the \
|
||||
original question. The purpose for this decomposition may be to:
|
||||
1) isolate individual entities (i.e., 'compare sales of company A and company B' -> \
|
||||
['what are sales for company A', 'what are sales for company B'])
|
||||
2) clarify or disambiguate ambiguous terms (i.e., 'what is our success with company A' -> \
|
||||
['what are our sales with company A','what is our market share with company A', \
|
||||
'is company A a reference customer for us', etc.])
|
||||
3) if a term or a metric is essentially clear, but it could relate to various components of an entity and you \
|
||||
are generally familiar with the entity, then you can decompose the question into sub-questions that are more \
|
||||
specific to components (i.e., 'what do we do to improve scalability of product X', 'what do we to to improve \
|
||||
scalability of product X', 'what do we do to improve stability of product X', ...])
|
||||
4) research an area that could really help to answer the question.
|
||||
|
||||
To give you some context, you will see below also some documents that may relate to the question. Please only \
|
||||
use this information to learn what the question is approximately asking about, but do not focus on the details \
|
||||
to construct the sub-questions! Also, some of the entities, relationships and terms that are in the dataset may \
|
||||
not be in these few documents, so DO NOT focussed too much on the documents when constructing the sub-questions! \
|
||||
Decomposition and disambiguations are most important!
|
||||
|
||||
Here are the sample docs to give you some context:
|
||||
{SEPARATOR_LINE}
|
||||
{{sample_doc_str}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here is the initial question to decompose:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
{{history}}
|
||||
|
||||
Do NOT include any text in your answer outside of the list of sub-questions!\
|
||||
Please formulate your answer as a newline-separated list of questions like so:
|
||||
<sub-question>
|
||||
<sub-question>
|
||||
<sub-question>
|
||||
...
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
# Retrieval
|
||||
QUERY_REWRITING_PROMPT = (
|
||||
"Please convert the initial user question into a 2-3 more appropriate short and pointed search queries for"
|
||||
" retrieval from a document store. Particularly, try to think about resolving ambiguities and make the search"
|
||||
" queries more specific, enabling the system to search more broadly.\n"
|
||||
"Also, try to make the search queries not redundant, i.e. not too similar!\n\n"
|
||||
"Here is the initial question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Do NOT include any text in your answer outside of the list of queries!"
|
||||
"Formulate the queries separated by newlines (Do not say 'Query 1: ...', just write the querytext) as follows:\n"
|
||||
"<query 1>\n"
|
||||
"<query 2>\n"
|
||||
"...\n\n"
|
||||
"Queries:"
|
||||
)
|
||||
QUERY_REWRITING_PROMPT = f"""
|
||||
Please convert the initial user question into a 2-3 more appropriate short and pointed search queries for \
|
||||
retrieval from a document store. Particularly, try to think about resolving ambiguities and make the search \
|
||||
queries more specific, enabling the system to search more broadly.
|
||||
|
||||
Also, try to make the search queries not redundant, i.e. not too similar!
|
||||
|
||||
Here is the initial question:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Do NOT include any text in your answer outside of the list of queries!\
|
||||
Formulate the queries separated by newlines (Do not say 'Query 1: ...', just write the querytext) as follows:
|
||||
<query 1>
|
||||
<query 2>
|
||||
...
|
||||
|
||||
Queries:
|
||||
""".strip()
|
||||
|
||||
|
||||
DOCUMENT_VERIFICATION_PROMPT = (
|
||||
"Determine whether the following document text contains data or information that is potentially relevant "
|
||||
"for a question. It does not have to be fully relevant, but check whether it has some information that "
|
||||
"would help - possibly in conjunction with other documents - to address the question.\n\n"
|
||||
"Be careful that you do not use a document where you are not sure whether the text applies to the objects "
|
||||
"or entities that are relevant for the question. For example, a book about chess could have long passage "
|
||||
"discussing the psychology of chess without - within the passage - mentioning chess. If now a question "
|
||||
"is asked about the psychology of football, one could be tempted to use the document as it does discuss "
|
||||
"psychology in sports. However, it is NOT about football and should not be deemed relevant. Please "
|
||||
"consider this logic.\n\n"
|
||||
"DOCUMENT TEXT:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{document_content}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Do you think that this document text is useful and relevant to answer the following question?\n\n"
|
||||
"QUESTION:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please answer with exactly and only a 'yes' or 'no'. Do NOT include any other text in your response:\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
DOCUMENT_VERIFICATION_PROMPT = f"""
|
||||
Determine whether the following document text contains data or information that is potentially relevant \
|
||||
for a question. It does not have to be fully relevant, but check whether it has some information that \
|
||||
would help - possibly in conjunction with other documents - to address the question.
|
||||
|
||||
Be careful that you do not use a document where you are not sure whether the text applies to the objects \
|
||||
or entities that are relevant for the question. For example, a book about chess could have long passage \
|
||||
discussing the psychology of chess without - within the passage - mentioning chess. If now a question \
|
||||
is asked about the psychology of football, one could be tempted to use the document as it does discuss \
|
||||
psychology in sports. However, it is NOT about football and should not be deemed relevant. Please \
|
||||
consider this logic.
|
||||
|
||||
DOCUMENT TEXT:
|
||||
{SEPARATOR_LINE}
|
||||
{{document_content}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Do you think that this document text is useful and relevant to answer the following question?
|
||||
|
||||
QUESTION:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please answer with exactly and only a '{YES}' or '{NO}'. Do NOT include any other text in your response:
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
# Sub-Question Anser Generation
|
||||
SUB_QUESTION_RAG_PROMPT = (
|
||||
"Use the context provided below - and only the provided context - to answer the given question. "
|
||||
"(Note that the answer is in service of answering a broader question, given below as 'motivation'.)\n\n"
|
||||
"Again, only use the provided context and do not use your internal knowledge! If you cannot answer the "
|
||||
f'question based on the context, say "{UNKNOWN_ANSWER}". It is a matter of life and death that you do NOT '
|
||||
"use your internal knowledge, just the provided information!\n\n"
|
||||
"Make sure that you keep all relevant information, specifically as it concerns to the ultimate goal. "
|
||||
"(But keep other details as well.)\n\n"
|
||||
"It is critical that you provide inline citations in the format [D1], [D2], [D3], etc! "
|
||||
"It is important that the citation is close to the information it supports. "
|
||||
"Proper citations are very important to the user!\n\n"
|
||||
"For your general information, here is the ultimate motivation:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{original_question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here is the actual question I want you to answer based on the context above (with the motivation in mind):\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here is the context:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{context}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please keep your answer brief and concise, and focus on facts and data.\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
SUB_QUESTION_RAG_PROMPT = f"""
|
||||
Use the context provided below - and only the provided context - to answer the given question. \
|
||||
(Note that the answer is in service of answering a broader question, given below as 'motivation').
|
||||
|
||||
Again, only use the provided context and do not use your internal knowledge! If you cannot answer the \
|
||||
question based on the context, say "{UNKNOWN_ANSWER}". It is a matter of life and death that you do NOT \
|
||||
use your internal knowledge, just the provided information!
|
||||
|
||||
Make sure that you keep all relevant information, specifically as it concerns to the ultimate goal. \
|
||||
(But keep other details as well.)
|
||||
|
||||
It is critical that you provide inline citations in the format [D1], [D2], [D3], etc! \
|
||||
It is important that the citation is close to the information it supports. \
|
||||
Proper citations are very important to the user!
|
||||
|
||||
For your general information, here is the ultimate motivation:
|
||||
{SEPARATOR_LINE}
|
||||
{{original_question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here is the actual question I want you to answer based on the context above (with the motivation in mind):
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here is the context:
|
||||
{SEPARATOR_LINE}
|
||||
{{context}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please keep your answer brief and concise, and focus on facts and data.
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
SUB_ANSWER_CHECK_PROMPT = (
|
||||
"Determine whether the given answer addresses the given question. "
|
||||
"Please do not use any internal knowledge you may have - just focus on whether the answer "
|
||||
"as given seems to largely address the question as given, or at least addresses part of the question.\n\n"
|
||||
"Here is the question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here is the suggested answer:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{base_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
f'Does the suggested answer address the question? Please answer with "{YES}" or "{NO}".'
|
||||
).strip()
|
||||
SUB_ANSWER_CHECK_PROMPT = f"""
|
||||
Determine whether the given answer addresses the given question. \
|
||||
Please do not use any internal knowledge you may have - just focus on whether the answer \
|
||||
as given seems to largely address the question as given, or at least addresses part of the question.
|
||||
|
||||
Here is the question:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here is the suggested answer:
|
||||
{SEPARATOR_LINE}
|
||||
{{base_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Does the suggested answer address the question? Please answer with "{YES}" or "{NO}".
|
||||
""".strip()
|
||||
|
||||
|
||||
# Initial Answer Generation
|
||||
INITIAL_ANSWER_PROMPT_W_SUB_QUESTIONS = (
|
||||
"{persona_specification}\n\n"
|
||||
"Use the information provided below - and only the provided information - to answer the provided main question.\n\n"
|
||||
"The information provided below consists of:\n"
|
||||
" 1) a number of answered sub-questions - these are very important to help you organize your thoughts and your answer\n"
|
||||
" 2) a number of documents that deemed relevant for the question.\n\n"
|
||||
"{history}\n\n"
|
||||
"It is critical that you provide prover inline citations to documents in the format [D1], [D2], [D3], etc.!\n"
|
||||
"It is important that the citation is close to the information it supports. If you have multiple citations that support\n"
|
||||
"a fact, please cite for example as [D1][D3], or [D2][D4], etc.\n"
|
||||
"Feel free to also cite sub-questions in addition to documents, but make sure that you have documents cited with the "
|
||||
"sub-question citation. If you want to cite both a document and a sub-question, please use [D1][Q3], or "
|
||||
"[D2][D7][Q4], etc.\n"
|
||||
"Again, please NEVER cite sub-questions without a document citation! "
|
||||
"Proper citations are very important for the user!\n\n"
|
||||
"IMPORTANT RULES:\n"
|
||||
" - If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer.\n"
|
||||
" You may give some additional facts you learned, but do not try to invent an answer.\n"
|
||||
f' - If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".\n'
|
||||
" - If the information is relevant but not fully conclusive, specify that the information is not conclusive and say why.\n\n"
|
||||
"Again, you should be sure that the answer is supported by the information provided!\n\n"
|
||||
"Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones,\n"
|
||||
"or assumptions you made.\n\n"
|
||||
"Here is the contextual information:\n"
|
||||
f"{SEPARATOR_LINE_LONG}\n\n"
|
||||
"*Answered Sub-questions (these should really matter!):\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{answered_sub_questions}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here are relevant document information that support the sub-question answers, "
|
||||
"or that are relevant for the actual question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{relevant_docs}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here is the question I want you to answer based on the information above:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please keep your answer brief and concise, and focus on facts and data.\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
INITIAL_ANSWER_PROMPT_W_SUB_QUESTIONS = f"""
|
||||
{{persona_specification}}
|
||||
|
||||
Use the information provided below - and only the provided information - to answer the provided main question.
|
||||
|
||||
The information provided below consists of:
|
||||
1) a number of answered sub-questions - these are very important to help you organize your thoughts and your answer
|
||||
2) a number of documents that deemed relevant for the question.
|
||||
|
||||
{{history}}
|
||||
|
||||
It is critical that you provide prover inline citations to documents in the format [D1], [D2], [D3], etc.! \
|
||||
It is important that the citation is close to the information it supports. If you have multiple citations that support \
|
||||
a fact, please cite for example as [D1][D3], or [D2][D4], etc. \
|
||||
Feel free to also cite sub-questions in addition to documents, but make sure that you have documents cited with the \
|
||||
sub-question citation. If you want to cite both a document and a sub-question, please use [D1][Q3], or [D2][D7][Q4], etc. \
|
||||
Again, please NEVER cite sub-questions without a document citation! Proper citations are very important for the user!
|
||||
|
||||
IMPORTANT RULES:
|
||||
- If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. \
|
||||
You may give some additional facts you learned, but do not try to invent an answer.
|
||||
- If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".
|
||||
- If the information is relevant but not fully conclusive, specify that the information is not conclusive and say why.
|
||||
|
||||
Again, you should be sure that the answer is supported by the information provided!
|
||||
|
||||
Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones, \
|
||||
or assumptions you made.
|
||||
|
||||
Here is the contextual information:
|
||||
{SEPARATOR_LINE_LONG}
|
||||
|
||||
*Answered Sub-questions (these should really matter!):
|
||||
{SEPARATOR_LINE}
|
||||
{{answered_sub_questions}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here are relevant document information that support the sub-question answers, or that are relevant for the actual question:
|
||||
{SEPARATOR_LINE}
|
||||
{{relevant_docs}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here is the question I want you to answer based on the information above:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please keep your answer brief and concise, and focus on facts and data.
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
# Used if sub_question_answer_str is empty
|
||||
INITIAL_ANSWER_PROMPT_WO_SUB_QUESTIONS = (
|
||||
"{answered_sub_questions}{persona_specification}\n\n"
|
||||
"Use the information provided below - and only the provided information - to answer the provided question. "
|
||||
"The information provided below consists of a number of documents that were deemed relevant for the question.\n"
|
||||
"{history}\n\n"
|
||||
"IMPORTANT RULES:\n"
|
||||
" - If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. "
|
||||
"You may give some additional facts you learned, but do not try to invent an answer.\n"
|
||||
f' - If the information is irrelevant, just say "{UNKNOWN_ANSWER}".\n'
|
||||
" - If the information is relevant but not fully conclusive, specify that the information is not conclusive and say why.\n\n"
|
||||
"Again, you should be sure that the answer is supported by the information provided!\n\n"
|
||||
"It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! "
|
||||
"It is important that the citation is close to the information it supports. If you have multiple citations, "
|
||||
"please cite for example as [D1][D3], or [D2][D4], etc. Citations are very important for the user!\n\n"
|
||||
"Here is the relevant context information:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{relevant_docs}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here is the question I want you to answer based on the context above:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please keep your answer brief and concise, and focus on facts and data.\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
INITIAL_ANSWER_PROMPT_WO_SUB_QUESTIONS = f"""
|
||||
{{answered_sub_questions}}{{persona_specification}}
|
||||
|
||||
Use the information provided below - and only the provided information - to answer the provided question. \
|
||||
The information provided below consists of a number of documents that were deemed relevant for the question.
|
||||
|
||||
{{history}}
|
||||
|
||||
IMPORTANT RULES:
|
||||
- If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. \
|
||||
You may give some additional facts you learned, but do not try to invent an answer.
|
||||
- If the information is irrelevant, just say "{UNKNOWN_ANSWER}".
|
||||
- If the information is relevant but not fully conclusive, specify that the information is not conclusive and say why.
|
||||
|
||||
Again, you should be sure that the answer is supported by the information provided!
|
||||
|
||||
It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! \
|
||||
It is important that the citation is close to the information it supports. \
|
||||
If you have multiple citations, please cite for example as [D1][D3], or [D2][D4], etc. \
|
||||
Citations are very important for the user!
|
||||
|
||||
Here is the relevant context information:
|
||||
{SEPARATOR_LINE}
|
||||
{{relevant_docs}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here is the question I want you to answer based on the context above:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please keep your answer brief and concise, and focus on facts and data.
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
# REFINEMENT PHASE
|
||||
REFINEMENT_QUESTION_DECOMPOSITION_PROMPT = (
|
||||
"An initial user question needs to be answered. An initial answer has been provided but it wasn't quite "
|
||||
"good enough. Also, some sub-questions had been answered and this information has been used to provide "
|
||||
"the initial answer. Some other subquestions may have been suggested based on little knowledge, but they "
|
||||
"were not directly answerable. Also, some entities, relationships and terms are given to you so that "
|
||||
"you have an idea of how the available data looks like.\n\n"
|
||||
"Your role is to generate 2-4 new sub-questions that would help to answer the initial question, considering:\n\n"
|
||||
"1) The initial question\n"
|
||||
"2) The initial answer that was found to be unsatisfactory\n"
|
||||
"3) The sub-questions that were answered\n"
|
||||
"4) The sub-questions that were suggested but not answered\n"
|
||||
"5) The entities, relationships and terms that were extracted from the context\n\n"
|
||||
"The individual questions should be answerable by a good RAG system. "
|
||||
"So a good idea would be to use the sub-questions to resolve ambiguities and/or to separate the "
|
||||
"question for different entities that may be involved in the original question, but in a way that does "
|
||||
"not duplicate questions that were already tried.\n\n"
|
||||
"Additional Guidelines:\n"
|
||||
"- The sub-questions should be specific to the question and provide richer context for the question, "
|
||||
"resolve ambiguities, or address shortcoming of the initial answer\n"
|
||||
"- Each sub-question - when answered - should be relevant for the answer to the original question\n"
|
||||
"- The sub-questions should be free from comparisons, ambiguities,judgements, aggregations, or any "
|
||||
"other complications that may require extra context.\n"
|
||||
"- The sub-questions MUST have the full context of the original question so that it can be executed by "
|
||||
"a RAG system independently without the original question available\n"
|
||||
" (Example:\n"
|
||||
' - initial question: "What is the capital of France?"\n'
|
||||
' - bad sub-question: "What is the name of the river there?"\n'
|
||||
' - good sub-question: "What is the name of the river that flows through Paris?")\n'
|
||||
"- For each sub-question, please also provide a search term that can be used to retrieve relevant "
|
||||
"documents from a document store.\n"
|
||||
"- Consider specifically the sub-questions that were suggested but not answered. This is a sign that they are not "
|
||||
"answerable with the available context, and you should not ask similar questions.\n\n"
|
||||
"Here is the initial question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{history}\n\n"
|
||||
"Here is the initial sub-optimal answer:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{base_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here are the sub-questions that were answered:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{answered_sub_questions}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here are the sub-questions that were suggested but not answered:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{failed_sub_questions}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here are the entities, relationships and terms extracted from the context:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{entity_term_extraction_str}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please generate the list of good, fully contextualized sub-questions that would help to address the main question.\n"
|
||||
"Specifically pay attention also to the entities, relationships and terms extracted, as these indicate what type of "
|
||||
"objects/relationships/terms you can ask about! Do not ask about entities, terms or relationships that are not "
|
||||
"mentioned in the 'entities, relationships and terms' section.\n\n"
|
||||
"Again, please find questions that are NOT overlapping too much with the already answered "
|
||||
"sub-questions or those that already were suggested and failed.\n"
|
||||
"In other words - what can we try in addition to what has been tried so far?\n\n"
|
||||
"Generate the list of questions separated by one new line like this:\n"
|
||||
"<sub-question 1>\n"
|
||||
"<sub-question 2>\n"
|
||||
"<sub-question 3>\n"
|
||||
"..."
|
||||
).strip()
|
||||
REFINEMENT_QUESTION_DECOMPOSITION_PROMPT = f"""
|
||||
An initial user question needs to be answered. An initial answer has been provided but it wasn't quite good enough. \
|
||||
Also, some sub-questions had been answered and this information has been used to provide the initial answer. \
|
||||
Some other subquestions may have been suggested based on little knowledge, but they were not directly answerable. \
|
||||
Also, some entities, relationships and terms are given to you so that you have an idea of how the available data looks like.
|
||||
|
||||
Your role is to generate 2-4 new sub-questions that would help to answer the initial question, considering:
|
||||
|
||||
1) The initial question
|
||||
2) The initial answer that was found to be unsatisfactory
|
||||
3) The sub-questions that were answered
|
||||
4) The sub-questions that were suggested but not answered
|
||||
5) The entities, relationships and terms that were extracted from the context
|
||||
|
||||
The individual questions should be answerable by a good RAG system. So a good idea would be to use the sub-questions to \
|
||||
resolve ambiguities and/or to separate the question for different entities that may be involved in the original question, \
|
||||
but in a way that does not duplicate questions that were already tried.
|
||||
|
||||
Additional Guidelines:
|
||||
- The sub-questions should be specific to the question and provide richer context for the question, resolve ambiguities, \
|
||||
or address shortcoming of the initial answer
|
||||
- Each sub-question - when answered - should be relevant for the answer to the original question
|
||||
- The sub-questions should be free from comparisons, ambiguities,judgements, aggregations, or any other complications that \
|
||||
may require extra context
|
||||
- The sub-questions MUST have the full context of the original question so that it can be executed by a RAG system \
|
||||
independently without the original question available
|
||||
Example:
|
||||
- initial question: "What is the capital of France?"
|
||||
- bad sub-question: "What is the name of the river there?"
|
||||
- good sub-question: "What is the name of the river that flows through Paris?"
|
||||
- For each sub-question, please also provide a search term that can be used to retrieve relevant documents from a document store.
|
||||
- Consider specifically the sub-questions that were suggested but not answered. This is a sign that they are not answerable \
|
||||
with the available context, and you should not ask similar questions.
|
||||
|
||||
Here is the initial question:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
{{history}}
|
||||
|
||||
Here is the initial sub-optimal answer:
|
||||
{SEPARATOR_LINE}
|
||||
{{base_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here are the sub-questions that were answered:
|
||||
{SEPARATOR_LINE}
|
||||
{{answered_sub_questions}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here are the sub-questions that were suggested but not answered:
|
||||
{SEPARATOR_LINE}
|
||||
{{failed_sub_questions}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here are the entities, relationships and terms extracted from the context:
|
||||
{SEPARATOR_LINE}
|
||||
{{entity_term_extraction_str}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please generate the list of good, fully contextualized sub-questions that would help to address the main question. \
|
||||
Specifically pay attention also to the entities, relationships and terms extracted, as these indicate what type of \
|
||||
objects/relationships/terms you can ask about! Do not ask about entities, terms or relationships that are not mentioned in the \
|
||||
'entities, relationships and terms' section.
|
||||
|
||||
Again, please find questions that are NOT overlapping too much with the already answered sub-questions or those that \
|
||||
already were suggested and failed. In other words - what can we try in addition to what has been tried so far?
|
||||
|
||||
Generate the list of questions separated by one new line like this:
|
||||
<sub-question 1>
|
||||
<sub-question 2>
|
||||
<sub-question 3>
|
||||
...""".strip()
|
||||
|
||||
|
||||
REFINED_ANSWER_PROMPT_W_SUB_QUESTIONS = (
|
||||
"{persona_specification}\n\n"
|
||||
"Your task is to improve on a given answer to a question, as the initial answer was found to be lacking in some way.\n\n"
|
||||
"Use the information provided below - and only the provided information - to write your new and improved answer.\n\n"
|
||||
"The information provided below consists of:\n"
|
||||
" 1) an initial answer that was given but found to be lacking in some way.\n"
|
||||
" 2) a number of answered sub-questions - these are very important(!) and definitely should help you to answer "
|
||||
"the main question. Note that the sub-questions have a type, 'initial' and 'refined'. The 'initial' "
|
||||
"ones were available for the creation of the initial answer, but the 'refined' were not, they are new. So please use "
|
||||
"the 'refined' sub-questions in particular to update/extend/correct/enrich the initial answer and to add "
|
||||
"more details/new facts!\n"
|
||||
" 3) a number of documents that were deemed relevant for the question. This is the context that you use largely for "
|
||||
"citations (see below). So consider the answers to the sub-questions as guidelines to construct your new answer, but "
|
||||
"make sure you cite the relevant document for a fact!\n\n"
|
||||
"It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! "
|
||||
"It is important that the citation is close to the information it supports. "
|
||||
"DO NOT just list all of the citations at the very end. "
|
||||
"Feel free to also cite sub-questions in addition to documents, but make sure that you have documents cited with the "
|
||||
"sub-question citation. If you want to cite both a document and a sub-question, please use [D1][Q3], or [D2][D7][Q4], etc. "
|
||||
"and always place the document citation before the sub-question citation. "
|
||||
"Again, please NEVER cite sub-questions without a document citation!\n"
|
||||
"Proper citations are very important for the user!\n\n"
|
||||
"{history}\n\n"
|
||||
"IMPORTANT RULES:\n"
|
||||
" - If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. "
|
||||
"You may give some additional facts you learned, but do not try to invent an answer.\n"
|
||||
f' - If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".\n'
|
||||
" - If the information is relevant but not fully conclusive, provide an answer to the extent you can but also "
|
||||
"specify that the information is not conclusive and why.\n"
|
||||
" - Ignore any existing citations within the answered sub-questions, like [D1]... and [Q2]! "
|
||||
"The citations you will need to use will need to refer to the documents (and sub-questions) that you are explicitly "
|
||||
"presented with below!\n\n"
|
||||
"Again, you should be sure that the answer is supported by the information provided!\n\n"
|
||||
"Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones, "
|
||||
"or assumptions you made.\n\n"
|
||||
"Here is the contextual information:\n"
|
||||
f"{SEPARATOR_LINE_LONG}\n\n"
|
||||
"*Initial Answer that was found to be lacking:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{initial_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"*Answered Sub-questions (these should really help you to research your answer! They also contain questions/answers "
|
||||
"that were not available when the original answer was constructed):\n"
|
||||
"{answered_sub_questions}\n\n"
|
||||
"And here are the relevant documents that support the sub-question answers, and that are relevant for the actual question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{relevant_docs}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Lastly, here is the main question I want you to answer based on the information above:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please keep your answer brief and concise, and focus on facts and data.\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
REFINED_ANSWER_PROMPT_W_SUB_QUESTIONS = f"""
|
||||
{{persona_specification}}
|
||||
|
||||
Your task is to improve on a given answer to a question, as the initial answer was found to be lacking in some way.
|
||||
|
||||
Use the information provided below - and only the provided information - to write your new and improved answer.
|
||||
|
||||
The information provided below consists of:
|
||||
1) an initial answer that was given but found to be lacking in some way.
|
||||
2) a number of answered sub-questions - these are very important(!) and definitely should help you to answer the main \
|
||||
question. Note that the sub-questions have a type, 'initial' and 'refined'. The 'initial' ones were available for the \
|
||||
creation of the initial answer, but the 'refined' were not, they are new. So please use the 'refined' sub-questions in \
|
||||
particular to update/extend/correct/enrich the initial answer and to add more details/new facts!
|
||||
3) a number of documents that were deemed relevant for the question. This is the context that you use largely for citations \
|
||||
(see below). So consider the answers to the sub-questions as guidelines to construct your new answer, but make sure you cite \
|
||||
the relevant document for a fact!
|
||||
|
||||
It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! \
|
||||
It is important that the citation is close to the information it supports. \
|
||||
DO NOT just list all of the citations at the very end. \
|
||||
Feel free to also cite sub-questions in addition to documents, \
|
||||
but make sure that you have documents cited with the sub-question citation. \
|
||||
If you want to cite both a document and a sub-question, please use [D1][Q3], or [D2][D7][Q4], etc. and always place the \
|
||||
document citation before the sub-question citation. Again, please NEVER cite sub-questions without a document citation! \
|
||||
Proper citations are very important for the user!
|
||||
|
||||
{{history}}
|
||||
|
||||
IMPORTANT RULES:
|
||||
- If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. \
|
||||
You may give some additional facts you learned, but do not try to invent an answer.
|
||||
- If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".
|
||||
- If the information is relevant but not fully conclusive, provide an answer to the extent you can but also specify that \
|
||||
the information is not conclusive and why.
|
||||
- Ignore any existing citations within the answered sub-questions, like [D1]... and [Q2]! The citations you will need to \
|
||||
use will need to refer to the documents (and sub-questions) that you are explicitly presented with below!
|
||||
|
||||
Again, you should be sure that the answer is supported by the information provided!
|
||||
|
||||
Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones, \
|
||||
or assumptions you made.
|
||||
|
||||
Here is the contextual information:
|
||||
{SEPARATOR_LINE_LONG}
|
||||
|
||||
*Initial Answer that was found to be lacking:
|
||||
{SEPARATOR_LINE}
|
||||
{{initial_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
*Answered Sub-questions (these should really help you to research your answer! They also contain questions/answers that \
|
||||
were not available when the original answer was constructed):
|
||||
{{answered_sub_questions}}
|
||||
|
||||
And here are the relevant documents that support the sub-question answers, and that are relevant for the actual question:
|
||||
{SEPARATOR_LINE}
|
||||
{{relevant_docs}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Lastly, here is the main question I want you to answer based on the information above:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please keep your answer brief and concise, and focus on facts and data.
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
# sub_question_answer_str is empty
|
||||
REFINED_ANSWER_PROMPT_WO_SUB_QUESTIONS = (
|
||||
"{answered_sub_questions}{persona_specification}\n\n"
|
||||
"Use the information provided below - and only the provided information - to answer the provided question.\n\n"
|
||||
"The information provided below consists of:\n"
|
||||
" 1) an initial answer that was given but found to be lacking in some way.\n"
|
||||
" 2) a number of documents that were also deemed relevant for the question.\n\n"
|
||||
"It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! "
|
||||
"It is important that the citation is close to the information it supports. "
|
||||
"DO NOT just list all of the citations at the very end of your response. Citations are very important for the user!\n\n"
|
||||
"{history}\n\n"
|
||||
"IMPORTANT RULES:\n"
|
||||
" - If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. "
|
||||
"You may give some additional facts you learned, but do not try to invent an answer.\n"
|
||||
f' - If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".\n'
|
||||
" - If the information is relevant but not fully conclusive, provide an answer to the extent you can but also "
|
||||
"specify that the information is not conclusive and why.\n\n"
|
||||
"Again, you should be sure that the answer is supported by the information provided!\n\n"
|
||||
"Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones, "
|
||||
"or assumptions you made.\n\n"
|
||||
"Here is the contextual information:\n"
|
||||
f"{SEPARATOR_LINE_LONG}\n\n"
|
||||
"*Initial Answer that was found to be lacking:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{initial_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"And here are relevant document information that support the sub-question answers, "
|
||||
"or that are relevant for the actual question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{relevant_docs}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Lastly, here is the question I want you to answer based on the information above:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Please keep your answer brief and concise, and focus on facts and data.\n\n"
|
||||
"Answer:"
|
||||
).strip()
|
||||
REFINED_ANSWER_PROMPT_WO_SUB_QUESTIONS = f"""
|
||||
{{answered_sub_questions}}{{persona_specification}}
|
||||
|
||||
Use the information provided below - and only the provided information - to answer the provided question.
|
||||
|
||||
The information provided below consists of:
|
||||
1) an initial answer that was given but found to be lacking in some way.
|
||||
2) a number of documents that were also deemed relevant for the question.
|
||||
|
||||
It is critical that you provide proper inline citations to documents in the format [D1], [D2], [D3], etc! \
|
||||
It is important that the citation is close to the information it supports. \
|
||||
DO NOT just list all of the citations at the very end of your response. Citations are very important for the user!
|
||||
|
||||
{{history}}
|
||||
|
||||
IMPORTANT RULES:
|
||||
- If you cannot reliably answer the question solely using the provided information, say that you cannot reliably answer. \
|
||||
You may give some additional facts you learned, but do not try to invent an answer.
|
||||
- If the information is empty or irrelevant, just say "{UNKNOWN_ANSWER}".
|
||||
- If the information is relevant but not fully conclusive, provide an answer to the extent you can but also specify that \
|
||||
the information is not conclusive and why.
|
||||
|
||||
Again, you should be sure that the answer is supported by the information provided!
|
||||
|
||||
Try to keep your answer concise. But also highlight uncertainties you may have should there be substantial ones, \
|
||||
or assumptions you made.
|
||||
|
||||
Here is the contextual information:
|
||||
{SEPARATOR_LINE_LONG}
|
||||
|
||||
*Initial Answer that was found to be lacking:
|
||||
{SEPARATOR_LINE}
|
||||
{{initial_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
And here are relevant document information that support the sub-question answers, \
|
||||
or that are relevant for the actual question:
|
||||
{SEPARATOR_LINE}
|
||||
{{relevant_docs}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Lastly, here is the question I want you to answer based on the information above:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Please keep your answer brief and concise, and focus on facts and data.
|
||||
|
||||
Answer:
|
||||
""".strip()
|
||||
|
||||
|
||||
INITIAL_REFINED_ANSWER_COMPARISON_PROMPT = (
|
||||
"For the given question, please compare the initial answer and the refined answer and determine if "
|
||||
"the refined answer is substantially better than the initial answer, not just a bit better. Better could mean:\n"
|
||||
" - additional information\n"
|
||||
" - more comprehensive information\n"
|
||||
" - more concise information\n"
|
||||
" - more structured information\n"
|
||||
" - more details\n"
|
||||
" - new bullet points\n"
|
||||
" - substantially more document citations ([D1], [D2], [D3], etc.)\n\n"
|
||||
"Put yourself in the shoes of the user and think about whether the refined answer is really substantially "
|
||||
"better and delivers really new insights than the initial answer.\n\n"
|
||||
"Here is the question:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{question}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here is the initial answer:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{initial_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"Here is the refined answer:\n"
|
||||
f"{SEPARATOR_LINE}\n"
|
||||
"{refined_answer}\n"
|
||||
f"{SEPARATOR_LINE}\n\n"
|
||||
"With these criteria in mind, is the refined answer substantially better than the initial answer?\n\n"
|
||||
f'Please answer with a simple "{YES}" or "{NO}".'
|
||||
).strip()
|
||||
INITIAL_REFINED_ANSWER_COMPARISON_PROMPT = f"""
|
||||
For the given question, please compare the initial answer and the refined answer and determine if the refined answer is \
|
||||
substantially better than the initial answer, not just a bit better. Better could mean:
|
||||
- additional information
|
||||
- more comprehensive information
|
||||
- more concise information
|
||||
- more structured information
|
||||
- more details
|
||||
- new bullet points
|
||||
- substantially more document citations ([D1], [D2], [D3], etc.)
|
||||
|
||||
Put yourself in the shoes of the user and think about whether the refined answer is really substantially better and \
|
||||
delivers really new insights than the initial answer.
|
||||
|
||||
Here is the question:
|
||||
{SEPARATOR_LINE}
|
||||
{{question}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here is the initial answer:
|
||||
{SEPARATOR_LINE}
|
||||
{{initial_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
Here is the refined answer:
|
||||
{SEPARATOR_LINE}
|
||||
{{refined_answer}}
|
||||
{SEPARATOR_LINE}
|
||||
|
||||
With these criteria in mind, is the refined answer substantially better than the initial answer?
|
||||
|
||||
Please answer with a simple "{YES}" or "{NO}"
|
||||
""".strip()
|
||||
|
||||
@ -2,8 +2,10 @@ from onyx.prompts.constants import GENERAL_SEP_PAT
|
||||
from onyx.prompts.constants import QUESTION_PAT
|
||||
|
||||
REQUIRE_CITATION_STATEMENT = """
|
||||
Cite relevant statements INLINE using the format [1], [2], [3], etc to reference the document number, \
|
||||
DO NOT provide a reference section at the end and DO NOT provide any links following the citations.
|
||||
Cite relevant statements INLINE using the format [1], [2], [3], etc. to reference the document number. \
|
||||
DO NOT provide any links following the citations. In other words, avoid using the format [1](https://example.com). \
|
||||
Avoid using double brackets like [[1]]. To cite multiple documents, use [1], [2] format instead of [1, 2]. \
|
||||
Try to cite inline as opposed to leaving all citations until the very end of the response.
|
||||
""".rstrip()
|
||||
|
||||
NO_CITATION_STATEMENT = """
|
||||
|
||||
@ -20,7 +20,7 @@ prompts:
|
||||
The documents may not all be relevant, ignore any documents that are not directly relevant
|
||||
to the most recent user query.
|
||||
|
||||
I have not read or seen any of the documents and do not want to read them.
|
||||
I have not read or seen any of the documents and do not want to read them. Do not refer to them by Document number.
|
||||
|
||||
If there are no relevant documents, refer to the chat history and your internal knowledge.
|
||||
# Inject a statement at the end of system prompt to inform the LLM of the current date/time
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
import json
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
from onyx.configs.constants import MessageType
|
||||
@ -65,6 +66,9 @@ def test_send_message_simple_with_history(reset: None) -> None:
|
||||
assert found_doc["metadata"]["document_id"] == doc.id
|
||||
|
||||
|
||||
@pytest.mark.xfail(
|
||||
reason="agent search broke this",
|
||||
)
|
||||
def test_using_reference_docs_with_simple_with_history_api_flow(reset: None) -> None:
|
||||
# Creating an admin user (first user created is automatically an admin)
|
||||
admin_user: DATestUser = UserManager.create(name="admin_user")
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user