All Supported Endpoints

CachedContents (Beta API)

Context caching allows you to save and reuse precomputed input tokens that you wish to use repeatedly, for example when asking different questions about the same media file.

Create

Creates CachedContent resource.

private async Task<GeminiCachedContent> RunCreateCachedContentRequest()
{
    // Content must be at least 32,768 tokens.
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < 1800; i++)
        sb.Append("(*)#$*OIJIR$U(IJT^(U$*I%O$#@");


    return await GeminiManager.Instance.Request<GeminiCachedContent>(new GeminiCachedContentCreateRequest(new GeminiCachedContentCreationData
    {
        Contents = new[]
        {
            GeminiContent.GetContent(sb.ToString(), GeminiRole.User),
        },
        ExpireTime = DateTime.UtcNow.AddDays(1),
        Model = "Gemini-1.5-flash-001", // Make sure the model you use supports caching!
    }));
}

See GeminiCachedContent and GeminiCachedContentCreateRequest for more details.

Delete

Deletes CachedContent resource.

private async Task RunDeleteCachedContentRequest(GeminiCachedContent content)
{
    Debug.Log("Deleting cached content...");
    await GeminiManager.Instance.Request(new GeminiCachedContentDeleteRequest(content.Name));
    Debug.Log("Content deleted.");
}

See GeminiCachedContentDeleteRequest for more details.

Get

Reads CachedContent resource.

private async Task<GeminiCachedContent> RunGetCachedContentRequest(string contentName)
{
    return await GeminiManager.Instance.Request<GeminiCachedContent>(new GeminiCachedContentGetRequest(contentName));
}

See GeminiCachedContent and GeminiCachedContentGetRequest for more details.

List

Lists CachedContents.

private async Task<GeminiCachedContent[]> RunListCachedContentRequest()
{
    GeminiCachedContentListResponse response = await GeminiManager.Instance.Request<GeminiCachedContentListResponse>(new GeminiCachedContentListRequest());
    return response.CachedContents;
}

See GeminiCachedContentListResponse and GeminiCachedContentListRequest for more details.

Patch

Updates CachedContent resource (only expiration is updatable).

private async Task<GeminiCachedContent> RunPatchCachedContentRequest(string contentName)
{
    return await GeminiManager.Instance.Request<GeminiCachedContent>(new GeminiCachedContentPatchRequest(new GeminiCachedContentPatchData
    {
        ExpireTime = DateTime.UtcNow.AddYears(1),
    }, contentName));
}

See GeminiCachedContent and GeminiCachedContentPatchRequest for more details.

Models

The Models endpoint contains methods that allow you to access and inference Gemini models.

Get

Gets information about a specific Model such as its version number, token limits, parameters and other metadata.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;

private async Task<GeminiModel> RunGetModelRequest(string modelId)
{
    return await GeminiManager.Instance.Request<GeminiModel>(new GeminiModelGetRequest(modelId));
}

See GeminiModel and GeminiModelGetRequest for more details.

Newer models will not be recognized by the request if you're not using the Beta API.

List

Lists the Models available through the Gemini API.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;

private async Task<GeminiModel[]> RunListModelsRequest(int maxModels = 50, string pageToken = null)
{
    GeminiModelListResponse response = await GeminiManager.Instance.Request<GeminiModelListResponse>(new GeminiModelListRequest()
    {
        MaxResponseModels = maxModels,
        PageToken = string.IsNullOrWhiteSpace(pageToken) ? string.Empty : pageToken,
    });

    return response?.Models;
}

See GeminiModelListResponse and GeminiModelListRequest for more details.

Newer models will not be recognized by the request if you're not using the Beta API.

EmbedContent

Generates a text embedding vector from the input Content using the specified Gemini Embedding model.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Embedding;

private async void RunEmbedContentRequest()
{
    Debug.Log("Running embedding request.");

    GeminiEmbedContentResponse response = await GeminiManager.Instance.Request<GeminiEmbedContentResponse>(
        new GeminiEmbedContentRequest(GeminiModel.TextEmbedding004)
        {
            Content = GeminiContent.GetContent("Hello! How are you?"),
        }
    );

    Debug.Log($"Embedding values: {string.Join(", ", response.Embedding.Values)}");
}

See GeminiEmbedContentResponse and GeminiEmbedContentRequest for more details.

