| Name | aient JSON |
| Version |
1.2.24
JSON |
| download |
| home_page | None |
| Summary | Aient: The Awakening of Agent. |
| upload_time | 2025-09-02 20:46:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aient
[English](./README.md) | [Chinese](./README_CN.md)
aient is a powerful library designed to simplify and unify the use of different large language models, including gpt-4.1/5, o3, DALL-E 3, claude4, gemini-2.5-pro/flash, Vertex AI (Claude, Gemini), and Groq. The library supports GPT format function calls and has built-in Google search and URL summarization features, greatly enhancing the practicality and flexibility of the models.
## ✨ Features
- **Multi-model support**: Integrate various latest large language models.
- **Real-time Interaction**: Supports real-time query streams, real-time model response retrieval.
- **Function Expansion**: With built-in function calling support, the model's functions can be easily expanded, currently supporting plugins such as DuckDuckGo and Google search, content summarization, Dalle-3 drawing, arXiv paper summaries, current time, code interpreter, and more.
- **Simple Interface**: Provides a concise and unified API interface, making it easy to call and manage the model.
## Quick Start
The following is a guide on how to quickly integrate and use aient in your Python project.
### Install
First, you need to install aient. It can be installed directly via pip:
```bash
pip install aient
```
### Usage example
The following is a simple example demonstrating how to use aient to request the GPT-4 model and handle the returned streaming data:
```python
from aient import chatgpt
# Initialize the model, set the API key and the selected model
bot = chatgpt(api_key="{YOUR_API_KEY}", engine="gpt-4o")
# Get response
result = bot.ask("python list use")
# Send request and get streaming response in real-time
for text in bot.ask_stream("python list use"):
print(text, end="")
# Disable all plugins
bot = chatgpt(api_key="{YOUR_API_KEY}", engine="gpt-4o", use_plugins=False)
```
## 🍃 Environment Variables
The following is a list of environment variables related to plugin settings:
| Variable Name | Description | Required? |
|---------------|-------------|-----------|
| get_search_results | Enable search plugin. Default value is `False`. | No |
| get_url_content | Enable URL summary plugin. The default value is `False`. | No |
| download_read_arxiv_pdf | Whether to enable the arXiv paper abstract plugin. The default value is `False`. | No |
| run_python_script | Whether to enable the code interpreter plugin. The default value is `False`. | No |
| generate_image | Whether to enable the image generation plugin. The default value is `False`. | No |
| get_time | Whether to enable the date plugin. The default value is `False`. | No |
## Supported models
- gpt-4.1/5
- o3
- DALL-E 3
- claude4
- gemini-2.5-pro/flash
- Vertex AI (Claude, Gemini)
- Groq
## 🧩 Plugin
This project supports multiple plugins, including: DuckDuckGo and Google search, URL summary, ArXiv paper summary, DALLE-3 drawing, and code interpreter, etc. You can enable or disable these plugins by setting environment variables.
- How to develop a plugin?
The plugin-related code is all in the aient git submodule of this repository. aient is an independent repository I developed for handling API requests, conversation history management, and other functionality. When you clone this repository with the `--recurse-submodules` parameter, aient will be automatically downloaded. All plugin code is located in the relative path `aient/src/aient/plugins` in this repository. You can add your own plugin code in this directory. The plugin development process is as follows:
1. Create a new Python file in the `aient/src/aient/plugins` directory, for example, `myplugin.py`. Register the plugin by adding the `@register_tool()` decorator above the function. Import `register_tool` with `from .registry import register_tool`.
After completing the above steps, your plugin is ready to use. 🎉
## License
This project is licensed under the MIT License.
## Contribution
Welcome to contribute improvements by submitting issues or pull requests through GitHub.
## Contact Information
If you have any questions or need assistance, please contact us at [yym68686@outlook.com](mailto:yym68686@outlook.com).
Raw data
{
"_id": null,
"home_page": null,
"name": "aient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3b/e8/22a505bef051a3019a8a7d5974ef8576efb452591ba87bea5f532434514b/aient-1.2.24.tar.gz",
"platform": null,
"description": "# aient\n\n[English](./README.md) | [Chinese](./README_CN.md)\n\naient is a powerful library designed to simplify and unify the use of different large language models, including gpt-4.1/5, o3, DALL-E 3, claude4, gemini-2.5-pro/flash, Vertex AI (Claude, Gemini), and Groq. The library supports GPT format function calls and has built-in Google search and URL summarization features, greatly enhancing the practicality and flexibility of the models.\n\n## \u2728 Features\n\n- **Multi-model support**: Integrate various latest large language models.\n- **Real-time Interaction**: Supports real-time query streams, real-time model response retrieval.\n- **Function Expansion**: With built-in function calling support, the model's functions can be easily expanded, currently supporting plugins such as DuckDuckGo and Google search, content summarization, Dalle-3 drawing, arXiv paper summaries, current time, code interpreter, and more.\n- **Simple Interface**: Provides a concise and unified API interface, making it easy to call and manage the model.\n\n## Quick Start\n\nThe following is a guide on how to quickly integrate and use aient in your Python project.\n\n### Install\n\nFirst, you need to install aient. It can be installed directly via pip:\n\n```bash\npip install aient\n```\n\n### Usage example\n\nThe following is a simple example demonstrating how to use aient to request the GPT-4 model and handle the returned streaming data:\n\n```python\nfrom aient import chatgpt\n\n# Initialize the model, set the API key and the selected model\nbot = chatgpt(api_key=\"{YOUR_API_KEY}\", engine=\"gpt-4o\")\n\n# Get response\nresult = bot.ask(\"python list use\")\n\n# Send request and get streaming response in real-time\nfor text in bot.ask_stream(\"python list use\"):\n print(text, end=\"\")\n\n# Disable all plugins\nbot = chatgpt(api_key=\"{YOUR_API_KEY}\", engine=\"gpt-4o\", use_plugins=False)\n```\n\n## \ud83c\udf43 Environment Variables\n\nThe following is a list of environment variables related to plugin settings:\n\n| Variable Name | Description | Required? |\n|---------------|-------------|-----------|\n| get_search_results | Enable search plugin. Default value is `False`. | No |\n| get_url_content | Enable URL summary plugin. The default value is `False`. | No |\n| download_read_arxiv_pdf | Whether to enable the arXiv paper abstract plugin. The default value is `False`. | No |\n| run_python_script | Whether to enable the code interpreter plugin. The default value is `False`. | No |\n| generate_image | Whether to enable the image generation plugin. The default value is `False`. | No |\n| get_time | Whether to enable the date plugin. The default value is `False`. | No |\n\n## Supported models\n\n- gpt-4.1/5\n- o3\n- DALL-E 3\n- claude4\n- gemini-2.5-pro/flash\n- Vertex AI (Claude, Gemini)\n- Groq\n\n## \ud83e\udde9 Plugin\n\nThis project supports multiple plugins, including: DuckDuckGo and Google search, URL summary, ArXiv paper summary, DALLE-3 drawing, and code interpreter, etc. You can enable or disable these plugins by setting environment variables.\n\n- How to develop a plugin?\n\nThe plugin-related code is all in the aient git submodule of this repository. aient is an independent repository I developed for handling API requests, conversation history management, and other functionality. When you clone this repository with the `--recurse-submodules` parameter, aient will be automatically downloaded. All plugin code is located in the relative path `aient/src/aient/plugins` in this repository. You can add your own plugin code in this directory. The plugin development process is as follows:\n\n1. Create a new Python file in the `aient/src/aient/plugins` directory, for example, `myplugin.py`. Register the plugin by adding the `@register_tool()` decorator above the function. Import `register_tool` with `from .registry import register_tool`.\n\nAfter completing the above steps, your plugin is ready to use. \ud83c\udf89\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contribution\n\nWelcome to contribute improvements by submitting issues or pull requests through GitHub.\n\n## Contact Information\n\nIf you have any questions or need assistance, please contact us at [yym68686@outlook.com](mailto:yym68686@outlook.com).\n",
"bugtrack_url": null,
"license": null,
"summary": "Aient: The Awakening of Agent.",
"version": "1.2.24",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f41dd7a7ebe0aebb9e16c57cebd91cc89910f667dfc2f552fa14e48dd3acfa60",
"md5": "ff9635210dc5c91a9e85de67184f8520",
"sha256": "0f86a70b56c8d6c815666fa124d7acf3be9d4f5055cbda7b49497235ea8aa617"
},
"downloads": -1,
"filename": "aient-1.2.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff9635210dc5c91a9e85de67184f8520",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 122955,
"upload_time": "2025-09-02T20:46:18",
"upload_time_iso_8601": "2025-09-02T20:46:18.464538Z",
"url": "https://files.pythonhosted.org/packages/f4/1d/d7a7ebe0aebb9e16c57cebd91cc89910f667dfc2f552fa14e48dd3acfa60/aient-1.2.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3be822a505bef051a3019a8a7d5974ef8576efb452591ba87bea5f532434514b",
"md5": "2c7cecf2c6c290e8f6b828a2245991f2",
"sha256": "2c3bc0f6e8871a92fd0eae20b5911c03984cba7b6ac8d694e56cec7277dd6e85"
},
"downloads": -1,
"filename": "aient-1.2.24.tar.gz",
"has_sig": false,
"md5_digest": "2c7cecf2c6c290e8f6b828a2245991f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 118510,
"upload_time": "2025-09-02T20:46:19",
"upload_time_iso_8601": "2025-09-02T20:46:19.930207Z",
"url": "https://files.pythonhosted.org/packages/3b/e8/22a505bef051a3019a8a7d5974ef8576efb452591ba87bea5f532434514b/aient-1.2.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 20:46:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aient"
}
