crypto-com-ai-agent-client


Namecrypto-com-ai-agent-client JSON
Version 1.0.2b0 PyPI version JSON
download
home_pagehttps://github.com/crypto-com/cdc-ai-agent-client-py
SummaryA python client to interact with the crypto.com AI agent service
upload_time2024-09-26 11:03:46
maintainerNone
docs_urlNone
authorRic Arcifa
requires_python<4.0.0,>=3.8.1
licenseMIT
keywords agent blockchain crypto.com ai cdc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Crypto.com AI Agent Client.py

The Crypto.com AI Agent Client.py is a Python library designed to facilitate easy and efficient interactions with the Crypto.com AI Agent Service API. This client library provides methods to send queries and fetch responses from the Crypto.com AI Agent Service seamlessly.

![PyPI](https://img.shields.io/pypi/v/crypto-com-ai-agent-client)

## Features

- Simple and intuitive API for interacting with the Crypto.com AI Agent.
- Supports sending queries and receiving AI-generated responses.
- Configurable client instances tailored to your specific endpoint and security needs.
- **Currently in beta**: Expect frequent updates and potential changes in future releases.

## Installation

To install the package, run the following command:

```bash
pip install crypto_com_ai_agent_client
```

## Usage

Here’s how you can use the Crypto.com AI Agent Client in your project:

### Configuring the Client

```py
from crypto_com_ai_agent_client import create_client

client = create_client({
    'openAI': {
        'apiKey': 'YOUR_OPEN_AI_API_KEY'
    },
    'chain': {
        'id': 'CHAIN_ID', # e.g. 282 for the Cronos ZkEVM Testnet
        'name': 'CHAIN_NAME',
        'rpc': 'CHAIN_RPC_URL',
    },
    'explorer': {
        'apiKey': 'EXPLORER_API_KEY',
    }
})
```

### Sending a Query

```py
def send_query(query):
    try:
        response = client.agent.generate_query(query)
        print('Crypto.com AI Agent Response:', response)
    except Exception as e:
        print(f"Error sending query: {str(e)}")

send_query("What is the latest block?")
```

## API

### Client Methods

- `generate_query(query)`: Generates a query that is send to the Crypto.com AI Agent Service and returns a response.

## Licensing

The code in this project is licensed under the MIT license.

## Contact

If you have any questions or comments about the library, please feel free to open an issue or a pull request on our GitHub repository.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/crypto-com/cdc-ai-agent-client-py",
    "name": "crypto-com-ai-agent-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": "agent, blockchain, crypto.com, AI, CDC",
    "author": "Ric Arcifa",
    "author_email": "ricardo.arcifa@crypto.com",
    "download_url": null,
    "platform": null,
    "description": "# Crypto.com AI Agent Client.py\n\nThe Crypto.com AI Agent Client.py is a Python library designed to facilitate easy and efficient interactions with the Crypto.com AI Agent Service API. This client library provides methods to send queries and fetch responses from the Crypto.com AI Agent Service seamlessly.\n\n![PyPI](https://img.shields.io/pypi/v/crypto-com-ai-agent-client)\n\n## Features\n\n- Simple and intuitive API for interacting with the Crypto.com AI Agent.\n- Supports sending queries and receiving AI-generated responses.\n- Configurable client instances tailored to your specific endpoint and security needs.\n- **Currently in beta**: Expect frequent updates and potential changes in future releases.\n\n## Installation\n\nTo install the package, run the following command:\n\n```bash\npip install crypto_com_ai_agent_client\n```\n\n## Usage\n\nHere\u2019s how you can use the Crypto.com AI Agent Client in your project:\n\n### Configuring the Client\n\n```py\nfrom crypto_com_ai_agent_client import create_client\n\nclient = create_client({\n    'openAI': {\n        'apiKey': 'YOUR_OPEN_AI_API_KEY'\n    },\n    'chain': {\n        'id': 'CHAIN_ID', # e.g. 282 for the Cronos ZkEVM Testnet\n        'name': 'CHAIN_NAME',\n        'rpc': 'CHAIN_RPC_URL',\n    },\n    'explorer': {\n        'apiKey': 'EXPLORER_API_KEY',\n    }\n})\n```\n\n### Sending a Query\n\n```py\ndef send_query(query):\n    try:\n        response = client.agent.generate_query(query)\n        print('Crypto.com AI Agent Response:', response)\n    except Exception as e:\n        print(f\"Error sending query: {str(e)}\")\n\nsend_query(\"What is the latest block?\")\n```\n\n## API\n\n### Client Methods\n\n- `generate_query(query)`: Generates a query that is send to the Crypto.com AI Agent Service and returns a response.\n\n## Licensing\n\nThe code in this project is licensed under the MIT license.\n\n## Contact\n\nIf you have any questions or comments about the library, please feel free to open an issue or a pull request on our GitHub repository.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python client to interact with the crypto.com AI agent service",
    "version": "1.0.2b0",
    "project_urls": {
        "Documentation": "https://github.com/crypto-com/cdc-ai-agent-client-py",
        "Homepage": "https://github.com/crypto-com/cdc-ai-agent-client-py",
        "Repository": "https://github.com/crypto-com/cdc-ai-agent-client-py"
    },
    "split_keywords": [
        "agent",
        " blockchain",
        " crypto.com",
        " ai",
        " cdc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30a4f6797ee2abafe8ab6574dbaa92334a3c527a53c677adb256f0e5f491e928",
                "md5": "27a69e1450803730964d095b0573cbfc",
                "sha256": "d5623d44aaee56246e22218072c7743f45ed287e076edf68ade7630e1aea11c8"
            },
            "downloads": -1,
            "filename": "crypto_com_ai_agent_client-1.0.2b0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "27a69e1450803730964d095b0573cbfc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.8.1",
            "size": 6876,
            "upload_time": "2024-09-26T11:03:46",
            "upload_time_iso_8601": "2024-09-26T11:03:46.766025Z",
            "url": "https://files.pythonhosted.org/packages/30/a4/f6797ee2abafe8ab6574dbaa92334a3c527a53c677adb256f0e5f491e928/crypto_com_ai_agent_client-1.0.2b0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-26 11:03:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "crypto-com",
    "github_project": "cdc-ai-agent-client-py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "crypto-com-ai-agent-client"
}
        
Elapsed time: 0.36705s