Chat API · Needless UI

इम्पोर्ट

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 मधून हे थ्रो करा. इतर त्रुटी सर्वसाधारण संदेश दाखवतात, त्यामुळे आतले काही बाहेर जात नाही.