https://github.com/arnavk-09/mdb_dart
🎯 MindsAI SDK for Dart for efficient interaction...
https://github.com/arnavk-09/mdb_dart
api dart hacktoberfest mindsdb mindsdb-dart-sdk pub sdk
Last synced: 5 months ago
JSON representation
🎯 MindsAI SDK for Dart for efficient interaction...
- Host: GitHub
- URL: https://github.com/arnavk-09/mdb_dart
- Owner: ArnavK-09
- License: mpl-2.0
- Created: 2024-10-04T18:38:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-18T18:54:12.000Z (over 1 year ago)
- Last Synced: 2025-04-06T07:59:35.673Z (about 1 year ago)
- Topics: api, dart, hacktoberfest, mindsdb, mindsdb-dart-sdk, pub, sdk
- Language: Dart
- Homepage: https://pub.dev/documentation/mdb_dart
- Size: 394 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
🎯 Minds Dart 🎯
> [!NOTE]
>
> A powerful and intuitive **Dart SDK** for interacting with the [**Minds AI API**](https://mdb.ai). Seamlessly integrate machine learning capabilities into your Dart applications!
## 📚 Table of Contents
- [🚀 Features](#-features)
- [🎪 Installation](#-installation)
- [🏁 Getting Started](#-getting-started)
- [📘 API Reference](#-api-reference)
- [Client](#client)
- [Datasources](#datasources)
- [Minds](#minds)
- [Mind](#mind)
- [Exceptions](#exceptions)
- [🌟 Usage Examples](#-usage-examples)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
---
## 🚀 Features
- **🔐 Secure API Authentication**
Safeguard your application with cutting-edge authentication methods that ensure your connection to the Minds API remains protected and confidential. Experience peace of mind while accessing advanced AI functionalities.
- **📊 Intuitive Data Source Management**
Easily manage and configure your data sources with sdk. Add, modify, or remove data connections effortlessly, allowing your AI models to access the most relevant and up-to-date information.
- **🧠 Tailored AI Model Creation (Minds AI)**
Design bespoke AI models that suit your specific requirements. With our platform, you can create, customize, and optimize Minds that deliver personalized responses, making your applications smarter and more intuitive.
- **🔄 Effortless Minds API Integration**
Experience a hassle-free integration with the Minds API, enabling you to tap into the full spectrum of AI capabilities quickly. Connect your systems and workflows seamlessly, enhancing your application’s functionality.
- **📡 Real-time Interaction Capabilities**
Engage your users in real-time with interactive responses! Our real-time streaming support enables you to build applications that deliver immediate feedback, making conversations more dynamic and engaging.
- **📦 Modular Architecture**
Benefit from a flexible, modular architecture that allows you to extend and customize the functionality of your application easily. Add new features and capabilities as your project evolves, ensuring long-term adaptability.
## 🎪 Installation
> Add **[`mdb_dart`](https://pub.dev/packages/mdb_dart)** to your project!
###### terminal
```bash
dart pub add mdb_dart
```
## 🏁 Getting Started
Import the library and create a client:
```dart
import 'package:mdb_dart/mdb_dart.dart';
void main() async {
final client = Client('YOUR_API_KEY');
// Now you're ready to use the SDK!!!
}
```
> Checkout [`demo`](https://github.com/ArnavK-09/mdb_dart/blob/main/example%2Fmain.dart) code!
---
## 📘 API Reference
### [Client](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/client.dart#L32)
| Property | Description |
| ---------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`RestAPI api`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/client.dart#L34) | Instance for making API calls |
| [`Datasources datasources`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/client.dart#L37) | Manages data sources |
| [`Minds minds`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/client.dart#L40) | Manages minds (AI models) |
### [Datasources](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L116)
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- |
| [`list()`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L203) | List all datasources |
| [`get(String name)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L247) | Get a specific datasource |
| [`create(DatabaseConfig dsConfig, {bool replace = false})`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L169) | Create a new datasource |
| [`drop(String name)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L288) | Delete a datasource |
### [Datasource](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L57)
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`Datasource({String name, String engine, String description, Map? connectionData, List? tables})`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L57) | Creates a new `Datasource` instance with required parameters `name`, `engine`, `description`, and optional `connectionData`, `tables`. Inherits from `DatabaseConfig`. |
| [`fromJson(Map json)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L102) | Creates a new `Datasource` instance from a JSON map. Inherited fields include `name`, `engine`, `description`, `connectionData`, and `tables`. |
| [`toJson()`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/datasources.dart#L42) | Converts the `Datasource` instance into a JSON-compatible map. Inherited from `DatabaseConfig`. |
### [Minds](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L408)
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| [`list()`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L435) | List all minds (AI models) |
| [`get(String name)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L468) | Get a specific mind (AI model) |
| [`create({required String name, modelName, provider, promptTemplate, datasources})`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L519) | Create a new mind |
| [`drop(String name)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L583) | Delete a mind |
### [Mind](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L37)
| Method | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [`update({String? name, modelName, provider, promptTemplate, datasources, parameters})`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L101) | Updates the properties of the mind. |
| [`addDatasource(dynamic datasource)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L161) | Adds a new datasource to the mind. |
| [`delDatasource(dynamic datasource)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L195) | Deletes a specific datasource from the mind. |
| [`completion(String message)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L238) | Sends a chat message to the Mind API and retrieves a completion response. |
| [`streamCompletion(String message)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L286) | Streams chat completions from the Mind API based on a user's message. |
| [`fromJson(Client client, Map json)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L384) | Creates a new instance of Mind from a JSON map. |
| [`toJson()`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/minds.dart#L337) | Converts the Mind instance into a JSON map. |
### Exceptions
| Exception | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [`ObjectNotFound([String message = 'Object not found.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L4) | Thrown when a requested object cannot be found. |
| [`ObjectAlreadyExists([String message = 'Object already exists.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L15) | Thrown when trying to create an object that already exists. |
| [`ObjectNotSupported([String message = 'Object not supported.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L26) | Thrown when an unsupported operation is attempted. |
| [`Forbidden([String message = 'Access forbidden.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L37) | Thrown when access is forbidden. |
| [`Unauthorized([String message = 'Unauthorized access.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L48) | Thrown when access is unauthorized. |
| [`UnknownError([String message = 'An unknown error occurred.'])`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L59) | Thrown for unspecified errors. |
| [`ValueError(String message)`](https://github.com/ArnavK-09/mdb_dart/blob/main/lib/src/exceptions.dart#L70) | Thrown when a value is invalid or out of range. |
---
## 🌟 Usage Examples
### 💿 Managing `Datasources`
> #### List Datasources
```dart
List datasources = await client.datasources.list();
for (var ds in datasources) {
print('Datasource: ${ds.name}');
}
```
> #### Create a Datasource
```dart
final newDatasource = await client.datasources.create(
DatabaseConfig(
name: 'my_postgres_db',
engine: 'postgres',
description: 'My PostgreSQL Database',
connectionData: {
'host': 'localhost',
'port': 5432,
'user': 'username',
'password': 'password',
'database': 'mydb',
},
)
);
print('Created datasource: ${newDatasource.name}');
```
> #### Get a Datasource
```dart
Datasource datasource = await client.datasources.get('my_postgres_db');
print('Datasource engine: ${datasource.engine}');
```
> #### Delete a Datasource
```dart
await client.datasources.drop('my_postgres_db');
print('Datasource deleted successfully');
```
### 🧠 Managing `Minds`
> #### List Minds
```dart
List minds = await client.minds.list();
for (var mind in minds) {
print('Mind: ${mind.name}');
}
```
> #### Create a Mind
```dart
final newMind = await client.minds.create(
name: 'my_predictor',
modelName: 'gpt-4o',
provider: 'openai',
promptTemplate: 'Predict the next value: {{input}}',
datasources: ['my_postgres_db'],
);
print('Created mind: ${newMind.name}');
```
> #### Get a Mind
```dart
Mind mind = await client.minds.get('my_predictor');
print('Mind model: ${mind.modelName}');
```
> #### Delete a Mind
```dart
await client.minds.drop('my_predictor');
print('Mind deleted successfully');
```
> #### Using a Mind for Predictions
```dart
Mind mind = await client.minds.get('my_predictor');
final completion = await mind.completion('What will be the stock price tomorrow?');
print('Prediction: ${completion.choices.first.message.content?.first.text}');
```
> #### Streaming Completions
```dart
Mind mind = await client.minds.get('my_predictor');
final stream = await mind.streamCompletion('Explain quantum computing');
await for (var chunk in stream) {
print('Chunk: ${chunk.choices.first.delta.content?.first?.text}');
}
```
---
📹 Contributing
We welcome contributions to improve and expand the Minds AI Dart SDK!
To get started with contributing, please follow the guidelines outlined in our CONTRIBUTING file.
📄 License
This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.
---
If you find this project helpful, please give it a ⭐ on GitHub!
---
> [!WARNING]
>
> _This repository is heavily influenced by the [minds_python_sdk](https://github.com/mindsdb/minds_python_sdk) and mirrors its structure and functionality._