API do componente Chat · Needless UI

Importação

import-chat.ts

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

NuiChat

A conversa e a caixa de texto, juntas.

Seletor: nui-chat

NuiChat: Propriedades
Nome	Tipo	Padrão	Descrição
`session`Input	`NuiChatSession`		A conversa a ser mostrada.
`assistant`Input	`string`	`'Assistant'`	O nome do assistente, nos títulos que os leitores de tela anunciam.
`headingLevel`Input	`number`	`3`	O nível do título de cada mensagem, que só os leitores de tela percebem. Os títulos nas respostas ficam um nível abaixo.
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	O que os leitores de tela anunciam quando uma resposta fica completa: tudo, um aviso curto ou nada.
`images`Input	`boolean`	`false`	Mostra as imagens nas respostas. Senão, o texto delas vira um link para a imagem.
`value`Bidirecional	`string`	`''`	O texto sendo escrito.
`placeholder`Input	`string`		O texto mostrado no campo vazio.
`suggestions`Input	`string[]`	`[]`	Prompts para enviar com um clique, até a primeira mensagem.
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	Se o Enter envia, ou Ctrl ou ⌘ + Enter.
`disabled`Input	`boolean`	`false`	Impede o envio pela caixa de texto.
`attach`Input	`boolean`	`false`	Aceita arquivos: escolhidos, colados ou arrastados.
`accept`Input	`string`	`''`	Os tipos de arquivo aceitos, como em `<input type="file">`.
`maxFiles`Input	`number`	`10`	Quantos arquivos uma mensagem pode levar.
`maxSize`Input	`number`	`20_000_000`	O tamanho máximo de arquivo, em bytes.
`labels`Input	`NuiChatLabelsInput`		Todo texto que o chat mostra ou anuncia, para traduzir.
`rated`Output	`{ message, rating }`		Emite uma resposta que o usuário avaliou, com a avaliação, ou `null` quando ela é desfeita.
`focus`Método	`() => void`		Move o foco para o campo de texto.
`scrollToEnd`Método	`(behavior?) => void`		Rola até a última mensagem e a acompanha.

NuiChatSession

A conversa, sem nenhum DOM. Crie-a em um componente, com as opções respond, messages e id.

NuiChatSession: Propriedades
Nome	Tipo	Descrição
`respond`Propriedade	`(request) => NuiChatReply`	A sua função: escreve a resposta para `request.messages` e se interrompe quando `request.signal` é abortado.
`messages`Propriedade	`Signal<NuiChatMessage[]>`	A conversa na tela.
`all`Propriedade	`Signal<NuiChatMessage[]>`	Todas as mensagens de todas as versões, para salvar e passar de volta como `messages`.
`busy`Propriedade	`Signal<boolean>`	Indica se há uma resposta a caminho.
`send`Método	`(text, files?) => Promise<void>`	Envia uma mensagem e pede uma resposta.
`stop`Método	`() => void`	Interrompe a resposta, mantendo o que ela já escreveu.
`retry`Método	`(message?) => Promise<void>`	Pergunta de novo. A nova resposta é uma versão ao lado da antiga.
`edit`Método	`(message, text) => Promise<void>`	Envia uma nova versão de uma das mensagens do usuário.
`versions`Método	`(message) => NuiChatMessage[]`	Todas as versões de uma mensagem, da mais antiga para a mais nova.
`show`Método	`(message) => void`	Muda a conversa para esta versão.
`rate`Método	`(message, 'up' \| 'down' \| null) => void`	Registra a avaliação do usuário sobre uma resposta.
`remove, load, clear`Método	`(…) => void`	Remove uma mensagem e o que vem depois, substitui a conversa ou recomeça do zero.

NuiChatMessage

Uma mensagem. Mensagens com o mesmo parent são versões umas das outras.

NuiChatMessage: Propriedades
Nome	Tipo	Descrição
`id, parent`Propriedade	`string, string \| null`	A chave da mensagem, e a da mensagem que ela segue.
`role`Propriedade	`'user' \| 'assistant'`	Quem a escreveu.
`text`Propriedade	`string`	Markdown do assistente, texto simples do usuário.
`status`Propriedade	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	Em que ponto está uma resposta, da espera ao fim.
`reasoning`Propriedade	`string`	O que o modelo pensou antes de responder.
`tools`Propriedade	`NuiChatTool[]`	As ferramentas que ele chamou, com estado, entrada e saída.
`sources`Propriedade	`{ url, title? }[]`	As páginas que ele usou.
`attachments`Propriedade	`NuiChatAttachment[]`	Os arquivos enviados com ela.
`rating`Propriedade	`'up' \| 'down' \| null`	A avaliação do usuário.
`data`Propriedade	`unknown`	Qualquer outra coisa para guardar com ela, como o nome do modelo.

NuiChatToolTemplate

Desenha uma chamada de ferramenta, como um card de clima. O contexto contém a chamada e a mensagem dela.

Seletor: ng-template[nuiChatTool]

NuiChatToolTemplate: Propriedades
Nome	Tipo	Padrão	Descrição
`nuiChatTool`Input	`string`		O nome da ferramenta. Sem nome, desenha toda chamada que nenhum outro template nomeia.

NuiChatThread

A conversa sozinha, para um layout seu. Ela recebe os inputs de nui-chat que tratam da conversa.

Seletor: nui-chat-thread

NuiChatComposer

A caixa de texto sozinha. Ela recebe os inputs de nui-chat que tratam da escrita.

Seletor: nui-chat-composer

NuiServerEvent

O que nuiEventStream produz para cada evento. nuiTextStream lê texto simples e nuiJsonStream, linhas JSON; os três recebem uma resposta de fetch.

NuiServerEvent: Propriedades
Nome	Tipo	Padrão	Descrição
`event`Propriedade	`string`	`'message'`	O nome do evento.
`data`Propriedade	`string`		As linhas de dados dele, unidas.
`id`Propriedade	`string`		O último id que o stream enviou.

NuiChatError

Lance-o em respond para mostrar a mensagem dele. Qualquer outro erro mostra uma mensagem genérica, para que nada interno vaze.