API ของแชท · Needless UI

Import

import-chat.ts

import { NuiChat, NuiChatSession, nuiEventStream } from '@needless-ui/angular/chat';

NuiChat

บทสนทนาและช่องพิมพ์ข้อความรวมไว้ในที่เดียว

Selector: nui-chat

NuiChat: พร็อพเพอร์ตี
ชื่อ	ชนิด	ค่าเริ่มต้น	คำอธิบาย
`session`Input	`NuiChatSession`		บทสนทนาที่จะแสดง
`assistant`Input	`string`	`'Assistant'`	ชื่อของผู้ช่วย ใช้ในหัวข้อที่โปรแกรมอ่านหน้าจออ่าน
`headingLevel`Input	`number`	`3`	ระดับหัวข้อของแต่ละข้อความ ซึ่งมีเฉพาะสำหรับโปรแกรมอ่านหน้าจอ หัวข้อในคำตอบจะลึกลงไปอีกหนึ่งระดับ
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	สิ่งที่โปรแกรมอ่านหน้าจออ่านเมื่อคำตอบเสร็จ: ทั้งหมด การแจ้งสั้น ๆ หรือไม่อ่านเลย
`images`Input	`boolean`	`false`	แสดงรูปภาพในคำตอบ หากไม่เปิด ข้อความของรูปจะเป็นลิงก์ไปยังรูปนั้น
`value`สองทาง	`string`	`''`	ข้อความที่กำลังเขียน
`placeholder`Input	`string`		คำใบ้ในช่องที่ยังว่าง
`suggestions`Input	`string[]`	`[]`	พรอมต์ที่ส่งได้ในคลิกเดียว แสดงจนกว่าจะมีข้อความแรก
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	ส่งด้วย Enter หรือด้วย Ctrl หรือ ⌘ + Enter
`disabled`Input	`boolean`	`false`	ไม่ให้ช่องพิมพ์ส่งข้อความ
`attach`Input	`boolean`	`false`	รับไฟล์ที่เลือก วาง หรือลากมาวาง
`accept`Input	`string`	`''`	ชนิดของไฟล์ที่รับ แบบเดียวกับ `<input type="file">`
`maxFiles`Input	`number`	`10`	จำนวนไฟล์ที่แนบได้ในหนึ่งข้อความ
`maxSize`Input	`number`	`20_000_000`	ขนาดไฟล์ใหญ่สุดที่รับ หน่วยเป็นไบต์
`labels`Input	`NuiChatLabelsInput`		ข้อความทุกส่วนที่แชทแสดงหรือประกาศ สำหรับการแปล
`rated`Output	`{ message, rating }`		ส่งคำตอบที่ผู้ใช้ให้คะแนนออกมาพร้อมคะแนน หรือ `null` เมื่อถอนคะแนน
`focus`เมธอด	`() => void`		โฟกัสที่ช่องข้อความ
`scrollToEnd`เมธอด	`(behavior?) => void`		เลื่อนไปยังข้อความล่าสุด และเลื่อนตามต่อไป

NuiChatSession

บทสนทนาโดยไม่มี DOM สร้างในคอมโพเนนต์ด้วยตัวเลือก respond messages และ id

NuiChatSession: พร็อพเพอร์ตี
ชื่อ	ชนิด	คำอธิบาย
`respond`พร็อพเพอร์ตี	`(request) => NuiChatReply`	ฟังก์ชันที่คุณเขียนเอง: สร้างคำตอบให้กับ `request.messages` และหยุดเมื่อ `request.signal` ถูกยกเลิก
`messages`พร็อพเพอร์ตี	`Signal<NuiChatMessage[]>`	บทสนทนาที่แสดงบนหน้าจอ
`all`พร็อพเพอร์ตี	`Signal<NuiChatMessage[]>`	ทุกข้อความของทุกเวอร์ชัน สำหรับบันทึกแล้วส่งกลับมาเป็น `messages`
`busy`พร็อพเพอร์ตี	`Signal<boolean>`	คำตอบกำลังมาอยู่หรือไม่
`send`เมธอด	`(text, files?) => Promise<void>`	ส่งข้อความและขอคำตอบ
`stop`เมธอด	`() => void`	หยุดคำตอบ โดยเก็บส่วนที่เขียนแล้วไว้
`retry`เมธอด	`(message?) => Promise<void>`	ถามอีกครั้ง คำตอบใหม่จะเป็นอีกเวอร์ชันหนึ่งคู่กับคำตอบเดิม
`edit`เมธอด	`(message, text) => Promise<void>`	ส่งเวอร์ชันใหม่ของข้อความหนึ่งของผู้ใช้
`versions`เมธอด	`(message) => NuiChatMessage[]`	ทุกเวอร์ชันของข้อความ เรียงจากเก่าสุด
`show`เมธอด	`(message) => void`	สลับบทสนทนาไปยังเวอร์ชันนี้
`rate`เมธอด	`(message, 'up' \| 'down' \| null) => void`	บันทึกคะแนนที่ผู้ใช้ให้กับคำตอบ
`remove, load, clear`เมธอด	`(…) => void`	ลบข้อความพร้อมทุกอย่างที่ตามมา แทนที่บทสนทนา หรือเริ่มใหม่ทั้งหมด