BatchEmbedContents

Generates multiple embedding vectors from the input Content which consists of a batch of strings represented as EmbedContentRequest objects.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Embedding;

private async void RunBatchEmbedContentRequest()
{
    Debug.Log("Running batch embedding request.");

    // Make sure the model used for the batch request is the same for all included requests.
    GeminiBatchEmbedContentResponse response = await GeminiManager.Instance.Request<GeminiBatchEmbedContentResponse>(
        new GeminiBatchEmbedContentRequest(GeminiModel.TextEmbedding004)
        {
            Requests = new GeminiEmbedContentRequest[]
            {
                new GeminiEmbedContentRequest(GeminiModel.TextEmbedding004)
                {
                    Content = GeminiContent.GetContent("Hello! How are you?"),
                },
                new GeminiEmbedContentRequest(GeminiModel.TextEmbedding004)
                {
                    Content = GeminiContent.GetContent("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."),
                }
            }
        }
    );

    foreach (GeminiContentEmbedding embedding in response.Embeddings)
        Debug.Log($"Embedding values: {string.Join(", ", embedding.Values)}");
}

See GeminiBatchEmbedContentResponse and GeminiBatchEmbedContentRequest for more details.

GenerateContent

Generates a model response given an input GenerateContentRequest.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Generation.Chat;

private async void RunChatRequest()
{
    Debug.Log("Running chat request.");

    GeminiChatResponse response = await GeminiManager.Instance.Request<GeminiChatResponse>(
        new GeminiChatRequest(GeminiModel.Gemini1_5Flash)
        {
            Contents = new GeminiContent[]
            {
                GeminiContent.GetContent("What's up?")
            },
        }
    );
    
    Debug.Log($"Gemini's response: {response.Parts[^1].Text}");
}

See GeminiChatResponse and GeminiChatRequest for more details.

StreamGenerateContent

Generates a streamed response from the model given an input GenerateContentRequest.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Generation.Chat;

private async void RunStreamingChatRequest()
{
    Debug.Log("Running streamed chat request.");

    GeminiChatResponse response = await GeminiManager.Instance.StreamRequest(
        new GeminiChatRequest(GeminiModel.Gemini1_5Flash)
        {
            Contents = new GeminiContent[]
            {
                GeminiContent.GetContent("What's up? Tell me a story about airplanes.")
            },
            OnPartialResponseReceived = partialResponse =>
            {
                if (partialResponse.Candidates == null || partialResponse.Candidates.Length < 0)
                    return Task.CompletedTask;

                Debug.Log($"Gemini's partial response: {partialResponse.Parts[^1].Text}");
                return Task.CompletedTask;
            }
        }
    );

    Debug.Log($"Gemini's final response: {response.Parts[^1].Text}");
}

See GeminiChatResponse and GeminiChatRequest for more details.

GenerateAnswer (Beta API)

Generates a grounded answer from the model given an input GenerateAnswerRequest.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Content.Attribution;
using Uralstech.UGemini.Models.Generation.QuestionAnswering;
using Uralstech.UGemini.Models.Generation.QuestionAnswering.Grounding;

private async void RunQuestionAnsweringRequest()
{
    Debug.Log("Running Q/A request.");

    GeminiAnswerResponse response = await GeminiManager.Instance.Request<GeminiAnswerResponse>(
        new GeminiAnswerRequest(GeminiModel.Aqa)
        {
            Contents = new GeminiContent[]
            {
                GeminiContent.GetContent("What is ezr²?")
            },

            InlinePassages = new GeminiGroundingPassages()
            {
                Passages = new GeminiGroundingPassage[]
                {
                    new GeminiGroundingPassage()
                    {
                        Id = "ezrSquaredContext",
                        Content = GeminiContent.GetContent(
                            "ezr² is an easy to learn and practical interpreted programming language for beginners and experts alike made in C#." +
                            "The latest version of ezr² RE has been released! ezr² RE, or REwrite, is the project's initiative to rewrite ezr². " +
                            "The latest working version of ezr² RE has many more features than the latest version of ezr²! But, it is still in " +
                            "development, has some essential features missing. Like the include expression, or any built-in object methods like " +
                            "\"a string\".length or [\"a\", \"list\"].insert. If you want to help in testing it out and fixing bugs, feel free to" +
                            " download the latest version of ezr² RE from the ezr² GitHub releases page and compiling it using the .NET SDK and/or" +
                            " Visual Studio. The GitHub releases page is: https://github.com/Uralstech/ezrSquared/releases."
                        )
                    }
                }
            },

            AnswerStyle = GeminiAnswerStyle.Verbose,
        }
    );

    if (response.Answer.Content != null)
        Debug.Log($"Gemini's answer: {response.Answer.Content.Parts[^1].Text}");
    
    foreach (GeminiGroundingAttribution attribution in response.Answer.GroundingAttributions)
        Debug.Log($"Attribution ID: {attribution.SourceId.GroundingPassage.PassageId} | Content: {attribution.Content.Parts[^1].Text}");
}

