首页>编程相关>其他源码
下载 

    .d8888b.  888888b.   888    d8P
   d88P  Y88b 888  "88b  888   d8P
   888    888 888  .88P  888  d8P
   888        8888888K.  888d88K
   888        888  "Y88b 8888888b
   888    888 888    888 888  Y88b
   Y88b  d88P 888   d88P 888   Y88b
    "Y8888P"  8888888P"  888    Y88b .ai

ChatBotKit 节点 SDK

欢迎使用 ChatBotKit 节点 SDK。该 SDK 提供了一个基于 JavaScript 的平台，可轻松构建对话式 AI 机器人和代理。借助 ChatBotKit，您可以快速开发和部署能够进行自然语言交互的 AI 机器人。

这是 ChatBotKit Node SDK 的元存储库。它包含许多流行平台和框架的 SDK 包，例如React 、 Next.js 、 NextAuth等。

主要套餐

ChatBotKit Node SDK 由以下包组成：

包裹版本描述
@chatbotkit/cli ChatBotKit CLI。
@chatbotkit/sdk ChatBotKit API SDK。
@chatbotkit/反应ChatBotKit React SDK。
@chatbotkit/下一个ChatBotKit Next.js SDK。
@chatbotkit/nextauth ChatBotKit NextAuth.js SDK。
@chatbotkit/获取ChatBotKit 等距获取实现。

其他工具

该存储库还包含以下工具：

包裹版本描述
创建 cbk 应用程序创建新 CBK 应用程序的快速工具。

SDK特性

  • 轻松设置：安装过程快速而简单。
  • 无服务器兼容性：与无服务器、Edge、Vercel、Netlify、Cloudflare Workers、Deno、AWS Lambda 等现代运行时环境无缝协作。
  • 现代框架支持：内置支持 CommonJS、ECMAScript 模块、异步/等待、流等。
  • 可定制性：定制聊天机器人的行为和响应以适应特定的用例。
  • 多平台：在网站、移动应用程序以及 Slack、Discord 和 WhatsApp 等消息平台上部署聊天机器人。
  • 多模型：支持多种语言模型，包括GPT-3、GPT-4、Claude等。

ChatBotKit 功能

  • 多模态支持：支持 OpenAI、Anthropic、Mistral、AWS、Google 等所有供应商的各种语言和图像模型。
  • ？多语言支持：允许在不同的语言环境中轻松定制和使用。
  • 对话管理：轻松管理复杂的对话缺陷。
  • ？聊天历史记录：查看和参考过去的对话。
  • ？自定义数据集：组织机器人响应的数据。
  • 自定义技能：为聊天机器人配备图像生成或网络获取等独特功能。
  • ？文档文件导入：将各种文档文件类型导入聊天机器人数据集中。
  • ？媒体文件导入：将一系列媒体文件格式导入聊天机器人数据集。
  • 小部件集成：通过可自定义的选项将聊天机器人无缝嵌入到网站上。
  • Slack、Discord、WhatsApp Bot 集成：与流行的消息传递平台轻松集成。
  • ？站点地图集成：将网站内容提取到可搜索的知识库中。
  • ？流媒体：启用/禁用流媒体功能。
  • 数据安全：保护用户数据的强有力措施。
  • ？隐私焦点：强大的隐私控制，以确保负责任的数据处理。
  • 内容审核：自动扫描和标记滥用内容。
  • ？简单的定价：透明且直接的定价。

入门

请按照以下步骤开始使用 ChatBotKit：

  1. 安装： 
    npm install @chatbotkit/sdk
  2. 用法：在您的聊天机器人项目中实施 SDK。

流媒体示例

此示例演示了边缘和无服务器环境中的流处理功能： 

 import { ConversationClient } from '@chatbotkit/sdk/conversation/index.js'

const client = new ConversationClient ( /* configuration */ )

for await ( const { type , data } of client
  . complete ( null , { model : 'gpt-4' , messages } )
  . stream ( ) ) {
  if ( type === 'token' ) {
    process . stdout . write ( data . token )
  }
}

Next.js 的 NextGen 示例

此示例展示了如何在 Next.js 项目中构建具有流式传输、函数调用、服务器端渲染等功能的高级对话式 AI：

