indoxrouter 0.1.3__tar.gz → 0.1.4__tar.gz

{indoxrouter-0.1.3 → indoxrouter-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: indoxrouter
-Version: 0.1.3
+Version: 0.1.4
 Summary: A unified client for various AI providers
 Home-page: https://github.com/indoxrouter/indoxrouter
 Author: indoxRouter Team
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: requests>=2.25.0
@@ -37,7 +38,7 @@ Dynamic: summary
 
 # IndoxRouter Client
 
-A unified client for various AI providers, including OpenAI, Anthropic, Cohere, Google, and Mistral.
+A unified client for various AI providers, including OpenAI, Anthropic, Google, and Mistral.
 
 ## Features
 
@@ -59,19 +60,26 @@ pip install indoxrouter
 ```python
 from indoxrouter import Client
 
-# Initialize with API key
-client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+# Initialize with API key (default connects to localhost:8000)
+client = Client(api_key="your_api_key")
 
-# Or initialize with username and password
+# Or specify a custom server URL
 client = Client(
-    username="your_username",
-    password="your_password",
+    api_key="your_api_key",
     base_url="http://your-server-url:8000"
 )
 
+# Connect to Docker container inside the Docker network
+client = Client(
+    api_key="your_api_key",
+    base_url="http://indoxrouter-server:8000"
+)
+
 # Using environment variables
-# Set INDOXROUTER_API_KEY or INDOXROUTER_USERNAME and INDOXROUTER_PASSWORD
-client = Client(base_url="http://your-server-url:8000")
+# Set INDOX_ROUTER_API_KEY environment variable
+import os
+os.environ["INDOX_ROUTER_API_KEY"] = "your_api_key"
+client = Client()
 ```
 
 ### Chat Completions
@@ -82,8 +90,7 @@ response = client.chat(
         {"role": "system", "content": "You are a helpful assistant."},
         {"role": "user", "content": "Tell me a joke."}
     ],
-    provider="openai",
-    model="gpt-3.5-turbo",
+    model="openai/gpt-4o-mini",  # Provider/model format
     temperature=0.7
 )
 
@@ -95,8 +102,7 @@ print(response["choices"][0]["message"]["content"])
 ```python
 response = client.completion(
     prompt="Once upon a time,",
-    provider="openai",
-    model="gpt-3.5-turbo-instruct",
+    model="openai/gpt-4o-mini",
     max_tokens=100
 )
 
@@ -108,12 +114,11 @@ print(response["choices"][0]["text"])
 ```python
 response = client.embeddings(
     text=["Hello world", "AI is amazing"],
-    provider="openai",
-    model="text-embedding-ada-002"
+    model="openai/text-embedding-3-small"
 )
 
-print(f"Dimensions: {response['dimensions']}")
-print(f"First embedding: {response['embeddings'][0][:5]}...")
+print(f"Dimensions: {len(response['data'][0]['embedding'])}")
+print(f"First embedding: {response['data'][0]['embedding'][:5]}...")
 ```
 
 ### Image Generation
@@ -121,12 +126,11 @@ print(f"First embedding: {response['embeddings'][0][:5]}...")
 ```python
 response = client.images(
     prompt="A serene landscape with mountains and a lake",
-    provider="openai",
-    model="dall-e-3",
+    model="openai/dall-e-3",
     size="1024x1024"
 )
 
-print(f"Image URL: {response['images'][0]['url']}")
+print(f"Image URL: {response['data'][0]['url']}")
 ```
 
 ### Streaming Responses
@@ -134,9 +138,10 @@ print(f"Image URL: {response['images'][0]['url']}")
 ```python
 for chunk in client.chat(
     messages=[{"role": "user", "content": "Write a short story."}],
+    model="openai/gpt-4o-mini",
     stream=True
 ):
-    if "choices" in chunk and len(chunk["choices"]) > 0:
+    if chunk.get("choices") and len(chunk["choices"]) > 0:
         content = chunk["choices"][0].get("delta", {}).get("content", "")
         print(content, end="", flush=True)
 ```
@@ -149,7 +154,7 @@ providers = client.models()
 for provider in providers:
     print(f"Provider: {provider['name']}")
     for model in provider["models"]:
-        print(f"  - {model['id']}: {model['name']}")
+        print(f"  - {model['id']}: {model['description'] or ''}")
 
 # Get models for a specific provider
 openai_provider = client.models("openai")
@@ -162,11 +167,10 @@ print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
 from indoxrouter import Client, ModelNotFoundError, ProviderError
 
 try:
-    client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+    client = Client(api_key="your_api_key")
     response = client.chat(
         messages=[{"role": "user", "content": "Hello"}],
-        provider="nonexistent",
-        model="nonexistent-model"
+        model="nonexistent-provider/nonexistent-model"
     )
 except ModelNotFoundError as e:
     print(f"Model not found: {e}")
@@ -177,8 +181,11 @@ except ProviderError as 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!"}])
+with Client(api_key="your_api_key") as client:
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello!"}],
+        model="openai/gpt-4o-mini"
+    )
     print(response["choices"][0]["message"]["content"])
 # Client is automatically closed when exiting the block
 ```

