openai assistant
v1.2.1
ไลบรารี NestJS สำหรับการสร้างโซลูชันที่มีประสิทธิภาพ ปรับขนาดได้ และรวดเร็วโดยใช้ OpenAI Assistant API (แชทบอท)
เริ่มต้นการพัฒนาผู้ช่วย AI ของคุณภายในเวลาไม่ถึง 15 นาที
ขอแนะนำไลบรารี NestJS ไม่ว่าคุณจะสร้างผู้ช่วยเสมือนหรือแชทบอทแบบโต้ตอบเพื่อดึงดูดประสบการณ์ผู้ใช้ ไลบรารีของเราช่วยให้คุณใช้ประโยชน์จากความสามารถ AI ที่ล้ำสมัยได้โดยใช้ความพยายามเพียงเล็กน้อย
ไลบรารีมีจุดสิ้นสุด API ที่พร้อมใช้งาน ซึ่งจัดการผู้ช่วยของคุณและเซิร์ฟเวอร์ WebSocket สำหรับการสื่อสารแบบเรียลไทม์ระหว่างไคลเอนต์และผู้ช่วย ติดตั้งไลบรารีและวางการกำหนดค่าเพื่อให้ไลบรารีทำงาน
วิดีโอ - ผู้ช่วย AI ใน 15 นาที
พื้นที่เก็บข้อมูลประกอบด้วยไลบรารี แต่ยังมีคุณสมบัติเพิ่มเติมอีกด้วย คุณสามารถโคลนพื้นที่เก็บข้อมูลและใช้งานได้ทันทีเพื่อรับประโยชน์จากคุณสมบัติทั้งหมด:
ในส่วนนี้ คุณจะได้เรียนรู้วิธีรวมไลบรารี AI Assistant เข้ากับแอปพลิเคชัน NestJS ของคุณ ขั้นตอนต่อไปนี้จะแนะนำคุณตลอดกระบวนการตั้งค่าไลบรารีและการสร้างฟังก์ชันการทำงานแบบง่าย
^20.0.0 )^10.0.0 )^10.0.0 )^4.51.0 )เปิดหรือสร้างแอปพลิเคชัน NestJS ที่คุณต้องการรวม AI Assistant หากต้องการสร้างแอปพลิเคชัน NestJS ใหม่ ให้ใช้คำสั่งต่อไปนี้:
nest new project-nameตอนนี้คุณต้องติดตั้งแพ็คเกจ ไปที่ขั้นตอนถัดไป
ตรวจสอบให้แน่ใจว่าคุณอยู่ในไดเรกทอรีรากของโครงการของคุณ ติดตั้งไลบรารีและแพ็คเกจ openai โดยใช้ npm:
npm i @boldare/openai-assistant openai --saveติดตั้งไลบรารีแล้ว แต่เราต้องกำหนดค่า ไปที่ขั้นตอนถัดไป
ตั้งค่าตัวแปรสภาพแวดล้อม สร้างตัวแปรสภาพแวดล้อมในไฟล์ .env ในไดเร็กทอรีรากของโปรเจ็กต์ และเติมข้อมูลลับที่จำเป็นลงในไฟล์ ID ผู้ช่วยเป็นทางเลือกและทำหน้าที่เป็นตัวระบุเฉพาะสำหรับผู้ช่วยของคุณ เมื่อไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม ตัวช่วยจะถูกสร้างขึ้นโดยอัตโนมัติ คุณสามารถใช้ ID ผู้ช่วยเพื่อเชื่อมต่อกับผู้ช่วยที่มีอยู่ได้ ซึ่งสามารถพบได้ในแพลตฟอร์ม OpenAI หลังจากสร้างผู้ช่วยแล้ว
สร้างไฟล์ .env ในไดเร็กทอรีรากของโปรเจ็กต์ของคุณและเติมข้อมูลลับที่จำเป็น:
touch .env เพิ่มเนื้อหาต่อไปนี้ลงในไฟล์ .env :
# OpenAI API Key
OPENAI_API_KEY =
# Assistant ID - leave it empty if you don't have an assistant to reuse
ASSISTANT_ID = โปรดทราบว่าไม่ควรส่งไฟล์ .env ไปยังที่เก็บ เพิ่มไฟล์ .env ลงในไฟล์ .gitignore เพื่อป้องกันไม่ให้คอมมิต
นี่เป็นขั้นตอนแรกที่จำเป็นในการเปิดห้องสมุด ขั้นตอนต่อไปคือการกำหนดค่าผู้ช่วย
ไลบรารีจัดเตรียมวิธีกำหนดค่าผู้ช่วยด้วยเมธอด AssistantModule.forRoot วิธีการใช้วัตถุการกำหนดค่าเป็นอาร์กิวเมนต์ สร้างไฟล์การกำหนดค่าใหม่เช่นเดียวกับในไฟล์การกำหนดค่าตัวอย่าง (chat.config.ts) และกรอกการกำหนดค่าที่จำเป็น
// 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' ] ,
} ,
} ,
} ;รายละเอียดเพิ่มเติมเกี่ยวกับการกำหนดค่าสามารถพบได้ในวิกิ
จากนี้ไป คุณสามารถเรียกใช้แอปพลิเคชันของคุณและโทรหาผู้ช่วยได้
การเรียกใช้ฟังก์ชันช่วยให้คุณขยายขีดความสามารถของผู้ช่วยด้วยตรรกะที่กำหนดเอง หากคุณจะไม่ใช้การเรียกใช้ฟังก์ชัน คุณสามารถข้ามไปที่: ขั้นตอนที่ 5: การทดสอบ
สร้างบริการใหม่ที่ขยายคลาส AgentBase กรอกข้อกำหนดและใช้วิธี output
output เป็นวิธีการหลักที่จะถูกเรียกใช้เมื่อผู้ช่วยเรียกใช้ฟังก์ชันdefinition คือออบเจ็กต์ที่อธิบายฟังก์ชันและพารามิเตอร์เพื่อให้ผู้ช่วยเข้าใจวิธีการเรียกฟังก์ชันนั้นสำหรับข้อมูลเพิ่มเติมเกี่ยวกับการเรียกใช้ฟังก์ชัน โปรดดูเอกสารประกอบของ OpenAI
คำแนะนำในการสร้างฟังก์ชันสามารถพบได้ในวิกิ ในขณะที่ตัวอย่างสามารถพบได้ในไดเร็กทอรีตัวแทน
หากคุณได้กำหนดฟังก์ชันและวิธีการส่งออก ตอนนี้คุณสามารถเรียกได้จากผู้ช่วยเพียงแค่ขอให้เขาดำเนินการตามที่อธิบายไว้ในคำจำกัดความของฟังก์ชัน
เรียกใช้แอปพลิเคชันของคุณและจะช่วยให้คุณสามารถทดสอบผู้ช่วยได้
# 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 startจากนั้นคุณสามารถทดสอบผู้ช่วยได้
/assistant/threads โดยมี วัตถุว่างอยู่ในเนื้อหา/assistant/chat ด้วยเนื้อหาต่อไปนี้: {
"threadId" : " your-thread-id " ,
"content" : " Hello, how are you? "
}/assistant/chat ด้วยเนื้อหาเดียวกันกับในขั้นตอนที่ 2ยินดีด้วย! คุณได้รวมไลบรารี AI Assistant เข้ากับแอปพลิเคชัน NestJS ของคุณสำเร็จแล้ว -
เอกสารฉบับสมบูรณ์เกี่ยวกับวิธีการรันการสาธิตด้วยแอปพลิเคชันและไลบรารีทั้งหมดจากพื้นที่เก็บข้อมูลสามารถพบได้ในวิกิ
วิศวกรของ Boldare พร้อมให้ความช่วยเหลือคุณ หากคุณมีคำถามหรือต้องการความช่วยเหลือในการติดตั้ง โปรดจองการโทรคุยกับวิศวกรของเรา
เรียนรู้เพิ่มเติมว่า Boldare สามารถช่วยคุณในการพัฒนา AI ได้อย่างไร
คุณยังสามารถถามคำถามได้ในส่วนการสนทนา GitHub
คุณต้องการที่จะเห็นคุณสมบัติใหม่ในห้องสมุดหรือไม่?
@boldare/openai-assistant และพื้นที่เก็บข้อมูลนี้ได้รับอนุญาตจาก MIT
