indoxrouter 0.1.0__tar.gz → 0.1.3__tar.gz

indoxrouter-0.1.3/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include cookbook *.md *.ipynb
+recursive-include examples *.py 

indoxrouter-0.1.3/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.2
+Name: indoxrouter
+Version: 0.1.3
+Summary: A unified client for various AI providers
+Home-page: https://github.com/indoxrouter/indoxrouter
+Author: indoxRouter Team
+Author-email: ashkan.eskandari.dev@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# IndoxRouter Client
+
+A unified client for various AI providers, including OpenAI, Anthropic, Cohere, Google, and Mistral.
+
+## Features
+
+- **Unified API**: Access multiple AI providers through a single API
+- **Simple Interface**: Easy-to-use methods for chat, completion, embeddings, and image generation
+- **Error Handling**: Standardized error handling across providers
+- **Authentication**: Automatic token management
+
+## Installation
+
+```bash
+pip install indoxrouter
+```
+
+## Usage
+
+### Initialization
+
+```python
+from indoxrouter import Client
+
+# Initialize with API key
+client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+
+# Or initialize with username and password
+client = Client(
+    username="your_username",
+    password="your_password",
+    base_url="http://your-server-url:8000"
+)
+
+# Using environment variables
+# Set INDOXROUTER_API_KEY or INDOXROUTER_USERNAME and INDOXROUTER_PASSWORD
+client = Client(base_url="http://your-server-url:8000")
+```
+
+### Chat Completions
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="openai",
+    model="gpt-3.5-turbo",
+    temperature=0.7
+)
+
+print(response["choices"][0]["message"]["content"])
+```
+
+### Text Completions
+
+```python
+response = client.completion(
+    prompt="Once upon a time,",
+    provider="openai",
+    model="gpt-3.5-turbo-instruct",
+    max_tokens=100
+)
+
+print(response["choices"][0]["text"])
+```
+
+### Embeddings
+
+```python
+response = client.embeddings(
+    text=["Hello world", "AI is amazing"],
+    provider="openai",
+    model="text-embedding-ada-002"
+)
+
+print(f"Dimensions: {response['dimensions']}")
+print(f"First embedding: {response['embeddings'][0][:5]}...")
+```
+
+### Image Generation
+
+```python
+response = client.images(
+    prompt="A serene landscape with mountains and a lake",
+    provider="openai",
+    model="dall-e-3",
+    size="1024x1024"
+)
+
+print(f"Image URL: {response['images'][0]['url']}")
+```
+
+### Streaming Responses
+
+```python
+for chunk in client.chat(
+    messages=[{"role": "user", "content": "Write a short story."}],
+    stream=True
+):
+    if "choices" in chunk and len(chunk["choices"]) > 0:
+        content = chunk["choices"][0].get("delta", {}).get("content", "")
+        print(content, end="", flush=True)
+```
+
+### Getting Available Models
+
+```python
+# Get all providers and models
+providers = client.models()
+for provider in providers:
+    print(f"Provider: {provider['name']}")
+    for model in provider["models"]:
+        print(f"  - {model['id']}: {model['name']}")
+
+# Get models for a specific provider
+openai_provider = client.models("openai")
+print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
+```
+
+## Error Handling
+
+```python
+from indoxrouter import Client, ModelNotFoundError, ProviderError
+
+try:
+    client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello"}],
+        provider="nonexistent",
+        model="nonexistent-model"
+    )
+except ModelNotFoundError as e:
+    print(f"Model not found: {e}")
+except ProviderError as e:
+    print(f"Provider error: {e}")
+```
+
+## Context Manager
+
+```python
+with Client(api_key="your_api_key", base_url="http://your-server-url:8000") as client:
+    response = client.chat([{"role": "user", "content": "Hello!"}])
+    print(response["choices"][0]["message"]["content"])
+# Client is automatically closed when exiting the block
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

indoxrouter-0.1.3/README.md

