Mscc.GenerativeAI 0.8.0

Gemini AI Client for .NET and ASP.NET Core

Access the Gemini API in Google AI Studio and Google Cloud Vertex AI.

Client for .NET:

Client for ASP.NET Core:

Read more about Mscc.GenerativeAI.Web and how to add it to your ASP.NET web applications.

Client for .NET using Google API Client Library:

Read more about Mscc.GenerativeAI.Google and how to add it to your .NET applications.

Install the package 🖥️

Install the package Mscc.GenerativeAI from NuGet. You can install the package from the command line using either the command line or the NuGet Package Manager Console. Or you add it directly to your .NET project.

Add the package using the dotnet command line tool in your .NET project folder.

> dotnet add package Mscc.GenerativeAI

Working with Visual Studio use the NuGet Package Manager to install the package Mscc.GenerativeAI.

PM> Install-Package Mscc.GenerativeAI

Alternatively, add the following line to your .csproj file.

  <ItemGroup>
    <PackageReference Include="Mscc.GenerativeAI" Version="0.7.1" />
  </ItemGroup>

You can then add this code to your sources whenever you need to access any Gemini API provided by Google. This package works for Google AI (Google AI Studio) and Google Cloud Vertex AI.

Authentication use cases 👥

The package supports the following use cases to authenticate.

• Google AI: Authentication with an API key
• Google AI: Authentication with OAuth
• Vertex AI: Authentication with Application Default Credentials (ADC)
• Vertex AI: Authentication with OAuth (using Mscc.GenerativeAI.Google)
• Vertex AI: Authentication with Service Account (using Mscc.GenerativeAI.Google)

This applies mainly to the instantiation procedure.

Getting Started 🚀

Use of Gemini API in either Google AI or Vertex AI is almost identical. The major difference is the way to instantiate the model handling your prompt.

Using Environment variables

In the cloud most settings are configured via environment variables (EnvVars). The ease of configuration, their wide spread support and the simplicity of environment variables makes them a very interesting option.

Using any environment variable provides a simplified access to a model.

using Mscc.GenerativeAI;

var model = new GenerativeModel();

Choose an API and authentication mode

Google AI with an API key

using Mscc.GenerativeAI;
// Google AI with an API key
var model = new GenerativeModel(apiKey: "your API key", model: Model.GeminiPro);

Google AI with OAuth. Use gcloud auth application-default print-access-token to get the access token.

using Mscc.GenerativeAI;
// Google AI with OAuth. Use `gcloud auth application-default print-access-token` to get the access token.
var model = new GenerativeModel(model: Model.GeminiPro);
model.AccessToken = accessToken;

Vertex AI with OAuth. Use gcloud auth application-default print-access-token to get the access token.

using Mscc.GenerativeAI;
// Vertex AI with OAuth. Use `gcloud auth application-default print-access-token` to get the access token.
var vertex = new VertexAI(projectId: projectId, region: region);
var model = vertex.GenerativeModel(model: Model.Gemini10Pro);
model.AccessToken = accessToken;

The ConfigurationFixture type in the test project implements multiple options to retrieve sensitive information, ie. API key or access token.

Using Google AI Gemini API

Working with Google AI in your application requires an API key. Get an API key from Google AI Studio.

using Mscc.GenerativeAI;

var apiKey = "your_api_key";
var prompt = "Write a story about a magic backpack.";

var model = new GenerativeModel(apiKey: apiKey, model: Model.GeminiPro);

var response = model.GenerateContent(prompt).Result;
Console.WriteLine(response.Text);

Using Vertex AI Gemini API

Use of Vertex AI requires an account on Google Cloud, a project with billing and Vertex AI API enabled.

using Mscc.GenerativeAI;

var projectId = "your_google_project_id"; // the ID of a project, not its name.
var region = "us-central1";     // see documentation for available regions.
var accessToken = "your_access_token";      // use `gcloud auth application-default print-access-token` to get it.
var prompt = "Write a story about a magic backpack.";

var vertex = new VertexAI(projectId: projectId, region: region);
var model = vertex.GenerativeModel(model: Model.GeminiPro);
model.AccessToken = accessToken;

var response = model.GenerateContent(prompt).Result;
Console.WriteLine(response.Text);

More examples

Chat conversations

Gemini enables you to have freeform conversations across multiple turns. You can interact with Gemini Pro using a single-turn prompt and response or chat with it in a multi-turn, continuous conversation, even for code understanding and generation.

using Mscc.GenerativeAI;

var apiKey = "your_api_key";
var model = new GenerativeModel(apiKey: apiKey);    // using default model: gemini-pro
var chat = model.StartChat();

