Import
import { NuiChat, NuiChatSession, nuiEventStream } from '@needless-ui/angular/chat';NuiChat
Obrolan lan kothak kanggo nulis, dadi siji.
| Jeneng | Jinis | Gawan | Katrangan |
|---|---|---|---|
sessionInput | NuiChatSession | Obrolan sing ditampilake. | |
assistantInput | string | 'Assistant' | Jeneng asisten, ing heading sing dirungokake screen reader. |
headingLevelInput | number | 3 | Level heading saben pesen, sing mung katon kanggo screen reader. Heading ing jawaban siji level luwih jero. |
announceInput | 'reply' | 'notice' | 'off' | 'reply' | Apa sing dirungokake screen reader nalika jawaban rampung: kabeh, kabar cekak, utawa ora ana. |
imagesInput | boolean | false | Nampilake gambar ing jawaban. Yen ora, teks-e dadi pranala menyang gambar. |
valueRong arah | string | '' | Teks sing lagi ditulis. |
placeholderInput | string | Pitunjuk ing kolom kosong. | |
suggestionsInput | string[] | [] | Prompt sing dikirim sak klik, nganti pesen kapisan. |
sendOnInput | 'enter' | 'mod+enter' | 'enter' | Apa Enter ngirim, utawa Ctrl utawa ⌘ + Enter. |
disabledInput | boolean | false | Ngalangi kothak tulis ngirim. |
attachInput | boolean | false | Nampa berkas: sing dipilih, ditempel utawa diselehake. |
acceptInput | string | '' | Jinis berkas sing ditampa, kaya ing <input type="file">. |
maxFilesInput | number | 10 | Pira berkas sing bisa digawa siji pesen. |
maxSizeInput | number | 20_000_000 | Berkas paling gedhe sing ditampa, ing bita. |
labelsInput | NuiChatLabelsInput | Saben teks sing ditampilake utawa diumumake chat, kanggo diterjemahake. | |
ratedOutput | { message, rating } | Ngetokake jawaban sing diwenehi rating dening sing maca, bareng rating-e, utawa null yen rating dibatalake. | |
focusMetode | () => void | Mindhah fokus menyang kolom teks. | |
scrollToEndMetode | (behavior?) => void | Nggulung menyang pesen paling anyar, lan ngetutake. |
NuiChatSession
Obrolan, tanpa DOM babar pisan. Gawe ing sawijining komponen, kanthi pilihan respond, messages lan id.
| Jeneng | Jinis | Gawan | Katrangan |
|---|---|---|---|
respondProperti | (request) => NuiChatReply | Duweke panjenengan: nulis jawaban kanggo request.messages, lan mandheg nalika request.signal dibatalake. | |
messagesProperti | Signal<NuiChatMessage[]> | Obrolan ing layar. | |
allProperti | Signal<NuiChatMessage[]> | Saben pesen saka saben versi, kanggo disimpen lan dibalekake minangka messages. | |
busyProperti | Signal<boolean> | Apa ana jawaban sing lagi teka. | |
sendMetode | (text, files?) => Promise<void> | Ngirim pesen lan njaluk jawaban. | |
stopMetode | () => void | Mandhegake jawaban, sing wis ditulis tetep ana. | |
retryMetode | (message?) => Promise<void> | Takon maneh. Jawaban anyar dadi versi ing sandhinge sing lawas. | |
editMetode | (message, text) => Promise<void> | Ngirim versi anyar saka salah siji pesen pangguna. | |
versionsMetode | (message) => NuiChatMessage[] | Saben versi sawijining pesen, sing paling lawas dhisik. | |
showMetode | (message) => void | Ngalih obrolan menyang versi iki. | |
rateMetode | (message, 'up' | 'down' | null) => void | Nyathet penilaian sing maca marang jawaban. | |
remove, load, clearMetode | (…) => void | Mbusak pesen lan sabanjure, ngganti obrolan, utawa miwiti saka wiwitan. |
NuiChatMessage
Siji pesen. Pesen kanthi parent sing padha iku versi siji lan sijine.
| Jeneng | Jinis | Gawan | Katrangan |
|---|---|---|---|
id, parentProperti | string, string | null | Kunci pesen, lan kunci pesen sadurunge. | |
roleProperti | 'user' | 'assistant' | Sing nulis. | |
textProperti | string | Markdown saka asisten, teks biasa saka pangguna. | |
statusProperti | 'pending' | 'streaming' | 'done' | 'stopped' | 'error' | Tahap jawaban, saka ngenteni nganti rampung. | |
reasoningProperti | string | Apa sing dipikir model sadurunge njawab. | |
toolsProperti | NuiChatTool[] | Tool sing diceluk, kanthi kahanan, input lan output-e. | |
sourcesProperti | { url, title? }[] | Kaca sing dienggo. | |
attachmentsProperti | NuiChatAttachment[] | Berkas sing dikirim bareng. | |
ratingProperti | 'up' | 'down' | null | Penilaian sing maca. | |
dataProperti | unknown | Apa wae liyane sing disimpen bareng, kayata jeneng model. |
NuiChatToolTemplate
Nggambar celukan tool, kayata kertu cuaca. Konteks-e ngemot celukan lan pesene.
| Jeneng | Jinis | Gawan | Katrangan |
|---|---|---|---|
nuiChatToolInput | string | Jeneng tool. Yen ora ana, nggambar saben celukan sing ora dijenengi template liya. |
NuiChatThread
Obrolan thok, kanggo tata letak panjenengan dhewe. Nampa input nui-chat sing gegayutan karo obrolan.
NuiChatComposer
Kothak tulis thok. Nampa input nui-chat sing gegayutan karo nulis.
NuiServerEvent
Apa sing diwetokake nuiEventStream kanggo saben event. nuiTextStream maca teks biasa lan nuiJsonStream baris JSON; katelune nampa response fetch.
| Jeneng | Jinis | Gawan | Katrangan |
|---|---|---|---|
eventProperti | string | 'message' | Jeneng event. |
dataProperti | string | Baris data-ne, digabung. | |
idProperti | string | Id pungkasan sing dikirim stream. |
NuiChatError
Throw saka respond kanggo nampilake pesene. Error liyane nampilake pesen umum, dadi ora ana rincian internal sing bocor.