docs: update payman docs (#29479)

- **Description:** fix the import docs variables

---------

Co-authored-by: ccurme <chester.curme@gmail.com>
This commit is contained in:
Tyllen 2025-02-01 19:41:54 -07:00 committed by GitHub
parent db1693aa70
commit 0c782ee547
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,4 +1,3 @@
# PaymanAI
PaymanAI provides functionality to send and receive payments (fiat and crypto) on behalf of an AI Agent. To get started:
@ -24,16 +23,16 @@ These can be wrapped as **LangChain Tools** for an LLM-based agent to call them
| Class | Package | Serializable | JS support | Package latest |
| :--- | :--- | :---: | :---: | :--- |
| PaymanAI | `langchain_community` | ❌ | ❌ | [PyPI Version] |
| PaymanAI | `langchain-payman-tool` | ❌ | ❌ | [PyPI Version] |
If you're simply calling the PaymanAI SDK, you can do it directly or via the **Tool** interface in LangChain.
## Setup
1. **Install** the `langchain-community` (or equivalent) package:
1. **Install** the PaymanAI tool package:
```bash
pip install --quiet -U langchain-community
pip install langchain-payman-tool
```
2. **Install** the PaymanAI SDK:
@ -54,7 +53,7 @@ Your `PAYMAN_API_SECRET` should be the secret key from app.paymanai.com. The `PA
Here is an example of instantiating a PaymanAI tool. If you have multiple Payman methods, you can create multiple tools.
```python
from langchain_community.tools.langchain_payman_tool.tool import PaymanAI
from langchain_payman_tool.tool import PaymanAI
# Instantiate the PaymanAI tool (example)
tool = PaymanAI(
@ -104,7 +103,7 @@ You can bind a PaymanAI tool to a LangChain agent or chain that supports tool-ca
1. **Sign up** at app.paymanai.com to get your **API Key**.
2. **Install** dependencies:
```bash
pip install paymanai langchain-community
pip install paymanai langchain-payman-tool
```
3. **Export** environment variables:
```bash
@ -112,4 +111,4 @@ You can bind a PaymanAI tool to a LangChain agent or chain that supports tool-ca
export PAYMAN_ENVIRONMENT="sandbox"
```
4. **Instantiate** a PaymanAI tool, passing your desired name/description.
5. **Call** the tool with `.invoke(...)` or integrate it into a chain or agent.
5. **Call** the tool with `.invoke(...)` or integrate it into a chain or agent.