Skip to content

Latest commit

 

History

History
173 lines (129 loc) · 4.77 KB

README.md

File metadata and controls

173 lines (129 loc) · 4.77 KB
Raw

ClientAI

ClientAI logo

A unified client for seamless interaction with multiple AI providers.

Tests PyPi Version Supported Python Versions

ClientAI is a Python package that provides a unified interface for interacting with multiple AI providers, including OpenAI, Replicate, Groq and Ollama. It offers seamless integration and consistent methods for text generation and chat functionality across different AI platforms.

Documentation: igorbenav.github.io/clientai/

Features

  • 🔄 Unified Interface: Consistent methods for text generation and chat across multiple AI providers.
  • 🔌 Multiple Providers: Support for OpenAI, Replicate, Groq and Ollama, with easy extensibility for future providers.
  • 🌊 Streaming Support: Efficient streaming of responses for real-time applications.
  • 🎛️ Flexible Configuration: Easy setup with provider-specific configurations.
  • 🔧 Customizable: Extensible design for adding new providers or customizing existing ones.
  • 🧠 Type Hinting: Comprehensive type annotations for better development experience.
  • 🔒 Provider Isolation: Optional installation of provider-specific dependencies to keep your environment lean.

Requirements

Before installing ClientAI, ensure you have the following:

  • Python: Version 3.9 or newer.
  • Dependencies: The core ClientAI package has minimal dependencies. Provider-specific packages (e.g., openai, replicate, ollama, groq) are optional and can be installed separately.

Installing

To install ClientAI with all providers, run:

pip install clientai[all]

Or, if you prefer to install only specific providers:

pip install clientai[openai]  # For OpenAI support
pip install clientai[replicate]  # For Replicate support
pip install clientai[ollama]  # For Ollama support
pip install clientai[groq]  # For Groq support

Usage

ClientAI provides a simple and consistent way to interact with different AI providers. Here are some examples:

Initializing the Client

from clientai import ClientAI

# Initialize with OpenAI
openai_client = ClientAI('openai', api_key="your-openai-key")

# Initialize with Replicate
replicate_client = ClientAI('replicate', api_key="your-replicate-key")

# Initialize with Ollama
ollama_client = ClientAI('ollama', host="your-ollama-host")

# Initialize with Groq
groq_client = ClientAI('groq', host="your-groq-key")

Generating Text

# Using OpenAI
response = openai_client.generate_text(
    "Tell me a joke",
    model="gpt-3.5-turbo",
)

# Using Replicate
response = replicate_client.generate_text(
    "Explain quantum computing",
    model="meta/llama-2-70b-chat:latest",
)

# Using Ollama
response = ollama_client.generate_text(
    "What is the capital of France?",
    model="llama2",
)

# Using Groq
response = groq_client.generate_text(
    "Who was the first US president?",
    model="llama3-8b-8192",
)

Chat Functionality

messages = [
    {"role": "user", "content": "What is the capital of France?"},
    {"role": "assistant", "content": "Paris."},
    {"role": "user", "content": "What is its population?"}
]

# Using OpenAI
response = openai_client.chat(
    messages,
    model="gpt-3.5-turbo",
)

# Using Replicate
response = replicate_client.chat(
    messages,
    model="meta/llama-2-70b-chat:latest",
)

# Using Ollama
response = ollama_client.chat(
    messages,
    model="llama2",
)

# Using Groq
response = groq_client.chat(
    messages,
    model="llama3-8b-8192",
)

Streaming Responses

for chunk in client.generate_text(
    "Tell me a long story",
    model="gpt-3.5-turbo",
    stream=True
):
    print(chunk, end="", flush=True)

Contributing

Contributions to ClientAI are welcome! Please refer to our Contributing Guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Igor Magalhaes – @igormagalhaesr – [email protected] github.com/igorbenav