xplat-vui

KO | EN

gitlite — search

#ai #typescript #llm #go #machine-learning #deep-learning #linux #docker #macos #kubernetes #awesome-list #ios #mcp #open-source

(★ 10)

A simple cross-platform library for building VUI smart speaker skills using C#

xplat-vui 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# XPlat.VUI
A simple cross-platform library for building VUI smart speaker skills using C#.

# Supported platform
* Google Assistant
* Amazon Alexa
* LINE Clova

# Usage
## Inherit AssistantBase abstract class

Create a class that inherits `AssistantBase`.

```csharp
public class MyAssistant : AssistantBase
{
}
```

*If you need more properties or methods, use an extended interface.

```csharp
public interface ILoggableAssistant : IAssistant
{
    ILogger Logger { get; set; }
}

public class MyAssistant : AssistantBase, ILoggableAssistant
{
    public ILogger Logger { get; set; }
}
```

## Instantiate or Dependency Injection

Instantiate the derived class.

```csharp
var Assistant = new MyAssistant();
```

If you want to use Dependency Injection, call `AddAssistant` extension method in the Startup class.

```csharp
public void ConfigureServices(IServiceCollection services)
{
    services.AddAssistant<IAssistant, MyAssistant>();
    services.AddMvc();
}
```

## Call RespondAsync method

Pass request object to handle request and create response.

```csharp
var response = await Assistant.RespondAsync(req, Platform.GoogleAssistant);  // specify platform
return new OkObjectResult(response.ToGoogleAssistantResponse());
```

## Override Methods

Override methods executed for each request type or event.

```csharp
public class MyAssistant : AssistantBase
{
    protected override Task OnLaunchRequestAsync(
        Dictionary<string, object> session, CancellationToken cancellationToken)
    {
        throw new NotImplementedException();
    }

protected override Task OnIntentRequestAsync(
        string intent, Dictionary<string, object> slots, Dictionary<string, object> session,
        CancellationToken cancellationToken)
    {
        throw new NotImplementedException();
    }
}
```

## Add content to Response property

You can add content for response of Assistant Extension to `Response` property with method chaining.

1\. Add Reply.

```csharp
Response
    .Speak("お元気ですか？")                     // Speek simple text
    .Break(3)                                   // Pause for 3 seconds.
    .Play("https://dummy.domain/myaudio.mp3");  // Play mp3 audio.
```

2\. Keep listening for multi-turn session and add reprompt.

```csharp
Response
    .Speak("お元気ですか？")
    .KeepListening("元気かどうか教えてください。");
```

3\. Play audio with AudioPlayer / Media responses.

```csharp
Response.PlayWithAudioPlayer(
    "sample-id",    // audio item id
    "https://dummy.domain/myaudio.mp3",   // audio url
    "Sample Title", "Sample Subtitle").
```

4\. Different responce for each platform

```csharp
Response
    .Speak("私はグーグルです。", Platform.GoogleAssistant)
    .Speak("私はアレクサです。", Platform.Alexa)
    .Speak("私はクローバです。", Platform.Clova);
```

5\. Different processing for each platform

```csharp
if (Request.CurrentPlatform == Platform.Clova)
{
    // Push LINE Message to same account
    await lineMessagingClient.PushMessageAsync(Request.UserId, "Hello!");        
}
```

# LISENCE

[MIT](./LICENSE)

xplat-vui

xplat-vui 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

xplat-vui

xplat-vui 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README