API del componente Chat

Importación

import-chat.ts

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

NuiChat

La conversación y el cuadro de texto, juntos.

Selector: nui-chat

NuiChat: Propiedades
Nombre	Tipo	Predeterminado	Descripción
`session`Input	`NuiChatSession`		La conversación que se muestra.
`assistant`Input	`string`	`'Assistant'`	El nombre del asistente, en los encabezados que anuncian los lectores de pantalla.
`headingLevel`Input	`number`	`3`	El nivel del encabezado de cada mensaje, que solo perciben los lectores de pantalla. Los encabezados de las respuestas bajan un nivel más.
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	Lo que anuncian los lectores de pantalla cuando una respuesta está completa: todo, un aviso breve o nada.
`images`Input	`boolean`	`false`	Muestra las imágenes de las respuestas. Si no, su texto enlaza a ellas.
`value`Bidireccional	`string`	`''`	El texto que se está escribiendo.
`placeholder`Input	`string`		El texto que se muestra en el campo vacío.
`suggestions`Input	`string[]`	`[]`	Prompts que se envían con un clic, hasta el primer mensaje.
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	Si se envía con Intro, o con Ctrl o ⌘ + Intro.
`disabled`Input	`boolean`	`false`	Impide enviar desde el cuadro de texto.
`attach`Input	`boolean`	`false`	Acepta archivos: elegidos, pegados o arrastrados.
`accept`Input	`string`	`''`	Los tipos de archivo que se aceptan, como en `<input type="file">`.
`maxFiles`Input	`number`	`10`	Cuántos archivos puede llevar un mensaje.
`maxSize`Input	`number`	`20_000_000`	El tamaño máximo de archivo, en bytes.
`labels`Input	`NuiChatLabelsInput`		Todos los textos que el chat muestra o anuncia, para traducirlos.
`rated`Output	`{ message, rating }`		Emite una respuesta que el usuario valoró, con la valoración, o `null` si la retira.
`focus`Método	`() => void`		Pone el foco en el campo de texto.
`scrollToEnd`Método	`(behavior?) => void`		Se desplaza hasta el último mensaje y lo sigue.

NuiChatSession

La conversación, sin nada de DOM. Créala en un componente con las opciones respond, id y messages.

NuiChatSession: Propiedades
Nombre	Tipo	Descripción
`respond`Propiedad	`(request) => NuiChatReply`	Tu función: escribe la respuesta a `request.messages` y se detiene cuando se aborta `request.signal`.
`messages`Propiedad	`Signal<NuiChatMessage[]>`	La conversación en pantalla.
`all`Propiedad	`Signal<NuiChatMessage[]>`	Todos los mensajes de todas las versiones, para guardarlos y volver a pasarlos como `messages`.
`busy`Propiedad	`Signal<boolean>`	Indica si hay una respuesta en camino.
`send`Método	`(text, files?) => Promise<void>`	Envía un mensaje y pide una respuesta.
`stop`Método	`() => void`	Detiene la respuesta y conserva lo que ya escribió.
`retry`Método	`(message?) => Promise<void>`	Vuelve a preguntar. La nueva respuesta es una versión junto a la anterior.
`edit`Método	`(message, text) => Promise<void>`	Envía una nueva versión de uno de los mensajes del usuario.
`versions`Método	`(message) => NuiChatMessage[]`	Todas las versiones de un mensaje, de la más antigua a la más nueva.
`show`Método	`(message) => void`	Cambia la conversación a esta versión.
`rate`Método	`(message, 'up' \| 'down' \| null) => void`	Registra la valoración del usuario sobre una respuesta.
`remove, load, clear`Método	`(…) => void`	Quita un mensaje y lo que le sigue, reemplaza la conversación o empieza de cero.

NuiChatMessage

Un mensaje. Los mensajes con el mismo parent son versiones entre sí.

NuiChatMessage: Propiedades
Nombre	Tipo	Descripción
`id, parent`Propiedad	`string, string \| null`	La clave del mensaje y la del mensaje al que sigue.
`role`Propiedad	`'user' \| 'assistant'`	Quién lo escribió.
`text`Propiedad	`string`	Markdown del asistente, texto plano del usuario.
`status`Propiedad	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	En qué punto está una respuesta, de la espera al final.
`reasoning`Propiedad	`string`	Lo que pensó el modelo antes de responder.
`tools`Propiedad	`NuiChatTool[]`	Las herramientas que llamó, con su estado, entrada y salida.
`sources`Propiedad	`{ url, title? }[]`	Las páginas que usó.
`attachments`Propiedad	`NuiChatAttachment[]`	Los archivos enviados con él.
`rating`Propiedad	`'up' \| 'down' \| null`	La valoración del usuario.
`data`Propiedad	`unknown`	Cualquier otra cosa que guardar con él, como el nombre del modelo.

NuiChatToolTemplate

Dibuja una llamada a herramienta, como una tarjeta del clima. El contexto contiene la llamada y su mensaje.

Selector: ng-template[nuiChatTool]

NuiChatToolTemplate: Propiedades
Nombre	Tipo	Predeterminado	Descripción
`nuiChatTool`Input	`string`		El nombre de la herramienta. Sin él, dibuja todas las llamadas que ninguna otra plantilla nombra.

NuiChatThread

La conversación por separado, para tu propio diseño. Acepta los inputs de nui-chat relativos a la conversación.

Selector: nui-chat-thread

NuiChatComposer

El cuadro de texto por separado. Acepta los inputs de nui-chat relativos a la escritura.

Selector: nui-chat-composer

NuiServerEvent

Lo que nuiEventStream produce por cada evento. nuiTextStream lee texto plano y nuiJsonStream, líneas JSON; los tres reciben una respuesta de fetch.

NuiServerEvent: Propiedades
Nombre	Tipo	Predeterminado	Descripción
`event`Propiedad	`string`	`'message'`	El nombre del evento.
`data`Propiedad	`string`		Sus líneas de datos, unidas.
`id`Propiedad	`string`		El último id que envió el flujo.

NuiChatError

Lánzalo desde respond para mostrar su mensaje. Cualquier otro error muestra uno genérico, para que no se filtre nada interno.