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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.4.0
+Version: 0.6.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
@@ -143,15 +144,17 @@ export MECHX_API_KEY=<your api key>
 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 +180,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 +202,53 @@ 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 interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+mechx deposit-token --chain-config <chain_config> <amount>
 ```
 
-To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+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>
+```
+
+:warning: If you face issues with base RPC, please consider updating to a new one [here](https://github.com/valory-xyz/mech-client/blob/feat/nvm_sub_integration/scripts/nvm_subscription/resources/networks.json#L10).
+
+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 +369,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 +508,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.6.0}/README.md

@@ -121,15 +121,17 @@ export MECHX_API_KEY=<your api key>
 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 +157,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 +179,53 @@ 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 interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+mechx deposit-token --chain-config <chain_config> <amount>
 ```
 
-To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+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>
+```
+
+:warning: If you face issues with base RPC, please consider updating to a new one [here](https://github.com/valory-xyz/mech-client/blob/feat/nvm_sub_integration/scripts/nvm_subscription/resources/networks.json#L10).
+
+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 +346,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 +485,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.6.0/mech_client/__init__.py

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