npm 包 @tmtek/convo 使用教程

介绍

@tmtek/convo 是一个快速搭建聊天机器人的框架,它基于 Node.js 平台,使用 TypeScript 编写,依赖了 Bot Framework 和 Azure 的 Cognitive Services,可以方便快速地创建并运行聊天机器人应用。

安装

你需要先安装 Node.js 平台和 npm 工具,然后执行以下命令:

--- ------- -- ------------

这将全局安装 @tmtek/convo 包,可以在终端中直接使用。

开始

在使用 @tmtek/convo 前,你需要先准备一个 Bot Framework 的 AppId 和 AppSecret,以及 Cognitive Services 的 AzureSubscriptionKey 和 AzureRegion。你可以在 Bot Framework 网站Azure 网站 上免费注册并获取这些凭据。

准备好凭据后,你可以使用以下命令创建一个新的聊天机器人项目:

----- ------ ----------

这将在当前目录下创建一个名为 <bot-name> 的新项目目录,并生成相关的配置文件和代码骨架。

接着,你需要在项目目录中执行以下命令,安装项目所需的依赖:

--- -------

然后修改 .env 配置文件,将凭据信息填入:

------------------------------------------
----------------------------------------------------
------------------------------------------------------------------------------------
----------------------------------------------------------------

最后,你可以启动聊天机器人程序:

--- -----

这将启动一个 HTTP 服务器,监听本地的 3978 端口,可以在本地测试聊天机器人的功能。

基本概念

@tmtek/convo 框架的核心是 Convo 类,它代表一个聊天机器人应用程序。

你可以创建一个 JS/TS 文件,使用以下代码导入 @tmtek/convo 包,并创建一个 Convo 实例:

------ - ----- - ---- ---------------

----- ----- - --- --------

Convo 实例包含了多个事件和方法,用于处理聊天机器人的输入和输出,包括收到消息、发送消息、获取用户信息等。

消息处理

当聊天机器人接收到用户的消息时,会触发 activityReceived 事件。你可以在 Convo 实例上注册一个事件处理函数,来处理这个事件。

---------------------------- ----- ---------- -- -
  -- ---------
---

在事件处理函数中,你可以读取用户的输入信息,根据输入信息处理并生成输出信息,然后将输出信息发送回给用户。

---------------------------- ----- ---------- -- -
  ----- ---- - --------------
  ----- -------- - ---------------

  ----- --------------------
    ----- ----------
    ----- ---------
    ---------- --------------
    ----- -------------------
  ---
---

在发送消息时,你需要指定消息的类型、文本内容、收件人、发件人等信息。

上下文管理

在处理聊天机器人消息时,需要考虑消息之间的上下文关系,以便更好的理解用户的意图。@tmtek/convo 提供了一组上下文相关的方法,使得消息处理逻辑更加简单和易于维护。

GenerateContextId

GenerateContextId 是一个生成上下文标识的方法,可以用于标识不同的上下文。

----- --------- - ----------------------------------

GetContextData

GetContextData 是一个获取上下文信息的方法,可以从上下文缓存中读取存储的数据。

----- ---- - --------------------------------

SetContextData

SetContextData 是一个保存上下文信息的方法,可以将数据存储到上下文缓存中。

------------------------------- ------

DeleteContextData

DeleteContextData 是一个删除上下文信息的方法,可以从上下文缓存中删除指定的数据。

---------------------------------- -----

ClearContextData

ClearContextData 是一个清空上下文信息的方法,可以清空指定的上下文缓存。

----------------------------------

示例代码

------ - ----- - ---- ---------------

----- ----- - --- --------

---------------------------- ----- ---------- -- -
  ----- ---- - --------------
  ----- -------- - ---------------

  ----- --------------------
    ----- ----------
    ----- ---------
    ---------- --------------
    ----- -------------------
  ---
---

----- ---- - ---------------- -- -----

------------------ -- -- -
  ------------------ --------- -- ---- ----------
---

总结

本文介绍了如何使用 @tmtek/convo 快速搭建聊天机器人应用程序,包括项目创建、依赖安装、配置凭据、处理消息、管理上下文等方面的内容,希望能够对开发聊天机器人的初学者有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600668fcd9381d61a3541053