{indoxrouter-0.1.3 → indoxrouter-0.1.4}/README.md

@@ -1,6 +1,6 @@
 # IndoxRouter Client
 
-A unified client for various AI providers, including OpenAI, Anthropic, Cohere, Google, and Mistral.
+A unified client for various AI providers, including OpenAI, Anthropic, Google, and Mistral.
 
 ## Features
 
@@ -22,19 +22,26 @@ pip install indoxrouter
 ```python
 from indoxrouter import Client
 
-# Initialize with API key
-client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+# Initialize with API key (default connects to localhost:8000)
+client = Client(api_key="your_api_key")
 
-# Or initialize with username and password
+# Or specify a custom server URL
 client = Client(
-    username="your_username",
-    password="your_password",
+    api_key="your_api_key",
     base_url="http://your-server-url:8000"
 )
 
+# Connect to Docker container inside the Docker network
+client = Client(
+    api_key="your_api_key",
+    base_url="http://indoxrouter-server:8000"
+)
+
 # Using environment variables
-# Set INDOXROUTER_API_KEY or INDOXROUTER_USERNAME and INDOXROUTER_PASSWORD
-client = Client(base_url="http://your-server-url:8000")
+# Set INDOX_ROUTER_API_KEY environment variable
+import os
+os.environ["INDOX_ROUTER_API_KEY"] = "your_api_key"
+client = Client()
 ```
 
 ### Chat Completions
@@ -45,8 +52,7 @@ response = client.chat(
         {"role": "system", "content": "You are a helpful assistant."},
         {"role": "user", "content": "Tell me a joke."}
     ],
-    provider="openai",
-    model="gpt-3.5-turbo",
+    model="openai/gpt-4o-mini",  # Provider/model format
     temperature=0.7
 )
 
@@ -58,8 +64,7 @@ print(response["choices"][0]["message"]["content"])
 ```python
 response = client.completion(
     prompt="Once upon a time,",
-    provider="openai",
-    model="gpt-3.5-turbo-instruct",
+    model="openai/gpt-4o-mini",
     max_tokens=100
 )
 
@@ -71,12 +76,11 @@ print(response["choices"][0]["text"])
 ```python
 response = client.embeddings(
     text=["Hello world", "AI is amazing"],
-    provider="openai",
-    model="text-embedding-ada-002"
+    model="openai/text-embedding-3-small"
 )
 
-print(f"Dimensions: {response['dimensions']}")
-print(f"First embedding: {response['embeddings'][0][:5]}...")
+print(f"Dimensions: {len(response['data'][0]['embedding'])}")
+print(f"First embedding: {response['data'][0]['embedding'][:5]}...")
 ```
 
 ### Image Generation
@@ -84,12 +88,11 @@ print(f"First embedding: {response['embeddings'][0][:5]}...")
 ```python
 response = client.images(
     prompt="A serene landscape with mountains and a lake",
-    provider="openai",
-    model="dall-e-3",
+    model="openai/dall-e-3",
     size="1024x1024"
 )
 
-print(f"Image URL: {response['images'][0]['url']}")
+print(f"Image URL: {response['data'][0]['url']}")
 ```
 
 ### Streaming Responses
@@ -97,9 +100,10 @@ print(f"Image URL: {response['images'][0]['url']}")
 ```python
 for chunk in client.chat(
     messages=[{"role": "user", "content": "Write a short story."}],
+    model="openai/gpt-4o-mini",
     stream=True
 ):
