Mistral AI client for Dart

.github/workflows/check.yaml style: very good analysis

Description

This is an unofficial Dart/Flutter client for the Mistral AI API.

The implementation is inspired by the official Mistral AI JS client.

Flutter Flow

For Flutter Flow integration please use the mistralai_client_dart_flutter_flow package.

It's a version of this package that is adapted to work with Flutter Flow.

Installation

dart pub add mistralai_client_dart

Usage

Create client

import 'package:mistralai_client_dart/mistralai_client_dart.dart';

final client = MistralAIClient(apiKey: 'your api key here');

List models

final modelsResult = await client.listModels();
final models = modelsResult.data.map((e) => e.id).toList();
print(models.join(', '));

Chat

final params = ChatParams(
  model: 'mistral-small-latest',
  messages: const [
    ChatMessage(role: 'user', content: 'Hello chat!'),
  ],
);
final chatCompletion = await client.chat(params);
final chatMessage = chatCompletion.choices[0].message;
print(chatMessage);

Chat stream

final stream = client.streamChat(params);
await for (final completionChunk in stream) {
  final chatMessage = completionChunk.choices[0].delta?.content;
  if (chatMessage != null) {
    print(chatMessage);
  }
}

Embeddings

final embeddings = await client.embeddings(
  const EmbeddingParams(
    model: 'mistral-embed',
    input: ['Hello chat!'],
  ),
);
for (final data in embeddings.data) {
  print(data.embedding);
}

Function calling

String retrievePaymentStatus(Map<String, String> data, String transactionId) =>
    '{"status": ${data[transactionId]}}';

final namesToFunctions = {
  'retrievePaymentStatus': (String transactionId) =>
      retrievePaymentStatus(paymentStatusData, transactionId),
};

final tools = [
  const ToolsFunction(
    name: 'retrievePaymentStatus',
    description: 'Get payment status of a transaction',
    parameters: [
      ToolsFunctionParameter(
        name: 'transactionId',
        type: 'string',
        description: 'The transaction ID',
        isRequired: true,
      ),
    ],
  ).toChatParamsFormat(),
];

var chatResponse = await client.chat(
    ChatParams(
        model: 'mistral-large-latest',
        messages: messages,
        tools: tools,
        toolChoice: 'auto',
    ),
);

final toolCall = chatResponse.choices[0].message.toolCalls?[0];
if (toolCall != null && toolCall.type == 'function') {
  final functionName = toolCall.function!.name;
  final functionParams = toolCall.function!.argumentsMap;

  print('calling functionName: $functionName');
  print('functionParams: $functionParams');

  final functionResult = namesToFunctions[functionName]!(
      functionParams['transactionId']! as String,
  );

  messages.add(
    ChatMessage(
      role: 'tool',
      content: functionResult,
      name: functionName,
      toolCallId: toolCall.id,
    ),
  );

  chatResponse = await client.chat(
      ChatParams(
          model: model,
          messages: messages,
          tools: tools,
          toolChoice: 'auto',
      ),
  );

  print(chatResponse.choices[0].message.content);
}

Files

Check examples:

Fine-tuning Jobs

Check examples:

Fill in the middle completion

Check examples:

Resources

You can check the official Mistral AI docs.

Contributing

For contributing guide please see CONTRIBUTING.md.

Libraries

mistralai_client_dart