See GeminiAnswerResponse and GeminiAnswerRequest for more details.

CountTokens

Runs a model's tokenizer on input Content and returns the token count.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.CountTokens;

private async void RunTokenCountRequest()
{
    Debug.Log("Running token counting request.");

    GeminiTokenCountResponse response = await GeminiManager.Instance.Request<GeminiTokenCountResponse>(
        new GeminiTokenCountRequest(GeminiModel.Gemini1_5Flash)
        {
            Contents = new GeminiContent[]
            {
                GeminiContent.GetContent("Hello! How are you?"),
            }
        }
    );

    Debug.Log($"Tokens: {response.TotalTokens}");
}

See GeminiTokenCountResponse and GeminiTokenCountRequest for more details.

TunedModels (Beta API)

The TunedModels endpoint contains methods that allow you to access and inference fine-tuned Gemini models.

You will have to use OAuth authorization to access a lot of these endpoints, with permissions like:

https://www.googleapis.com/auth/generative-language.tuning

https://www.googleapis.com/auth/cloud-platform

Create

Creates a tuned model. Check intermediate tuning progress (if any) through the google.longrunning.Operations service with the UCloud.Operations plugin. See Operations Endpoints for more details and code examples.

using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelCreateRequest(string oauthAccessToken)
{
    Debug.Log("Creating tuned model.");

    GeminiTuningExample[] examples = new GeminiTuningExample[20];
    for (int i = 0; i < examples.Length; i++)
    {
        examples[i] = new GeminiTuningExample
        {
            TextInput = "What is your name?",
            Output = "My name is [insert name here].",
        };
    }

    GeminiTunedModelCreateResponse response = await GeminiManager.Instance.Request<GeminiTunedModelCreateResponse>(
        new GeminiTunedModelCreateRequest(
            new GeminiTunedModelCreationData
            {
                BaseModel = GeminiModel.Gemini1_5FlashTuning,
                DisplayName = "Test Model",
                Description = "This is a test model",
                TuningTask = new GeminiInitialTuningTask
                {
                    TrainingData = new GeminiTuningDataset
                    {
                        Examples = new GeminiTuningExamples
                        {
                            Examples = examples,
                        },
                    },
                },
            }, true)
        {
            ModelId = "tunedModels/mynameis",
            OAuthAccessToken = oauthAccessToken,
        });

    Debug.Log($"Tuned model created (JSON): {JsonConvert.SerializeObject(response)}");
}

See GeminiTunedModelCreateResponse and GeminiTunedModelCreateRequest for more details.

Delete

Deletes a tuned model. This will also delete the operations associated with it.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelDeleteRequest(string oauthAccessToken)
{
    Debug.Log("Deleting tuned model.");

    await GeminiManager.Instance.Request(
        new GeminiTunedModelDeleteRequest("tunedModels/mynameis")
        {
            OAuthAccessToken = oauthAccessToken
        });

    Debug.Log("Tuned model deleted.");
}

See GeminiTunedModelDeleteRequest for more details.

GenerateContent

Generates a model response given an input GenerateContentRequest.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Content;
using Uralstech.UGemini.Models.Generation.Chat;

private async void RunTunedModelChatRequest(string oauthAccessToken)
{
    Debug.Log("Running chat request on tuned model.");

    GeminiChatResponse response = await GeminiManager.Instance.Request<GeminiChatResponse>(
        new GeminiChatRequest("tunedModels/mynameis")
        {
            AuthMethod = GeminiAuthMethod.OAuthAccessToken,
            OAuthAccessToken = oauthAccessToken,
            Contents = new GeminiContent[]
            {
                GeminiContent.GetContent("Who are you?")
            },
        }
    );
    
    Debug.Log($"Tuned Gemini's response: {response.Parts[^1].Text}");
}