-    if "choices" in chunk and len(chunk["choices"]) > 0:
+    if chunk.get("choices") and len(chunk["choices"]) > 0:
         content = chunk["choices"][0].get("delta", {}).get("content", "")
         print(content, end="", flush=True)
 ```
@@ -112,7 +116,7 @@ providers = client.models()
 for provider in providers:
     print(f"Provider: {provider['name']}")
     for model in provider["models"]:
-        print(f"  - {model['id']}: {model['name']}")
+        print(f"  - {model['id']}: {model['description'] or ''}")
 
 # Get models for a specific provider
 openai_provider = client.models("openai")
@@ -125,11 +129,10 @@ print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
 from indoxrouter import Client, ModelNotFoundError, ProviderError
 
 try:
-    client = Client(api_key="your_api_key", base_url="http://your-server-url:8000")
+    client = Client(api_key="your_api_key")
     response = client.chat(
         messages=[{"role": "user", "content": "Hello"}],
-        provider="nonexistent",
-        model="nonexistent-model"
+        model="nonexistent-provider/nonexistent-model"
     )
 except ModelNotFoundError as e:
     print(f"Model not found: {e}")
@@ -140,8 +143,11 @@ except ProviderError as 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!"}])
+with Client(api_key="your_api_key") as client:
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello!"}],
+        model="openai/gpt-4o-mini"
+    )
     print(response["choices"][0]["message"]["content"])
 # Client is automatically closed when exiting the block
 ```

{indoxrouter-0.1.3 → indoxrouter-0.1.4}/cookbook/indoxRouter_cookbook.ipynb

@@ -16,7 +16,7 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 1,
+      "execution_count": null,
       "id": "e03bc1cc",
       "metadata": {},
       "outputs": [],
