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/

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
)

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)

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.0.tar.gz (4.6 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.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mineai-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 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.0.tar.gz
Algorithm Hash digest
SHA256 856eb54ab56d66b7dcbd4395c64db14a453c60214354f6715542f704a2f2bc0e
MD5 917dab16058475fb67bc5762e560e56f
BLAKE2b-256 8098a648f75605b7a2285840c34e5fd4f7f093359ca86163f3eb0d49245163cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mineai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68f6f83e3b1e70a4baec6bc8d5e93fc95359b6e3023a73d9ac3ffd0652ec362a
MD5 3ea0a4daf5c2d58bddee7ad0a7ed41b2
BLAKE2b-256 89551e6abe75ef6fab91f9222d52fdcf3a97bc2645b0c232b0e0d8fe704693f9

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