bot: thinking...
) : null}
setText(e.target.value)} onSubmit={submit} placeholder="Type something..." style={{ border: 0, outline: 'none', resize: 'none', width: '100%', marginTop: '10px', }} />
) } export default function ChatArea() { return ( ) } // file: ./actions/conversation.jsx 'use server' import CalendarEvents from '../components/CalendarEvents.jsx' import { streamComplete } from '@chatbotkit/react/actions/complete' import { ChatBotKit } from '@chatbotkit/sdk' const cbk = new ChatBotKit({ secret: process.env.CHATBOTKIT_API_SECRET, }) export async function complete({ messages }) { return streamComplete({ client: cbk.conversation, messages, functions: [ { name: 'getUserName', description: 'Get the authenticated user name', parameters: {}, handler: async () => { return 'John Doe' }, }, { name: 'getCalendarEvents', description: 'Get a list of calendar events', parameters: {}, handler: async () => { const events = [ { id: 1, title: 'Meeting with Jane Doe' }, { id: 2, title: 'Meeting with Jill Doe' }, ] return { children: , result: { events, }, } }, }, { name: 'declineCalendarEvent', description: 'Decline a calendar event', parameters: { type: 'object', properties: { id: { type: 'number', description: 'The ID of the event to decline', }, }, required: ['id'], }, handler: async ({ id }) => { return `You have declined the event with ID ${id}` }, }, ], }) }">
 // file: ./app/page.jsx
import ChatArea from '../components/ChatArea.jsx'

export default function Page ( ) {
  return < ChatArea / >
}

// file: ./components/ChatArea.jsx
'use client'

import { useContext } from 'react'

import { complete } from '../actions/conversation.jsx'

import { ChatInput , ConversationContext } from '@chatbotkit/react'
import ConversationManager from '@chatbotkit/react/components/ConversationManager'

export function ChatMessages ( ) {
  const {
    thinking ,

    text ,
    setText ,

    messages ,

    submit ,
  } = useContext ( ConversationContext )

  return (
    < div >
      < div >
        { messages . map ( ( { id , type , text , children } ) => {
          switch ( type ) {
            case 'user' :
              return (
                < div key = { id } >
                  < div >
                    < strong > user: < / strong > { text }
                  < / div >
                < / div >
              )

            case 'bot' :
              return (
                < div key = { id } >
                  < div >
                    < strong > bot: < / strong > { text }
                  < / div >
                  { children ? < div > { children } < / div > : null }
                < / div >
              )
          }
        } ) }
        { thinking ? (
          < div key = "thinking" >
            < strong > bot: < / strong > thinking...
          < / div >
        ) : null }
      < / div >
      < ChatInput
        value = { text }
        onChange = { ( e ) => setText ( e . target . value ) }
        onSubmit = { submit }
        placeholder = "Type something..."
        style = { {
          border : 0 ,
          outline : 'none' ,
          resize : 'none' ,
          width : '100%' ,
          marginTop : '10px' ,
        } }
      / >
    < / div >
  )
}

export default function ChatArea ( ) {
  return (
    < ConversationManager endpoint = { complete } >
      < ChatMessages / >
    < / ConversationManager >
  )
}

// file: ./actions/conversation.jsx
'use server'

import CalendarEvents from '../components/CalendarEvents.jsx'

import { streamComplete } from '@chatbotkit/react/actions/complete'
import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit ( {
  secret : process . env . CHATBOTKIT_API_SECRET ,
} )

export async function complete ( { messages } ) {
  return streamComplete ( {
    client : cbk . conversation ,

    messages ,

    functions : [
      {
        name : 'getUserName' ,
        description : 'Get the authenticated user name' ,
        parameters : { } ,
        handler : async ( ) => {
          return 'John Doe'
        } ,
      } ,

      {
        name : 'getCalendarEvents' ,
        description : 'Get a list of calendar events' ,
        parameters : { } ,
        handler : async ( ) => {
          const events = [
            { id : 1 , title : 'Meeting with Jane Doe' } ,
            { id : 2 , title : 'Meeting with Jill Doe' } ,
          ]

          return {
            children : < CalendarEvents events = { events } / > ,

            result : {
              events ,
            } ,
          }
        } ,
      } ,

      {
        name : 'declineCalendarEvent' ,
        description : 'Decline a calendar event' ,
        parameters : {
          type : 'object' ,
          properties : {
            id : {
              type : 'number' ,
              description : 'The ID of the event to decline' ,
            } ,
          } ,
          required : [ 'id' ] ,
        } ,
        handler : async ( { id } ) => {
          return `You have declined the event with ID ${ id } `
        } ,
      } ,
    ] ,
  } )
}