@@ -30,7 +30,7 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 2,
+      "execution_count": null,
       "metadata": {},
       "outputs": [],
       "source": [
@@ -38,7 +38,9 @@
         "# !pip install indoxrouter\n",
         "\n",
         "# Import the client and exceptions\n",
-        "from indoxRouter_client import Client"
+        "from indoxRouter import Client\n",
+        "\n",
+        "from pprint import pprint"
       ]
     },
     {
@@ -51,19 +53,12 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 3,
+      "execution_count": null,
       "metadata": {},
       "outputs": [],
       "source": [
         "# Initialize with API key\n",
-        "client = Client(api_key=\"indox_iCifK9DShPRcFW0RbWuMb6vPzwDEtQz2YkU40uu_DDY\")\n",
-        "\n",
-        "# Or use environment variable\n",
-        "# export INDOX_ROUTER_API_KEY=your_api_key\n",
-        "# client = Client()\n",
-        "\n",
-        "# You can also set a custom timeout\n",
-        "# client = Client(api_key=\"your_api_key\", timeout=30)  # 30 seconds timeout"
+        "client = Client(api_key=\"indox_4mfg24GRj_qGaZ2-qXw-mXYqaNqMkyGkG1lncGUrRkA\")"
       ]
     },
     {
@@ -82,49 +77,32 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 4,
-      "metadata": {},
-      "outputs": [
-        {
-          "name": "stdout",
-          "output_type": "stream",
-          "text": [
-            "Response: The capital of France is Paris.\n",
-            "Cost: 0.0032\n",
-            "Tokens used: 32\n"
-          ]
-        }
-      ],
+      "execution_count": null,
+      "id": "82ec17da",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "client.get_model_info(provider=\"openai\",model=\"gpt-4o-mini\")"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
       "source": [
+        "\n",
         "response = client.chat(\n",
         "    messages=[\n",
         "        {\"role\": \"system\", \"content\": \"You are a helpful assistant.\"},\n",
         "        {\"role\": \"user\", \"content\": \"What is the capital of France?\"}\n",
         "    ],\n",
-        "    model=\"openai/gpt-4o-mini\"\n",
+        "    model=\"openai/gpt-4o-mini\"  \n",
         ")\n",
         "\n",
         "print(\"Response:\", response[\"data\"])\n",
-        "print(\"Cost:\", response[\"usage\"][\"cost\"])\n",
-        "print(\"Tokens used:\", response[\"usage\"][\"tokens_total\"])"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": 5,
-      "id": "fb681be0",
-      "metadata": {},
-      "outputs": [
-        {
-          "name": "stdout",
-          "output_type": "stream",
-          "text": [
-            "{'request_id': '8f7a1a49-2df2-4716-b5d8-621dfbaaaad1', 'created_at': '2025-04-05T17:31:53.680969', 'duration_ms': 4284.862756729126, 'provider': 'openai', 'model': 'openai/gpt-4o-mini', 'success': True, 'message': '', 'usage': {'tokens_prompt': 24, 'tokens_completion': 8, 'tokens_total': 32, 'cost': 0.0032, 'latency': 2.7800915241241455, 'timestamp': '2025-04-05T17:31:53.541938'}, 'raw_response': None, 'data': 'The capital of France is Paris.', 'finish_reason': None}\n"
-          ]
-        }
-      ],
-      "source": [
-        "print(response)"
+        "print(\"Tokens:\", response[\"usage\"][\"tokens_total\"])\n",
+        "\n"
       ]
     },
     {
@@ -150,7 +128,28 @@
         "        {\"role\": \"system\", \"content\": \"You are a helpful assistant.\"},\n",
         "        {\"role\": \"user\", \"content\": \"Write a short poem about AI.\"}\n",
         "    ],\n",
-        "    model=\"anthropic/claude-3-haiku\",\n",
+        "    model=\"mistral/mistral-large-latest\",\n",
+        "    temperature=0.8,\n",
+        "    max_tokens=500\n",
+        ")\n",
+        "\n",
+        "print(\"Response:\", response[\"data\"])\n",
+        "print(\"Cost:\", response[\"usage\"][\"cost\"])"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "d530c4ed",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "response = client.chat(\n",
+        "    messages=[\n",
+        "        {\"role\": \"system\", \"content\": \"You are a helpful assistant.\"},\n",
+        "        {\"role\": \"user\", \"content\": \"Write a short poem about AI.\"}\n",
+        "    ],\n",
+        "    model=\"deepseek/deepseek-chat\",\n",
         "    temperature=0.8,\n",
         "    max_tokens=500\n",
         ")\n",
@@ -177,11 +176,13 @@
       "metadata": {},
       "outputs": [],
       "source": [
+        "# Initialize conversation with system prompt and first user message\n",
         "conversation = [\n",
-        "    {\"role\": \"system\", \"content\": \"You are a helpful assistant.\"},\n",
-        "    {\"role\": \"user\", \"content\": \"Hello, how are you?\"}\n",
+        "    {\"role\": \"system\", \"content\": \"You are a helpful assistant with expertise in programming.\"},\n",
+        "    {\"role\": \"user\", \"content\": \"Hello, I'm learning about APIs. Can you help me?\"}\n",
         "]\n",
         "\n",
+        "# Get first response from the model\n",
         "response = client.chat(\n",
         "    messages=conversation,\n",
         "    model=\"openai/gpt-4o-mini\"\n",
@@ -189,16 +190,41 @@
         "\n",
         "# Add the assistant's response to the conversation\n",
         "conversation.append({\"role\": \"assistant\", \"content\": response[\"data\"]})\n",
+        "print(f\"Response 1: {response['data'][:50]}...\")  # Print preview of response\n",
         "\n",
-        "# Continue the conversation\n",
-        "conversation.append({\"role\": \"user\", \"content\": \"Tell me a joke about programming.\"})\n",
+        "# Second turn - asking a specific question\n",
+        "conversation.append({\"role\": \"user\", \"content\": \"What's the difference between REST and GraphQL APIs?\"})\n",
         "\n",
+        "# Get second response\n",
         "response = client.chat(\n",
         "    messages=conversation,\n",
         "    model=\"openai/gpt-4o-mini\"\n",
         ")\n",
+        "conversation.append({\"role\": \"assistant\", \"content\": response[\"data\"]})\n",
+        "print(f\"Response 2: {response['data'][:50]}...\")\n",
         "\n",
-        "print(\"Response:\", response[\"data\"])"
+        "# Third turn - follow-up question to test context retention\n",
+        "conversation.append({\"role\": \"user\", \"content\": \"Can you give me a simple example of each?\"})\n",
+        "\n",
+        "# Get third response\n",
+        "response = client.chat(\n",
+        "    messages=conversation,\n",
+        "    model=\"openai/gpt-4o-mini\"\n",
+        ")\n",
+        "conversation.append({\"role\": \"assistant\", \"content\": response[\"data\"]})\n",
+        "print(f\"Response 3: {response['data'][:50]}...\")\n",
+        "\n",
+        "# Fourth turn - testing memory of previous discussion\n",
+        "conversation.append({\"role\": \"user\", \"content\": \"Which one would you recommend for a beginner building a small blog site?\"})\n",
+        "\n",
+        "# Get fourth response\n",
+        "response = client.chat(\n",
+        "    messages=conversation,\n",
+        "    model=\"openai/gpt-4o-mini\"\n",
+        ")\n",
+        "print(f\"Response 4: {response['data'][:50]}...\")\n",
+        "\n",
+        "pprint(conversation)"
       ]
     },
     {
@@ -224,7 +250,7 @@
         "    messages=[\n",
         "        {\"role\": \"user\", \"content\": \"Tell me a story about a robot in 5 sentences.\"}\n",
         "    ],\n",
-        "    model=\"openai/gpt-4o-mini\",\n",
+        "    model=\"mistral/mistral-large-latest\",\n",
         "    stream=True\n",
         "):\n",
         "    if isinstance(chunk, dict) and \"data\" in chunk:\n",
@@ -315,6 +341,22 @@
         "print(\"Cost:\", response[\"usage\"][\"cost\"])"
       ]
     },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "17b3ca0a",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "response = client.completion(\n",
