harrison/add-usage-readmes
Harrison Chase 1 year ago
parent d11f233270
commit c936711f2a

@ -16,5 +16,33 @@ Once you have that path, you can load it in the following manner:
```python
from langchain.prompts import load_from_hub
prompt = load_from_hub("qa/basic.py")
prompt = load_from_hub("qa/basic.json")
```
## Uploading
There are three methods for uploading prompts: `json`, `yaml`, and `python`.
The suggested options are `json` and `yaml`, but we provide `python` as an option for more flexibility.
Please see the below sections for instructions for uploading each format.
### `json`
To get a properly formatted json file, if you have prompt in memory in Python you can run:
```python
prompt.save("file_name.json")
```
Replace `"file_name"` with the desired name of the file.
### `yaml`
To get a properly formatted yaml file, if you have prompt in memory in Python you can run:
```python
prompt.save("file_name.yaml")
```
Replace `"file_name"` with the desired name of the file.
### `python`
To get a properly formatted Python file, you should upload a Python file that exposes a `PROMPT` variable.
This is the variable that will be loaded.
This variable should be an instance of a subclass of BasePromptTemplate in LangChain.

Loading…
Cancel
Save