API کامپوننت چت

ایمپورت

import-chat.ts

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

NuiChat

گفتگو و کادر نوشتن، با هم.

سلکتور: nui-chat

NuiChat: ویژگی‌ها
نام	نوع	پیش‌فرض	توضیح
`session`ورودی	`NuiChatSession`		گفتگویی که نمایش داده می‌شود.
`assistant`ورودی	`string`	`'Assistant'`	نام دستیار، در سرتیترهایی که صفحه‌خوان‌ها می‌خوانند.
`headingLevel`ورودی	`number`	`3`	سطح سرتیتر هر پیام، که فقط برای صفحه‌خوان‌هاست. سرتیترهای درون پاسخ‌ها یک سطح پایین‌ترند.
`announce`ورودی	`'reply' \| 'notice' \| 'off'`	`'reply'`	آنچه صفحه‌خوان‌ها هنگام کامل شدن پاسخ اعلام می‌کنند: کل پاسخ، یک اعلان کوتاه یا هیچ.
`images`ورودی	`boolean`	`false`	تصاویر را در پاسخ‌ها نشان می‌دهد. در غیر این صورت، متن تصویر به آن لینک می‌شود.
`value`دوطرفه	`string`	`''`	متنی که در حال نوشتن است.
`placeholder`ورودی	`string`		متنی که در فیلد خالی نمایش داده می‌شود.
`suggestions`ورودی	`string[]`	`[]`	پرامپت‌هایی برای ارسال با یک کلیک، تا پیش از اولین پیام.
`sendOn`ورودی	`'enter' \| 'mod+enter'`	`'enter'`	اینکه Enter ارسال کند، یا Ctrl یا ⌘ + Enter.
`disabled`ورودی	`boolean`	`false`	جلوی ارسال از کادر نوشتن را می‌گیرد.
`attach`ورودی	`boolean`	`false`	فایل می‌پذیرد: انتخاب‌شده، چسبانده‌شده یا رهاشده.
`accept`ورودی	`string`	`''`	نوع فایل‌های پذیرفتنی، مانند `<input type="file">`.
`maxFiles`ورودی	`number`	`10`	تعداد فایل‌هایی که هر پیام می‌تواند داشته باشد.
`maxSize`ورودی	`number`	`20_000_000`	بزرگ‌ترین فایل پذیرفتنی، به بایت.
`labels`ورودی	`NuiChatLabelsInput`		همهٔ متن‌هایی که چت نشان می‌دهد یا اعلام می‌کند، برای ترجمه.
`rated`خروجی	`{ 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`ورودی	`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 پرتاب کنید تا پیامش نمایش داده شود. هر خطای دیگری پیامی کلی نشان می‌دهد تا هیچ چیز داخلی لو نرود.