See GeminiChatResponse and GeminiChatRequest for more details.

Get

Gets information about a specific TunedModel.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelGetRequest(string oauthAccessToken)
{
    Debug.Log("Getting tuned model.");

    GeminiTunedModel response = await GeminiManager.Instance.Request<GeminiTunedModel>(
        new GeminiTunedModelGetRequest("tunedModels/mynameis")
        {
            OAuthAccessToken = oauthAccessToken
        });

    Debug.Log($"Got tuned model (JSON): {JsonConvert.SerializeObject(response)}");
}

See GeminiTunedModel and GeminiTunedModelGetRequest for more details.

List

Lists created tuned models.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelListRequest(string oauthAccessToken)
{
    Debug.Log("Listing tuned models.");

    GeminiTunedModelListResponse response = await GeminiManager.Instance.Request<GeminiTunedModelListResponse>(
        new GeminiTunedModelListRequest()
        {
            OAuthAccessToken = oauthAccessToken
        });

    Debug.Log($"Got tuned models (JSON): {JsonConvert.SerializeObject(response)}");
}

See GeminiTunedModelListResponse and GeminiTunedModelListRequest for more details.

Patch

Updates a tuned model.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelPatchRequest(string oauthAccessToken)
{
    Debug.Log("Patching tuned model.");

    GeminiTunedModelPatchData response = await GeminiManager.Instance.Request<GeminiTunedModelPatchData>(
        new GeminiTunedModelPatchRequest(
            new GeminiTunedModelPatchData
            {
                DisplayName = "This has been changed!",
            }, "tunedModels/mynameis")
            {
                OAuthAccessToken = oauthAccessToken,
            });

    Debug.Log($"Patched tuned model (JSON): {JsonConvert.SerializeObject(response)}");
}

See GeminiTunedModelPatchData and GeminiTunedModelPatchRequest for more details.

TransferOwnership

Transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.

using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelTransferOwnershipRequest(string oauthAccessToken)
{
    Debug.Log("Transferring tuned model.");

    await GeminiManager.Instance.Request(new GeminiTunedModelTransferOwnershipRequest("tunedModels/mynameis")
    {
        EmailAddress = "SomeGuy@SomeMail.com",
        OAuthAccessToken = oauthAccessToken,
    });

    Debug.Log("Tuned model transferred.");
}

See GeminiTunedModelTransferOwnershipRequest for more details.

Files (Beta API)

The Gemini File API can be used to store data on the cloud for future prompting with the Gemini models.

Delete

Deletes the File.

using Uralstech.UGemini;
using Uralstech.UGemini.FileAPI;

private async void RunDeleteFileRequest(string fileId)
{
    Debug.Log("Deleting file...");
    await GeminiManager.Instance.Request(new GeminiFileDeleteRequest(fileId));
    Debug.Log("File deleted.");
}

See GeminiFileDeleteRequest for more details.

Get

Gets the metadata for the given File.

using Uralstech.UGemini;
using Uralstech.UGemini.FileAPI;

private async Task<GeminiFile> RunGetFileRequest(string fileId)
{
    return await GeminiManager.Instance.Request<GeminiFile>(new GeminiFileGetRequest(fileId));
}

See GeminiFile and GeminiFileGetRequest for more details.

List

Lists the metadata for Files owned by the requesting project.

using Uralstech.UGemini;
using Uralstech.UGemini.FileAPI;

private async Task<GeminiFile[]> RunListFilesRequest(int maxFiles = 10, string pageToken = null)
{
    GeminiFileListResponse response = await GeminiManager.Instance.Request<GeminiFileListResponse>(new GeminiFileListRequest()
    {
        MaxResponseFiles = maxFiles,
        PageToken = string.IsNullOrWhiteSpace(pageToken) ? string.Empty : pageToken,
    });

    return response?.Files;
}

See GeminiFileListResponse and GeminiFileListRequest for more details.

Media (Beta API)

The Gemini File API can be used to store data on the cloud for future prompting with the Gemini models.

Upload

Creates a File.

using Uralstech.UGemini;
using Uralstech.UGemini.FileAPI;

