API Chat · Needless UI

Impor

import-chat.ts

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

NuiChat

Percakapan dan kotak untuk menulis, dalam satu komponen.

Selektor: nui-chat

NuiChat: Properti
Nama	Tipe	Default	Deskripsi
`session`Input	`NuiChatSession`		Percakapan yang ditampilkan.
`assistant`Input	`string`	`'Assistant'`	Nama asisten, dalam heading yang dibacakan pembaca layar.
`headingLevel`Input	`number`	`3`	Level heading setiap pesan, yang hanya ditampilkan untuk pembaca layar. Heading di dalam balasan satu level lebih dalam.
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	Yang dibacakan pembaca layar saat balasan selesai: seluruhnya, pemberitahuan singkat, atau tidak ada.
`images`Input	`boolean`	`false`	Menampilkan gambar di balasan. Jika tidak, teksnya menjadi tautan ke gambar.
`value`Dua arah	`string`	`''`	Teks yang sedang ditulis.
`placeholder`Input	`string`		Teks yang ditampilkan saat kolom kosong.
`suggestions`Input	`string[]`	`[]`	Prompt yang bisa dikirim dengan sekali klik, sampai pesan pertama.
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	Apakah Enter yang mengirim, atau Ctrl atau ⌘ + Enter.
`disabled`Input	`boolean`	`false`	Mencegah kotak tulis mengirim pesan.
`attach`Input	`boolean`	`false`	Menerima file: dipilih, ditempel, atau di-drop.
`accept`Input	`string`	`''`	Jenis file yang diterima, seperti pada `<input type="file">`.
`maxFiles`Input	`number`	`10`	Jumlah file yang bisa dibawa satu pesan.
`maxSize`Input	`number`	`20_000_000`	Ukuran file terbesar yang diterima, dalam byte.
`labels`Input	`NuiChatLabelsInput`		Semua teks yang ditampilkan atau diumumkan chat, untuk diterjemahkan.
`rated`Output	`{ message, rating }`		Mengirimkan balasan yang diberi rating oleh pengguna, beserta rating-nya, atau `null` saat rating dibatalkan.
`focus`Metode	`() => void`		Memfokuskan kolom teks.
`scrollToEnd`Metode	`(behavior?) => void`		Menggulir ke pesan terbaru, lalu mengikutinya.

NuiChatSession

Percakapan, tanpa DOM sama sekali. Buat di dalam komponen, dengan opsi respond, messages, dan id.

NuiChatSession: Properti
Nama	Tipe	Deskripsi
`respond`Properti	`(request) => NuiChatReply`	Fungsi Anda: menulis balasan untuk `request.messages`, dan berhenti saat `request.signal` dibatalkan.
`messages`Properti	`Signal<NuiChatMessage[]>`	Percakapan yang tampil di layar.
`all`Properti	`Signal<NuiChatMessage[]>`	Setiap pesan dari setiap versi, untuk disimpan lalu diteruskan kembali sebagai `messages`.
`busy`Properti	`Signal<boolean>`	Apakah balasan sedang dalam perjalanan.
`send`Metode	`(text, files?) => Promise<void>`	Mengirim pesan dan meminta balasan.
`stop`Metode	`() => void`	Menghentikan balasan, dengan tetap menyimpan yang sudah ditulis.
`retry`Metode	`(message?) => Promise<void>`	Meminta ulang. Balasan baru menjadi versi di samping yang lama.
`edit`Metode	`(message, text) => Promise<void>`	Mengirim versi baru dari salah satu pesan pengguna.
`versions`Metode	`(message) => NuiChatMessage[]`	Setiap versi sebuah pesan, dari yang terlama.
`show`Metode	`(message) => void`	Mengalihkan percakapan ke versi ini.
`rate`Metode	`(message, 'up' \| 'down' \| null) => void`	Mencatat penilaian pengguna atas sebuah balasan.
`remove, load, clear`Metode	`(…) => void`	Menghapus pesan beserta yang mengikutinya, mengganti percakapan, atau memulai dari awal.

NuiChatMessage

Satu pesan. Pesan dengan parent yang sama adalah versi satu sama lain.

NuiChatMessage: Properti
Nama	Tipe	Deskripsi
`id, parent`Properti	`string, string \| null`	Kunci pesan, dan kunci pesan yang diikutinya.
`role`Properti	`'user' \| 'assistant'`	Siapa yang menulisnya.
`text`Properti	`string`	Markdown dari asisten, teks biasa dari pengguna.
`status`Properti	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	Tahap balasan, dari menunggu hingga selesai.
`reasoning`Properti	`string`	Apa yang dipikirkan model sebelum menjawab.
`tools`Properti	`NuiChatTool[]`	Tool yang dipanggilnya, beserta status, input, dan output-nya.
`sources`Properti	`{ url, title? }[]`	Halaman yang dipakainya.
`attachments`Properti	`NuiChatAttachment[]`	File yang dikirim bersamanya.
`rating`Properti	`'up' \| 'down' \| null`	Penilaian pengguna.
`data`Properti	`unknown`	Apa pun yang perlu disimpan bersamanya, misalnya nama model.

NuiChatToolTemplate

Menggambar panggilan tool, misalnya kartu cuaca. Konteksnya berisi panggilan dan pesannya.

Selektor: ng-template[nuiChatTool]

NuiChatToolTemplate: Properti
Nama	Tipe	Default	Deskripsi
`nuiChatTool`Input	`string`		Nama tool. Tanpa nama, template ini menggambar setiap panggilan yang tidak disebut template lain.

NuiChatThread

Percakapan saja, untuk tata letak buatan Anda. Menerima input nui-chat yang berkaitan dengan percakapan.

Selektor: nui-chat-thread

NuiChatComposer

Kotak untuk menulis saja. Menerima input nui-chat yang berkaitan dengan penulisan.

Selektor: nui-chat-composer

NuiServerEvent

Yang dihasilkan nuiEventStream untuk setiap event. nuiTextStream membaca teks biasa dan nuiJsonStream baris JSON; ketiganya menerima respons fetch.

NuiServerEvent: Properti
Nama	Tipe	Default	Deskripsi
`event`Properti	`string`	`'message'`	Nama event.
`data`Properti	`string`		Baris-baris datanya, digabungkan.
`id`Properti	`string`		Id terakhir yang dikirim stream.

NuiChatError

Lempar dari respond untuk menampilkan pesannya. Error lain menampilkan pesan umum, jadi tidak ada detail internal yang bocor.