Chat کا 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 سے throw کریں تاکہ اس کا پیغام دکھے۔ کوئی بھی دوسری غلطی ایک عمومی پیغام دکھاتی ہے، تاکہ اندر کی کوئی بات باہر نہ جائے۔