Skip to main content

Aient: The Awakening of Agent.

Project description

aient

English | Chinese

aient is a powerful library designed to simplify and unify the use of different large language models, including GPT-3.5/4/4 Turbo/4o, o1-preview/o1-mini, DALL-E 3, Claude2/3/3.5, Gemini1.5 Pro/Flash, Vertex AI (Claude, Gemini), DuckDuckGo, 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:

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:

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_date_time_weekday Whether to enable the date plugin. The default value is False. No

Supported models

  • GPT-3.5/4/4 Turbo/4o
  • o1-preview/o1-mini
  • DALL-E 3
  • Claude2/3/3.5
  • Gemini1.5 Pro/Flash
  • Vertex AI (Claude, Gemini)
  • Groq
  • DuckDuckGo(gpt-4o-mini, claude-3-haiku, Meta-Llama-3.1-70B, Mixtral-8x7B)

🧩 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aient-1.0.29.tar.gz (84.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aient-1.0.29-py3-none-any.whl (78.3 kB view details)

Uploaded Python 3

File details

Details for the file aient-1.0.29.tar.gz.

File metadata

  • Download URL: aient-1.0.29.tar.gz
  • Upload date:
  • Size: 84.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for aient-1.0.29.tar.gz
Algorithm Hash digest
SHA256 111c999f93d61e53199780591c9a94b264950a150a48550dc055df998b71b569
MD5 bae2c6275457261640f63ff36756b345
BLAKE2b-256 3c804dcb07863fa64ad5f5cfac123f5362acdb807d6b8b45030752b471d3673e

See more details on using hashes here.

File details

Details for the file aient-1.0.29-py3-none-any.whl.

File metadata

  • Download URL: aient-1.0.29-py3-none-any.whl
  • Upload date:
  • Size: 78.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for aient-1.0.29-py3-none-any.whl
Algorithm Hash digest
SHA256 245666a235da80463828c2e877582c7bd515a0e9ec1f565e8d3dc593eaa3ebe9
MD5 41cee079b39854a8a6e6ff4373d774f5
BLAKE2b-256 ac41b6a9e34386e0adc625e1fbcc69f570ecac070c2d31f64a9fa3dd65058f0e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page