API компонента Чат

Импорт

import-chat.ts

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

NuiChat

Диалог и поле ввода вместе.

Селектор: 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[]`	Вызванные инструменты с состоянием, входными и выходными данными.
`sources`Свойство	`{ url, title? }[]`	Использованные страницы.
`attachments`Свойство	`NuiChatAttachment[]`	Отправленные с ним файлы.
`rating`Свойство	`'up' \| 'down' \| null`	Оценка пользователя.
`data`Свойство	`unknown`	Любые другие данные, например название модели.

NuiChatToolTemplate

Рисует вызов инструмента, например карточку погоды. В контексте — вызов и его сообщение.

Селектор: ng-template[nuiChatTool]

NuiChatToolTemplate: Свойства
Имя	Тип	По умолчанию	Описание
`nuiChatTool`Input	`string`		Имя инструмента. Без него шаблон рисует все вызовы, не указанные в других шаблонах.

NuiChatThread

Только диалог — для своей раскладки. Принимает входные свойства nui-chat, относящиеся к диалогу.

Селектор: nui-chat-thread

NuiChatComposer

Только поле ввода. Принимает входные свойства nui-chat, относящиеся к вводу.

Селектор: nui-chat-composer

NuiServerEvent

Что nuiEventStream выдаёт на каждое событие. nuiTextStream читает обычный текст, а nuiJsonStream — строки JSON; все три принимают ответ fetch.

NuiServerEvent: Свойства
Имя	Тип	По умолчанию	Описание
`event`Свойство	`string`	`'message'`	Имя события.
`data`Свойство	`string`		Склеенные строки данных.
`id`Свойство	`string`		Последний id, присланный потоком.

NuiChatError

Выбросьте её в respond, чтобы показать её сообщение. При других ошибках сообщение общее: внутренние детали не утекают.