@@ -0,0 +1,151 @@
+# IndoxRouter Client
+
+A unified client for various AI providers, including OpenAI, Anthropic, Cohere, Google, and Mistral.
+
+## Features
+
+- **Unified API**: Access multiple AI providers through a single API
+- **Simple Interface**: Easy-to-use methods for chat, completion, embeddings, and image generation
+- **Error Handling**: Standardized error handling across providers
+- **Authentication**: Automatic token management
+
+## Installation
+
+```bash
+pip install indoxrouter
+```
+
+## Usage
+
+### Initialization
+
+```python
+from indoxrouter import Client
+
+# Initialize with API key
+client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+
+# Or initialize with username and password
+client = Client(
+    username="your_username",
+    password="your_password",
+    base_url="http://your-server-url:8000"
+)
+
+# Using environment variables
+# Set INDOXROUTER_API_KEY or INDOXROUTER_USERNAME and INDOXROUTER_PASSWORD
+client = Client(base_url="http://your-server-url:8000")
+```
+
+### Chat Completions
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="openai",
+    model="gpt-3.5-turbo",
+    temperature=0.7
+)
+
+print(response["choices"][0]["message"]["content"])
+```
+
+### Text Completions
+
+```python
+response = client.completion(
+    prompt="Once upon a time,",
+    provider="openai",
+    model="gpt-3.5-turbo-instruct",
+    max_tokens=100
+)
+
+print(response["choices"][0]["text"])
+```
+
+### Embeddings
+
+```python
+response = client.embeddings(
+    text=["Hello world", "AI is amazing"],
+    provider="openai",
+    model="text-embedding-ada-002"
+)
+
+print(f"Dimensions: {response['dimensions']}")
+print(f"First embedding: {response['embeddings'][0][:5]}...")
+```
+
+### Image Generation
+
+```python
+response = client.images(
+    prompt="A serene landscape with mountains and a lake",
+    provider="openai",
+    model="dall-e-3",
+    size="1024x1024"
+)
+
+print(f"Image URL: {response['images'][0]['url']}")
+```
+
+### Streaming Responses
+
+```python
+for chunk in client.chat(
+    messages=[{"role": "user", "content": "Write a short story."}],
+    stream=True
+):
+    if "choices" in chunk and len(chunk["choices"]) > 0:
+        content = chunk["choices"][0].get("delta", {}).get("content", "")
+        print(content, end="", flush=True)
+```
+
+### Getting Available Models
+
+```python
+# Get all providers and models
+providers = client.models()
+for provider in providers:
+    print(f"Provider: {provider['name']}")
+    for model in provider["models"]:
+        print(f"  - {model['id']}: {model['name']}")
+
+# Get models for a specific provider
+openai_provider = client.models("openai")
+print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
+```
+
+## Error Handling
+
+```python
+from indoxrouter import Client, ModelNotFoundError, ProviderError
+
+try:
+    client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello"}],
+        provider="nonexistent",
+        model="nonexistent-model"
+    )
+except ModelNotFoundError as e:
+    print(f"Model not found: {e}")
+except ProviderError as e:
+    print(f"Provider error: {e}")
+```
+
+## Context Manager
+
+```python
+with Client(api_key="your_api_key", base_url="http://your-server-url:8000") as client:
+    response = client.chat([{"role": "user", "content": "Hello!"}])
+    print(response["choices"][0]["message"]["content"])
+# Client is automatically closed when exiting the block
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

indoxrouter-0.1.3/cookbook/README.md

@@ -0,0 +1,44 @@
+# IndoxRouter Cookbook
+
+This directory contains examples and recipes for using the IndoxRouter client to interact with various AI providers.
+
+## Examples
+
+- [Chat Completion](chat_completion.md): Examples of generating chat completions
+- [Embeddings](embeddings.md): Examples of generating embeddings
+- [Image Generation](image_generation.md): Examples of generating images
+
+## Jupyter Notebook
+
+- [IndoxRouter Cookbook](indoxRouter_cookbook.ipynb): A comprehensive Jupyter notebook with examples of using the IndoxRouter client
+
+## Getting Started
+
+To run these examples, you'll need to:
+
+1. Install the IndoxRouter client:
+
+```bash
+pip install indoxrouter
+```
+
+2. Set your API key:
+
+```bash
+# Set environment variable
+export INDOXROUTER_API_KEY=your-api-key
+
+# Or provide it directly in your code
+from indoxrouter import Client
+client = Client(api_key="your-api-key")
+```
+
+3. Run the examples:
+
+```bash
+python -c "from indoxrouter import Client; client = Client(api_key='your_api_key'); print(client.chat([{'role': 'user', 'content': 'Hello!'}]))"
+```
+
+## Note on API Keys
+
+The IndoxRouter API key is used to authenticate with the IndoxRouter server. You don't need to provide individual API keys for each provider (like OpenAI, Anthropic, etc.) as the IndoxRouter server handles that for you.

indoxrouter-0.1.3/cookbook/chat_completion.md