// Instead of discarding you could also use the response and access `response.Text`.
_ = await chat.SendMessage("Hello, fancy brainstorming about IT?");
_ = await chat.SendMessage("In one sentence, explain how a computer works to a young child.");
_ = await chat.SendMessage("Okay, how about a more detailed explanation to a high schooler?");
_ = await chat.SendMessage("Lastly, give a thorough definition for a CS graduate.");

// A chat session keeps every response in its history.
chat.History.ForEach(c => Console.WriteLine($"{c.Role}: {c.Parts[0].Text}"));

Create a tuned model

The Gemini API lets you tune models on your own data. Since it's your data and your tuned models this needs stricter access controls than API-Keys can provide.

Before you can create a tuned model, you'll need to setup OAuth for your project.

using Mscc.GenerativeAI;

var projectId = "your_google_project_id"; // the ID of a project, not its name.
var accessToken = "your_access_token";      // use `gcloud auth application-default print-access-token` to get it.
var model = new GenerativeModel(apiKey: null, model: Model.Gemini10Pro001)
{
    AccessToken = accessToken,
    ProjectId = projectId
};
var request = new CreateTunedModelRequest()
{
    BaseModel = $"models/{Model.Gemini10Pro001}",
    DisplayName = "Autogenerated Test model",
    TuningTask = new()
    {
        Hyperparameters = new() { BatchSize = 2, LearningRate = 0.001f, EpochCount = 3 },
        TrainingData = new()
        {
            Examples = new()
            {
                Examples = new()
                {
                    new TrainingDataExample() { TextInput = "1", Output = "2" },
                    new TrainingDataExample() { TextInput = "3", Output = "4" },
                    new TrainingDataExample() { TextInput = "-3", Output = "-2" },
                    new TrainingDataExample() { TextInput = "twenty two", Output = "twenty three" },
                    new TrainingDataExample() { TextInput = "two hundred", Output = "two hundred one" },
                    new TrainingDataExample() { TextInput = "ninety nine", Output = "one hundred" },
                    new TrainingDataExample() { TextInput = "8", Output = "9" },
                    new TrainingDataExample() { TextInput = "-98", Output = "-97" },
                    new TrainingDataExample() { TextInput = "1,000", Output = "1,001" },
                    new TrainingDataExample() { TextInput = "thirteen", Output = "fourteen" },
                    new TrainingDataExample() { TextInput = "seven", Output = "eight" },
                }
            }
        }
    }
};

// Act
var response = await model.CreateTunedModel(request);
Console.WriteLine($"Name: {response.Name}");
Console.WriteLine($"Model: {response.Metadata.TunedModel} (Steps: {response.Metadata.TotalSteps})");

(This is still work in progress but operational. Future release will provide types to simplify the create request.)

Tuned models appear in your Google AI Studio library.

More samples

The folders samples and tests contain more examples.

• Simple console application
• ASP.NET Core Minimal web application
• ASP.NET Core MVP web application (work in progress!)

Troubleshooting ⚡

Sometimes you might have authentication warnings HTTP 403 (Forbidden). Especially while working with OAuth-based authentication. You can fix it by re-authenticating through ADC.

gcloud config set project "$PROJECT_ID"

gcloud auth application-default set-quota-project "$PROJECT_ID"
gcloud auth application-default login

Make sure that the required API have been enabled.

# ENABLE APIs
gcloud services enable aiplatform.googleapis.com

Using the tests 🧩

The repository contains a number of test cases for Google AI and Vertex AI. You will find them in the tests folder. They are part of the [GenerativeAI solution]. To run the tests, either enter the relevant information into the appsettings.json, create a new appsettings.user.json file with the same JSON structure in the tests folder, or define the following environment variables

• GOOGLE_API_KEY
• GOOGLE_PROJECT_ID
• GOOGLE_REGION
• GOOGLE_ACCESS_TOKEN (optional: if absent, gcloud auth application-default print-access-token is executed)

The test cases should provide more insights and use cases on how to use the Mscc.GenerativeAI package in your .NET projects.

Feedback ✨

For support and feedback kindly create issues at the https://github.com/mscraftsman/generative-ai repository.

License 📜

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

Citation 📚

If you use Mscc.GenerativeAI in your research project, kindly cite as follows

@misc{Mscc.GenerativeAI,
  author = {Kirstätter, J and MSCraftsman},
  title = {Mscc.GenerativeAI - Gemini AI Client for .NET and ASP.NET Core},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  note = {https://github.com/mscraftsman/generative-ai}
}

Created by Jochen Kirstätter.