@streamoji/aitwin 0.7.4 → 0.7.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aitwin.cjs +6 -6
- package/dist/aitwin.js +2372 -2348
- package/dist/index.d.ts +28 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -153,6 +153,16 @@ export declare type AiTwinProps = {
|
|
|
153
153
|
pixiMaxTextureSize?: number;
|
|
154
154
|
/** Plain subtitles during TTS/voice playback. */
|
|
155
155
|
captions?: boolean | AiTwinCaptionsOptions;
|
|
156
|
+
/** Logged-in visitor display name for conversation history / billing attribution. */
|
|
157
|
+
userName?: string;
|
|
158
|
+
/** Logged-in visitor email for conversation history. */
|
|
159
|
+
userEmail?: string;
|
|
160
|
+
/**
|
|
161
|
+
* Visitor note for the twin (what they want it to know).
|
|
162
|
+
* Passed through to speakWithReply / connect as `userContext`; backend
|
|
163
|
+
* injects into the LLM prompt for that request (not Redis-persisted).
|
|
164
|
+
*/
|
|
165
|
+
userContext?: string;
|
|
156
166
|
};
|
|
157
167
|
|
|
158
168
|
export declare type AiTwinRecord = {
|
|
@@ -598,6 +608,15 @@ export declare type SpeakWithReplyOptions = AvatarTtsSpeakOptions & {
|
|
|
598
608
|
brainId?: string;
|
|
599
609
|
brainUrl?: string;
|
|
600
610
|
history?: SpeakWithReplyMessage[];
|
|
611
|
+
/** Logged-in visitor display name — persisted on non-meeting conversation history. */
|
|
612
|
+
userName?: string;
|
|
613
|
+
/** Logged-in visitor email — persisted on non-meeting conversation history. */
|
|
614
|
+
userEmail?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Visitor note for the twin (what they want the twin to know).
|
|
617
|
+
* Sent each turn; backend injects into the LLM prompt (not Redis-persisted).
|
|
618
|
+
*/
|
|
619
|
+
userContext?: string;
|
|
601
620
|
/** Called as soon as spokenText arrives on the SSE stream. */
|
|
602
621
|
onSpokenText?: (spokenText: string) => void;
|
|
603
622
|
/** Called as soon as displayText arrives on the SSE stream. */
|
|
@@ -962,6 +981,15 @@ export declare type VoiceConnectOptions = {
|
|
|
962
981
|
speakOnlyWhenSpokenTo?: boolean;
|
|
963
982
|
/** Wake name used with `speakOnlyWhenSpokenTo` (e.g. twin.agentName). */
|
|
964
983
|
avatarName?: string;
|
|
984
|
+
/** Logged-in visitor display name — persisted on non-meeting conversation history. */
|
|
985
|
+
userName?: string;
|
|
986
|
+
/** Logged-in visitor email — persisted on non-meeting conversation history. */
|
|
987
|
+
userEmail?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Visitor note for the twin. Sent on connect; backend stores lead-scoped
|
|
990
|
+
* Sent on connect; backend injects into the LLM prompt (not Redis-persisted).
|
|
991
|
+
*/
|
|
992
|
+
userContext?: string;
|
|
965
993
|
/** HTTP API base; default `https://ai.aitwin.me`. */
|
|
966
994
|
apiBase?: string;
|
|
967
995
|
/** Full WebSocket URL override. Query params must be included. */
|