2023-11-13 23:52:25 +00:00
from langchain . chat_models import ChatOpenAI
from langchain . prompts import ChatPromptTemplate
from langchain . schema . output_parser import StrOutputParser
IMPROVEMENT research-assistant configurable report type (#13312)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- **Description:** a description of the change,
- **Issue:** the issue # it fixes (if applicable),
- **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md
If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
-->
---------
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-11-15 05:04:57 +00:00
from langchain . schema . runnable import ConfigurableField
2023-11-13 23:52:25 +00:00
IMPROVEMENT research-assistant configurable report type (#13312)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- **Description:** a description of the change,
- **Issue:** the issue # it fixes (if applicable),
- **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md
If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
-->
---------
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-11-15 05:04:57 +00:00
WRITER_SYSTEM_PROMPT = " You are an AI critical thinker research assistant. Your sole purpose is to write well written, critically acclaimed, objective and structured reports on given text. " # noqa: E501
# Report prompts from https://github.com/assafelovic/gpt-researcher/blob/master/gpt_researcher/master/prompts.py
RESEARCH_REPORT_TEMPLATE = """ Information:
2023-11-13 23:52:25 +00:00
- - - - - - - -
{ research_summary }
- - - - - - - -
Using the above information , answer the following question or topic : " {question} " in a detailed report - - \
The report should focus on the answer to the question , should be well structured , informative , \
in depth , with facts and numbers if available and a minimum of 1 , 200 words .
You should strive to write the report as long as you can using all relevant and necessary information provided .
You must write the report with markdown syntax .
You MUST determine your own concrete and valid opinion based on the given information . Do NOT deter to general and meaningless conclusions .
Write all used source urls at the end of the report , and make sure to not add duplicated sources , but only one reference for each .
You must write the report in apa format .
Please do your best , this is very important to my career . """ # noqa: E501
IMPROVEMENT research-assistant configurable report type (#13312)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- **Description:** a description of the change,
- **Issue:** the issue # it fixes (if applicable),
- **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md
If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
-->
---------
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-11-15 05:04:57 +00:00
RESOURCE_REPORT_TEMPLATE = """ Information:
- - - - - - - -
{ research_summary }
- - - - - - - -
Based on the above information , generate a bibliography recommendation report for the following question or topic : " {question} " . \
The report should provide a detailed analysis of each recommended resource , explaining how each source can contribute to finding answers to the research question . \
Focus on the relevance , reliability , and significance of each source . \
Ensure that the report is well - structured , informative , in - depth , and follows Markdown syntax . \
Include relevant facts , figures , and numbers whenever available . \
The report should have a minimum length of 1 , 200 words .
Please do your best , this is very important to my career . """ # noqa: E501
OUTLINE_REPORT_TEMPLATE = """ Information:
- - - - - - - -
{ research_summary }
- - - - - - - -
Using the above information , generate an outline for a research report in Markdown syntax for the following question or topic : " {question} " . \
The outline should provide a well - structured framework for the research report , including the main sections , subsections , and key points to be covered . \
The research report should be detailed , informative , in - depth , and a minimum of 1 , 200 words . \
Use appropriate Markdown syntax to format the outline and ensure readability .
Please do your best , this is very important to my career . """ # noqa: E501
2023-11-13 23:52:25 +00:00
model = ChatOpenAI ( temperature = 0 )
prompt = ChatPromptTemplate . from_messages (
[
IMPROVEMENT research-assistant configurable report type (#13312)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- **Description:** a description of the change,
- **Issue:** the issue # it fixes (if applicable),
- **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md
If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
-->
---------
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-11-15 05:04:57 +00:00
( " system " , WRITER_SYSTEM_PROMPT ) ,
( " user " , RESEARCH_REPORT_TEMPLATE ) ,
2023-11-13 23:52:25 +00:00
]
IMPROVEMENT research-assistant configurable report type (#13312)
<!-- Thank you for contributing to LangChain!
Replace this entire comment with:
- **Description:** a description of the change,
- **Issue:** the issue # it fixes (if applicable),
- **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!
Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.
See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md
If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.
If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
-->
---------
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-11-15 05:04:57 +00:00
) . configurable_alternatives (
ConfigurableField ( " report_type " ) ,
default_key = " research_report " ,
resource_report = ChatPromptTemplate . from_messages (
[
( " system " , WRITER_SYSTEM_PROMPT ) ,
( " user " , RESOURCE_REPORT_TEMPLATE ) ,
]
) ,
outline_report = ChatPromptTemplate . from_messages (
[
( " system " , WRITER_SYSTEM_PROMPT ) ,
( " user " , OUTLINE_REPORT_TEMPLATE ) ,
]
) ,
2023-11-13 23:52:25 +00:00
)
chain = prompt | model | StrOutputParser ( )