猜你喜欢

  • npm 包 react-native-highlight-updates 使用教程

    在 React Native 应用中,我们经常需要关注组件状态及其变更。为了帮助开发者更加直观地理解组件状态的变化,我们可以使用 react-native-highlight-updates 这个 n...

    3 年前
  • npm包optical-js使用教程

    随着前端技术的更新迭代,我们需要日益高效地处理页面中的各种图片、视频等媒体资源,因此实现图片处理的工具也越来越受到前端工程师们的关注。其中一个 npm 包 optica-js ,就是一个提供了各种前端...

    3 年前
  • npm包 gold-iban-input 使用教程

    在现代的前端开发中,有许多优秀的 npm 包可以使用。其中,gold-iban-input 是一个非常实用的库,可以帮助开发者轻松地在网站上集成和管理国际银行账号。

    3 年前
  • npm 包 eslint-config-jm 使用教程

    在前端开发中,代码规范非常重要。而 eslint 是目前最受欢迎的代码规范工具之一。eslint-config-jm 是一款符合公司内部规范的 eslint 配置包,该包是基于 eslint-conf...

    3 年前
  • npm 包 redux-shape 使用教程

    前端开发中,状态管理对于应用程序的设计和复杂程度非常重要。在 React 应用程序中,Redux 是一个流行的状态管理工具。然而,Redux 自身不提供任何数据结构或核心结构。

    3 年前
  • npm 包 wct-headless 使用教程

    在前端开发中,我们经常需要进行单元测试来保证代码质量和稳定性。wct-headless 是一个 npm 包,它可以让我们在无界面的浏览器环境中进行 Web 组件测试。

    3 年前
  • NPM 包 Vuex2VueX 使用教程

    在前端开发中,我们经常使用各种工具来提高开发效率和代码可维护性。其中,状态管理工具是非常重要的一种。Vuex2VueX 是 Vue.js 的状态管理库,它提供了一种集中式存储管理应用程序所有组件的状态...

    3 年前
  • npm 包 bst-lib 使用教程

    什么是 npm 包 bst-lib npm (Node Package Manager)是世界上最大的软件仓库之一,其中包含了各种各样的包,用于前端和后端开发。在这个仓库中,有一个叫做 bst-lib...

    3 年前
  • npm包ppcase-widget使用教程

    什么是PPCase? PPCase是一个专业的码农社区,旨在为开发者提供最新的技术资讯、交流、分享和求助,并提供代码托管、应用市场等优质服务。PPCase致力于成为中文开发者的信仰。

    3 年前
  • npm 包 @babyeyefe/localstorage 使用教程

    前言 在前端开发中,我们经常需要使用浏览器本地存储,而 LocalStorage 是其中一种比较常用且方便的方式。然而,官方提供的 LocalStorage API 的使用方式有些繁琐和不便,因此一些...

    3 年前
  • npm 包 filstem 使用教程

    简介 filstem 是一个用于文件系统操作的 Node.js 模块,它提供了一系列非常方便的方法来处理文件和目录,比如读取、创建、修改、删除、重命名等。使用 filstem 可以帮助我们更加高效地编...

    3 年前
  • npm 包 @kingjs/descriptor.object.clone 使用教程

    在前端开发中,我们经常需要操作对象数据,例如复制一个对象。但是 JavaScript 中对象是引用类型,直接复制会导致原对象和复制后的对象共用同一块内存,修改一个对象会影响到另一个对象。

    3 年前
  • npm包@kingjs/descriptor.object.writable-symbol使用教程

    前言 随着前端技术的不断发展,越来越多的开发者开始使用各种工具和库来提高自己的工作效率,其中npm包@kingjs/descriptor.object.writable-symbol就是一款非常优秀的...

    3 年前
  • npm 包 @kingjs/descriptor.writable-symbol 使用教程

    简介 @kingjs/descriptor.writable-symbol 是一个 npm 包,它提供了一种方便的方法来创建可写的 Symbol。这可以非常有用,例如在创建对象时创建一个纯粹的数据描述...

    3 年前
  • npm 包 `generator-node-module-ts` 使用教程

    导语 当你在进行 Node.js 开发时,难免会涉及到创建 npm 包。而在创建的过程中,我们根据业务需求需要编写不同的代码,而这些代码可能会被用于多个项目中,因此,我们需要一种工具来帮助我们快速创建...

    3 年前
  • npm 包 @thematter_io/plasma.js 使用教程

    前言 随着前端技术的不断发展,现代前端开发越来越复杂,需要使用各种工具和框架来提高开发效率。其中,npm(Node Package Manager),是一个非常重要的工具,可以方便地下载并安装我们需要...

    3 年前
  • npm包 nvcli使用教程

    Nvcli 是一个基于命令行的工具,它可以对npm仓库进行查询,让我们能够更快捷地查询和安装npm包,而不需要去网页进行搜索和下载。 在本文中,我们将介绍如何安装和使用nvcli,并提供几个关于其实用...

    3 年前
  • npm 包 vue-co-dialog 使用教程

    在前端开发中,经常需要使用到弹窗功能。而 vue-co-dialog 是一个方便易用的 npm 包,可以帮助我们快速实现各种类型的弹窗。该 npm 包提供了丰富的选项和功能,可以满足大部分的业务需求。

    3 年前
  • npm 包 @kingjs/descriptor.is-frozen 使用教程

    如今前端开发中,我们经常需要用到对象。而对象可以包含若干个属性,这些属性都可以单独进行访问和修改。但是,由于 JavaScript 是一门动态语言,属性的新增和修改并没有受到限制,所以对象的属性会变得...

    3 年前
  • npm 包 elmish-ts 使用教程

    什么是 elmish-ts elmish-ts 是一个 JavaScript 库,它提供了一个用于构建在架构上工作的应用程序的模型,以及减少了在应用程序中出现的错误数量的 API。

    3 年前

相关推荐

    暂无文章