API du composant Chat · Needless UI

Import

import-chat.ts

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

NuiChat

La conversation et la zone de saisie, réunies.

Sélecteur: nui-chat

NuiChat: Propriétés
Nom	Type	Par défaut	Description
`session`Input	`NuiChatSession`		La conversation à afficher.
`assistant`Input	`string`	`'Assistant'`	Le nom de l’assistant, dans les titres qu’annoncent les lecteurs d’écran.
`headingLevel`Input	`number`	`3`	Le niveau du titre de chaque message, que seuls les lecteurs d’écran perçoivent. Les titres des réponses descendent d’un niveau.
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	Ce qu’annoncent les lecteurs d’écran quand une réponse est complète : tout, un court avis, ou rien.
`images`Input	`boolean`	`false`	Affiche les images des réponses. Sinon, leur texte renvoie vers elles.
`value`Bidirectionnel	`string`	`''`	Le texte en cours de saisie.
`placeholder`Input	`string`		L’indication dans le champ vide.
`suggestions`Input	`string[]`	`[]`	Des prompts à envoyer d’un clic, jusqu’au premier message.
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	Si l’envoi se fait avec Entrée, ou avec Ctrl ou ⌘ + Entrée.
`disabled`Input	`boolean`	`false`	Empêche l’envoi depuis la zone de saisie.
`attach`Input	`boolean`	`false`	Accepte des fichiers : choisis, collés ou déposés.
`accept`Input	`string`	`''`	Les types de fichiers acceptés, comme pour `<input type="file">`.
`maxFiles`Input	`number`	`10`	Le nombre de fichiers qu’un message peut contenir.
`maxSize`Input	`number`	`20_000_000`	La taille maximale d’un fichier, en octets.
`labels`Input	`NuiChatLabelsInput`		Tous les textes que le chat affiche ou annonce, à traduire.
`rated`Output	`{ message, rating }`		Émet une réponse évaluée par l’utilisateur, avec son avis, ou `null` s’il le retire.
`focus`Méthode	`() => void`		Place le focus sur le champ de texte.
`scrollToEnd`Méthode	`(behavior?) => void`		Fait défiler jusqu’au dernier message, et le suit.

NuiChatSession

La conversation, sans aucun DOM. Créez-la dans un composant, avec les options respond, messages et id.

NuiChatSession: Propriétés
Nom	Type	Description
`respond`Propriété	`(request) => NuiChatReply`	Votre fonction : écrit la réponse à `request.messages` et s’arrête quand `request.signal` est interrompu.
`messages`Propriété	`Signal<NuiChatMessage[]>`	La conversation à l’écran.
`all`Propriété	`Signal<NuiChatMessage[]>`	Tous les messages de toutes les versions, à enregistrer puis à repasser en `messages`.
`busy`Propriété	`Signal<boolean>`	Indique si une réponse est en route.
`send`Méthode	`(text, files?) => Promise<void>`	Envoie un message et demande une réponse.
`stop`Méthode	`() => void`	Arrête la réponse en gardant ce qu’elle a écrit.
`retry`Méthode	`(message?) => Promise<void>`	Redemande. La nouvelle réponse est une version à côté de l’ancienne.
`edit`Méthode	`(message, text) => Promise<void>`	Envoie une nouvelle version d’un des messages de l’utilisateur.
`versions`Méthode	`(message) => NuiChatMessage[]`	Toutes les versions d’un message, de la plus ancienne à la plus récente.
`show`Méthode	`(message) => void`	Bascule la conversation sur cette version.
`rate`Méthode	`(message, 'up' \| 'down' \| null) => void`	Enregistre l’avis de l’utilisateur sur une réponse.
`remove, load, clear`Méthode	`(…) => void`	Supprime un message et ce qui le suit, remplace la conversation, ou repart de zéro.

NuiChatMessage

Un message. Les messages de même parent sont des versions les uns des autres.

NuiChatMessage: Propriétés
Nom	Type	Description
`id, parent`Propriété	`string, string \| null`	La clé du message, et celle du message qu’il suit.
`role`Propriété	`'user' \| 'assistant'`	Qui l’a écrit.
`text`Propriété	`string`	Du Markdown pour l’assistant, du texte brut pour l’utilisateur.
`status`Propriété	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	Où en est une réponse, de l’attente à la fin.
`reasoning`Propriété	`string`	Ce que le modèle a pensé avant de répondre.
`tools`Propriété	`NuiChatTool[]`	Les outils appelés, avec leur état, leur entrée et leur sortie.
`sources`Propriété	`{ url, title? }[]`	Les pages utilisées.
`attachments`Propriété	`NuiChatAttachment[]`	Les fichiers envoyés avec lui.
`rating`Propriété	`'up' \| 'down' \| null`	L’avis de l’utilisateur.
`data`Propriété	`unknown`	Tout ce qu’il faut garder avec lui, comme le nom du modèle.

NuiChatToolTemplate

Dessine un appel d’outil, par exemple une carte météo. Le contexte contient l’appel et son message.

Sélecteur: ng-template[nuiChatTool]

NuiChatToolTemplate: Propriétés
Nom	Type	Par défaut	Description
`nuiChatTool`Input	`string`		Le nom de l’outil. Sans nom, il dessine chaque appel qu’aucun autre template ne nomme.

NuiChatThread

La conversation seule, pour votre propre mise en page. Elle accepte les inputs de nui-chat qui concernent la conversation.

Sélecteur: nui-chat-thread

NuiChatComposer

La zone de saisie seule. Elle accepte les inputs de nui-chat qui concernent la saisie.

Sélecteur: nui-chat-composer

NuiServerEvent

Ce que nuiEventStream produit pour chaque événement. nuiTextStream lit du texte brut et nuiJsonStream des lignes JSON ; les trois prennent une réponse fetch.

NuiServerEvent: Propriétés
Nom	Type	Par défaut	Description
`event`Propriété	`string`	`'message'`	Le nom de l’événement.
`data`Propriété	`string`		Ses lignes de données, jointes.
`id`Propriété	`string`		Le dernier id envoyé par le flux.

NuiChatError

Levez-la depuis respond pour afficher son message. Toute autre erreur affiche un message générique, pour que rien d’interne ne fuite.