README.md

Firebase Genkit <> Mistral AI Plugin

Mistral AI Community Plugin for Google Firebase Genkit

genkitx-mistral is a community plugin for using OpenAI APIs with Firebase Genkit. Built by The Fire Company. 🔥

Installation

Install the plugin in your project with your favorite package manager:

• npm install genkitx-mistral
• yarn add genkitx-mistral
• pnpm add genkitx-mistral

Usage

Initialize

import 'dotenv/config';

import { configureGenkit } from '@genkit-ai/core';
import { defineFlow, startFlowsServer } from '@genkit-ai/flow';
import { mistral } from 'genkitx-mistral';

configureGenkit({
  plugins: [
    // Mistral API key is required and defaults to the MISTRAL_API_KEY environment variable
    mistral({ apiKey: process.env.MISTRAL_API_KEY }),
  ],
  logLevel: 'debug',
  enableTracingAndMetrics: true,
});

Basic examples

The simplest way to call the text generation model is by using the helper function generate:

// Basic usage of an LLM
const response = await generate({
  model: openMixtral8x22B, // model imported from genkitx-mistral
  prompt: 'Tell me a joke.',
});

console.log(await response.text());

Within a flow

export const myFlow = defineFlow(
  {
    name: 'menuSuggestionFlow',
    inputSchema: z.string(),
    outputSchema: z.string(),
  },
  async (subject) => {
    const llmResponse = await generate({
      prompt: `Suggest an item for the menu of a ${subject} themed restaurant`,
      model: openMixtral8x22B,
    });

    return llmResponse.text();
  }
);
startFlowsServer();

Contributing

Want to contribute to the project? That's awesome! Head over to our Contribution Guidelines.

Need support?

Note

This repository depends on Google's Firebase Genkit. For issues and questions related to Genkit, please refer to instructions available in Genkit's repository.

Reach out by opening a discussion on Github Discussions.

Credits

This plugin is proudly maintained by the team at The Fire Company. 🔥

License

This project is licensed under the Apache 2.0 License.