@inkeep/cxkit-types 0.5.94 → 0.5.96
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/index.d.ts +22 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -74,8 +74,9 @@ export declare interface AIChatFunctions {
|
|
|
74
74
|
/**
|
|
75
75
|
* Displays a form overlay in the chat interface.
|
|
76
76
|
* @param formSettings Configuration object defining the form's fields and behavior
|
|
77
|
+
* @param getHelpOption Optional getHelpOption that triggered the form (for analytics)
|
|
77
78
|
*/
|
|
78
|
-
openForm: (formSettings: AIChatFormSettings) => void;
|
|
79
|
+
openForm: (formSettings: AIChatFormSettings, getHelpOption?: GetHelpOption) => void;
|
|
79
80
|
/**
|
|
80
81
|
* Programmatically sets focus to the chat input field.
|
|
81
82
|
* Useful after programmatic updates or when showing the chat interface.
|
|
@@ -113,6 +114,13 @@ export declare interface AIChatToolbarButtonLabels {
|
|
|
113
114
|
|
|
114
115
|
export declare type AnswerConfidence = 'very_confident' | 'somewhat_confident' | 'not_confident' | 'no_sources' | 'other';
|
|
115
116
|
|
|
117
|
+
export declare interface AssistantAnswerDisplayedEvent {
|
|
118
|
+
eventName: 'assistant_answer_displayed';
|
|
119
|
+
properties: {
|
|
120
|
+
conversation?: ConversationResponse;
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
|
|
116
124
|
export declare interface AssistantCodeBlockCopiedEvent {
|
|
117
125
|
eventName: 'assistant_code_block_copied';
|
|
118
126
|
properties: {
|
|
@@ -150,12 +158,12 @@ export declare interface AssistantMessageReceivedEvent {
|
|
|
150
158
|
}
|
|
151
159
|
|
|
152
160
|
export declare interface AssistantNegativeFeedbackSubmittedEvent {
|
|
153
|
-
eventName: '
|
|
161
|
+
eventName: 'assistant_negative_feedback_submitted';
|
|
154
162
|
properties: FeedbackProperties;
|
|
155
163
|
}
|
|
156
164
|
|
|
157
165
|
export declare interface AssistantPositiveFeedbackSubmittedEvent {
|
|
158
|
-
eventName: '
|
|
166
|
+
eventName: 'assistant_positive_feedback_submitted';
|
|
159
167
|
properties: FeedbackProperties;
|
|
160
168
|
}
|
|
161
169
|
|
|
@@ -203,7 +211,7 @@ export declare interface ChatClearButtonClickedEvent {
|
|
|
203
211
|
};
|
|
204
212
|
}
|
|
205
213
|
|
|
206
|
-
export declare type ChatEvent = AssistantMessageReceivedEvent | UserMessageSubmittedEvent | SharedChatLoadedEvent | AssistantPositiveFeedbackSubmittedEvent | AssistantNegativeFeedbackSubmittedEvent | ChatClearButtonClickedEvent | AssistantMessageCopiedEvent | GetHelpOptionClickedEvent | ChatShareButtonClickedEvent | AssistantSourceItemClickedEvent | AssistantMessageLinkOpenedEvent | AssistantCodeBlockCopiedEvent;
|
|
214
|
+
export declare type ChatEvent = AssistantMessageReceivedEvent | AssistantAnswerDisplayedEvent | UserMessageSubmittedEvent | UserEscalationIndicatedEvent | SharedChatLoadedEvent | AssistantPositiveFeedbackSubmittedEvent | AssistantNegativeFeedbackSubmittedEvent | ChatClearButtonClickedEvent | AssistantMessageCopiedEvent | GetHelpOptionClickedEvent | ChatShareButtonClickedEvent | AssistantSourceItemClickedEvent | AssistantMessageLinkOpenedEvent | AssistantCodeBlockCopiedEvent;
|
|
207
215
|
|
|
208
216
|
export declare enum ChatModel {
|
|
209
217
|
/**
|
|
@@ -1665,6 +1673,16 @@ export declare interface UseColorModeProps {
|
|
|
1665
1673
|
systemColorMode?: 'dark' | 'light';
|
|
1666
1674
|
}
|
|
1667
1675
|
|
|
1676
|
+
export declare interface UserEscalationIndicatedEvent {
|
|
1677
|
+
eventName: 'user_escalation_indicated';
|
|
1678
|
+
properties: {
|
|
1679
|
+
escalationType: 'downvote' | 'get_help_option' | 'contact_us' | 'support_form';
|
|
1680
|
+
getHelpOption?: GetHelpOption;
|
|
1681
|
+
getHelpOptionName?: string;
|
|
1682
|
+
conversation?: ConversationResponse;
|
|
1683
|
+
};
|
|
1684
|
+
}
|
|
1685
|
+
|
|
1668
1686
|
export declare interface UserMessage extends MessageBase {
|
|
1669
1687
|
role: 'user';
|
|
1670
1688
|
}
|