مرجع 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 لعرض رسالته. وأي خطأ آخر يعرض رسالة عامة، فلا يتسرّب شيء من الداخل.