@@ -0,0 +1,117 @@
+# Chat Completion Example
+
+This example demonstrates how to use the IndoxRouter client to generate chat completions from various AI providers.
+
+## Basic Chat Completion
+
+```python
+from indoxrouter import Client
+
+# Initialize client with API key
+client = Client(api_key="your_api_key")
+
+# Generate a chat completion
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="openai",
+    model="gpt-3.5-turbo",
+    temperature=0.7
+)
+
+# Print the response
+print(response["choices"][0]["message"]["content"])
+```
+
+## Streaming Chat Completion
+
+```python
+from indoxrouter import Client
+
+# Initialize client with API key
+client = Client(api_key="your_api_key")
+
+# Generate a streaming chat completion
+print("Response: ", end="", flush=True)
+for chunk in client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Write a short story about a robot learning to paint."}
+    ],
+    provider="openai",
+    model="gpt-3.5-turbo",
+    temperature=0.7,
+    stream=True
+):
+    if "choices" in chunk and len(chunk["choices"]) > 0:
+        content = chunk["choices"][0].get("delta", {}).get("content", "")
+        print(content, end="", flush=True)
+print("\n")
+```
+
+## Using Different Providers
+
+### Anthropic (Claude)
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="anthropic",
+    model="claude-3-haiku-20240307",
+    temperature=0.7
+)
+```
+
+### Mistral
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="mistral",
+    model="mistral-small",
+    temperature=0.7
+)
+```
+
+### Google (Gemini)
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    provider="google",
+    model="gemini-pro",
+    temperature=0.7
+)
+```
+
+## Error Handling
+
+```python
+from indoxrouter import Client
+from indoxrouter.exceptions import ModelNotFoundError, ProviderNotFoundError
+
+try:
+    client = Client(api_key="your_api_key")
+    response = client.chat(
+        messages=[
+            {"role": "user", "content": "Hello"}
+        ],
+        provider="nonexistent",
+        model="nonexistent-model"
+    )
+except ProviderNotFoundError as e:
+    print(f"Provider not found: {e}")
+except ModelNotFoundError as e:
+    print(f"Model not found: {e}")
+```

indoxrouter-0.1.3/cookbook/embeddings.md

@@ -0,0 +1,123 @@
+# Embeddings Example
+
+This example demonstrates how to use the IndoxRouter client to generate embeddings from various AI providers.
+
+## Basic Embeddings
+
+```python
+from indoxrouter import Client
+
+# Initialize client with API key
+client = Client(api_key="your_api_key")
+
+# Generate embeddings for a single text
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    provider="openai",
+    model="text-embedding-ada-002"
+)
+
+# Print the response
+print(f"Dimensions: {response['dimensions']}")
+print(f"Embedding (first 5 values): {response['embeddings'][0][:5]}")
+```
+
+## Batch Embeddings
+
+```python
+import numpy as np
+from indoxrouter import Client
+
+# Initialize client with API key
+client = Client(api_key="your_api_key")
+
+# Define some texts to embed
+texts = [
+    "The quick brown fox jumps over the lazy dog.",
+    "The five boxing wizards jump quickly.",
+    "How vexingly quick daft zebras jump!",
+]
+
+# Generate embeddings for multiple texts
+response = client.embeddings(
+    text=texts,
+    provider="openai",
+    model="text-embedding-ada-002"
+)
+
+# Print the response
+print(f"Number of embeddings: {len(response['embeddings'])}")
+print(f"Dimensions: {response['dimensions']}")
+
+# Calculate cosine similarity between embeddings
+embeddings = response["embeddings"]
+
+def cosine_similarity(a, b):
+    return np.dot(a, b) / (np.linalg.norm(a) * np.linalg.norm(b))
+
+for i in range(len(embeddings)):
+    for j in range(i + 1, len(embeddings)):
+        similarity = cosine_similarity(embeddings[i], embeddings[j])
+        print(f"Similarity between text {i+1} and text {j+1}: {similarity:.4f}")
+```
+
+## Using Different Providers
+
+### OpenAI
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    provider="openai",
+    model="text-embedding-ada-002"
+)
+```
+
+### Cohere
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    provider="cohere",
+    model="embed-english-v3.0"
+)
+```
+
+### Google
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    provider="google",
+    model="embedding-001"
+)
+```
+
+### Mistral
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    provider="mistral",
+    model="mistral-embed"
+)
+```
+
+## Error Handling
+
+```python
+from indoxrouter import Client
+from indoxrouter.exceptions import ModelNotFoundError, ProviderNotFoundError
+
+try:
+    client = Client(api_key="your_api_key")
+    response = client.embeddings(
+        text="This is a sample text to embed.",
+        provider="nonexistent",
+        model="nonexistent-model"
+    )
+except ProviderNotFoundError as e:
+    print(f"Provider not found: {e}")
+except ModelNotFoundError as e:
+    print(f"Model not found: {e}")
+```