private async Task<GeminiFile> RunUploadFileRequest(string text)
{
    GeminiFileUploadResponse response = await GeminiManager.Instance.Request<GeminiFileUploadResponse>(new GeminiFileUploadRequest(GeminiContentType.TextPlain.MimeType())
    {
        File = new GeminiFileUploadMetaData()
        {
            DisplayName = "I'm a File",
        },
        RawData = Encoding.UTF8.GetBytes(text)
    });
    
    return response.File;
}

See GeminiFileUploadResponse and GeminiFileUploadRequest for more details.

Operations Endpoints

The operations endpoint allows you to view the status of long-running processes.

This functionality is not part of UGemini, but its sister plugin UCloud.Operations. More general documentation about UCloud.Operations can be found here

UCloud.Operations uses OAuth authorization to access and edit running operations. The following permissions may or may not be required depending on the type of operations that you access or edit in the Gemini API:

https://www.googleapis.com/auth/generative-language.tuning

https://www.googleapis.com/auth/cloud-platform

List

Lists all long-running operations in the Gemini API.

using Uralstech.UCloud.Operations;
using Uralstech.UGemini;

private async void RunOperationsListRequest(string oauthAccessToken)
{
    Debug.Log("Listing all operations.");

    OperationsListResponse response = await OperationsManager.Instance.Request<OperationsListResponse>(oauthAccessToken,
        new OperationsListRequest()
        {
            BaseServiceUri = GeminiManager.ProductionApiUri,
        });

    Debug.Log($"All operations: {JsonConvert.SerializeObject(response)}");
}

TunedModels.Operations.Cancel

Cancels a long-running tuned model creation operation in the Gemini API.

using Uralstech.UCloud.Operations;
using Uralstech.UGemini;

private async void RunTunedModelOperationsCancelRequest(string oauthAccessToken, string operationResourceName)
{
    Debug.Log("Cancelling tuned model operation.");

    await OperationsManager.Instance.Request(oauthAccessToken,
        new OperationCancelRequest(operationResourceName)
        {
            BaseServiceUri = GeminiManager.ProductionApiUri
        });

    Debug.Log("Tuned model operation cancelled.");
}

TunedModels.Operations.Get

Gets a long-running tuned model creation operation in the Gemini API.

using Uralstech.UCloud.Operations;
using Uralstech.UGemini;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelOperationsGetRequest(string oauthAccessToken, string operationResourceName)
{
    Debug.Log("Getting tuned model operation.");

    GeminiTunedModelCreateResponse response = await OperationsManager.Instance.Request<GeminiTunedModelCreateResponse>(oauthAccessToken,
        new OperationGetRequest(operationResourceName)
        {
            BaseServiceUri = GeminiManager.ProductionApiUri
        });

    Debug.Log($"Got tuned model operation: {JsonConvert.SerializeObject(response)}");
}

TunedModels.Operations.List

Lists all long-running operations of the specified tuned model in the Gemini API.

using Uralstech.UCloud.Operations;
using Uralstech.UCloud.Operations.Generic;
using Uralstech.UGemini;
using Uralstech.UGemini.Models;
using Uralstech.UGemini.Models.Tuning;

private async void RunTunedModelOperationsListRequest(string oauthAccessToken, GeminiModelId model)
{
    Debug.Log($"Listing all operations of tuned model: {model.Name}");

    OperationsListResponse<GeminiTunedModelCreateResponse> response = await OperationsManager.Instance.Request<OperationsListResponse<GeminiTunedModelCreateResponse>>(oauthAccessToken,
        new OperationsListRequest()
        {
            BaseServiceUri = $"{GeminiManager.ProductionApiUri}/{model.Name}",
        });

    Debug.Log($"All operations of model \"{model.Name}\": {JsonConvert.SerializeObject(response)}");
}

Table of Contents

All Supported Endpoints

CachedContents (Beta API)

Create

Delete

Get

List

Patch

Models

Get

List

EmbedContent

BatchEmbedContents

GenerateContent

StreamGenerateContent

GenerateAnswer (Beta API)

CountTokens

TunedModels (Beta API)

Create

Delete

GenerateContent

Get

List

Patch

TransferOwnership

Files (Beta API)

Delete

Get

List

Media (Beta API)

Upload

Operations Endpoints

List

TunedModels.Operations.Cancel

TunedModels.Operations.Get

TunedModels.Operations.List