Skip to content

Commit

Permalink
docs: update payman docs (#29479)
Browse files Browse the repository at this point in the history
- **Description:** fix the import docs variables

---------

Co-authored-by: ccurme <[email protected]>
  • Loading branch information
tyllenb and ccurme authored Feb 2, 2025
1 parent db1693a commit 0c782ee
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/docs/integrations/providers/payman-tool.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:
Expand All @@ -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(
Expand Down Expand Up @@ -104,12 +103,12 @@ 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
export PAYMAN_API_SECRET="YOUR_SECRET_KEY"
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.

0 comments on commit 0c782ee

Please sign in to comment.