+        "    prompt=\"Once upon a time\",\n",
+        "    model=\"deepseek/deepseek-chat\",\n",
+        ")\n",
+        "\n",
+        "print(\"Response:\", response[\"data\"])\n",
+        "print(\"Cost:\", response[\"usage\"][\"cost\"])"
+      ]
+    },
     {
       "cell_type": "markdown",
       "metadata": {},
@@ -335,7 +377,7 @@
       "source": [
         "response = client.completion(\n",
         "    prompt=\"Write a recipe for chocolate cake\",\n",
-        "    model=\"anthropic/claude-3-haiku\",\n",
+        "    model=\"mistral/mistral-large-latest\",\n",
         "    temperature=0.7,\n",
         "    max_tokens=1000\n",
         ")\n",
@@ -364,7 +406,7 @@
         "print(\"Streaming response:\")\n",
         "for chunk in client.completion(\n",
         "    prompt=\"Explain quantum computing in simple terms\",\n",
-        "    model=\"openai/gpt-4o-mini\",\n",
+        "    model=\"mistral/mistral-large-latest\",\n",
         "    stream=True\n",
         "):\n",
         "    if isinstance(chunk, dict) and \"data\" in chunk:\n",
@@ -390,18 +432,9 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 4,
-      "metadata": {},
-      "outputs": [
-        {
-          "name": "stdout",
-          "output_type": "stream",
-          "text": [
-            "Embedding dimensions: 1536\n",
-            "First 5 values: [-0.019193023443222046, -0.025299284607172012, -0.0016930076526477933, 0.018802976235747337, -0.03383997827768326]\n"
-          ]
-        }
-      ],
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
       "source": [
         "response = client.embeddings(\n",
         "    text=\"Hello, world!\",  \n",
@@ -432,12 +465,11 @@
       "source": [
         "response = client.embeddings(\n",
         "    text=[\"Hello, world!\", \"How are you?\", \"IndoxRouter is awesome!\"],\n",
-        "    model=\"openai/text-embedding-ada-002\"\n",
+        "    model=\"openai/text-embedding-3-small\"\n",
         ")\n",
         "\n",
         "print(\"Number of embeddings:\", len(response[\"data\"]))\n",
-        "print(\"Dimensions of each embedding:\", len(response[\"data\"][0]))\n",
-        "print(\"Cost:\", response[\"usage\"][\"cost\"])"
+        "print(\"Dimensions of each embedding:\", len(response[\"data\"][0]))"
       ]
     },
     {
@@ -461,11 +493,11 @@
         "# Cohere embeddings\n",
         "response = client.embeddings(\n",
         "    text=\"Hello, world!\",\n",
-        "    model=\"cohere/embed-english-v3.0\"\n",
+        "    model=\"mistral-embed\"\n",
         ")\n",
         "\n",
-        "print(\"Cohere embedding dimensions:\", len(response[\"data\"][0]))\n",
-        "print(\"Cost:\", response[\"usage\"][\"cost\"])"
+        "print(\"Mistral embedding dimensions:\", len(response[\"data\"][0]))\n",
+        "print(\"First 5 values:\", response[\"data\"][0][:5])\n"
       ]
     },
     {
@@ -592,7 +624,7 @@
         "models = client.models()\n",
         "\n",
         "print(\"Available providers:\")\n",
-        "for provider in models[\"providers\"]:\n",
+        "for provider in models:\n",
         "    print(f\"- {provider['name']} ({provider['id']})\")\n",
         "    print(f\"  Capabilities: {', '.join(provider['capabilities'])}\")\n",
         "    print(f\"  Models: {len(provider['models'])}\")"
@@ -1122,7 +1154,7 @@
       "outputs": [],
       "source": [
         "# First few characters of the API key (for security)\n",
-        "   print(f\"API key starts with: {client.api_key[:5]}...\")"
+        "print(f\"API key starts with: {client.api_key[:5]}...\")"
       ]
     },
     {
@@ -1149,7 +1181,7 @@
       "outputs": [],
       "source": [
         "connection_info = client.test_connection()\n",
-        "   print(f\"Connection status: {connection_info}\")"
+        "print(f\"Connection status: {connection_info}\")"
       ]
     },
     {
@@ -1178,7 +1210,7 @@
         "try:\n",
         "      usage = client.get_usage()\n",
         "      print(f\"Remaining credits: ${usage['remaining_credits']}\")\n",
-        "   except Exception as e:\n",
+        "except Exception as e:\n",
         "      print(f\"Error getting usage: {e}\")"
       ]
     },