Api.Gate.AiAssistantService 1.0.8

Api.Gate.AiAssistant

A simple C# .NET client library for AiAssistanService of company advancevauxhall.co.uk.This library facilitates seamless connection to corporate business chatbot via their RESTful API.

Description of the service The AiAssistantService allows users to engage in conversations based on pre-defined topics. During the conversation process, key data is collected. The outcome of the conversation depends on the targeted topic. In most cases, the result of the conversation involves issuing a service order.

For example:

Requirements

• This library targets .NET 6.0 and above.
• It should work across console apps, winforms, wpf, asp.net, etc.
• It should also work across Windows, Linux, and Mac.

Getting started

Install from NuGet Install package Api.Gate.AiAssistantService from Nuget. Here's how via command line:

AI Conversation The general algorithm of working with the dialogs service is reduced to the following steps:

1. Authentication API.
2. Create a dialog object with a given topic.
3. Add event handlers if it is necessary
4. Pass the user's phrase to the dialog, get an answer from the AI. If necessary, use additional functions: Add a phrase to the dialog, Continue the dialog, Update the last phrase in the dialog, Get the dialog lines

Authentication API

   static IAiAssistantConversation _conversation;

   static async Task Main(string[] args)
   {
      var api = new ApiAiAssistantService(_base_url);
   }

_base_url = path to api of .../aiassistantgate/ url

Create a dialog object with a given topic.

    var api = new ApiAiAssistantService(_base_url);
    var bExists = await api.IsConversationExistsAsync(_conversationId);
       if (bExists)
       {
        _conversation = await api.GetConversationAsync(_conversationId);
       }
       else
       {      
           _conversation = await api.CreateConversationAsync(_conversationTopicCode, _conversationId);
       }

_conversationTopicCode - this code of topic from script editor _conversationId - unique id of conversation

Add event handlers. The conversation object supports events of two types: OnTopicChanged and OnConversationEnded. Both classes inherit from the EventDto class and have the following payload structure: Event OnTopicChanged has next structure:

     public class ConversationTopicChangedEventDto : BaseEventPayload
{
    public int PrevTopicId { get; set; }
    public int CurrentTopicId { get; set; }
    public Dictionary<string, string> Variables { get; set; } // A set of key information collected in the dialogue at the current point in time
}

Event OnConversationEnded has next structure:

   public class ConversationEndedEventDto : BaseEventPayload
{
    public int TopicId { get; set; }
    public DateTime FinishDate { get; set; }
    public Dictionary<string, string> Variables { get; set; } // A set of key information collected in the dialogue at the current point in time
}

Add event handlers.

     // add event handler OnTopicChanged
     _conversation.OnTopicChanged += (sender, e) =>
     {
        Console.WriteLine("Topic changed from " + e.EventDto.PrevTopicId + " to " + e.EventDto.CurrentTopicId);
     };
    // add event handler OnConversationEnded
    _conversation.OnConversationEnded += (sender, e) =>
    {
        Console.WriteLine("Conversation ended");
    };

Alternative work with events In addition to the method of working with events through the event model, can be used the method FetchEventAsync. In this case you should after got ai replica check event exists by method FetchEventAsync

     _conversation = await api.CreateConversationAsync(_conversationTopicCode, _conversationId,false);
       Console.Write("user:");
       string phrase = Console.ReadLine();
       phrase = phrase.Replace("user:", "");
       UserSayResponse response = await _conversation.UserSayAsync(phrase);
       Console.WriteLine("ai:" + response.AssistantPhrase);
               
       var aiEvent= await _conversation.FetchEventAsync();
           if(aiEvent!=null)
               {
                   Console.WriteLine("ai event:" + aiEvent.EventType.ToString());
               }

Pass the user's phrase to the dialog, get an answer from the AI.

    UserSayResponse response = await _conversation.UserSayAsync("HI there");

Add a phrase to the dialog.

    await _conversation.AddPhraseAsync(CONVERSATION_MEMBER_ROLE.AI, "new AI phrase");

Update last phrase of dialog.

    await _conversation.UpdateLastPhraseAsync(CONVERSATION_MEMBER_ROLE.AI, "update AI phrase");

Continue exists dialog This function uses when exist some dialog and client want to get new version of answer from AI to last replica of user.

     UserSayResponse p=await _conversation.CompleteConversationAsync(_conversationId);
     Console.WriteLine(p.AssistantPhrase);

CopyWriterService The copyright service is a separate function that allows you to generate advertising messages about the sale of cars from a database campaign advancevauxhall.co.uk The function can be accessed either directly or through the functionality of the package.

Generate advitersment by HTTP request You can generate an ad based on records from the database by executing a get request at: #path to api of advancevauxhall#/aiassistantgate/writeadvertisement/?topiccode=112&platenumber= ce67pmu

Generate advitersment by API

    var copyWriterService = new CopyWriterService(baseUrl); 
    string ad = await copyWriterService.MakeAdvertisment(topicCode, plateNumber);
    Console.WriteLine(ad);

topicCode - it is child codes from topic 'Advertising' of topic editor

General Remarks

The package includes custom 'Business Exception' types, which arise when there are flaws in the operational business logic. For instance, scenarios like 'Non-existent conversation topic' or 'Unavailable conversation ID' can trigger these exceptions.

    public async Task Run()
        {
            try
            {
                string plate = InputPalteNumber();
                var ad = await _api.MakeAdvertisment(_topicCode, plate);
                Console.WriteLine(ad);
                await Run();
            }
            catch (BusinessException e)
            {
                Console.WriteLine(e.Info);                
            }
            catch (Exception e)
            {
                Console.WriteLine(e.ToString());                
            }
        }