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`		దాని data లైన్‌లు, కలిపి.
`id`ప్రాపర్టీ	`string`		స్ట్రీమ్ పంపిన చివరి id.

NuiChatError

సందేశం చూపించడానికి respond నుంచి దీన్ని throw చేయండి. ఇతర ఎర్రర్‌లు సాధారణ సందేశాన్నే చూపిస్తాయి, కాబట్టి అంతర్గత వివరాలేవీ బయటపడవు.