openai assistant
v1.2.1
Pustaka NestJS untuk membangun solusi yang efisien, terukur, dan cepat menggunakan OpenAI Assistant API (chatbots).
Mulailah pengembangan Asisten AI Anda dalam waktu kurang dari 15 menit
Memperkenalkan perpustakaan NestJS. Baik Anda membuat asisten virtual, atau chatbot interaktif untuk pengalaman pengguna yang menarik, perpustakaan kami memberdayakan Anda untuk memanfaatkan kemampuan AI mutakhir dengan sedikit usaha.
Pustaka menyediakan titik akhir API siap pakai yang menangani asisten Anda dan server WebSocket untuk komunikasi real-time antara klien dan asisten. Instal perpustakaan dan tempel konfigurasi untuk menjalankannya.
Video - Asisten AI dalam 15 menit
Repositori berisi perpustakaan tetapi juga menyediakan fitur tambahan. Anda cukup mengkloning repositori dan menggunakannya secara instan untuk mendapatkan semua fitur:
Di bagian ini, Anda akan mempelajari cara mengintegrasikan perpustakaan Asisten AI ke dalam aplikasi NestJS Anda. Langkah-langkah berikut akan memandu Anda melalui proses pengaturan perpustakaan dan pembuatan fungsionalitas sederhana.
^20.0.0 )^10.0.0 )^10.0.0 )^4.51.0 )Buka atau buat aplikasi NestJS tempat Anda ingin mengintegrasikan Asisten AI. Untuk membuat aplikasi NestJS baru, gunakan perintah berikut:
nest new project-nameSekarang Anda harus menginstal paket-paketnya. Lanjutkan ke langkah berikutnya.
Pastikan Anda berada di direktori root proyek Anda. Instal paket perpustakaan dan openai menggunakan npm:
npm i @boldare/openai-assistant openai --savePerpustakaan sudah diinstal tetapi kita harus mengkonfigurasinya. Lanjutkan ke langkah berikutnya.
Siapkan variabel lingkungan Anda, buat variabel lingkungan dalam file .env di direktori root proyek, dan isi dengan rahasia yang diperlukan. ID asisten bersifat opsional dan berfungsi sebagai pengidentifikasi unik untuk asisten Anda. Jika variabel lingkungan tidak disetel, asisten akan dibuat secara otomatis. Anda dapat menggunakan ID asisten untuk terhubung ke asisten yang ada, yang dapat ditemukan di platform OpenAI setelah membuat asisten.
Buat file .env di direktori root proyek Anda dan isi dengan rahasia yang diperlukan:
touch .env Tambahkan konten berikut ke file .env :
# OpenAI API Key
OPENAI_API_KEY =
# Assistant ID - leave it empty if you don't have an assistant to reuse
ASSISTANT_ID = Harap dicatat bahwa file .env tidak boleh dikomit ke repositori. Tambahkan file .env ke file .gitignore untuk mencegahnya dikomit.
Ini adalah langkah pertama yang diperlukan untuk menjalankan perpustakaan. Langkah selanjutnya adalah mengkonfigurasi asisten.
Pustaka menyediakan cara untuk mengonfigurasi asisten dengan metode AssistantModule.forRoot . Metode ini mengambil objek konfigurasi sebagai argumen. Buat file konfigurasi baru seperti pada contoh file konfigurasi (chat.config.ts) dan isi dengan konfigurasi yang diperlukan.
// chat.config.ts file
import { AssistantConfigParams } from '@boldare/openai-assistant' ;
import { AssistantCreateParams } from 'openai/resources/beta' ;
// Default OpenAI configuration
export const assistantParams : AssistantCreateParams = {
name : 'Your assistant name' ,
instructions : `You are a chatbot assistant. Speak briefly and clearly.` ,
tools : [ { type : 'file_search' } ] ,
model : 'gpt-4-turbo' ,
temperature : 0.05 ,
} ;
// Additional configuration for our assistant
export const assistantConfig : AssistantConfigParams = {
id : process . env [ 'ASSISTANT_ID' ] ,
params : assistantParams ,
filesDir : './apps/api/src/app/knowledge' ,
toolResources : {
file_search : {
// Provide files if you use file_search tool
fileNames : [ 'example1.txt' , 'example2.txt' ] ,
} ,
} ,
} ;Detail lebih lanjut tentang konfigurasi dapat ditemukan di wiki.
Mulai sekarang Anda dapat menjalankan aplikasi Anda dan memanggil asisten.
Pemanggilan fungsi memungkinkan Anda memperluas kemampuan asisten dengan logika khusus. Jika Anda tidak akan menggunakan pemanggilan fungsi, Anda dapat langsung ke: Langkah 5: Pengujian.
Buat layanan baru yang memperluas kelas AgentBase , isi definisi dan terapkan metode output .
output adalah metode utama yang akan dipanggil ketika fungsi tersebut dipanggil oleh asisten.definition adalah objek yang mendeskripsikan fungsi dan parameternya sehingga asisten dapat memahami cara memanggilnya.Untuk informasi selengkapnya tentang pemanggilan fungsi, Anda dapat merujuk ke dokumentasi OpenAI.
Petunjuk untuk membuat suatu fungsi dapat ditemukan di wiki, sedangkan contohnya dapat ditemukan di direktori agen.
Jika Anda telah mendefinisikan suatu fungsi dan metode keluaran, kini Anda dapat memanggilnya dari asisten hanya dengan memintanya melakukan tindakan yang dijelaskan dalam definisi fungsi.
Jalankan aplikasi Anda dan ini akan memungkinkan Anda menguji asisten.
# use this if you are using the repository:
npm run start:dev
# if you are using your own NestJS application, please check the npm scripts in the package.json file
# defualt command for NestJS is:
npm run startKemudian Anda dapat menguji asistennya.
/assistant/threads dengan objek kosong di body ./assistant/chat dengan isi berikut: {
"threadId" : " your-thread-id " ,
"content" : " Hello, how are you? "
}/assistant/chat dengan isi yang sama seperti pada langkah 2.Selamat! Anda telah berhasil mengintegrasikan perpustakaan Asisten AI ke dalam aplikasi NestJS Anda. ?
Dokumentasi lengkap tentang cara menjalankan demo dengan semua aplikasi dan perpustakaan dari repositori dapat ditemukan di wiki.
Insinyur Boldare siap membantu Anda. Jika Anda memiliki pertanyaan atau memerlukan bantuan dalam penerapannya, silakan hubungi salah satu teknisi kami.
Pelajari lebih lanjut bagaimana Boldare dapat membantu Anda dalam pengembangan AI .
Anda juga dapat mengajukan pertanyaan di bagian Diskusi GitHub.
Apakah Anda ingin melihat fitur baru di perpustakaan?
@boldare/openai-assistant dan repositori ini berlisensi MIT