基本 Next.js 示例

此快速示例演示了如何在 Next.js 项目中使用 SDK：

bot: thinking...
)} setText(e.target.value)} onKeyDown={handleOnKeyDown} placeholder="Type something..." style={{ border: 0, outline: 'none', resize: 'none', width: '100%', marginTop: '10px', }} /> ) } // file: ./pages/api/conversation/complete.js import { ChatBotKit } from '@chatbotkit/sdk' import { stream } from '@chatbotkit/next/edge' const cbk = new ChatBotKit({ secret: process.env.CHATBOTKIT_API_SECRET, }) export default async function handler(req) { const { messages } = await req.json() return stream(cbk.conversation.complete(null, { messages })) } export const config = { runtime: 'edge', }">
 // file: ./pages/index.js
import { AutoTextarea , useConversationManager } from '@chatbotkit/react'

export default function Index ( ) {
  const {
    thinking ,

    text ,
    setText ,

    messages ,

    submit ,
  } = useConversationManager ( {
    endpoint : '/api/conversation/complete' ,
  } )

  function handleOnKeyDown ( event ) {
    if ( event . keyCode === 13 ) {
      event . preventDefault ( )

      submit ( )
    }
  }

  return (
    < div style = { { fontFamily : 'monospace' , padding : '10px' } } >
      { messages . map ( ( { id , type , text } ) => (
        < div key = { id } >
          < strong > { type } : < / strong > { text }
        < / div >
      ) ) }
      { thinking && (
        < div key = "thinking" >
          < strong > bot: < / strong > thinking...
        < / div >
      ) }
      < AutoTextarea
        value = { text }
        onChange = { ( e ) => setText ( e . target . value ) }
        onKeyDown = { handleOnKeyDown }
        placeholder = "Type something..."
        style = { {
          border : 0 ,
          outline : 'none' ,
          resize : 'none' ,
          width : '100%' ,
          marginTop : '10px' ,
        } }
      / >
    < / div >
  )
}

// file: ./pages/api/conversation/complete.js
import { ChatBotKit } from '@chatbotkit/sdk'
import { stream } from '@chatbotkit/next/edge'

const cbk = new ChatBotKit ( {
  secret : process . env . CHATBOTKIT_API_SECRET ,
} )

export default async function handler ( req ) {
  const { messages } = await req . json ( )

  return stream ( cbk . conversation . complete ( null , { messages } ) )
}

export const config = {
  runtime : 'edge' ,
}

示例

在这里探索一系列示例。

一些值得注意的例子包括：

平台例子描述
Next.js无状态聊天（应用程序路由器 + RSC + 函数 + 函数请求）无状态聊天机器人示例，其中对话由客户端和服务器管理。此示例使用应用程序路由器和服务器操作以及具有函数请求的 AI 函数。这是一个强有力的示例，展示了 ChatBotKit 对话式 AI 平台的全部功能。
Next.js无状态聊天（应用程序路由器 + RSC + 功能）无状态聊天机器人示例，其中对话由客户端和服务器管理。此示例使用应用程序路由器和服务器操作以及 AI 功能。
Next.js无状态聊天（应用程序路由器 + RSC）无状态聊天机器人示例，其中对话由客户端和服务器管理。此示例使用应用程序路由器和服务器操作。
Next.js无状态聊天（应用程序路由器）无状态聊天机器人示例，其中对话由客户端管理。此示例使用应用程序路由器。
Next.js无状态聊天无状态聊天机器人示例，其中对话由客户端管理。
Next.js基本聊天一个基本的聊天机器人示例，其中对话由 ChatBotKit 管理。
Next.js下一个验证示例展示如何结合 NextAuth 和 ChatBotKit。
节点GPT4 流媒体 AI 聊天机器人一个简单的流式人工智能聊天机器人示例。
Cloudflare 工人GPT4 人工智能聊天机器人Cloudflare Workers 的流式 AI 聊天机器人示例。

稳定

除非明确标记为稳定，否则所有 SDK 功能都被视为不稳定。文档中存在@stable标记表明稳定性。

文档

  • 类型文档：此处有关可用类型的详细信息。
  • 平台文档：这里是 ChatBotKit 的综合指南。
  • 平台教程：此处提供 ChatBotKit 的分步教程。

贡献

遇到错误或想做出贡献？在我们的官方 GitHub 存储库上提出问题或提交拉取请求。

展开
附加信息
相关应用
为您推荐
相关资讯 全部