@carbon/ai-chat 1.4.4 → 1.5.0-rc.0
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/es/aiChatEntry.js +41 -23
- package/dist/es/aiChatEntry.js.map +1 -1
- package/dist/es/chat.ChatAppEntry.js +4589 -3950
- package/dist/es/chat.ChatAppEntry.js.map +1 -1
- package/dist/es/{chat.languages.js → chat.languageUtils.js} +15 -24
- package/dist/es/chat.languageUtils.js.map +1 -0
- package/dist/es/serverEntry.js +3 -5
- package/dist/es/serverEntry.js.map +1 -1
- package/dist/es/web-components/cds-aichat-container/index.js +41 -20
- package/dist/es/web-components/cds-aichat-container/index.js.map +1 -1
- package/dist/es/web-components/cds-aichat-custom-element/index.js +38 -17
- package/dist/es/web-components/cds-aichat-custom-element/index.js.map +1 -1
- package/dist/es-custom/aiChatEntry.js +41 -23
- package/dist/es-custom/aiChatEntry.js.map +1 -1
- package/dist/es-custom/chat.ChatAppEntry.js +4589 -3950
- package/dist/es-custom/chat.ChatAppEntry.js.map +1 -1
- package/dist/es-custom/{chat.languages.js → chat.languageUtils.js} +15 -24
- package/dist/es-custom/chat.languageUtils.js.map +1 -0
- package/dist/es-custom/serverEntry.js +3 -5
- package/dist/es-custom/serverEntry.js.map +1 -1
- package/dist/es-custom/web-components/cds-aichat-container/index.js +41 -20
- package/dist/es-custom/web-components/cds-aichat-container/index.js.map +1 -1
- package/dist/es-custom/web-components/cds-aichat-custom-element/index.js +38 -17
- package/dist/es-custom/web-components/cds-aichat-custom-element/index.js.map +1 -1
- package/dist/types/aiChatEntry.d.ts +3 -3
- package/dist/types/{serverEntry-BBTNDChc.d.ts → serverEntry-CwwZQCSX.d.ts} +241 -13
- package/dist/types/serverEntry.d.ts +2 -2
- package/package.json +5 -5
- package/dist/es/chat.languages.js.map +0 -1
- package/dist/es-custom/chat.languages.js.map +0 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { C as ChatContainerProps, B as BusEventViewPreChange, a as ChatInstance, b as BusEventViewChange } from './serverEntry-
|
|
2
|
-
export {
|
|
1
|
+
import { C as ChatContainerProps, B as BusEventViewPreChange, a as ChatInstance, b as BusEventViewChange } from './serverEntry-CwwZQCSX.js';
|
|
2
|
+
export { aF as AdditionalDataToAgent, aG as AgentAvailability, b0 as AudioItem, aX as BaseGenericItem, b1 as BaseMessageInput, x as BusEvent, N as BusEventChatReady, O as BusEventChunkUserDefinedResponse, Q as BusEventClosePanelButtonClicked, R as BusEventCustomPanelClose, U as BusEventCustomPanelOpen, X as BusEventCustomPanelPreClose, Y as BusEventCustomPanelPreOpen, a1 as BusEventFeedback, a2 as BusEventHistoryBegin, a3 as BusEventHistoryEnd, y as BusEventHumanAgentAreAnyAgentsOnline, z as BusEventHumanAgentEndChat, A as BusEventHumanAgentPreEndChat, G as BusEventHumanAgentPreReceive, H as BusEventHumanAgentPreSend, J as BusEventHumanAgentPreStartChat, K as BusEventHumanAgentReceive, M as BusEventHumanAgentSend, a4 as BusEventMessageItemCustom, a5 as BusEventPreReceive, a6 as BusEventPreReset, a7 as BusEventPreSend, a8 as BusEventReceive, a9 as BusEventReset, aa as BusEventSend, ab as BusEventStateChange, ac as BusEventType, ad as BusEventUserDefinedResponse, Z as BusEventWorkspaceClose, _ as BusEventWorkspaceOpen, $ as BusEventWorkspacePreClose, a0 as BusEventWorkspacePreOpen, b2 as ButtonItem, b3 as ButtonItemKind, b4 as ButtonItemType, an as CancellationReason, aq as CarbonTheme, b5 as CardItem, b6 as CarouselItem, c4 as CdsAiChatContainerAttributes, c5 as CdsAiChatCustomElementAttributes, bQ as ChainOfThoughtStep, j as ChangeFunction, d as ChatHeaderConfig, k as ChatInstanceInput, ao as ChatInstanceMessaging, l as ChatInstanceServiceDeskActions, b7 as Chunk, b8 as CompleteItemChunk, b9 as ConnectToHumanAgentItem, ba as ConnectToHumanAgentItemTransferInfo, aI as ConnectingErrorInfo, bb as ConversationalSearchItem, bc as ConversationalSearchItemCitation, v as CornersType, ar as CustomMenuOption, e as CustomPanelConfigOptions, f as CustomPanelInstance, i as CustomPanelOpenOptions, h as CustomPanels, ap as CustomSendMessageOptions, bd as DateItem, aD as DeepPartial, D as DefaultCustomPanelConfigOptions, as as DisclaimerPublicConfig, aJ as DisconnectedErrorInfo, aK as EndChatInfo, aL as ErrorType, E as EventBusHandler, m as EventHandlers, be as EventInput, bf as EventInputData, ae as FeedbackInteractionType, aM as FileStatusValue, aN as FileUpload, F as FileUploadCapabilities, bg as FinalResponseChunk, bh as GenericItem, bi as GenericItemMessageFeedbackCategories, bU as GenericItemMessageFeedbackOptions, bV as GenericItemMessageOptions, bj as GridItem, au as HeaderConfig, c0 as HistoryItem, aj as HomeScreenConfig, ak as HomeScreenStarterButton, al as HomeScreenStarterButtons, am as HomeScreenState, bk as HorizontalCellAlignment, bP as HumanAgentMessageType, aH as HumanAgentsOnlineStatus, bl as IFrameItem, bm as IFrameItemDisplayOption, bn as ImageItem, I as IncreaseOrDecrease, bo as InlineErrorItem, av as InputConfig, bp as ItemStreamingMetadata, aw as LanguagePack, c2 as LauncherCallToActionConfig, c3 as LauncherConfig, ax as LayoutConfig, L as LayoutCustomProperties, bu as MediaFileAccessibility, bq as MediaItem, br as MediaItemDimensions, bs as MediaSubtitleTrack, bt as MediaTranscript, bW as Message, c1 as MessageErrorState, bZ as MessageHistoryFeedback, bv as MessageInput, bw as MessageInputType, bx as MessageItemPanelInfo, by as MessageOutput, bz as MessageRequest, a_ as MessageRequestHistory, bA as MessageResponse, aZ as MessageResponseHistory, aY as MessageResponseOptions, bB as MessageResponseTypes, af as MessageSendSource, ay as MinimizeButtonIconType, aE as ObjectMap, az as OnErrorData, aA as OnErrorType, bC as OptionItem, bD as OptionItemPreference, P as PageObjectId, g as PanelType, bE as PartialItemChunk, bX as PartialOrCompleteItemChunk, bY as PartialResponse, bF as PauseItem, ai as PersistedHumanAgentState, ah as PersistedState, q as PublicChatHumanAgentState, r as PublicChatState, aB as PublicConfig, aC as PublicConfigMessaging, o as PublicCustomPanelsState, p as PublicDefaultCustomPanelState, n as PublicInputState, bS as ReasoningStep, bT as ReasoningStepOpenState, bR as ReasoningSteps, c6 as RenderUserDefinedResponse, c7 as RenderUserDefinedState, c8 as RenderWriteableElementResponse, a$ as ResponseUserProfile, aO as ScreenShareState, b_ as SearchResult, S as SendOptions, aP as ServiceDesk, aQ as ServiceDeskCallback, aR as ServiceDeskCapabilities, aS as ServiceDeskErrorInfo, aT as ServiceDeskFactoryParameters, aU as ServiceDeskPublicConfig, bO as SingleOption, aV as StartChatOptions, bG as StreamChunk, T as TestId, bH as TextItem, s as TypeAndHandler, bI as UserDefinedItem, aW as UserMessageErrorInfo, b$ as UserType, bJ as VerticalCellAlignment, bK as VideoItem, ag as ViewChangeReason, V as ViewState, c as ViewType, bL as WidthOptions, bM as WithBodyAndFooter, bN as WithWidthOptions, W as WorkspaceCustomPanelConfigOptions, t as WriteableElementName, u as WriteableElements, at as enLanguagePack, w as loadAllLazyDeps } from './serverEntry-CwwZQCSX.js';
|
|
3
3
|
import React from 'react';
|
|
4
|
-
export {
|
|
4
|
+
export { ChainOfThoughtStepStatus } from '@carbon/ai-chat-components/es/components/chain-of-thought/defs.js';
|
|
5
5
|
import '@carbon/web-components/es/components/button/defs.js';
|
|
6
6
|
import '@carbon/ai-chat-components/es/react/chat-button.js';
|
|
7
7
|
import 'lit-html';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BUTTON_KIND, BUTTON_SIZE } from '@carbon/web-components/es/components/button/defs.js';
|
|
2
2
|
import { CHAT_BUTTON_KIND, CHAT_BUTTON_SIZE } from '@carbon/ai-chat-components/es/react/chat-button.js';
|
|
3
|
-
import {
|
|
3
|
+
import { ChainOfThoughtStepStatus } from '@carbon/ai-chat-components/es/components/chain-of-thought/defs.js';
|
|
4
4
|
import { ReactNode } from 'react';
|
|
5
5
|
import * as lit_html from 'lit-html';
|
|
6
6
|
import { LitElement, PropertyValues } from 'lit';
|
|
@@ -16,6 +16,10 @@ import { Root } from 'react-dom/client';
|
|
|
16
16
|
* @experimental
|
|
17
17
|
*/
|
|
18
18
|
declare enum PageObjectId {
|
|
19
|
+
/**
|
|
20
|
+
* The root chat widget container (for scoping tests/accessibility checks).
|
|
21
|
+
*/
|
|
22
|
+
CHAT_WIDGET = "chat_widget",
|
|
19
23
|
/**
|
|
20
24
|
* Minimize chat button in header.
|
|
21
25
|
*/
|
|
@@ -130,7 +134,18 @@ declare enum PanelType {
|
|
|
130
134
|
/**
|
|
131
135
|
* Opens the panel so that it overlays the main chat content.
|
|
132
136
|
*/
|
|
133
|
-
DEFAULT = "default"
|
|
137
|
+
DEFAULT = "default",
|
|
138
|
+
/**
|
|
139
|
+
* Opens the panel in the Workspace layout.
|
|
140
|
+
*
|
|
141
|
+
* On large screens, the panel is placed at the `preferredLocation` (`start` or `end`)
|
|
142
|
+
* and pushes the chat content.
|
|
143
|
+
*
|
|
144
|
+
* On small screens, the panel behaves like `DEFAULT`.
|
|
145
|
+
*
|
|
146
|
+
* @experimental
|
|
147
|
+
*/
|
|
148
|
+
WORKSPACE = "workspace"
|
|
134
149
|
}
|
|
135
150
|
/**
|
|
136
151
|
* This manager handles fetching an instance for manipulating the custom panel.
|
|
@@ -253,13 +268,30 @@ interface DefaultCustomPanelConfigOptions {
|
|
|
253
268
|
*/
|
|
254
269
|
hideBackButton?: boolean;
|
|
255
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
* Options supported by the workspace custom panel implementation.
|
|
273
|
+
*
|
|
274
|
+
* @experimental
|
|
275
|
+
* @category Instance
|
|
276
|
+
*/
|
|
277
|
+
interface WorkspaceCustomPanelConfigOptions {
|
|
278
|
+
/**
|
|
279
|
+
* Determines if the panel open/close animation should be turned off. By default, the panel will animate up from the
|
|
280
|
+
* bottom of the chat window.
|
|
281
|
+
*/
|
|
282
|
+
disableAnimation?: boolean;
|
|
283
|
+
/**
|
|
284
|
+
* Where the chat will attempt to render the workspace in logical terms. For a ltr layout "start" will render on the left and "end" will render on the right. If there is not enough room to render the workspace, it will be rendered as a panel overlaying the content with a back button.
|
|
285
|
+
*/
|
|
286
|
+
preferredLocation?: "start" | "end";
|
|
287
|
+
}
|
|
256
288
|
/**
|
|
257
289
|
* Options accepted by {@link CustomPanelInstance.open}. Legacy consumers may continue to pass
|
|
258
290
|
* {@link CustomPanelConfigOptions} until the next major release.
|
|
259
291
|
*
|
|
260
292
|
* @category Instance
|
|
261
293
|
*/
|
|
262
|
-
type CustomPanelOpenOptions = CustomPanelConfigOptions | DefaultCustomPanelConfigOptions;
|
|
294
|
+
type CustomPanelOpenOptions = CustomPanelConfigOptions | DefaultCustomPanelConfigOptions | WorkspaceCustomPanelConfigOptions;
|
|
263
295
|
|
|
264
296
|
/**
|
|
265
297
|
* @category Config
|
|
@@ -574,7 +606,11 @@ declare enum MessageResponseTypes {
|
|
|
574
606
|
/**
|
|
575
607
|
* Ability to show citations on your RAG result.
|
|
576
608
|
*/
|
|
577
|
-
CONVERSATIONAL_SEARCH = "conversational_search"
|
|
609
|
+
CONVERSATIONAL_SEARCH = "conversational_search",
|
|
610
|
+
/**
|
|
611
|
+
* Displays a preview card that can take the user flow to a workspace view.
|
|
612
|
+
*/
|
|
613
|
+
PREVIEW_CARD = "preview_card"
|
|
578
614
|
}
|
|
579
615
|
/**
|
|
580
616
|
* These are the human agent specific message types.
|
|
@@ -683,6 +719,53 @@ interface ItemStreamingMetadata {
|
|
|
683
719
|
stream_stopped?: boolean;
|
|
684
720
|
}
|
|
685
721
|
|
|
722
|
+
/**
|
|
723
|
+
* A chain of thought step is meant to show tool calls and other steps made by your agent
|
|
724
|
+
* to reach its final answer.
|
|
725
|
+
*
|
|
726
|
+
* @category Messaging
|
|
727
|
+
*/
|
|
728
|
+
interface ChainOfThoughtStep {
|
|
729
|
+
/**
|
|
730
|
+
* The plain text name of the step.
|
|
731
|
+
*/
|
|
732
|
+
title?: string;
|
|
733
|
+
/**
|
|
734
|
+
* An optional human readable description of what the tool does.
|
|
735
|
+
*
|
|
736
|
+
* Accepts markdown formatted text.
|
|
737
|
+
*/
|
|
738
|
+
description?: string;
|
|
739
|
+
/**
|
|
740
|
+
* The plain text name of the tool called.
|
|
741
|
+
*/
|
|
742
|
+
tool_name?: string;
|
|
743
|
+
/**
|
|
744
|
+
* Optional request metadata sent to a tool.
|
|
745
|
+
*/
|
|
746
|
+
request?: {
|
|
747
|
+
/**
|
|
748
|
+
* Arguments sent to the tool. If this is properly formed JSON, it will be shown as a code block.
|
|
749
|
+
*/
|
|
750
|
+
args?: unknown;
|
|
751
|
+
};
|
|
752
|
+
/**
|
|
753
|
+
* Optional response from a tool.
|
|
754
|
+
*/
|
|
755
|
+
response?: {
|
|
756
|
+
/**
|
|
757
|
+
* Content returned by the tool. If this is properly formed JSON, it will be shown as a code block.
|
|
758
|
+
*
|
|
759
|
+
* You can also return markdown compatible text here.
|
|
760
|
+
*/
|
|
761
|
+
content: unknown;
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* Optionally, share the status of this step. An icon will appear in the view showing the status. If no status is
|
|
765
|
+
* shared, the UI will assume success.
|
|
766
|
+
*/
|
|
767
|
+
status?: ChainOfThoughtStepStatus;
|
|
768
|
+
}
|
|
686
769
|
/**
|
|
687
770
|
* Options that control additional features available for a message item.
|
|
688
771
|
*
|
|
@@ -806,7 +889,7 @@ interface BaseGenericItem<TUserDefinedType = Record<string, unknown>> {
|
|
|
806
889
|
*
|
|
807
890
|
* @category Messaging
|
|
808
891
|
*/
|
|
809
|
-
type GenericItem<TUserDefinedType = Record<string, unknown>> = TextItem<TUserDefinedType> | OptionItem<TUserDefinedType> | ConnectToHumanAgentItem<TUserDefinedType> | ImageItem<TUserDefinedType> | PauseItem<TUserDefinedType> | UserDefinedItem<TUserDefinedType> | IFrameItem<TUserDefinedType> | VideoItem<TUserDefinedType> | AudioItem<TUserDefinedType> | DateItem<TUserDefinedType> | InlineErrorItem<TUserDefinedType> | CardItem<TUserDefinedType> | CarouselItem<TUserDefinedType> | ButtonItem<TUserDefinedType> | GridItem<TUserDefinedType> | ConversationalSearchItem<TUserDefinedType>;
|
|
892
|
+
type GenericItem<TUserDefinedType = Record<string, unknown>> = TextItem<TUserDefinedType> | OptionItem<TUserDefinedType> | ConnectToHumanAgentItem<TUserDefinedType> | ImageItem<TUserDefinedType> | PauseItem<TUserDefinedType> | UserDefinedItem<TUserDefinedType> | IFrameItem<TUserDefinedType> | VideoItem<TUserDefinedType> | AudioItem<TUserDefinedType> | DateItem<TUserDefinedType> | InlineErrorItem<TUserDefinedType> | CardItem<TUserDefinedType> | CarouselItem<TUserDefinedType> | ButtonItem<TUserDefinedType> | GridItem<TUserDefinedType> | ConversationalSearchItem<TUserDefinedType> | PreviewCardItem<TUserDefinedType>;
|
|
810
893
|
/**
|
|
811
894
|
* A user defined item returned in a message response from an assistant.
|
|
812
895
|
*
|
|
@@ -818,6 +901,25 @@ interface UserDefinedItem<TUserDefinedType = Record<string, unknown>> extends Ba
|
|
|
818
901
|
*/
|
|
819
902
|
full_width?: boolean;
|
|
820
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* This message item represents a preview card that can trigger a workflow view.
|
|
906
|
+
*
|
|
907
|
+
* @category Messaging
|
|
908
|
+
*/
|
|
909
|
+
interface PreviewCardItem<TUserDefinedType = Record<string, unknown>> extends BaseGenericItem<TUserDefinedType> {
|
|
910
|
+
/**
|
|
911
|
+
* The title of the preview card.
|
|
912
|
+
*/
|
|
913
|
+
title?: string;
|
|
914
|
+
/**
|
|
915
|
+
* The subtitle of the preview card.
|
|
916
|
+
*/
|
|
917
|
+
subtitle?: string;
|
|
918
|
+
/**
|
|
919
|
+
* Additional data to be passed to workspace.
|
|
920
|
+
*/
|
|
921
|
+
additional_data?: any;
|
|
922
|
+
}
|
|
821
923
|
/**
|
|
822
924
|
* A text item returned in a message response from an assistant.
|
|
823
925
|
*
|
|
@@ -2458,6 +2560,22 @@ declare enum BusEventType {
|
|
|
2458
2560
|
* Fired after a custom panel closes.
|
|
2459
2561
|
*/
|
|
2460
2562
|
CUSTOM_PANEL_CLOSE = "customPanel:close",
|
|
2563
|
+
/**
|
|
2564
|
+
* Fired before a workspace opens.
|
|
2565
|
+
*/
|
|
2566
|
+
WORKSPACE_PRE_OPEN = "workspace:pre:open",
|
|
2567
|
+
/**
|
|
2568
|
+
* Fired after a workspace opens.
|
|
2569
|
+
*/
|
|
2570
|
+
WORKSPACE_OPEN = "workspace:open",
|
|
2571
|
+
/**
|
|
2572
|
+
* Fired before a workspace closes.
|
|
2573
|
+
*/
|
|
2574
|
+
WORKSPACE_PRE_CLOSE = "workspace:pre:close",
|
|
2575
|
+
/**
|
|
2576
|
+
* Fired after a workspace closes.
|
|
2577
|
+
*/
|
|
2578
|
+
WORKSPACE_CLOSE = "workspace:close",
|
|
2461
2579
|
/**
|
|
2462
2580
|
* This event is fired before Carbon AI Chat processes a message received from a human agent from a service desk.
|
|
2463
2581
|
* You can use this to filter messages before they are displayed to the end user.
|
|
@@ -2568,11 +2686,6 @@ declare enum MessageSendSource {
|
|
|
2568
2686
|
* The user selected a value from a dropdown for an option response.
|
|
2569
2687
|
*/
|
|
2570
2688
|
OPTION_DROP_DOWN = "optionDropDown",
|
|
2571
|
-
/**
|
|
2572
|
-
* The message was sent as an automatic re-send when Carbon AI Chat is loaded. This occurs when Carbon AI Chat sees that the
|
|
2573
|
-
* last message request did not receive a response.
|
|
2574
|
-
*/
|
|
2575
|
-
HYDRATE_RESEND = "hydrateResend",
|
|
2576
2689
|
/**
|
|
2577
2690
|
* The message was sent as an event history update.
|
|
2578
2691
|
*/
|
|
@@ -2913,6 +3026,74 @@ interface BusEventCustomPanelPreClose extends BusEvent {
|
|
|
2913
3026
|
interface BusEventCustomPanelClose extends BusEvent {
|
|
2914
3027
|
type: BusEventType.CUSTOM_PANEL_CLOSE;
|
|
2915
3028
|
}
|
|
3029
|
+
/**
|
|
3030
|
+
* @category Events
|
|
3031
|
+
* @experimental
|
|
3032
|
+
*/
|
|
3033
|
+
interface BusEventWorkspacePreOpen extends BusEvent {
|
|
3034
|
+
type: BusEventType.WORKSPACE_PRE_OPEN;
|
|
3035
|
+
data: {
|
|
3036
|
+
/**
|
|
3037
|
+
* The individual message item that is being displayed in this custom response.
|
|
3038
|
+
*/
|
|
3039
|
+
message: GenericItem;
|
|
3040
|
+
/**
|
|
3041
|
+
* The full message response that contains the message item.
|
|
3042
|
+
*/
|
|
3043
|
+
fullMessage: MessageResponse;
|
|
3044
|
+
};
|
|
3045
|
+
}
|
|
3046
|
+
/**
|
|
3047
|
+
* @category Events
|
|
3048
|
+
* @experimental
|
|
3049
|
+
*/
|
|
3050
|
+
interface BusEventWorkspaceOpen extends BusEvent {
|
|
3051
|
+
type: BusEventType.WORKSPACE_OPEN;
|
|
3052
|
+
data: {
|
|
3053
|
+
/**
|
|
3054
|
+
* The individual message item that is being displayed in this custom response.
|
|
3055
|
+
*/
|
|
3056
|
+
message: GenericItem;
|
|
3057
|
+
/**
|
|
3058
|
+
* The full message response that contains the message item.
|
|
3059
|
+
*/
|
|
3060
|
+
fullMessage: MessageResponse;
|
|
3061
|
+
};
|
|
3062
|
+
}
|
|
3063
|
+
/**
|
|
3064
|
+
* @category Events
|
|
3065
|
+
* @experimental
|
|
3066
|
+
*/
|
|
3067
|
+
interface BusEventWorkspacePreClose extends BusEvent {
|
|
3068
|
+
type: BusEventType.WORKSPACE_PRE_CLOSE;
|
|
3069
|
+
data: {
|
|
3070
|
+
/**
|
|
3071
|
+
* The individual message item that is being displayed in this custom response.
|
|
3072
|
+
*/
|
|
3073
|
+
message: GenericItem;
|
|
3074
|
+
/**
|
|
3075
|
+
* The full message response that contains the message item.
|
|
3076
|
+
*/
|
|
3077
|
+
fullMessage: MessageResponse;
|
|
3078
|
+
};
|
|
3079
|
+
}
|
|
3080
|
+
/**
|
|
3081
|
+
* @category Events
|
|
3082
|
+
* @experimental
|
|
3083
|
+
*/
|
|
3084
|
+
interface BusEventWorkspaceClose extends BusEvent {
|
|
3085
|
+
type: BusEventType.WORKSPACE_CLOSE;
|
|
3086
|
+
data: {
|
|
3087
|
+
/**
|
|
3088
|
+
* The individual message item that is being displayed in this custom response.
|
|
3089
|
+
*/
|
|
3090
|
+
message: GenericItem;
|
|
3091
|
+
/**
|
|
3092
|
+
* The full message response that contains the message item.
|
|
3093
|
+
*/
|
|
3094
|
+
fullMessage: MessageResponse;
|
|
3095
|
+
};
|
|
3096
|
+
}
|
|
2916
3097
|
/**
|
|
2917
3098
|
* This event is fired before the user is connected to a service desk. This occurs as soon as the user clicks the
|
|
2918
3099
|
* "Request agent" button and before any attempt is made to communicate with the service desk.
|
|
@@ -3669,6 +3850,10 @@ interface PublicConfig {
|
|
|
3669
3850
|
* Sets the chat into a read only mode for displaying old conversations.
|
|
3670
3851
|
*/
|
|
3671
3852
|
isReadonly?: boolean;
|
|
3853
|
+
/**
|
|
3854
|
+
* Allows for feedback to persist in all messages, not just the latest message.
|
|
3855
|
+
*/
|
|
3856
|
+
persistFeedback?: boolean;
|
|
3672
3857
|
/**
|
|
3673
3858
|
* Sets the name of the assistant. Defaults to "watsonx". Used in screen reader announcements and error messages.
|
|
3674
3859
|
*/
|
|
@@ -4070,6 +4255,18 @@ interface ChatInstance extends EventHandlers, ChatActions {
|
|
|
4070
4255
|
* Manager for accessing and controlling custom panels.
|
|
4071
4256
|
*/
|
|
4072
4257
|
customPanels?: CustomPanels;
|
|
4258
|
+
/**
|
|
4259
|
+
* Enables/Disables Workspace Panel animations.
|
|
4260
|
+
*
|
|
4261
|
+
* @experimental
|
|
4262
|
+
*/
|
|
4263
|
+
updateWorkspaceAnimationBehaviour: (isDisabled: boolean) => void;
|
|
4264
|
+
/**
|
|
4265
|
+
* Manages the position of the workspace panel.
|
|
4266
|
+
*
|
|
4267
|
+
* @experimental
|
|
4268
|
+
*/
|
|
4269
|
+
updateWorkspacePosition: (preferredLocation: "start" | "end") => void;
|
|
4073
4270
|
}
|
|
4074
4271
|
/**
|
|
4075
4272
|
* This is the state made available by calling {@link ChatInstance.getState}. This is a public method that returns immutable values.
|
|
@@ -4091,6 +4288,19 @@ interface PublicDefaultCustomPanelState {
|
|
|
4091
4288
|
/** Indicates if the default custom panel overlay is currently open. */
|
|
4092
4289
|
isOpen: boolean;
|
|
4093
4290
|
}
|
|
4291
|
+
/**
|
|
4292
|
+
* Represents public state for workspace custom panel.
|
|
4293
|
+
*
|
|
4294
|
+
* @category Instance
|
|
4295
|
+
*/
|
|
4296
|
+
interface PublicWorkspaceCustomPanelState {
|
|
4297
|
+
/** Indicates if the workspace custom panel overlay is currently open. */
|
|
4298
|
+
isOpen: boolean;
|
|
4299
|
+
/**
|
|
4300
|
+
* Config options for the workspace panels.
|
|
4301
|
+
*/
|
|
4302
|
+
options: WorkspaceCustomPanelConfigOptions;
|
|
4303
|
+
}
|
|
4094
4304
|
/**
|
|
4095
4305
|
* Represents public state for each supported custom panel variant.
|
|
4096
4306
|
*
|
|
@@ -4099,6 +4309,12 @@ interface PublicDefaultCustomPanelState {
|
|
|
4099
4309
|
interface PublicCustomPanelsState {
|
|
4100
4310
|
/** State for the default overlay-style custom panel. */
|
|
4101
4311
|
default: PublicDefaultCustomPanelState;
|
|
4312
|
+
/**
|
|
4313
|
+
* State for the workspace custom panel.
|
|
4314
|
+
*
|
|
4315
|
+
* @experimental
|
|
4316
|
+
*/
|
|
4317
|
+
workspace: PublicWorkspaceCustomPanelState;
|
|
4102
4318
|
}
|
|
4103
4319
|
/**
|
|
4104
4320
|
* Type returned by {@link ChatInstance.getState}.
|
|
@@ -4123,6 +4339,13 @@ type PublicChatState = Readonly<Omit<PersistedState, "humanAgentState"> & {
|
|
|
4123
4339
|
* Counter that indicates if the chat is hydrating and a full screen loading state should be displayed.
|
|
4124
4340
|
*/
|
|
4125
4341
|
isHydratingCounter: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* The message id of the currently active response. The "active response" is the latest response that has been
|
|
4344
|
+
* received or is expected. For instance, if you send another message the current activeResponseId will be set to
|
|
4345
|
+
* null until you get a new response back. This is meant to be used to disable any user inputs in a user_defined
|
|
4346
|
+
* response that you don't want active if its not a message you should be receiving inputs from.
|
|
4347
|
+
*/
|
|
4348
|
+
activeResponseId: string | null;
|
|
4126
4349
|
/**
|
|
4127
4350
|
* @experimental State representing the main input surface.
|
|
4128
4351
|
*/
|
|
@@ -4381,7 +4604,11 @@ declare enum WriteableElementName {
|
|
|
4381
4604
|
/**
|
|
4382
4605
|
* An element to be housed in the custom panel.
|
|
4383
4606
|
*/
|
|
4384
|
-
CUSTOM_PANEL_ELEMENT = "customPanelElement"
|
|
4607
|
+
CUSTOM_PANEL_ELEMENT = "customPanelElement",
|
|
4608
|
+
/**
|
|
4609
|
+
* An element to be housed in the custom panel.
|
|
4610
|
+
*/
|
|
4611
|
+
WORKSPACE_PANEL_ELEMENT = "workspacePanelElement"
|
|
4385
4612
|
}
|
|
4386
4613
|
/**
|
|
4387
4614
|
* @category Instance
|
|
@@ -4552,6 +4779,7 @@ declare class ChatContainer extends LitElement {
|
|
|
4552
4779
|
* The chat instance.
|
|
4553
4780
|
*/
|
|
4554
4781
|
_instance: ChatInstance;
|
|
4782
|
+
firstUpdated(): void;
|
|
4555
4783
|
/**
|
|
4556
4784
|
* Adds the slot attribute to the element for the user_defined response type and then injects it into the component by
|
|
4557
4785
|
* updating this._userDefinedSlotNames;
|
|
@@ -4692,5 +4920,5 @@ interface ChatContainerProps extends PublicConfig {
|
|
|
4692
4920
|
renderWriteableElements?: RenderWriteableElementResponse;
|
|
4693
4921
|
}
|
|
4694
4922
|
|
|
4695
|
-
export { LayoutCustomProperties as L, PageObjectId as P,
|
|
4696
|
-
export type {
|
|
4923
|
+
export { LayoutCustomProperties as L, PageObjectId as P, OnErrorType as aA, HumanAgentsOnlineStatus as aH, ErrorType as aL, FileStatusValue as aM, ScreenShareState as aO, BusEventType as ac, FeedbackInteractionType as ae, MessageSendSource as af, ViewChangeReason as ag, CancellationReason as an, CarbonTheme as aq, enLanguagePack as at, MinimizeButtonIconType as ay, UserType as b$, ButtonItemKind as b3, ButtonItemType as b4, MessageResponseTypes as bB, OptionItemPreference as bD, WidthOptions as bL, HumanAgentMessageType as bP, ReasoningStepOpenState as bT, IFrameItemDisplayOption as bm, MessageInputType as bw, ViewType as c, MessageErrorState as c1, PanelType as g, WriteableElementName as t, CornersType as v, loadAllLazyDeps as w };
|
|
4924
|
+
export type { BusEventWorkspacePreClose as $, BusEventHumanAgentPreEndChat as A, BusEventViewPreChange as B, ChatContainerProps as C, DefaultCustomPanelConfigOptions as D, EventBusHandler as E, FileUploadCapabilities as F, BusEventHumanAgentPreReceive as G, BusEventHumanAgentPreSend as H, IncreaseOrDecrease as I, BusEventHumanAgentPreStartChat as J, BusEventHumanAgentReceive as K, BusEventHumanAgentSend as M, BusEventChatReady as N, BusEventChunkUserDefinedResponse as O, BusEventClosePanelButtonClicked as Q, BusEventCustomPanelClose as R, SendOptions as S, TestId as T, BusEventCustomPanelOpen as U, ViewState as V, WorkspaceCustomPanelConfigOptions as W, BusEventCustomPanelPreClose as X, BusEventCustomPanelPreOpen as Y, BusEventWorkspaceClose as Z, BusEventWorkspaceOpen as _, ChatInstance as a, ResponseUserProfile as a$, BusEventWorkspacePreOpen as a0, BusEventFeedback as a1, BusEventHistoryBegin as a2, BusEventHistoryEnd as a3, BusEventMessageItemCustom as a4, BusEventPreReceive as a5, BusEventPreReset as a6, BusEventPreSend as a7, BusEventReceive as a8, BusEventReset as a9, PublicConfig as aB, PublicConfigMessaging as aC, DeepPartial as aD, ObjectMap as aE, AdditionalDataToAgent as aF, AgentAvailability as aG, ConnectingErrorInfo as aI, DisconnectedErrorInfo as aJ, EndChatInfo as aK, FileUpload as aN, ServiceDesk as aP, ServiceDeskCallback as aQ, ServiceDeskCapabilities as aR, ServiceDeskErrorInfo as aS, ServiceDeskFactoryParameters as aT, ServiceDeskPublicConfig as aU, StartChatOptions as aV, UserMessageErrorInfo as aW, BaseGenericItem as aX, MessageResponseOptions as aY, MessageResponseHistory as aZ, MessageRequestHistory as a_, BusEventSend as aa, BusEventStateChange as ab, BusEventUserDefinedResponse as ad, PersistedState as ah, PersistedHumanAgentState as ai, HomeScreenConfig as aj, HomeScreenStarterButton as ak, HomeScreenStarterButtons as al, HomeScreenState as am, ChatInstanceMessaging as ao, CustomSendMessageOptions as ap, CustomMenuOption as ar, DisclaimerPublicConfig as as, HeaderConfig as au, InputConfig as av, LanguagePack as aw, LayoutConfig as ax, OnErrorData as az, BusEventViewChange as b, AudioItem as b0, BaseMessageInput as b1, ButtonItem as b2, CardItem as b5, CarouselItem as b6, Chunk as b7, CompleteItemChunk as b8, ConnectToHumanAgentItem as b9, MessageResponse as bA, OptionItem as bC, PartialItemChunk as bE, PauseItem as bF, StreamChunk as bG, TextItem as bH, UserDefinedItem as bI, VerticalCellAlignment as bJ, VideoItem as bK, WithBodyAndFooter as bM, WithWidthOptions as bN, SingleOption as bO, ChainOfThoughtStep as bQ, ReasoningSteps as bR, ReasoningStep as bS, GenericItemMessageFeedbackOptions as bU, GenericItemMessageOptions as bV, Message as bW, PartialOrCompleteItemChunk as bX, PartialResponse as bY, MessageHistoryFeedback as bZ, SearchResult as b_, ConnectToHumanAgentItemTransferInfo as ba, ConversationalSearchItem as bb, ConversationalSearchItemCitation as bc, DateItem as bd, EventInput as be, EventInputData as bf, FinalResponseChunk as bg, GenericItem as bh, GenericItemMessageFeedbackCategories as bi, GridItem as bj, HorizontalCellAlignment as bk, IFrameItem as bl, ImageItem as bn, InlineErrorItem as bo, ItemStreamingMetadata as bp, MediaItem as bq, MediaItemDimensions as br, MediaSubtitleTrack as bs, MediaTranscript as bt, MediaFileAccessibility as bu, MessageInput as bv, MessageItemPanelInfo as bx, MessageOutput as by, MessageRequest as bz, HistoryItem as c0, LauncherCallToActionConfig as c2, LauncherConfig as c3, CdsAiChatContainerAttributes as c4, CdsAiChatCustomElementAttributes as c5, RenderUserDefinedResponse as c6, RenderUserDefinedState as c7, RenderWriteableElementResponse as c8, ChatHeaderConfig as d, CustomPanelConfigOptions as e, CustomPanelInstance as f, CustomPanels as h, CustomPanelOpenOptions as i, ChangeFunction as j, ChatInstanceInput as k, ChatInstanceServiceDeskActions as l, EventHandlers as m, PublicInputState as n, PublicCustomPanelsState as o, PublicDefaultCustomPanelState as p, PublicChatHumanAgentState as q, PublicChatState as r, TypeAndHandler as s, WriteableElements as u, BusEvent as x, BusEventHumanAgentAreAnyAgentsOnline as y, BusEventHumanAgentEndChat as z };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export {
|
|
1
|
+
export { aF as AdditionalDataToAgent, aG as AgentAvailability, b0 as AudioItem, aX as BaseGenericItem, b1 as BaseMessageInput, x as BusEvent, N as BusEventChatReady, O as BusEventChunkUserDefinedResponse, Q as BusEventClosePanelButtonClicked, R as BusEventCustomPanelClose, U as BusEventCustomPanelOpen, X as BusEventCustomPanelPreClose, Y as BusEventCustomPanelPreOpen, a1 as BusEventFeedback, a2 as BusEventHistoryBegin, a3 as BusEventHistoryEnd, y as BusEventHumanAgentAreAnyAgentsOnline, z as BusEventHumanAgentEndChat, A as BusEventHumanAgentPreEndChat, G as BusEventHumanAgentPreReceive, H as BusEventHumanAgentPreSend, J as BusEventHumanAgentPreStartChat, K as BusEventHumanAgentReceive, M as BusEventHumanAgentSend, a4 as BusEventMessageItemCustom, a5 as BusEventPreReceive, a6 as BusEventPreReset, a7 as BusEventPreSend, a8 as BusEventReceive, a9 as BusEventReset, aa as BusEventSend, ab as BusEventStateChange, ac as BusEventType, ad as BusEventUserDefinedResponse, b as BusEventViewChange, B as BusEventViewPreChange, Z as BusEventWorkspaceClose, _ as BusEventWorkspaceOpen, $ as BusEventWorkspacePreClose, a0 as BusEventWorkspacePreOpen, b2 as ButtonItem, b3 as ButtonItemKind, b4 as ButtonItemType, an as CancellationReason, aq as CarbonTheme, b5 as CardItem, b6 as CarouselItem, c4 as CdsAiChatContainerAttributes, c5 as CdsAiChatCustomElementAttributes, bQ as ChainOfThoughtStep, j as ChangeFunction, d as ChatHeaderConfig, a as ChatInstance, k as ChatInstanceInput, ao as ChatInstanceMessaging, l as ChatInstanceServiceDeskActions, b7 as Chunk, b8 as CompleteItemChunk, b9 as ConnectToHumanAgentItem, ba as ConnectToHumanAgentItemTransferInfo, aI as ConnectingErrorInfo, bb as ConversationalSearchItem, bc as ConversationalSearchItemCitation, v as CornersType, ar as CustomMenuOption, e as CustomPanelConfigOptions, f as CustomPanelInstance, i as CustomPanelOpenOptions, h as CustomPanels, ap as CustomSendMessageOptions, bd as DateItem, aD as DeepPartial, D as DefaultCustomPanelConfigOptions, as as DisclaimerPublicConfig, aJ as DisconnectedErrorInfo, aK as EndChatInfo, aL as ErrorType, E as EventBusHandler, m as EventHandlers, be as EventInput, bf as EventInputData, ae as FeedbackInteractionType, aM as FileStatusValue, aN as FileUpload, F as FileUploadCapabilities, bg as FinalResponseChunk, bh as GenericItem, bi as GenericItemMessageFeedbackCategories, bU as GenericItemMessageFeedbackOptions, bV as GenericItemMessageOptions, bj as GridItem, au as HeaderConfig, c0 as HistoryItem, aj as HomeScreenConfig, ak as HomeScreenStarterButton, al as HomeScreenStarterButtons, am as HomeScreenState, bk as HorizontalCellAlignment, bP as HumanAgentMessageType, aH as HumanAgentsOnlineStatus, bl as IFrameItem, bm as IFrameItemDisplayOption, bn as ImageItem, I as IncreaseOrDecrease, bo as InlineErrorItem, av as InputConfig, bp as ItemStreamingMetadata, aw as LanguagePack, c2 as LauncherCallToActionConfig, c3 as LauncherConfig, ax as LayoutConfig, L as LayoutCustomProperties, bu as MediaFileAccessibility, bq as MediaItem, br as MediaItemDimensions, bs as MediaSubtitleTrack, bt as MediaTranscript, bW as Message, c1 as MessageErrorState, bZ as MessageHistoryFeedback, bv as MessageInput, bw as MessageInputType, bx as MessageItemPanelInfo, by as MessageOutput, bz as MessageRequest, a_ as MessageRequestHistory, bA as MessageResponse, aZ as MessageResponseHistory, aY as MessageResponseOptions, bB as MessageResponseTypes, af as MessageSendSource, ay as MinimizeButtonIconType, aE as ObjectMap, az as OnErrorData, aA as OnErrorType, bC as OptionItem, bD as OptionItemPreference, P as PageObjectId, g as PanelType, bE as PartialItemChunk, bX as PartialOrCompleteItemChunk, bY as PartialResponse, bF as PauseItem, ai as PersistedHumanAgentState, ah as PersistedState, q as PublicChatHumanAgentState, r as PublicChatState, aB as PublicConfig, aC as PublicConfigMessaging, o as PublicCustomPanelsState, p as PublicDefaultCustomPanelState, n as PublicInputState, bS as ReasoningStep, bT as ReasoningStepOpenState, bR as ReasoningSteps, c6 as RenderUserDefinedResponse, c7 as RenderUserDefinedState, c8 as RenderWriteableElementResponse, a$ as ResponseUserProfile, aO as ScreenShareState, b_ as SearchResult, S as SendOptions, aP as ServiceDesk, aQ as ServiceDeskCallback, aR as ServiceDeskCapabilities, aS as ServiceDeskErrorInfo, aT as ServiceDeskFactoryParameters, aU as ServiceDeskPublicConfig, bO as SingleOption, aV as StartChatOptions, bG as StreamChunk, T as TestId, bH as TextItem, s as TypeAndHandler, bI as UserDefinedItem, aW as UserMessageErrorInfo, b$ as UserType, bJ as VerticalCellAlignment, bK as VideoItem, ag as ViewChangeReason, V as ViewState, c as ViewType, bL as WidthOptions, bM as WithBodyAndFooter, bN as WithWidthOptions, W as WorkspaceCustomPanelConfigOptions, t as WriteableElementName, u as WriteableElements, at as enLanguagePack, w as loadAllLazyDeps } from './serverEntry-CwwZQCSX.js';
|
|
2
|
+
export { ChainOfThoughtStepStatus } from '@carbon/ai-chat-components/es/components/chain-of-thought/defs.js';
|
|
3
3
|
import '@carbon/web-components/es/components/button/defs.js';
|
|
4
4
|
import '@carbon/ai-chat-components/es/react/chat-button.js';
|
|
5
5
|
import 'react';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@carbon/ai-chat",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0-rc.0",
|
|
4
4
|
"description": "Be sure to review the [chat documentation](https://chat.carbondesignsystem.com/tag/latest/docs/documents/Overview.html).",
|
|
5
5
|
"author": "IBM Corp",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
],
|
|
74
74
|
"devDependencies": {
|
|
75
75
|
"@carbon/icons": "^11.53.0",
|
|
76
|
-
"@carbon/styles": "^1.
|
|
76
|
+
"@carbon/styles": "^1.97.0",
|
|
77
77
|
"@carbon/themes": "^11.58.0",
|
|
78
78
|
"@carbon/web-components": "^2.46.0",
|
|
79
79
|
"@open-wc/testing": "4.0.0",
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
"react-dom": ">=17.0.0 <20.0.0"
|
|
127
127
|
},
|
|
128
128
|
"dependencies": {
|
|
129
|
-
"@carbon/ai-chat-components": "^0.
|
|
129
|
+
"@carbon/ai-chat-components": "^0.7.0-rc.0",
|
|
130
130
|
"@carbon/icons": "^11.53.0",
|
|
131
131
|
"@ibm/telemetry-js": "^1.10.2",
|
|
132
132
|
"@lit/react": "^1.0.6",
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
"postinstall": "ibmtelemetry --config=telemetry.yml",
|
|
151
151
|
"start": "concurrently \"rollup -c ./tasks/rollup.aichat.js --watch\" \"typedoc --watch\" \"serve dist/docs/carbon-tsdocs -l 5001 --no-port-switching\" \"wait-on dist/docs/carbon-tsdocs/index.html && open http://localhost:5001\"",
|
|
152
152
|
"telemetry:config": "npx -y @ibm/telemetry-js-config-generator generate --id ef967584-5788-47d4-b9c2-a60da7ad901d --endpoint https://www-api.ibm.com/ibm-telemetry/v1/metrics --files ./src --wc",
|
|
153
|
-
"test": "jest"
|
|
153
|
+
"test": "jest --coverage --coverageReporters=text --coverageReporters=text-summary"
|
|
154
154
|
},
|
|
155
155
|
"repository": {
|
|
156
156
|
"type": "git",
|
|
@@ -160,5 +160,5 @@
|
|
|
160
160
|
"url": "https://github.com/carbon-design-system/carbon-ai-chat/issues"
|
|
161
161
|
},
|
|
162
162
|
"homepage": "https://github.com/carbon-design-system/carbon-ai-chat#readme",
|
|
163
|
-
"gitHead": "
|
|
163
|
+
"gitHead": "fde578d5343672ba3de865111276032df5d37476"
|
|
164
164
|
}
|