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 ಮಾಡಿ. ಬೇರೆ ದೋಷಗಳು ಸಾಮಾನ್ಯ ಸಂದೇಶವನ್ನೇ ತೋರಿಸುತ್ತವೆ, ಹಾಗಾಗಿ ಆಂತರಿಕ ವಿವರಗಳು ಸೋರುವುದಿಲ್ಲ.