Skip to main content

A unified library for interacting with various AI APIs through a standardized interface.

Project description

SwitchAI

SwitchAI is a lightweight and flexible library that provides a standardized interface for interacting with various AI APIs like OpenAI, Anthropic, Mistral, and more. With SwitchAI, you can easily switch between AI providers or use multiple APIs simultaneously, all with a simple and consistent interface.

Installation

You can install just the base switchai package, or install a provider's package along with it.

  • Base Package: This installs just the base switchai package without installing any provider's SDK.

    pip install switchai
    
  • OpenAI Provider: This installs switchai along with OpenAI's library.

    pip install switchai[openai]
    
  • All Providers: This installs switchai along with all provider-specific libraries.

    pip install switchai[all]
    

Getting Started

To use SwitchAI, you will need API keys for the AI providers you intend to interact with. You can set these keys either as environment variables or pass them as configuration to the SwitchAI client.

Option 1: In Code

from switchai import SwitchAI

client = SwitchAI(provider="openai", model_name="gpt-4", api_key="your_api_key")

Option 2: Environment Variables

Set the API key as an environment variable:

macOS/Linux:

export PROVIDER_API_KEY="your_api_key"

Windows:

set PROVIDER_API_KEY="your_api_key"

Make sure you follow the correct naming conventions for each provider's API key, as outlined in the documentation. This ensures that SwitchAI can automatically detect and use the appropriate key for the chosen provider.

Example Usage

Chat

from switchai import SwitchAI

# Initialize the client with the desired AI model
client = SwitchAI(provider="openai", model_name="gpt-4o")

# Send a message and receive a response
response = client.chat(
    messages=[
        {"role": "user", "content": "Hello, how are you?"}
    ]
)

# Print the response
print(response)

Vision

from switchai import SwitchAI

# Initialize the client with the a vision model
client = SwitchAI(provider="mistral", model_name="pixtral-large-latest")

# Send an image with a question and receive a response
response = client.chat(
    messages=[
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "What's in this image?"},
                {"type": "image", "image": "path/to/image/file.jpg"},
            ],
        }
    ]
)

# Print the response
print(response)

Text Embedding

from switchai import SwitchAI

# Initialize the client with the chosen embedding model
client = SwitchAI(provider="google", model_name="models/text-embedding-004")

# Generate embeddings for a list of text inputs
response = client.embed(
    input=[
        "I am feeling great today!",
        "I am feeling sad today."
    ]
)

# Print the response
print(response)

Speech to text

from switchai import SwitchAI

# Initialize the client with the desired speech-to-text model
client = SwitchAI(provider="deepgram", model_name="nova-2")

# Transcribe an audio file
response = client.transcribe(
    audio_path="path/to/audio/file.wav"
)

# Print the response
print(response)

Documentation

For full documentation, visit SwitchAI Documentation.

Contributing

Contributions are always welcome! If you'd like to help enhance SwitchAI, feel free to make a contribution.

Project details


Download files

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

Source Distribution

switchai-0.2.4.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

switchai-0.2.4-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file switchai-0.2.4.tar.gz.

File metadata

  • Download URL: switchai-0.2.4.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for switchai-0.2.4.tar.gz
Algorithm Hash digest
SHA256 574341198875a40b11bcff3fc1480fa36f1cd9eabec380b1523e979e27bf6309
MD5 ad1abbee08beca201cf35770ecec3115
BLAKE2b-256 0bafea48d14b7d2dd798bdb7a16ae1e162bc0220c0999cb853041e4d99f22d47

See more details on using hashes here.

File details

Details for the file switchai-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: switchai-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for switchai-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dc8b2e88aab09febdf1bc1f40f9ef447e4dbb63081e40d56c988212bd303f60e
MD5 20fcb3927efad1d7f1280e6b2beb5cfc
BLAKE2b-256 ed7a534c87f1d3bb552e5f25b046332d1c5d59fe2568900aa05fe765a83636ce

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