update readmes
parent
09c8e1ec04
commit
af68e070ca
@ -0,0 +1,26 @@
|
||||
# Description of Conversation Prompt
|
||||
|
||||
Prompt designed to simulate having a conversation and allow for a conversational response to be returned.
|
||||
|
||||
|
||||
## Inputs
|
||||
|
||||
This is a description of the inputs that the prompt expects.
|
||||
|
||||
1. `history`: History of the conversation up to that point.
|
||||
2. `input`: New user input.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Below is a code snippet for how to use the prompt.
|
||||
|
||||
```python
|
||||
from langchain.prompts import load_from_hub
|
||||
from langchain.chains import ConversationChain
|
||||
|
||||
llm = ...
|
||||
prompt = load_from_hub('conversation/<file-name>')
|
||||
chain = ConversationChain(llm=llm, prompt=prompt)
|
||||
```
|
||||
|
@ -1,34 +0,0 @@
|
||||
<!-- Add a template for READMEs that capture the utility of prompts -->
|
||||
|
||||
# Description of {{prompt}}
|
||||
|
||||
{{High level text description of the prompt, including use cases.}}
|
||||
|
||||
## Compatible Chains
|
||||
|
||||
Below is a list of chains we expect this prompt to be compatible with.
|
||||
|
||||
1. {{Chain Name}}: {{Path to chain in module}}
|
||||
2. ...
|
||||
|
||||
## Inputs
|
||||
|
||||
This is a description of the inputs that the prompt expects.
|
||||
|
||||
1. {{input_var}}: {{Description}}
|
||||
2. ...
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Below is a code snippet for how to use the prompt.
|
||||
|
||||
```python
|
||||
from langchain.prompts import load_from_hub
|
||||
from langchain.chains import ConversationChain
|
||||
|
||||
llm = ...
|
||||
prompt = load_from_hub('conversation/basic/<file-name>')
|
||||
chain = ConversationChain(llm=llm, prompt=prompt)
|
||||
```
|
||||
|
Loading…
Reference in New Issue