Hevolus.XRCopilot.Client.Public 2.2.7

XRCopilotPublicClient

The XRCopilotPublicClient library provides a simple and efficient way to interact with the XRCopilot API, enabling developers to easily integrate XRCopilot's assistant and speech capabilities into their .NET applications.

Features

• Chat with the XRCopilot assistant.
• Convert text to speech.
• Retrieve a welcome message in different languages.
• Check for data and AI capabilities by resource ID.
• Save and retrieve system data and parameters
• Manage storage and file indexing

Getting Started

Prerequisites

• .NET Core 3.1 or later
• An API key for the XRCopilot service

Installation

To install the XRCopilotPublicClient package, use the following NuGet command:

dotnet add package Hevolus.XRCopilot.Public.Client --version

Replace <version> with the specific version of the package you want to use.

Usage

First, create an instance of the XRCopilotPublicClient class with your endpoint and API key:

using XRCopilot.Client;

var apiKey = "your_api_key_here"; 
var client = new XRCopilotPublicClient(apiKey);

Chat with the Assistant

To chat with the XRCopilot assistant, use the ChatAsync method:

// Create a UserPrompt object
var prompt = new UserPrompt
{
    TenantId = "your_tenant_id_here",
    ResourceId = "your_resource_id_here",
    Message = "Hello, how can I assist you?",
    AnswerLanguage = "it",
    ConversationId = "your_conversation_id_here"
};

// Call the ChatAsync method
var response = await client.ChatAsync(prompt);

// Check the response
if (response != null)
{
    Console.WriteLine($"ResponseType: {response.ResponseType}");
    Console.WriteLine($"Message: {response.Message}");
    Console.WriteLine($"ConversationId: {response.ConversationId}");
    Console.WriteLine($"AnswareLanguage: {response.AnswerLanguage}");
}

Convert Text to Speech

To convert text to speech, use the SpeechAsync method:

// Prepare the request with the text you want to convert to speech
var speechRequest = new SpeechRequest
{
    Text = "Hello, world! This is a test of the SpeechAsync method.",
    Language = "en",
    VoiceGender = "male"
};

// Call the SpeechAsync method
var speechResponse = await client.SpeechAsync(speechRequest);

// Check the response
if (speechResponse != null)
{
	var audio = speechResponse.VoiceData;
}

Retrieve a Welcome Message

To retrieve a welcome message in different languages, use the GetWelcomeMessageAsync method:

var language = "en"; 
var welcomeMessage = await client.GetWelcomeMessageAsync(language); 
Console.WriteLine(welcomeMessage.Message);

Check for Data and AI Capabilities

To check for data and AI capabilities by resource ID, use the CheckCapabilitiesAsync method:

var resourceId = "your_resource_id_here";

var hasData = await client.HasDataAsync(resourceId);
Console.WriteLine($"Has Data: {hasData}");

var hasAI = await client.HasAIAsync(resourceId);
Console.WriteLine($"Has AI: {hasAI}");

Save and Retrieve System Data and Parameters

To save and retrieve system data and parameters, use the SaveDataAsync and GetDataAsync methods:

var sd = new SystemData
{                      
    resourceId = "your_resource_id_here",
    systemMessage = "Hello, how can I assist you?",
    documentsLanguage = "en",
    maxTokens = 800,
    temperature = 0.5f,
    minRankingScore = 1.2f,
    minWordsValidation = 50,
    numberOfInteractions = 2
};
var response = await client.SaveSystemDataAsync(sd);
Console.WriteLine($"SaveSystemData: {response}");

var resourceId = "your_resource_id_here";
var response = await client.GetSystemDataAsync(resourceId);
Console.WriteLine($"GetSystemData: {response.systemMessage}");

Manage Storage and File Indexing

To manage storage and file indexing, use the UploadFileAsync, ListFileAsync, GetFileAsync, GetFileUriAsync, DeleteFileAsync, DeleteFileAsync, DeleteAllAsync, PerformIndexingAsync, and DeleteIndexAsync methods:

var streamData = new MemoryStream(Encoding.UTF8.GetBytes("Hello, world!"));
var response = await client.UploadFileAsync("your_resource_id_here", "file_name", streamData);
Console.WriteLine($"UploadFile: {response}");

var response = await client.ListFileAsync("your_resource_id_here");
Console.WriteLine($"ListFile: {response}");

var response = await client.GetFileAsync("your_resource_id_here", "file_name");
Console.WriteLine($"GetFile: {response}");

var response = await client.GetFileUriAsync("your_resource_id_here", "file_name");
Console.WriteLine($"GetFileUri: {response}");

var response = await client.DeleteFileAsync("your_resource_id_here", "file_name");
Console.WriteLine($"DeleteFile: {response}");

var response = await client.DeleteAllAsync("your_resource_id_here");
Console.WriteLine($"DeleteAll: {response}");

var options = new IndexingOptions
{
	regenerateIndex = true
};
var response = await client.PerformIndexingAsync("your_company_id_here", "your_resource_id_here", options);
Console.WriteLine($"PerformIndexing: {response}");

var response = await client.DeleteIndexAsync("your_company_id_here", "your_resource_id_here");
Console.WriteLine($"DeleteIndex: {response}");