Unduh node SDK - Unduh kode sumber node SDK

simpul SDK

Kode sumber lainnya

1.0.0

Unduh

    .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

SDK Node ChatBotKit

Selamat datang di SDK Node ChatBotKit. SDK ini menawarkan platform berbasis JavaScript untuk dengan mudah membangun bot dan agen AI percakapan. Dengan ChatBotKit, Anda dapat dengan cepat mengembangkan dan menerapkan bot AI yang mampu melakukan interaksi bahasa alami.

Ini adalah repositori meta untuk ChatBotKit Node SDK. Ini berisi paket SDK untuk sejumlah platform dan kerangka kerja populer seperti React , Next.js , NextAuth dan banyak lagi.

Paket Utama

SDK Node ChatBotKit terdiri dari paket-paket berikut:

Kemasan	Versi	Keterangan
@chatbotkit/cli		CLI ChatBotKit.
@chatbotkit/sdk		SDK API ChatBotKit.
@chatbotkit/reaksi		SDK Reaksi ChatBotKit.
@chatbotkit/berikutnya		SDK ChatBotKit Next.js.
@chatbotkit/nextauth		SDK ChatBotKit NextAuth.js.
@chatbotkit/ambil		Implementasi pengambilan isometrik ChatBotKit.

Alat Lainnya

Repositori ini juga berisi alat-alat berikut:

Kemasan	Versi	Keterangan
buat-cbk-app		Alat cepat untuk membuat aplikasi CBK baru.

Fitur SDK

Pengaturan Mudah : Proses instalasi cepat dan mudah.
Kompatibilitas Tanpa Server : Bekerja secara lancar dengan lingkungan runtime modern seperti Tanpa Server, Edge, Vercel, Netlify, Cloudflare Workers, Deno, AWS Lambda, dan banyak lagi.
Dukungan Kerangka Modern : Dukungan bawaan untuk CommonJS, Modul ECMAScript, async/menunggu, streaming, dll.
Kemampuan untuk disesuaikan : Menyesuaikan perilaku dan respons chatbot agar sesuai dengan kasus penggunaan tertentu.
Multi-Platform : Terapkan chatbot di situs web, aplikasi seluler, dan platform perpesanan seperti Slack, Discord, dan WhatsApp.
Multi-Model : Dukungan untuk berbagai model bahasa, termasuk GPT-3, GPT-4, Claude, dan banyak lagi.

Kemampuan ChatBotKit

Dukungan Multi-modal : Mendukung berbagai bahasa dan model gambar dari semua vendor seperti OpenAI, Anthropic, Mistral, AWS, Google dan lainnya.
? Dukungan Multi-bahasa : Memungkinkan penyesuaian dan penggunaan yang mudah dalam konteks linguistik yang beragam.
Manajemen Percakapan : Kelola kekurangan percakapan yang kompleks dengan mudah.
? Riwayat Obrolan : Tinjau dan rujuk percakapan sebelumnya.
? Kumpulan Data Khusus : Mengatur data untuk respons bot.
Keahlian Khusus : Lengkapi chatbot dengan kemampuan unik seperti pembuatan gambar atau pengambilan web.
? Pengimporan File Dokumen : Impor berbagai jenis file dokumen ke dalam kumpulan data chatbot.
? Pengimporan File Media : Impor berbagai format file media ke dalam kumpulan data chatbot.
Integrasi Widget : Sematkan chatbot dengan mulus di situs web dengan opsi yang dapat disesuaikan.
Integrasi Slack, Discord, WhatsApp Bot : Integrasi mudah dengan platform perpesanan populer.
? Integrasi Peta Situs : Menyerap konten situs web ke dalam basis pengetahuan yang dapat dicari.
? Streaming : Mengaktifkan/menonaktifkan kemampuan streaming.
Keamanan Data : Tindakan tegas untuk melindungi data pengguna.
? Fokus Privasi : Kontrol privasi yang kuat untuk memastikan penanganan data yang bertanggung jawab.
Moderasi Konten : Pemindaian otomatis dan penandaan konten yang kasar.
? Penetapan Harga Sederhana : Penetapan harga yang transparan dan lugas.

Memulai

Ikuti langkah-langkah berikut untuk memulai ChatBotKit:

Instalasi :
```
npm install @chatbotkit/sdk
```
Penggunaan : Terapkan SDK di proyek chatbot Anda.

Contoh Streaming

Contoh ini menunjukkan kemampuan streaming di lingkungan Edge dan Tanpa Server:

 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 )
  }
}

Contoh NextGen untuk Next.js

Contoh ini menunjukkan cara membuat AI percakapan tingkat lanjut dengan streaming, panggilan fungsi, rendering sisi server, dan banyak lagi dalam proyek Next.js:

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 } `
        } ,
      } ,
    ] ,
  } )
}

Contoh Dasar Next.js

Contoh singkat ini menunjukkan cara menggunakan SDK dalam proyek Next.js:

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' ,
}

Contoh

Jelajahi berbagai contoh di sini.

Beberapa contoh penting meliputi:

Platform	Contoh	Keterangan
Berikutnya.js	Obrolan Tanpa Status (Router Aplikasi + RSC + Fungsi + Permintaan Fungsi)	Contoh chatbot stateless, dimana percakapan dikelola oleh klien dan server. Contoh ini menggunakan App Router dan Tindakan Server serta fungsi AI dengan permintaan fungsi. Ini adalah contoh yang kuat untuk menunjukkan kemampuan penuh platform AI percakapan ChatBotKit.
Berikutnya.js	Obrolan Tanpa Status (Router Aplikasi + RSC + Fungsi)	Contoh chatbot stateless, dimana percakapan dikelola oleh klien dan server. Contoh ini menggunakan App Router dan Tindakan Server serta fungsi AI.
Berikutnya.js	Obrolan Tanpa Status (Router Aplikasi + RSC)	Contoh chatbot stateless, dimana percakapan dikelola oleh klien dan server. Contoh ini menggunakan App Router dan Tindakan Server.
Berikutnya.js	Obrolan Tanpa Kewarganegaraan (Router Aplikasi)	Contoh chatbot stateless, yang percakapannya dikelola oleh klien. Contoh ini menggunakan App Router.
Berikutnya.js	Obrolan Tanpa Kewarganegaraan	Contoh chatbot tanpa kewarganegaraan, yang percakapannya dikelola oleh klien.
Berikutnya.js	Obrolan Dasar	Contoh chatbot dasar, dimana percakapan dikelola oleh ChatBotKit.
Berikutnya.js	Contoh Otentikasi Berikutnya	Menunjukkan cara menggabungkan NextAuth dan ChatBotKit.
simpul	Bot obrolan AI Streaming GPT4	Contoh chatbot AI streaming sederhana.
Pekerja Cloudflare	Bot obrolan AI GPT4	Contoh chatbot AI streaming untuk Cloudflare Workers.

Stabilitas

Semua fitur SDK dianggap tidak stabil kecuali secara eksplisit ditandai sebagai stabil. Stabilitas ditunjukkan dengan adanya tag @stable di dokumentasi.