NuiChatMessage

ข้อความหนึ่งข้อความ ข้อความที่มี parent เดียวกันเป็นเวอร์ชันของกันและกัน

NuiChatMessage: พร็อพเพอร์ตี
ชื่อ	ชนิด	คำอธิบาย
`id, parent`พร็อพเพอร์ตี	`string, string \| null`	คีย์ของข้อความ และคีย์ของข้อความที่อยู่ก่อนหน้า
`role`พร็อพเพอร์ตี	`'user' \| 'assistant'`	ผู้เขียนข้อความ
`text`พร็อพเพอร์ตี	`string`	Markdown จากผู้ช่วย ข้อความธรรมดาจากผู้ใช้
`status`พร็อพเพอร์ตี	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	สถานะของคำตอบ ตั้งแต่กำลังรอจนถึงเสร็จ
`reasoning`พร็อพเพอร์ตี	`string`	สิ่งที่โมเดลคิดก่อนตอบ
`tools`พร็อพเพอร์ตี	`NuiChatTool[]`	เครื่องมือที่เรียกใช้ พร้อมสถานะ input และ output
`sources`พร็อพเพอร์ตี	`{ url, title? }[]`	หน้าเว็บที่ใช้
`attachments`พร็อพเพอร์ตี	`NuiChatAttachment[]`	ไฟล์ที่ส่งมาพร้อมข้อความ
`rating`พร็อพเพอร์ตี	`'up' \| 'down' \| null`	คะแนนจากผู้ใช้
`data`พร็อพเพอร์ตี	`unknown`	ข้อมูลอื่นที่จะเก็บไว้ด้วย เช่น ชื่อโมเดล

NuiChatToolTemplate

วาดการเรียกใช้เครื่องมือ เช่น การ์ดสภาพอากาศ context มีการเรียกใช้นั้นและข้อความของมัน

Selector: ng-template[nuiChatTool]

NuiChatToolTemplate: พร็อพเพอร์ตี
ชื่อ	ชนิด	ค่าเริ่มต้น	คำอธิบาย
`nuiChatTool`Input	`string`		ชื่อเครื่องมือ หากไม่ระบุ จะวาดทุกการเรียกใช้ที่ไม่มีเทมเพลตอื่นระบุชื่อไว้

NuiChatThread

เฉพาะส่วนบทสนทนา สำหรับเลย์เอาต์ของคุณเอง รับ input ของ nui-chat ที่เกี่ยวกับบทสนทนา

Selector: nui-chat-thread

NuiChatComposer

เฉพาะช่องพิมพ์ข้อความ รับ input ของ nui-chat ที่เกี่ยวกับการเขียนข้อความ

Selector: nui-chat-composer

NuiServerEvent

สิ่งที่ nuiEventStream ส่งออกมาในแต่ละอีเวนต์ nuiTextStream อ่านข้อความธรรมดา และ nuiJsonStream อ่าน JSON ทีละบรรทัด ทั้งสามตัวรับ response จาก fetch

NuiServerEvent: พร็อพเพอร์ตี
ชื่อ	ชนิด	ค่าเริ่มต้น	คำอธิบาย
`event`พร็อพเพอร์ตี	`string`	`'message'`	ชื่อของอีเวนต์
`data`พร็อพเพอร์ตี	`string`		บรรทัด data ของอีเวนต์ที่ต่อกันแล้ว
`id`พร็อพเพอร์ตี	`string`		id ล่าสุดที่สตรีมส่งมา

NuiChatError

throw จาก respond เพื่อแสดงข้อความของมัน ข้อผิดพลาดอื่นจะแสดงข้อความทั่วไป ข้อมูลภายในจึงไม่รั่วไหล