Microsoft.SemanticWorkbench.Connector 0.2.241009.1

Prefix Reserved
This package has a SemVer 2.0.0 package version: 0.2.241009.1+031eaf2.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Microsoft.SemanticWorkbench.Connector --version 0.2.241009.1                
NuGet\Install-Package Microsoft.SemanticWorkbench.Connector -Version 0.2.241009.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.SemanticWorkbench.Connector" Version="0.2.241009.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.SemanticWorkbench.Connector --version 0.2.241009.1                
#r "nuget: Microsoft.SemanticWorkbench.Connector, 0.2.241009.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.SemanticWorkbench.Connector as a Cake Addin
#addin nuget:?package=Microsoft.SemanticWorkbench.Connector&version=0.2.241009.1

// Install Microsoft.SemanticWorkbench.Connector as a Cake Tool
#tool nuget:?package=Microsoft.SemanticWorkbench.Connector&version=0.2.241009.1                

Semantic Workbench

Semantic Workbench is a versatile tool designed for quickly prototyping intelligent assistants. Whether you're building new assistants or integrating existing ones, the workbench offers a unified interface for managing conversations, configuring settings, and customizing behavior.

Connector

The Connector allows to seamlessly integrate .NET agents, built with any framework, into Semantic Workbench. By using HTTP for communication, the connector enables your agent to handle instructions and exchange data with both the frontend and backend of Semantic Workbench.

Setup Guide

To integrate your agent:

  1. Add the Microsoft.SemanticWorkbench.Connector nuget to the .NET project containing your agent.

  2. Define an agent configuration: Create a configuration class for your agent. This can be empty if no configuration is needed from the workbench UI.

  3. Extend Agent Functionality: Inherit from Microsoft.SemanticWorkbench.Connector.AgentBase and implement the GetDefaultConfig and ParseConfig methods in your agent class. Examples are available in the repository.

  4. Create a Connector: Implement Microsoft.SemanticWorkbench.Connector.WorkbenchConnector and its CreateAgentAsync method to allow the workbench to create multiple agent instances.

  5. Start a Microsoft.SemanticWorkbench.Connector.WorkbenchConnector calling the ConnectAsync method.

  6. Start a Web service using the endpoints defined in Microsoft.SemanticWorkbench.Connector.Webservice.

Examples

Find sample .NET agents and assistants using this connector in the official repository.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.3.241104.1 117 11/5/2024
0.2.241009.1 238 10/9/2024
0.1.240910.6 161 9/11/2024