API na Chat · Needless UI

Shigo da shi

import-chat.ts

import { NuiChat, NuiChatSession, nuiEventStream } from '@needless-ui/angular/chat';

NuiChat

Tattaunawar da akwatin rubutu, a tare.

Selector: nui-chat

NuiChat: Kadarori
Suna	Iri	Na asali	Bayani
`session`Input	`NuiChatSession`		Tattaunawar da za a nuna.
`assistant`Input	`string`	`'Assistant'`	Sunan mataimakin, a cikin headings da manhajojin karanta allo ke karantawa.
`headingLevel`Input	`number`	`3`	Matakin heading na kowane saƙo, wanda manhajojin karanta allo kaɗai ke nunawa. Headings a cikin amsoshi suna sauka mataki ɗaya.
`announce`Input	`'reply' \| 'notice' \| 'off'`	`'reply'`	Abin da manhajojin karanta allo ke sanarwa idan amsa ta kammala: dukanta, gajeriyar sanarwa, ko ba komai.
`images`Input	`boolean`	`false`	Yana nuna hotuna a amsoshi. In ba haka ba, rubutunsu mahaɗa ne zuwa gare su.
`value`Hanya biyu	`string`	`''`	Rubutun da ake rubutawa.
`placeholder`Input	`string`		Rubutun da ake nunawa a filin da babu komai.
`suggestions`Input	`string[]`	`[]`	Saƙonnin da ake aikawa da dannawa ɗaya, har zuwa saƙon farko.
`sendOn`Input	`'enter' \| 'mod+enter'`	`'enter'`	Ko Enter ne ke aikawa, ko Ctrl ko ⌘ + Enter.
`disabled`Input	`boolean`	`false`	Yana hana akwatin rubutu aikawa.
`attach`Input	`boolean`	`false`	Yana karɓar fayiloli ta zaɓi, liƙawa ko ja da sauke.
`accept`Input	`string`	`''`	Irin fayilolin da za a karɓa, kamar a `<input type="file">`.
`maxFiles`Input	`number`	`10`	Yawan fayilolin da saƙo ɗaya zai iya ɗauka.
`maxSize`Input	`number`	`20_000_000`	Mafi girman fayil da za a karɓa, a bytes.
`labels`Input	`NuiChatLabelsInput`		Kowane rubutu da chat ɗin ke nunawa ko sanarwa, don fassarawa.
`rated`Output	`{ message, rating }`		Yana fitar da amsar da mai karatu ya ba ƙima, tare da ƙimar, ko `null` idan ya janye ta.
`focus`Method	`() => void`		Yana kai focus kan filin rubutu.
`scrollToEnd`Method	`(behavior?) => void`		Yana gungurawa zuwa sabon saƙo, kuma yana bin sa.

NuiChatSession

Tattaunawar, ba tare da DOM ba. Ku ƙirƙira ta a cikin component, da zaɓuɓɓukan respond, messages da id.

NuiChatSession: Kadarori
Suna	Iri	Bayani
`respond`Kadara	`(request) => NuiChatReply`	Function ɗinku: yana rubuta amsa ga `request.messages`, kuma yana tsayawa idan an soke `request.signal`.
`messages`Kadara	`Signal<NuiChatMessage[]>`	Tattaunawar da ke kan allo.
`all`Kadara	`Signal<NuiChatMessage[]>`	Kowane saƙo na kowace siga, don adanawa da mayarwa a matsayin `messages`.
`busy`Kadara	`Signal<boolean>`	Ko akwai amsa da ke kan hanya.
`send`Method	`(text, files?) => Promise<void>`	Yana aika saƙo kuma yana neman amsa.
`stop`Method	`() => void`	Yana tsayar da amsar, yana riƙe abin da ta rubuta.
`retry`Method	`(message?) => Promise<void>`	Yana sake tambaya. Sabuwar amsar siga ce kusa da tsohuwar.
`edit`Method	`(message, text) => Promise<void>`	Yana aika sabuwar siga ta ɗaya daga cikin saƙonnin mai amfani.
`versions`Method	`(message) => NuiChatMessage[]`	Kowace siga ta saƙo, mafi tsufa da farko.
`show`Method	`(message) => void`	Yana sauya tattaunawar zuwa wannan siga.
`rate`Method	`(message, 'up' \| 'down' \| null) => void`	Yana adana ra’ayin mai karatu kan amsa.
`remove, load, clear`Method	`(…) => void`	Yana cire saƙo da abin da ke biye da shi, yana maye gurbin tattaunawar, ko yana farawa daga farko.

NuiChatMessage

Saƙo ɗaya. Saƙonni masu parent ɗaya sigogin juna ne.

NuiChatMessage: Kadarori
Suna	Iri	Bayani
`id, parent`Kadara	`string, string \| null`	Key na saƙon, da saƙon da yake biye da shi.
`role`Kadara	`'user' \| 'assistant'`	Wanda ya rubuta shi.
`text`Kadara	`string`	Markdown daga mataimakin, rubutu zalla daga mai amfani.
`status`Kadara	`'pending' \| 'streaming' \| 'done' \| 'stopped' \| 'error'`	Matsayin amsa, daga jira zuwa kammalawa.
`reasoning`Kadara	`string`	Abin da model ya yi tunani kafin ya amsa.
`tools`Kadara	`NuiChatTool[]`	Kayan aikin da ya kira, tare da yanayinsu, input da output ɗinsu.
`sources`Kadara	`{ url, title? }[]`	Shafukan da ya yi amfani da su.
`attachments`Kadara	`NuiChatAttachment[]`	Fayilolin da aka aika tare da shi.
`rating`Kadara	`'up' \| 'down' \| null`	Ra’ayin mai karatu.
`data`Kadara	`unknown`	Duk wani abu da za a ajiye tare da shi, kamar sunan model.

NuiChatToolTemplate

Yana zana kiran kayan aiki, kamar kati don hasashen yanayi. Context ɗin yana ɗauke da kiran da saƙonsa.

Selector: ng-template[nuiChatTool]

NuiChatToolTemplate: Kadarori
Suna	Iri	Na asali	Bayani
`nuiChatTool`Input	`string`		Sunan kayan aikin. Idan babu, yana zana duk kiran da wani template bai ambata ba.

NuiChatThread

Tattaunawar ita kaɗai, don tsarin shafi naku. Yana karɓar inputs na nui-chat da suka shafi tattaunawar.

Selector: nui-chat-thread

NuiChatComposer

Akwatin rubutu shi kaɗai. Yana karɓar inputs na nui-chat da suka shafi rubutu.

Selector: nui-chat-composer

NuiServerEvent

Abin da nuiEventStream ke bayarwa ga kowane event. nuiTextStream yana karanta rubutu zalla, nuiJsonStream kuma layukan JSON; dukansu uku suna karɓar response na fetch.

NuiServerEvent: Kadarori
Suna	Iri	Na asali	Bayani
`event`Kadara	`string`	`'message'`	Sunan event ɗin.
`data`Kadara	`string`		Layukan bayanansa, a haɗe.
`id`Kadara	`string`		Id na ƙarshe da stream ɗin ya aiko.

NuiChatError

Ku jefa shi (throw) daga respond don a nuna saƙonsa. Kowane kuskure dabam yana nuna saƙo na gama-gari, don kada wani abu na ciki ya fita.