Skip to main content

The official Python SDK for MineAI

Project description

MineAI Python SDK

The official Python SDK from MineAI-Studio.

Powered by http://getmineai.site/

Fixes:

  • Memory
  • Error Handling
  • Fix Rate Limit Error
  • Fix Authentication Error
  • Fix Generations Errors

Integrations:

Installation

pip install mineai

Quick Start

Sync Client

from mineai import MineAI, Models

client = MineAI(api_key="YOUR_API_KEY")

response = client.chat.completions.create(
    model=Models.R3_RT_Y,
    messages=[
        {"role": "user", "content": "Hello MineAI!"}
    ]
)

print(response['choices'][0]['message']['content'])

Async Client

import asyncio
from mineai import AsyncMineAI, Models

async def main():
    client = AsyncMineAI(api_key="YOUR_API_KEY")
    
    response = await client.chat.completions.create(
        model=Models.R3_RT_Z,
        messages=[
            {"role": "user", "content": "Tell me a joke."}
        ]
    )
    print(response['choices'][0]['message']['content'])

asyncio.run(main())

Streaming

from mineai import MineAI, Models

client = MineAI(api_key="YOUR_API_KEY")

stream = client.chat.completions.create(
    model=Models.O1_FREE,
    messages=[
        {"role": "user", "content": "Write a long story."}
    ],
    stream=True
)

for chunk in stream:
    if 'choices' in chunk:
        content = chunk['choices'][0].get('delta', {}).get('content', '')
        print(content, end='', flush=True)

Memory Support

from mineai import MineAI, Models

client = MineAI(api_key="YOUR_API_KEY")

# Enable database-backed memory
response = client.chat.completions.create(
    model=Models.R3_RT_Y,
    messages=[
        {"role": "user", "content": "My name is John."}
    ],
    memory=True
)
    memory=True
)

Using Parameters [NEW]

You can customize the response using temperature, max_tokens, and retry_on_failure.

response = client.chat.completions.create(
    model=Models.R3_RT_Y,
    messages=[{"role": "user", "content": "Write a poem."}],
    temperature=0.9,
    max_tokens=50,
    retry_on_failure=True
)

[!IMPORTANT] Limitation: The mine:o1-free model does NOT support memory or retry_on_failure features. These are restricted to paid models.

Error Handling

The SDK provides custom exception classes for different API error scenarios:

from mineai import MineAI, AuthenticationError, RateLimitError

try:
    client = MineAI(api_key="INVALID_KEY")
    client.chat.completions.create(...)
except AuthenticationError:
    print("Invalid API key provided.")
except RateLimitError:
    print("Rate limit exceeded.")

Supported Models

  • Models.R3_RT_Y (mine:r3-rt-y)
  • Models.R3_RT_Z (mine:r3-rt-z)
  • Models.O1_FREE (mine:o1-free)

Issues

  • Older Version Might Trigger Errrors
  • Use The Latest Version of SDK ( Recommended: 0.1.5 )

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

mineai-0.1.6.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

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

mineai-0.1.6-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file mineai-0.1.6.tar.gz.

File metadata

  • Download URL: mineai-0.1.6.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for mineai-0.1.6.tar.gz
Algorithm Hash digest
SHA256 8c8ac0d0fa56d6780e949f186619a88c32d1ee3d86844ab60a1d12f8368ff9ae
MD5 6b02023577e04af0c16fb1bc7d1aa85c
BLAKE2b-256 ec6ee8238dfe484b5f0874e8653b12cecdfec8d8f6a7ca0fbb89454fef08517e

See more details on using hashes here.

File details

Details for the file mineai-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: mineai-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for mineai-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 87fc211890622f3e99387f7632ba5539a8512bcfc27082c6838c6a2bc307c099
MD5 7141dc7337e4b8f43383e1270255ea57
BLAKE2b-256 a51aed241d6a65314b9c123fec18f0b8fe0f754c274d5807b638e49058f3aa81

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