mech-client 0.4.0__tar.gz → 0.7.0__tar.gz

{mech_client-0.4.0 → mech_client-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.4.0
+Version: 0.7.0
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -16,6 +16,7 @@ Requires-Dist: open-aea-cli-ipfs (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-cosmos (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-ethereum (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea[cli] (>=1.53.0,<2.0.0)
+Requires-Dist: setuptools (>=77.0.3,<78.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: websocket-client (>=0.32.0,<1)
 Description-Content-Type: text/markdown
@@ -115,12 +116,6 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 >    echo ethereum_private_key.txt >> .gitignore
 >    ```
 
-### Select the mech you are going to send requests to
-
-Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
-Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, on Gnosis you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
-
-
 ### API Keys
 
 In order to fetch on-chain data for Gnosis and Base, mech client requires an API key from a blockchain data provider. You can find them here for [GnosisScan](https://gnosisscan.io/) and [BaseScan](https://basescan.org/). Follow these steps to generate your API key if you are planning to use mech client for gnosis and base:
@@ -138,20 +133,27 @@ export MECHX_API_KEY=<your api key>
 
 ### Generate Mech requests
 
+#### Select the mech you are going to send requests to
+
+Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
+Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech (available only on Gnosis) and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
+
 #### Legacy Mechs
 
 The basic usage of the Mech Client is as follows:
 
 ```bash
-mechx interact <prompt> --agent_id <agent_id>
+mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
 ```
 
-where agent with `<agent_id>` will process `<prompt>` with the default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+where agent with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+
+⚠️ Batch requests and tools are not supported for legacy mechs
 
 Some useful options:
 
 - `--key <private_key_path>`: Specifies the path of the private key. The default value is `./ethereum_private_key.txt`.
-- `--tool  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
+- `--tools  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
 
   ```text
   Select prompting tool
@@ -177,12 +179,12 @@ Some useful options:
   - `on-chain`: Wait for the result using the Subgraph and the Websocket subscription (whichever arrives first).
   - `wait-for-both` (Default): Wait for the result using both `off-chain` and `on-chain` (whichever arrives first).
 
-### Example
+##### Example
 
 Example of a request specifying a key file and tool:
 
 ```bash
-mechx interact "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+mechx interact --prompts "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tools openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
 ```
 
 You will see an output like this:
@@ -199,23 +201,56 @@ Data from agent: {'requestId': 1004074058566339663950817114309409628095686850319
 
 #### With the Mech Marketplace
 
-With the Mech Marketplace, the basic usage of the Mech Client is as follows.
+With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the 
+payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following: 
+
+```bash
+mechx deposit-native --chain-config <chain_config> <amount>
+```
+
+For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether): 
+
+```bash
+mechx deposit-token --chain-config <chain_config> <amount>
+```
+
+For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command: 
+
+```bash 
+mechx purchase-nvm-subscription --chain-config <chain_config>
+```
 
+⚠️ To ensure optimal performance and reliability when using `purchase-nvm-subscription`, it is advisable to use a custom RPC provider as public RPC endpoints may be rate-limited or unreliable under high usage. You can configure your custom RPC URL in your environment variables using
 ```bash
-mechx interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+export MECHX_CHAIN_RPC=
 ```
 
-To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+You can use the option `--key <private_key_file_path>` in order to customize the path to the private key file.
+
+The basic usage of the Mech Client is then as follows.
 
 ```bash
-mechx interact <prompt> --priority-mech <priority mech address> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+mechx interact --prompts <prompt> --priority-mech <priority mech address> --tools openai-gpt-3.5-turbo --chain-config <chain_config>
 ```
 
 Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
 
-`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False. <br>
 `--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
 
+The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this: 
+
+```bash
+mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
+```
+
+or <br>
+
+```bash
+mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
+```
+
+
 ### List tools available for agents
 
 To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
@@ -336,7 +371,6 @@ Additionally, you can override any configuration parameter by exporting any of t
 MECHX_CHAIN_RPC
 MECHX_WSS_ENDPOINT
 MECHX_GAS_LIMIT
-MECHX_CONTRACT_ABI_URL
 MECHX_TRANSACTION_URL
 MECHX_SUBGRAPH_URL
 
@@ -476,7 +510,7 @@ You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.auto
 Use the `--chain-config <name>` parameter together with a valid `<agent_id>`, for example:
 
 ```bash
-mechx interact "write a short poem" 2 --key ./ethereum_private_key.txt --tool openai-gpt-4 --chain-config celo --confirm on-chain
+mechx interact --prompts "write a short poem" --agent_id 2 --key ./ethereum_private_key.txt --tools openai-gpt-4 --chain-config celo --confirm on-chain
 ```
 
 </details>

{mech_client-0.4.0 → mech_client-0.7.0}/README.md

@@ -93,12 +93,6 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 >    echo ethereum_private_key.txt >> .gitignore
 >    ```
 
-### Select the mech you are going to send requests to
-
-Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
-Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, on Gnosis you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
-
-
 ### API Keys
 
 In order to fetch on-chain data for Gnosis and Base, mech client requires an API key from a blockchain data provider. You can find them here for [GnosisScan](https://gnosisscan.io/) and [BaseScan](https://basescan.org/). Follow these steps to generate your API key if you are planning to use mech client for gnosis and base:
@@ -116,20 +110,27 @@ export MECHX_API_KEY=<your api key>
 
 ### Generate Mech requests
 
+#### Select the mech you are going to send requests to
+
+Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
+Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech (available only on Gnosis) and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
+
 #### Legacy Mechs
 
 The basic usage of the Mech Client is as follows:
 
 ```bash
-mechx interact <prompt> --agent_id <agent_id>
+mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
 ```
 
-where agent with `<agent_id>` will process `<prompt>` with the default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+where agent with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+
+⚠️ Batch requests and tools are not supported for legacy mechs
 
 Some useful options:
 
 - `--key <private_key_path>`: Specifies the path of the private key. The default value is `./ethereum_private_key.txt`.
-- `--tool  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
+- `--tools  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
 
   ```text
   Select prompting tool
@@ -155,12 +156,12 @@ Some useful options:
   - `on-chain`: Wait for the result using the Subgraph and the Websocket subscription (whichever arrives first).
   - `wait-for-both` (Default): Wait for the result using both `off-chain` and `on-chain` (whichever arrives first).
 
-### Example
+##### Example
 
 Example of a request specifying a key file and tool:
 
 ```bash
-mechx interact "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+mechx interact --prompts "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tools openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
 ```
 
 You will see an output like this:
@@ -177,23 +178,56 @@ Data from agent: {'requestId': 1004074058566339663950817114309409628095686850319
 
 #### With the Mech Marketplace
 
-With the Mech Marketplace, the basic usage of the Mech Client is as follows.
+With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the 
+payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following: 
+
+```bash
+mechx deposit-native --chain-config <chain_config> <amount>
+```
+
+For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether): 
+
+```bash
+mechx deposit-token --chain-config <chain_config> <amount>
+```
+
+For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command: 
+
+```bash 
+mechx purchase-nvm-subscription --chain-config <chain_config>
+```
 
+⚠️ To ensure optimal performance and reliability when using `purchase-nvm-subscription`, it is advisable to use a custom RPC provider as public RPC endpoints may be rate-limited or unreliable under high usage. You can configure your custom RPC URL in your environment variables using
 ```bash
-mechx interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+export MECHX_CHAIN_RPC=
 ```
 
-To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+You can use the option `--key <private_key_file_path>` in order to customize the path to the private key file.
+
+The basic usage of the Mech Client is then as follows.
 
 ```bash
-mechx interact <prompt> --priority-mech <priority mech address> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+mechx interact --prompts <prompt> --priority-mech <priority mech address> --tools openai-gpt-3.5-turbo --chain-config <chain_config>
 ```
 
 Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
 
-`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False. <br>
 `--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
 
+The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this: 
+
+```bash
+mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
+```
+
+or <br>
+
+```bash
+mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
+```
+
+
 ### List tools available for agents
 
 To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
@@ -314,7 +348,6 @@ Additionally, you can override any configuration parameter by exporting any of t
 MECHX_CHAIN_RPC
 MECHX_WSS_ENDPOINT
 MECHX_GAS_LIMIT
-MECHX_CONTRACT_ABI_URL
 MECHX_TRANSACTION_URL
 MECHX_SUBGRAPH_URL
 
@@ -454,7 +487,7 @@ You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.auto
 Use the `--chain-config <name>` parameter together with a valid `<agent_id>`, for example:
 
 ```bash
-mechx interact "write a short poem" 2 --key ./ethereum_private_key.txt --tool openai-gpt-4 --chain-config celo --confirm on-chain
+mechx interact --prompts "write a short poem" --agent_id 2 --key ./ethereum_private_key.txt --tools openai-gpt-4 --chain-config celo --confirm on-chain
 ```
 
 </details>

mech_client-0.7.0/mech_client/__init__.py

@@ -0,0 +1,3 @@
+"""Mech client."""
+
+__version__ = "0.7.0"