pika-shared 1.0.2 → 1.2.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/types/chatbot/chatbot-types.d.mts +815 -35
- package/dist/types/chatbot/chatbot-types.d.ts +815 -35
- package/dist/types/chatbot/chatbot-types.js +44 -4
- package/dist/types/chatbot/chatbot-types.js.map +1 -1
- package/dist/types/chatbot/chatbot-types.mjs +38 -5
- package/dist/types/chatbot/chatbot-types.mjs.map +1 -1
- package/dist/util/instruction-assistance-utils.d.mts +49 -0
- package/dist/util/instruction-assistance-utils.d.ts +49 -0
- package/dist/util/instruction-assistance-utils.js +133 -0
- package/dist/util/instruction-assistance-utils.js.map +1 -0
- package/dist/util/instruction-assistance-utils.mjs +129 -0
- package/dist/util/instruction-assistance-utils.mjs.map +1 -0
- package/dist/util/server-client-utils.d.mts +17 -1
- package/dist/util/server-client-utils.d.ts +17 -1
- package/dist/util/server-client-utils.js +63 -0
- package/dist/util/server-client-utils.js.map +1 -1
- package/dist/util/server-client-utils.mjs +62 -1
- package/dist/util/server-client-utils.mjs.map +1 -1
- package/package.json +8 -1
- package/readme.md +8 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Trace, RetrievalFilter, FunctionDefinition } from '@aws-sdk/client-bedrock-agent-runtime';
|
|
1
|
+
import { Trace, AgentCollaboration, RetrievalFilter, FunctionDefinition } from '@aws-sdk/client-bedrock-agent-runtime';
|
|
2
2
|
|
|
3
3
|
type CompanyType = 'retailer' | 'supplier';
|
|
4
4
|
/**
|
|
@@ -41,6 +41,8 @@ interface ChatSession<T extends RecordOrUndef = undefined> {
|
|
|
41
41
|
chatAppId: string;
|
|
42
42
|
/** Unique identifier for the user's identity */
|
|
43
43
|
identityId: string;
|
|
44
|
+
/** Mode of the invocation of the agent */
|
|
45
|
+
invocationMode: ConverseInvocationMode;
|
|
44
46
|
/** Title or name of the chat session */
|
|
45
47
|
title?: string;
|
|
46
48
|
/** ID of the most recent message in the session */
|
|
@@ -493,6 +495,8 @@ interface ChatUserLite {
|
|
|
493
495
|
*/
|
|
494
496
|
interface AuthenticatedUser<T extends RecordOrUndef = undefined, U extends RecordOrUndef = undefined> extends ChatUser<U> {
|
|
495
497
|
authData?: T;
|
|
498
|
+
/** ISO 8601 timestamp of when ChatUser data was last refreshed from DynamoDB (the pikaframework sets this) */
|
|
499
|
+
lastChatUserRefresh?: string;
|
|
496
500
|
}
|
|
497
501
|
/**
|
|
498
502
|
* This is a simplified version of AuthenticatedUser that is used for auth headers.
|
|
@@ -584,6 +588,27 @@ interface ChatAppOverridableFeatures {
|
|
|
584
588
|
showUserRegionInLeftNav: boolean;
|
|
585
589
|
showChatHistoryInStandaloneMode: boolean;
|
|
586
590
|
};
|
|
591
|
+
tags?: TagsChatAppOverridableFeature;
|
|
592
|
+
agentInstructionAssistance: AgentInstructionChatAppOverridableFeature;
|
|
593
|
+
instructionAugmentation: InstructionAugmentationFeature;
|
|
594
|
+
}
|
|
595
|
+
interface AgentInstructionChatAppOverridableFeature {
|
|
596
|
+
enabled: boolean;
|
|
597
|
+
includeOutputFormattingRequirements: boolean;
|
|
598
|
+
includeInstructionsForTags: boolean;
|
|
599
|
+
completeExampleInstructionEnabled: boolean;
|
|
600
|
+
completeExampleInstructionLine?: string;
|
|
601
|
+
jsonOnlyImperativeInstructionEnabled: boolean;
|
|
602
|
+
jsonOnlyImperativeInstructionLine?: string;
|
|
603
|
+
}
|
|
604
|
+
interface InstructionAssistanceConfig {
|
|
605
|
+
outputFormattingRequirements: string;
|
|
606
|
+
tagInstructions?: string;
|
|
607
|
+
completeExampleInstructionLine: string;
|
|
608
|
+
jsonOnlyImperativeInstructionLine: string;
|
|
609
|
+
}
|
|
610
|
+
interface TagsChatAppOverridableFeature {
|
|
611
|
+
tagsEnabled: TagDefinitionLite[];
|
|
587
612
|
}
|
|
588
613
|
type ChatAppOverridableFeaturesForConverseFn = Omit<ChatAppOverridableFeatures, 'chatDisclaimerNotice' | 'traces' | 'logout' | 'suggestions' | 'promptInputFieldLabel' | 'uiCustomization' | 'fileUpload'>;
|
|
589
614
|
/**
|
|
@@ -654,17 +679,16 @@ interface BaseRequestData {
|
|
|
654
679
|
sessionId?: string;
|
|
655
680
|
chatAppId?: string;
|
|
656
681
|
agentId?: string;
|
|
657
|
-
agentAliasId?: string;
|
|
658
|
-
companyId?: string;
|
|
659
|
-
companyType?: CompanyType;
|
|
660
682
|
timezone?: string;
|
|
661
683
|
}
|
|
662
684
|
interface ConverseRequestWithCommand {
|
|
663
|
-
command: '
|
|
664
|
-
|
|
685
|
+
command: 'clearConverseLambdaCache';
|
|
686
|
+
cacheType: ClearConverseLambdaCacheType;
|
|
665
687
|
agentId?: string;
|
|
666
688
|
userId: string;
|
|
667
689
|
}
|
|
690
|
+
declare const ClearConverseLambdaCacheTypes: readonly ["agent", "tagDefinitions", "instructionAssistanceConfig", "all"];
|
|
691
|
+
type ClearConverseLambdaCacheType = (typeof ClearConverseLambdaCacheTypes)[number];
|
|
668
692
|
interface ConverseRequest extends BaseRequestData {
|
|
669
693
|
message: string;
|
|
670
694
|
/**
|
|
@@ -677,7 +701,29 @@ interface ConverseRequest extends BaseRequestData {
|
|
|
677
701
|
* It allows us to dynamically change the agent used for the conversation.
|
|
678
702
|
*/
|
|
679
703
|
agentId: string;
|
|
704
|
+
/**
|
|
705
|
+
* This is the attribute name in the user's custom data that is used to match against the entity access control lists.
|
|
706
|
+
* This is only used if the entity feature is enabled and the user has an entity associated with them.
|
|
707
|
+
*
|
|
708
|
+
* @see pika-config.ts#siteFeatures.entity.attributeName
|
|
709
|
+
*/
|
|
710
|
+
entityAttributeNameInUserCustomData?: string;
|
|
711
|
+
/**
|
|
712
|
+
* If provided, this will be used to determine the invocation mode of the converse request.
|
|
713
|
+
*
|
|
714
|
+
* If 'chat-app', then the converse request is a chat app request.
|
|
715
|
+
* If 'direct-agent-invoke', then the converse request is a direct agent invoke request and is not
|
|
716
|
+
* in the context of a chat app. Since we are adding mode after the fact, if mode is provided
|
|
717
|
+
* and it doesn't match what we expect, we will throw an error (chat-app requires that chatAppId is provided
|
|
718
|
+
* and direct-agent-invoke requires that chatAppId is not provided).
|
|
719
|
+
*
|
|
720
|
+
* If invocationMode is not provided, uses the presence or absence of chatAppId to determine the mode (if chatAppId
|
|
721
|
+
* is provided, then it's a chat app request, otherwise it's a direct agent invoke request).
|
|
722
|
+
*/
|
|
723
|
+
invocationMode?: ConverseInvocationMode;
|
|
680
724
|
}
|
|
725
|
+
declare const ConverseInvocationModes: readonly ["chat-app", "direct-agent-invoke"];
|
|
726
|
+
type ConverseInvocationMode = (typeof ConverseInvocationModes)[number];
|
|
681
727
|
interface ChatTitleUpdateRequest extends BaseRequestData {
|
|
682
728
|
/** If provided, this will be used as the title for the session */
|
|
683
729
|
title?: string;
|
|
@@ -703,6 +749,15 @@ interface SessionSearchAdminRequest {
|
|
|
703
749
|
command: 'sessionSearch';
|
|
704
750
|
search: SessionSearchRequest<RecordOrUndef>;
|
|
705
751
|
}
|
|
752
|
+
interface GetAgentRequest {
|
|
753
|
+
command: 'getAgent';
|
|
754
|
+
agentId: string;
|
|
755
|
+
}
|
|
756
|
+
interface GetAgentResponse {
|
|
757
|
+
success: boolean;
|
|
758
|
+
agent: AgentDefinition | undefined;
|
|
759
|
+
error?: string;
|
|
760
|
+
}
|
|
706
761
|
interface GetChatSessionFeedbackResponse {
|
|
707
762
|
success: boolean;
|
|
708
763
|
feedback: ChatSessionFeedback[];
|
|
@@ -956,6 +1011,10 @@ interface RolloutPolicy {
|
|
|
956
1011
|
interface AgentDefinition {
|
|
957
1012
|
/** Unique agent identifier (e.g., 'weather-bot') */
|
|
958
1013
|
agentId: string;
|
|
1014
|
+
/** Foundation model to use for this agent. */
|
|
1015
|
+
foundationModel?: string;
|
|
1016
|
+
/** Foundation model to use for verifying the response of this agent. */
|
|
1017
|
+
verificationFoundationModel?: string;
|
|
959
1018
|
/** System prompt template (can be a handlebars template with placeholders like {{user.email}}) */
|
|
960
1019
|
basePrompt: string;
|
|
961
1020
|
/** List of access control rules with conditions. If not provided, the agent will be accessible to all users. */
|
|
@@ -966,6 +1025,14 @@ interface AgentDefinition {
|
|
|
966
1025
|
rolloutPolicy?: RolloutPolicy;
|
|
967
1026
|
/** Cache configuration for testing and debugging, used in lambdas that create LRU caches for agent definitions */
|
|
968
1027
|
dontCacheThis?: boolean;
|
|
1028
|
+
/** List of collaborator agent IDs that are used to orchestrate this agent. */
|
|
1029
|
+
collaborators?: {
|
|
1030
|
+
agentId: string;
|
|
1031
|
+
instruction: string;
|
|
1032
|
+
historyRelay: 'TO_COLLABORATOR' | 'TO_AGENT';
|
|
1033
|
+
}[];
|
|
1034
|
+
/** The collaboration type for this agent. */
|
|
1035
|
+
agentCollaboration?: AgentCollaboration;
|
|
969
1036
|
/** List of tool definitions that this agent uses */
|
|
970
1037
|
toolIds: string[];
|
|
971
1038
|
/** A list of knowledge bases that are associated with this agent. */
|
|
@@ -1028,6 +1095,7 @@ interface AgentDataRequest {
|
|
|
1028
1095
|
type ToolIdToLambdaArnMap = Record<string, string>;
|
|
1029
1096
|
interface AgentAndTools {
|
|
1030
1097
|
agent: AgentDefinition;
|
|
1098
|
+
collaborators?: AgentDefinition[];
|
|
1031
1099
|
tools?: ToolDefinition[];
|
|
1032
1100
|
}
|
|
1033
1101
|
interface AgentDataResponse {
|
|
@@ -1047,7 +1115,7 @@ type AgentDefinitionForIdempotentCreateOrUpdate = Omit<AgentDefinition, 'toolIds
|
|
|
1047
1115
|
/**
|
|
1048
1116
|
* Execution type for tool definitions. Right now, only lambda is supported.
|
|
1049
1117
|
*/
|
|
1050
|
-
type ExecutionType = 'lambda' | 'http' | 'inline';
|
|
1118
|
+
type ExecutionType = 'lambda' | 'http' | 'inline' | 'mcp';
|
|
1051
1119
|
/**
|
|
1052
1120
|
* Lifecycle status for tool definitions
|
|
1053
1121
|
*/
|
|
@@ -1063,16 +1131,12 @@ interface ToolLifecycle {
|
|
|
1063
1131
|
/** Optional migration path to newer tool version */
|
|
1064
1132
|
migrationPath?: string;
|
|
1065
1133
|
}
|
|
1066
|
-
/**
|
|
1067
|
-
* JSON Schema definition
|
|
1068
|
-
*/
|
|
1069
|
-
/**
|
|
1070
|
-
* Bedrock function schema definition
|
|
1071
|
-
*/
|
|
1072
1134
|
/**
|
|
1073
1135
|
* Tool definition representing a callable function/service
|
|
1074
1136
|
*/
|
|
1075
|
-
interface
|
|
1137
|
+
interface ToolDefinitionBase {
|
|
1138
|
+
/** Type of execution (lambda, http, inline) */
|
|
1139
|
+
executionType: ExecutionType;
|
|
1076
1140
|
/** Unique tool name/version (e.g., 'weather-basic@1') */
|
|
1077
1141
|
toolId: string;
|
|
1078
1142
|
/** Friendly display name */
|
|
@@ -1081,15 +1145,8 @@ interface ToolDefinition {
|
|
|
1081
1145
|
name: string;
|
|
1082
1146
|
/** Description for LLM consumption. MUST BE LESS THAN 500 CHARACTERS */
|
|
1083
1147
|
description: string;
|
|
1084
|
-
/** Type of execution (lambda, http, inline) */
|
|
1085
|
-
executionType: ExecutionType;
|
|
1086
1148
|
/** Timeout in seconds (default: 30) */
|
|
1087
1149
|
executionTimeout?: number;
|
|
1088
|
-
/**
|
|
1089
|
-
* If executionType is 'lambda', this is the required ARN of the Lambda function.
|
|
1090
|
-
* Note that the Lambda function must have an 'agent-tool' tag set to 'true'.
|
|
1091
|
-
*/
|
|
1092
|
-
lambdaArn?: string;
|
|
1093
1150
|
/**
|
|
1094
1151
|
* List of agent frameworks that this tool supports
|
|
1095
1152
|
*
|
|
@@ -1117,18 +1174,45 @@ interface ToolDefinition {
|
|
|
1117
1174
|
/** If true, this is a test tool that will get deleted after 1 day. This is used for testing. */
|
|
1118
1175
|
test?: boolean;
|
|
1119
1176
|
}
|
|
1120
|
-
|
|
1121
|
-
|
|
1177
|
+
interface LambdaToolDefinition extends ToolDefinitionBase {
|
|
1178
|
+
executionType: 'lambda';
|
|
1179
|
+
/**
|
|
1180
|
+
* If executionType is 'lambda', this is the required ARN of the Lambda function.
|
|
1181
|
+
* Note that the Lambda function must have an 'agent-tool' tag set to 'true'.
|
|
1182
|
+
*/
|
|
1183
|
+
lambdaArn: string;
|
|
1184
|
+
}
|
|
1185
|
+
interface McpToolDefinition extends ToolDefinitionBase {
|
|
1186
|
+
executionType: 'mcp';
|
|
1187
|
+
url: string;
|
|
1188
|
+
auth?: OAuth;
|
|
1189
|
+
}
|
|
1190
|
+
type ToolDefinition = LambdaToolDefinition | McpToolDefinition;
|
|
1191
|
+
type UpdateableToolDefinitionFields = Extract<keyof ToolDefinitionBase, 'name' | 'displayName' | 'description' | 'executionType' | 'executionTimeout' | 'supportedAgentFrameworks' | 'functionSchema' | 'tags' | 'lifecycle' | 'accessRules'> | 'lambdaArn' | 'url' | 'auth';
|
|
1192
|
+
type ToolDefinitionForCreate = (Omit<LambdaToolDefinition, 'version' | 'createdAt' | 'updatedAt' | 'lastModifiedBy' | 'createdBy'> & {
|
|
1122
1193
|
toolId?: ToolDefinition['toolId'];
|
|
1123
|
-
}
|
|
1194
|
+
}) | (Omit<McpToolDefinition, 'version' | 'createdAt' | 'updatedAt' | 'lastModifiedBy' | 'createdBy'> & {
|
|
1195
|
+
toolId?: ToolDefinition['toolId'];
|
|
1196
|
+
});
|
|
1124
1197
|
type ToolDefinitionForIdempotentCreateOrUpdate = Omit<ToolDefinition, 'version' | 'createdAt' | 'updatedAt' | 'lastModifiedBy' | 'createdBy'> & {
|
|
1125
1198
|
lambdaArn: string;
|
|
1126
1199
|
functionSchema: FunctionDefinition[];
|
|
1127
1200
|
supportedAgentFrameworks: ['bedrock'];
|
|
1128
1201
|
};
|
|
1129
|
-
|
|
1202
|
+
interface OAuth {
|
|
1203
|
+
clientId: string;
|
|
1204
|
+
clientSecret: string;
|
|
1205
|
+
tokenUrl: string;
|
|
1206
|
+
token?: {
|
|
1207
|
+
accessToken: string;
|
|
1208
|
+
expires: number;
|
|
1209
|
+
};
|
|
1210
|
+
}
|
|
1211
|
+
type ToolDefinitionForUpdate = (Partial<Omit<LambdaToolDefinition, 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'lastModifiedBy'>> & {
|
|
1130
1212
|
toolId: string;
|
|
1131
|
-
}
|
|
1213
|
+
}) | (Partial<Omit<McpToolDefinition, 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'lastModifiedBy'>> & {
|
|
1214
|
+
toolId: string;
|
|
1215
|
+
});
|
|
1132
1216
|
type AgentFramework = 'bedrock';
|
|
1133
1217
|
interface CreateAgentRequest {
|
|
1134
1218
|
agent: AgentDefinitionForCreate;
|
|
@@ -1341,7 +1425,7 @@ interface ChatAppDataRequest {
|
|
|
1341
1425
|
/**
|
|
1342
1426
|
* These are the features that are available to be overridden by the chat app.
|
|
1343
1427
|
*/
|
|
1344
|
-
type ChatAppFeature = FileUploadFeatureForChatApp | SuggestionsFeatureForChatApp | PromptInputFieldLabelFeatureForChatApp | UiCustomizationFeatureForChatApp | VerifyResponseFeatureForChatApp | TracesFeatureForChatApp | ChatDisclaimerNoticeFeatureForChatApp | LogoutFeatureForChatApp | SessionInsightsFeatureForChatApp | UserDataOverrideFeatureForChatApp;
|
|
1428
|
+
type ChatAppFeature = FileUploadFeatureForChatApp | SuggestionsFeatureForChatApp | PromptInputFieldLabelFeatureForChatApp | UiCustomizationFeatureForChatApp | VerifyResponseFeatureForChatApp | TracesFeatureForChatApp | ChatDisclaimerNoticeFeatureForChatApp | LogoutFeatureForChatApp | SessionInsightsFeatureForChatApp | UserDataOverrideFeatureForChatApp | TagsFeatureForChatApp | AgentInstructionAssistanceFeatureForChatApp | InstructionAugmentationFeatureForChatApp;
|
|
1345
1429
|
interface Feature {
|
|
1346
1430
|
/**
|
|
1347
1431
|
* Must be unique, only alphanumeric and - _ allowed, may not start with a number
|
|
@@ -1352,7 +1436,7 @@ interface Feature {
|
|
|
1352
1436
|
/** Whether the feature is on or off for the chat app in question. Most features are off by default, see the specific feature for details. */
|
|
1353
1437
|
enabled: boolean;
|
|
1354
1438
|
}
|
|
1355
|
-
declare const FeatureIdList: readonly ["fileUpload", "promptInputFieldLabel", "suggestions", "uiCustomization", "verifyResponse", "traces", "chatDisclaimerNotice", "logout", "sessionInsights", "userDataOverrides"];
|
|
1439
|
+
declare const FeatureIdList: readonly ["fileUpload", "promptInputFieldLabel", "suggestions", "uiCustomization", "verifyResponse", "traces", "chatDisclaimerNotice", "logout", "sessionInsights", "userDataOverrides", "tags", "agentInstructionAssistance", "instructionAugmentation"];
|
|
1356
1440
|
type FeatureIdType = (typeof FeatureIdList)[number];
|
|
1357
1441
|
declare const EndToEndFeatureIdList: readonly ["verifyResponse", "traces"];
|
|
1358
1442
|
type EndToEndFeatureIdType = (typeof EndToEndFeatureIdList)[number];
|
|
@@ -1553,6 +1637,108 @@ interface PromptInputFieldLabelFeature {
|
|
|
1553
1637
|
interface PromptInputFieldLabelFeatureForChatApp extends PromptInputFieldLabelFeature, Feature {
|
|
1554
1638
|
featureId: 'promptInputFieldLabel';
|
|
1555
1639
|
}
|
|
1640
|
+
interface AgentInstructionAssistanceFeatureForChatApp extends Feature, AgentInstructionAssistanceFeature {
|
|
1641
|
+
featureId: 'agentInstructionAssistance';
|
|
1642
|
+
}
|
|
1643
|
+
interface InstructionAugmentationFeatureForChatApp extends InstructionAugmentationFeature, Feature {
|
|
1644
|
+
featureId: 'instructionAugmentation';
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* The prompt instruction assistance feature is used to add a markdown section to the prompt that instructs the agent on how to format its response.
|
|
1648
|
+
*
|
|
1649
|
+
* The `includeInstructionsForTags` feature is used to inject the instructions for tags into the prompt at `{{tag-instructions}}` if found in the prompt.
|
|
1650
|
+
* If not found, then the instructions will be appended to the end of the prompt. Note there is a separate feature named `tags` that is used
|
|
1651
|
+
* to define which tags are available for the agent. @see TagsFeatureForChatApp
|
|
1652
|
+
*
|
|
1653
|
+
* Thus the `tags` feature is how you decide which tags your chat app will allow. Each tag is marked as to whether it can be generated by the LLM or a tool.
|
|
1654
|
+
* So, when you turn on the AgentInstructionsAssistance feature in a chat app, pika knows which tags are available that we need to inject into the prompt.
|
|
1655
|
+
*
|
|
1656
|
+
* Note that when an agent is invoked in the context of a chat app, meaning through the pika chat app UI, the agent will be passed a
|
|
1657
|
+
* PromptInstructionAssistance object based on the features of the chat app in question. The site wide features can define the config for this feature
|
|
1658
|
+
* and the chat app can override it. So the pika front end will figure out which config is in play and pass the right value to the agent when it is
|
|
1659
|
+
* invoked.
|
|
1660
|
+
*
|
|
1661
|
+
* If the agent is invoked directly by your own custom client, you can pass in your own PromptInstructionAssistanceFeature object to specify the agent instructions
|
|
1662
|
+
* config.
|
|
1663
|
+
*
|
|
1664
|
+
* A common use case for this is to disable the includeInstructionsForTags.
|
|
1665
|
+
*/
|
|
1666
|
+
interface AgentInstructionAssistanceFeature {
|
|
1667
|
+
/**
|
|
1668
|
+
* If enabled, a markdown section titled Output Formatting Requirements will be added into your prompt. You can control where the prompt assistance language is added in
|
|
1669
|
+
* by using a replacement placeholder titled `{{prompt-assistance}}` in your prompt. If found, the prompt assistance language will be added at the location of the placeholder.
|
|
1670
|
+
* The injected prompt assistance language will first add the output formatting requirements, then the instructions for tags,
|
|
1671
|
+
* then the complete example instruction line, and finally the json only imperative instruction line.
|
|
1672
|
+
*
|
|
1673
|
+
* If `{{prompt-assistance}}` is not found, then we look for more fine-grained control by looking for these specific placeholder tags:
|
|
1674
|
+
* `{{output-formatting-requirements}}`, `{{tag-instructions}}`, `{{complete-example-instruction-line}}` and `{{json-only-imperative-instruction-line}}`. Of course,
|
|
1675
|
+
* if you haven't turned on the `includeInstructionsForTags` feature, then we will not inject the tag instructions.
|
|
1676
|
+
*
|
|
1677
|
+
* If neither `{{prompt-assistance}}` nor any of the specific placeholder tags are found, then the prompt assistance language will be appended to the end of the prompt
|
|
1678
|
+
* in this order: output formatting requirements, tag instructions, complete example instruction line, and json only imperative instruction line. If `{{prompt-assistance}}`
|
|
1679
|
+
* is not found and you did not specify all of the specific placeholder tags but you did turn on a feature that means we should inject instructions then we
|
|
1680
|
+
* will add the corresponding instructions to the end of the prompt.
|
|
1681
|
+
*
|
|
1682
|
+
* Here is what will be added to the prompt at a minimum:
|
|
1683
|
+
*
|
|
1684
|
+
* ```markdown
|
|
1685
|
+
* // If includeOutputFormattingRequirements.enabled is true
|
|
1686
|
+
* {{output-formatting-requirements}}
|
|
1687
|
+
*
|
|
1688
|
+
* // If includeInstructionsForTags.enabled is true
|
|
1689
|
+
* {{tag-instructions}}
|
|
1690
|
+
*
|
|
1691
|
+
* // If completeExampleInstructionLine.enabled is true
|
|
1692
|
+
* {{complete-example-instruction-line}}
|
|
1693
|
+
*
|
|
1694
|
+
* // If jsonOnlyImperativeInstructionLine.enabled is true
|
|
1695
|
+
* {{json-only-imperative-instruction-line}}
|
|
1696
|
+
*
|
|
1697
|
+
* ```
|
|
1698
|
+
*/
|
|
1699
|
+
enabled: boolean;
|
|
1700
|
+
/**
|
|
1701
|
+
* If enabled, basic output formatting requirements will be injected into the prompt at
|
|
1702
|
+
* `{{output-formatting-requirements}}` if found in the prompt. If not found, then the requirements will be appended to the end of the prompt.
|
|
1703
|
+
* This provides foundational formatting guidance for the agent's responses.
|
|
1704
|
+
*/
|
|
1705
|
+
includeOutputFormattingRequirements?: {
|
|
1706
|
+
enabled: boolean;
|
|
1707
|
+
};
|
|
1708
|
+
/**
|
|
1709
|
+
* If enabled, then the instructions for tags that are available for the agent will be injected into the prompt at
|
|
1710
|
+
* `{{tag-instructions}}` if found in the prompt. If not found, then the instructions will be appended to the end of the prompt.
|
|
1711
|
+
*/
|
|
1712
|
+
includeInstructionsForTags?: {
|
|
1713
|
+
enabled: boolean;
|
|
1714
|
+
};
|
|
1715
|
+
/**
|
|
1716
|
+
* If true, a line will be added to the prompt assistance language that instructs the agent to include a complete example of the tag structure.
|
|
1717
|
+
* If mdLine is provided, it will be used as the line. If mdLine is not provided, a default line will be used:
|
|
1718
|
+
*
|
|
1719
|
+
* ```markdown
|
|
1720
|
+
* `<answer>##Example markdown\nNormal text and an <image>http://some.url</image> and some **bold text**\n<chart>(...)</chart></answer>`
|
|
1721
|
+
* ```
|
|
1722
|
+
*
|
|
1723
|
+
* This will intelligenlty not include the <image> and <chart> tags in the exmaple if they are not supported in your instructions.
|
|
1724
|
+
*/
|
|
1725
|
+
completeExampleInstructionLine?: {
|
|
1726
|
+
enabled: boolean;
|
|
1727
|
+
mdLine?: string;
|
|
1728
|
+
};
|
|
1729
|
+
/**
|
|
1730
|
+
* If true, a line will be added to the prompt assistance language that instructs the agent to only respond with valid JSON.
|
|
1731
|
+
* If mdLine is provided, it will be used as the line. If mdLine is not provided, a default line will be used:
|
|
1732
|
+
*
|
|
1733
|
+
* ```markdown
|
|
1734
|
+
* BE ABSOLUTELY CERTAIN ANY JSON INCLUDED IS 100% VALID (especially for charts). Invalid JSON will break the user experience.
|
|
1735
|
+
* ```
|
|
1736
|
+
*/
|
|
1737
|
+
jsonOnlyImperativeInstructionLine?: {
|
|
1738
|
+
enabled: boolean;
|
|
1739
|
+
line?: string;
|
|
1740
|
+
};
|
|
1741
|
+
}
|
|
1556
1742
|
type SegmentType = 'text' | 'tag';
|
|
1557
1743
|
/**
|
|
1558
1744
|
* Represents the status of content being streamed into a segment.
|
|
@@ -1593,8 +1779,8 @@ interface TextMessageSegment extends MessageSegmentBase {
|
|
|
1593
1779
|
segmentType: 'text';
|
|
1594
1780
|
}
|
|
1595
1781
|
type MessageSegment = TagMessageSegment | TextMessageSegment;
|
|
1596
|
-
type SiteAdminRequest = GetInitialDataRequest | RefreshChatAppRequest | CreateOrUpdateChatAppOverrideRequest | DeleteChatAppOverrideRequest | GetValuesForEntityAutoCompleteRequest | GetValuesForUserAutoCompleteRequest |
|
|
1597
|
-
declare const SiteAdminCommand: readonly ["getInitialData", "refreshChatApp", "createOrUpdateChatAppOverride", "deleteChatAppOverride", "getValuesForEntityAutoComplete", "getValuesForUserAutoComplete", "
|
|
1782
|
+
type SiteAdminRequest = GetAgentRequest | GetInitialDataRequest | RefreshChatAppRequest | CreateOrUpdateChatAppOverrideRequest | DeleteChatAppOverrideRequest | GetValuesForEntityAutoCompleteRequest | GetValuesForUserAutoCompleteRequest | ClearConverseLambdaCacheRequest | ClearSvelteKitCachesRequest | AddChatSessionFeedbackAdminRequest | UpdateChatSessionFeedbackAdminRequest | SessionSearchAdminRequest | GetChatMessagesAsAdminRequest | CreateOrUpdateTagDefinitionAdminRequest | DeleteTagDefinitionAdminRequest | SearchTagDefinitionsAdminRequest | SearchSemanticDirectivesAdminRequest | SemanticDirectiveCreateOrUpdateAdminRequest | SemanticDirectiveDeleteAdminRequest | GetInstructionAssistanceConfigFromSsmRequest | GetAllChatAppsAdminRequest | GetAllAgentsAdminRequest | GetAllToolsAdminRequest;
|
|
1783
|
+
declare const SiteAdminCommand: readonly ["getAgent", "getInitialData", "refreshChatApp", "createOrUpdateChatAppOverride", "deleteChatAppOverride", "getValuesForEntityAutoComplete", "getValuesForUserAutoComplete", "clearConverseLambdaCache", "clearSvelteKitCaches", "addChatSessionFeedback", "updateChatSessionFeedback", "sessionSearch", "getChatMessagesAsAdmin", "createOrUpdateTagDefinition", "deleteTagDefinition", "searchTagDefinitions", "searchSemanticDirectives", "createOrUpdateSemanticDirective", "deleteSemanticDirective", "getInstructionAssistanceConfigFromSsm", "getAllChatApps", "getAllAgents", "getAllTools"];
|
|
1598
1784
|
type SiteAdminCommand = (typeof SiteAdminCommand)[number];
|
|
1599
1785
|
interface SiteAdminCommandRequestBase {
|
|
1600
1786
|
command: SiteAdminCommand;
|
|
@@ -1605,6 +1791,47 @@ interface GetChatMessagesAsAdminRequest extends SiteAdminCommandRequestBase {
|
|
|
1605
1791
|
chatAppId: string;
|
|
1606
1792
|
userId: string;
|
|
1607
1793
|
}
|
|
1794
|
+
interface CreateOrUpdateTagDefinitionAdminRequest extends SiteAdminCommandRequestBase {
|
|
1795
|
+
command: 'createOrUpdateTagDefinition';
|
|
1796
|
+
request: TagDefinitionCreateOrUpdateRequest;
|
|
1797
|
+
}
|
|
1798
|
+
interface DeleteTagDefinitionAdminRequest extends SiteAdminCommandRequestBase {
|
|
1799
|
+
command: 'deleteTagDefinition';
|
|
1800
|
+
request: TagDefinitionDeleteRequest;
|
|
1801
|
+
}
|
|
1802
|
+
interface SearchTagDefinitionsAdminRequest extends SiteAdminCommandRequestBase {
|
|
1803
|
+
command: 'searchTagDefinitions';
|
|
1804
|
+
request: TagDefinitionSearchRequest;
|
|
1805
|
+
}
|
|
1806
|
+
interface SearchSemanticDirectivesAdminRequest extends SiteAdminCommandRequestBase {
|
|
1807
|
+
command: 'searchSemanticDirectives';
|
|
1808
|
+
request: SearchSemanticDirectivesRequest;
|
|
1809
|
+
}
|
|
1810
|
+
interface SemanticDirectiveCreateOrUpdateAdminRequest extends SiteAdminCommandRequestBase {
|
|
1811
|
+
command: 'createOrUpdateSemanticDirective';
|
|
1812
|
+
request: SemanticDirectiveCreateOrUpdateRequest;
|
|
1813
|
+
}
|
|
1814
|
+
interface SemanticDirectiveDeleteAdminRequest extends SiteAdminCommandRequestBase {
|
|
1815
|
+
command: 'deleteSemanticDirective';
|
|
1816
|
+
request: SemanticDirectiveDeleteRequest;
|
|
1817
|
+
}
|
|
1818
|
+
interface GetAllChatAppsAdminRequest extends SiteAdminCommandRequestBase {
|
|
1819
|
+
command: 'getAllChatApps';
|
|
1820
|
+
}
|
|
1821
|
+
interface GetAllAgentsAdminRequest extends SiteAdminCommandRequestBase {
|
|
1822
|
+
command: 'getAllAgents';
|
|
1823
|
+
}
|
|
1824
|
+
interface GetAllToolsAdminRequest extends SiteAdminCommandRequestBase {
|
|
1825
|
+
command: 'getAllTools';
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* Request format for semantic directive data passed to custom CloudFormation resource
|
|
1829
|
+
*/
|
|
1830
|
+
type SemanticDirectiveDataRequest = {
|
|
1831
|
+
userId: string;
|
|
1832
|
+
groupId: string;
|
|
1833
|
+
semanticDirectives: SemanticDirectiveForCreateOrUpdate[];
|
|
1834
|
+
};
|
|
1608
1835
|
interface GetValuesForEntityAutoCompleteRequest extends SiteAdminCommandRequestBase {
|
|
1609
1836
|
command: 'getValuesForEntityAutoComplete';
|
|
1610
1837
|
valueProvidedByUser: string;
|
|
@@ -1637,12 +1864,35 @@ interface DeleteChatAppOverrideRequest extends SiteAdminCommandRequestBase {
|
|
|
1637
1864
|
command: 'deleteChatAppOverride';
|
|
1638
1865
|
chatAppId: string;
|
|
1639
1866
|
}
|
|
1640
|
-
interface
|
|
1641
|
-
command: '
|
|
1867
|
+
interface ClearConverseLambdaCacheRequest extends SiteAdminCommandRequestBase {
|
|
1868
|
+
command: 'clearConverseLambdaCache';
|
|
1869
|
+
cacheType: ClearConverseLambdaCacheType;
|
|
1642
1870
|
chatAppId?: string;
|
|
1643
1871
|
agentId?: string;
|
|
1644
1872
|
}
|
|
1645
|
-
|
|
1873
|
+
interface ClearSvelteKitCachesRequest extends SiteAdminCommandRequestBase {
|
|
1874
|
+
command: 'clearSvelteKitCaches';
|
|
1875
|
+
cacheType: ClearSvelteKitCacheType;
|
|
1876
|
+
chatAppId?: string;
|
|
1877
|
+
}
|
|
1878
|
+
declare const ClearSvelteKitCacheTypes: readonly ["chatAppCache", "tagDefinitionsCache", "instructionAssistanceConfigCache", "encryptionKeysCache", "all"];
|
|
1879
|
+
type ClearSvelteKitCacheType = (typeof ClearSvelteKitCacheTypes)[number];
|
|
1880
|
+
interface GetInstructionAssistanceConfigFromSsmRequest extends SiteAdminCommandRequestBase {
|
|
1881
|
+
command: 'getInstructionAssistanceConfigFromSsm';
|
|
1882
|
+
}
|
|
1883
|
+
interface GetInstructionAssistanceConfigFromSsmResponse extends SiteAdminCommandResponseBase {
|
|
1884
|
+
config: InstructionAssistanceConfig;
|
|
1885
|
+
}
|
|
1886
|
+
interface GetAllChatAppsAdminResponse extends SiteAdminCommandResponseBase {
|
|
1887
|
+
chatApps: ChatApp[];
|
|
1888
|
+
}
|
|
1889
|
+
interface GetAllAgentsAdminResponse extends SiteAdminCommandResponseBase {
|
|
1890
|
+
agents: AgentDefinition[];
|
|
1891
|
+
}
|
|
1892
|
+
interface GetAllToolsAdminResponse extends SiteAdminCommandResponseBase {
|
|
1893
|
+
tools: ToolDefinition[];
|
|
1894
|
+
}
|
|
1895
|
+
type SiteAdminResponse = GetAgentResponse | GetInitialDataResponse | RefreshChatAppResponse | CreateOrUpdateChatAppOverrideResponse | DeleteChatAppOverrideResponse | GetValuesForEntityAutoCompleteResponse | GetValuesForUserAutoCompleteResponse | ClearConverseLambdaCacheResponse | ClearSvelteKitCachesResponse | AddChatSessionFeedbackResponse | UpdateChatSessionFeedbackResponse | SessionSearchResponse | GetChatMessagesAsAdminResponse | GetInstructionAssistanceConfigFromSsmResponse | GetAllChatAppsAdminResponse | GetAllAgentsAdminResponse | GetAllToolsAdminResponse;
|
|
1646
1896
|
interface SiteAdminCommandResponseBase {
|
|
1647
1897
|
success: boolean;
|
|
1648
1898
|
error?: string;
|
|
@@ -1650,7 +1900,11 @@ interface SiteAdminCommandResponseBase {
|
|
|
1650
1900
|
interface GetChatMessagesAsAdminResponse extends SiteAdminCommandResponseBase {
|
|
1651
1901
|
messages: ChatMessage[];
|
|
1652
1902
|
}
|
|
1653
|
-
interface
|
|
1903
|
+
interface ClearConverseLambdaCacheResponse extends SiteAdminCommandResponseBase {
|
|
1904
|
+
}
|
|
1905
|
+
interface ClearSvelteKitCachesResponse extends SiteAdminCommandResponseBase {
|
|
1906
|
+
clearedCount?: number;
|
|
1907
|
+
cacheType: string;
|
|
1654
1908
|
}
|
|
1655
1909
|
interface GetValuesForEntityAutoCompleteResponse extends SiteAdminCommandResponseBase {
|
|
1656
1910
|
data: SimpleOption[] | undefined;
|
|
@@ -1979,6 +2233,308 @@ interface SiteFeatures {
|
|
|
1979
2233
|
uiCustomization?: UiCustomizationFeature;
|
|
1980
2234
|
/** Configure whether the session insights feature is enabled. */
|
|
1981
2235
|
sessionInsights?: SessionInsightsFeature;
|
|
2236
|
+
/** Configure which tag definitions are enabled by default at the site level. */
|
|
2237
|
+
tags?: TagsSiteFeature;
|
|
2238
|
+
/** Configure whether the agent instruction assistance feature is enabled. */
|
|
2239
|
+
agentInstructionAssistance?: AgentInstructionAssistanceFeature;
|
|
2240
|
+
/** Configure whether the instruction augmentation feature is enabled. */
|
|
2241
|
+
instructionAugmentation?: InstructionAugmentationFeature;
|
|
2242
|
+
}
|
|
2243
|
+
/**
|
|
2244
|
+
* Sometimes you need to augment the prompt you will give to the LLM with additional information.
|
|
2245
|
+
* Currently, only one type of augmentation is supported: llm semantic search. This uses the scope of the
|
|
2246
|
+
* agent invocation (chat app ID, agent ID, entity ID) to search for semantic directives in a database
|
|
2247
|
+
* of canned semantic directives that match the scope of the agent invocation. Then, those semantic
|
|
2248
|
+
* directives are added to the prompt to be used by the LLM. The LLM then takes the end user's message
|
|
2249
|
+
* and the semantic directives and uses them to determine if any of the semantic directives should be
|
|
2250
|
+
* included in the prompt. If they should be included, then the semantic directive instruction is added to the prompt.
|
|
2251
|
+
*
|
|
2252
|
+
* Note that by default the feature is turned off. To turn it on, you must set the `enabled` property to `true` or
|
|
2253
|
+
* it will not be turned on. Then, all agents will have the type of augmentation chosen.
|
|
2254
|
+
*
|
|
2255
|
+
* Setting this as a site wide feature sets the default instruction augmentation type used, if turned on. Individual chat apps
|
|
2256
|
+
* may override this behavior, turning off the feature or changing the augmentation type.
|
|
2257
|
+
*
|
|
2258
|
+
* Note that today we only support one type of augmentation: llm semantic directive search. This is a light-weight
|
|
2259
|
+
* approach with a good balance of engineer velocity (don't have to ingest and index embeddings into a knowledge base),
|
|
2260
|
+
* performance and cost.
|
|
2261
|
+
*/
|
|
2262
|
+
interface InstructionAugmentationFeature {
|
|
2263
|
+
enabled: boolean;
|
|
2264
|
+
type?: InstructionAugmentationType;
|
|
2265
|
+
}
|
|
2266
|
+
declare const InstructionAugmentationTypes: readonly ["llm-semantic-directive-search"];
|
|
2267
|
+
type InstructionAugmentationType = (typeof InstructionAugmentationTypes)[number];
|
|
2268
|
+
declare const InstructionAugmentationTypeDisplayNames: {
|
|
2269
|
+
readonly 'llm-semantic-directive-search': "LLM Semantic Directive Search";
|
|
2270
|
+
};
|
|
2271
|
+
type InstructionAugmentationTypeDisplayName = (typeof InstructionAugmentationTypeDisplayNames)[keyof typeof InstructionAugmentationTypeDisplayNames];
|
|
2272
|
+
declare const InstructionAugmentationScopeTypes: readonly ["chatapp", "agent", "tool", "entity", "agent-entity"];
|
|
2273
|
+
type InstructionAugmentationScopeType = (typeof InstructionAugmentationScopeTypes)[number];
|
|
2274
|
+
declare const InstructionAugmentationScopeTypeDisplayNames: {
|
|
2275
|
+
readonly chatapp: "Chat App";
|
|
2276
|
+
readonly agent: "Agent";
|
|
2277
|
+
readonly tool: "Tool";
|
|
2278
|
+
readonly entity: "Entity";
|
|
2279
|
+
readonly 'agent-entity': "Agent and Entity";
|
|
2280
|
+
};
|
|
2281
|
+
type InstructionAugmentationScopeTypeDisplayName = (typeof InstructionAugmentationScopeTypeDisplayNames)[keyof typeof InstructionAugmentationScopeTypeDisplayNames];
|
|
2282
|
+
/**
|
|
2283
|
+
* This is used to take the actual chatapp, agent, tools, and entity values used in a given agent invocation and use them
|
|
2284
|
+
* to go search for the matching semantic directives in the database.
|
|
2285
|
+
*/
|
|
2286
|
+
type InvocationScopes = Partial<Record<InstructionAugmentationScopeType, (string | number | Record<string, string | number>)[] | undefined>>;
|
|
2287
|
+
/**
|
|
2288
|
+
* A semantic directive is a special case or additional instruction paragraph that you might want the LLM to have included
|
|
2289
|
+
* in its context when responding to a user's question but that doesn't belong in the main prompt. So, the LLM will
|
|
2290
|
+
* be given the semantic directives in the context of the user's question and will decide if any of them should be
|
|
2291
|
+
* included in the prompt. If they should be included, then the semantic directive instruction is added to the prompt.
|
|
2292
|
+
*
|
|
2293
|
+
* One of the main use cases for this is when you have a tool with certain inputs and most of the time the LLM can
|
|
2294
|
+
* craft the correct inputs to your tool based on the question from an end user. But, occasionally, you might wish to give
|
|
2295
|
+
* the LLM special instructions on certain details that are specific to a certain situation.
|
|
2296
|
+
*
|
|
2297
|
+
* Semantic directives are stored in a database and are associated with a scope. The scope is used to narrow down which
|
|
2298
|
+
* directives we will give to the light-weight LLM to consider for inclusion in your prompt. We first search the
|
|
2299
|
+
* database based on chat app, agent, tool and entity to get the set of directives that match the scope and then have the
|
|
2300
|
+
* LLM tell us if we should include them in the prompt.
|
|
2301
|
+
*
|
|
2302
|
+
* IMPORTANT: when you see us refer to 'entity' in a scope, it means that the entity is the entity that is associated with the user,
|
|
2303
|
+
* assuming you have turned on the entity feature. The value of the entity is entityFeature.attributeName.
|
|
2304
|
+
*
|
|
2305
|
+
* In your pika-config.ts file, you can turn on the entity feature by setting the entity feature to true.
|
|
2306
|
+
*/
|
|
2307
|
+
interface SemanticDirective {
|
|
2308
|
+
/**
|
|
2309
|
+
* You don't set this value directly. Instead, you set the scopeType and scopeValue from which we will construct the scope.
|
|
2310
|
+
*
|
|
2311
|
+
* Remember that we might have a database full of these semantic directives. The scope then narrows down which
|
|
2312
|
+
* directives we will give to the light-weight LLM to consider for inclusion in your prompt. We first search the
|
|
2313
|
+
* database based on chat app, agent, tool and entity to get the set of directives that match the scope and then have the
|
|
2314
|
+
* LLM tell us if we should include them in the prompt.
|
|
2315
|
+
*
|
|
2316
|
+
* We support the following scopes at present:
|
|
2317
|
+
* - chatapp: The ID of the chat app this semantic directive is associated with.
|
|
2318
|
+
* - agent: The ID of the agent this semantic directive is associated with.
|
|
2319
|
+
* - tool: the ID of the tool this semantic directive is associated with.
|
|
2320
|
+
* - entity: The ID of the entity this semantic directive is associated with. Of course, if your pika instance
|
|
2321
|
+
* doesn't turn on the uses of entities, then this scope will not be used.
|
|
2322
|
+
*
|
|
2323
|
+
* We support only the following compound scopes at present:
|
|
2324
|
+
* - agent#{agent-id}#entity#{entity-id}
|
|
2325
|
+
*
|
|
2326
|
+
* Examples:
|
|
2327
|
+
*
|
|
2328
|
+
* - `chatapp#weather-chat-app`
|
|
2329
|
+
* - `agent#weather-agent`
|
|
2330
|
+
* - `tool#weather-tool`
|
|
2331
|
+
* - `entity#account-123`
|
|
2332
|
+
* - `agent#weather-agent#entity#account-123` // matches only for queries by account-123 to the weather agent
|
|
2333
|
+
*/
|
|
2334
|
+
scope: string;
|
|
2335
|
+
/**
|
|
2336
|
+
* The type of scope this semantic directive is associated with. This tells us what
|
|
2337
|
+
* the value in `scopeValue` is.
|
|
2338
|
+
*/
|
|
2339
|
+
scopeType: InstructionAugmentationScopeType;
|
|
2340
|
+
/**
|
|
2341
|
+
* The value of the scope this semantic directive is associated with. This is a string or an object
|
|
2342
|
+
* depending on the value of `scopeType`.
|
|
2343
|
+
*
|
|
2344
|
+
* If `scopeType` is `agent` then this will be the agent ID.
|
|
2345
|
+
* If `scopeType` is `tool` then this will be the tool ID.
|
|
2346
|
+
* If `scopeType` is `entity` then this will be the entity ID (entityFeature.attributeName from user.customData).
|
|
2347
|
+
* If `scopeType` is `agent-entity` then this will be {agent: string, entity: string}.
|
|
2348
|
+
*/
|
|
2349
|
+
scopeValue: string | number | Record<string, string | number>;
|
|
2350
|
+
/**
|
|
2351
|
+
* This plus scope must be unique across all semantic directives.
|
|
2352
|
+
*
|
|
2353
|
+
* Just a human-readable ID for the semantic directive. Consider it a variable name: may use dashes and underscores
|
|
2354
|
+
* and should start with a letter (no spaces or special characters). E.g. "account-details", "customer-support", "order-status", etc.
|
|
2355
|
+
* Used for db queries and to help engineers identify the semantic directive easily in a UI or DB.
|
|
2356
|
+
*/
|
|
2357
|
+
id: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* Used internally to group semantic directives created by a custom cloudformation resource. You shouldn't use this.
|
|
2360
|
+
* For example, a specific agent in a given stack may include CDK to define its semantic directives. Pika needs to
|
|
2361
|
+
* know the complete set of semantic directives that exist for that group so that the agent author can have the
|
|
2362
|
+
* freedom to modify semantic directive scope values. This groupId then is how the pika platform will be able
|
|
2363
|
+
* to query for all the semantic directives created as a "group" by the agent author and know which semantic directives
|
|
2364
|
+
* should be deleted because they are no longer present in the CDK stack.
|
|
2365
|
+
*
|
|
2366
|
+
* Don't set this value directly. Instead, let the custom cloudformation resource set it for you using the
|
|
2367
|
+
* `event.StackName` of the stack that created the semantic directive.
|
|
2368
|
+
*/
|
|
2369
|
+
groupId?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* This is what the light-weight LLM will use to decide if the question asked by the end user means that
|
|
2372
|
+
* this semantic directive should be included in the prompt to ensure the final LLM gives a correct response.
|
|
2373
|
+
*/
|
|
2374
|
+
description: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* If the light-weight LLM determines that this semantic directive should be included in the prompt, then these
|
|
2377
|
+
* instructions will be included in the final prompt to the final LLM to guide its response.
|
|
2378
|
+
*/
|
|
2379
|
+
instructions: string;
|
|
2380
|
+
/** If true, the semantic directive will not be used to augment the prompt. */
|
|
2381
|
+
disabled?: boolean;
|
|
2382
|
+
/** ISO 8601 formatted timestamp of when the semantic directive was created */
|
|
2383
|
+
createDate: string;
|
|
2384
|
+
/** User who created the semantic directive */
|
|
2385
|
+
createdBy: string;
|
|
2386
|
+
/** User who last updated the semantic directive */
|
|
2387
|
+
lastUpdatedBy: string;
|
|
2388
|
+
/** ISO 8601 formatted timestamp of the last semantic directive update */
|
|
2389
|
+
lastUpdate: string;
|
|
2390
|
+
}
|
|
2391
|
+
interface SemanticDirectiveForCreateOrUpdate extends Omit<SemanticDirective, 'scope' | 'createDate' | 'lastUpdate'> {
|
|
2392
|
+
createdBy: string;
|
|
2393
|
+
lastUpdatedBy: string;
|
|
2394
|
+
}
|
|
2395
|
+
interface SemanticDirectiveCreateOrUpdateRequest {
|
|
2396
|
+
semanticDirective: SemanticDirectiveForCreateOrUpdate;
|
|
2397
|
+
/**
|
|
2398
|
+
* If you are creating one of these objects through the CloudFormation custom resource, then you should set this
|
|
2399
|
+
* to be something that is tied to the stack that did the creation/update and we ask that you prepend it with 'cloudformation/'
|
|
2400
|
+
* so we understand it was created/updated by cloudformation as in 'cloudformation/my-stack-name'.
|
|
2401
|
+
*/
|
|
2402
|
+
userId: string;
|
|
2403
|
+
}
|
|
2404
|
+
interface SemanticDirectiveCreateOrUpdateResponse {
|
|
2405
|
+
success: boolean;
|
|
2406
|
+
semanticDirective: SemanticDirective;
|
|
2407
|
+
}
|
|
2408
|
+
interface SemanticDirectiveScope {
|
|
2409
|
+
scopeType: InstructionAugmentationScopeType;
|
|
2410
|
+
scopeValue: string | number | Record<string, string | number>;
|
|
2411
|
+
}
|
|
2412
|
+
/**
|
|
2413
|
+
* Search request for semantic directives. Supports multiple search patterns based on our DynamoDB table design:
|
|
2414
|
+
* - If findOne is provided, then we will return the first directive that matches the scopeType, scopeValue and id.
|
|
2415
|
+
* - Query by specific scopes (main table access pattern)
|
|
2416
|
+
* - Query by creator and date range (GSI1: createdBy + createDate)
|
|
2417
|
+
* - Query by directive ID(s) across scopes (GSI2: id + scope)
|
|
2418
|
+
* - Date range filtering (created or updated)
|
|
2419
|
+
*
|
|
2420
|
+
* If no search criteria provided, returns all directives with pagination.
|
|
2421
|
+
*/
|
|
2422
|
+
interface SearchSemanticDirectivesRequest {
|
|
2423
|
+
findOne?: {
|
|
2424
|
+
scopeType: InstructionAugmentationScopeType;
|
|
2425
|
+
scopeValue: string | number | Record<string, string | number>;
|
|
2426
|
+
id: string;
|
|
2427
|
+
};
|
|
2428
|
+
/**
|
|
2429
|
+
* Search for directives within specific scopes.
|
|
2430
|
+
* Uses parallel DynamoDB queries against the main table (PK = scope).
|
|
2431
|
+
*/
|
|
2432
|
+
scopes?: SemanticDirectiveScope[];
|
|
2433
|
+
/** Will be used by the custom cloudformation resource to query for all semantic directives created as a "group" by the agent author. */
|
|
2434
|
+
groupId?: string;
|
|
2435
|
+
/**
|
|
2436
|
+
* Search for directives created by a specific user.
|
|
2437
|
+
* When provided, results are automatically sorted by createDate (newest first by default).
|
|
2438
|
+
*
|
|
2439
|
+
* Uses GSI1: createdBy + createDate
|
|
2440
|
+
*/
|
|
2441
|
+
createdBy?: string;
|
|
2442
|
+
/**
|
|
2443
|
+
* Search for directives by specific IDs.
|
|
2444
|
+
* Returns directives matching any of the provided IDs across all scopes.
|
|
2445
|
+
*
|
|
2446
|
+
* Uses GSI2: id + scope
|
|
2447
|
+
*/
|
|
2448
|
+
directiveIds?: string[];
|
|
2449
|
+
/**
|
|
2450
|
+
* Filter directives created after this ISO 8601 timestamp.
|
|
2451
|
+
* Can be combined with other filters.
|
|
2452
|
+
* Example: "2024-01-15T00:00:00Z"
|
|
2453
|
+
*/
|
|
2454
|
+
createdAfter?: string;
|
|
2455
|
+
/**
|
|
2456
|
+
* Filter directives created before this ISO 8601 timestamp.
|
|
2457
|
+
* Can be combined with other filters.
|
|
2458
|
+
* Example: "2024-01-31T23:59:59Z"
|
|
2459
|
+
*/
|
|
2460
|
+
createdBefore?: string;
|
|
2461
|
+
/**
|
|
2462
|
+
* Filter directives updated after this ISO 8601 timestamp.
|
|
2463
|
+
* Can be combined with other filters.
|
|
2464
|
+
*/
|
|
2465
|
+
updatedAfter?: string;
|
|
2466
|
+
/**
|
|
2467
|
+
* Filter directives updated before this ISO 8601 timestamp.
|
|
2468
|
+
* Can be combined with other filters.
|
|
2469
|
+
*/
|
|
2470
|
+
updatedBefore?: string;
|
|
2471
|
+
/**
|
|
2472
|
+
* Sort order for results when using createdBy search or no specific search criteria.
|
|
2473
|
+
* - 'asc': Oldest first
|
|
2474
|
+
* - 'desc': Newest first (default)
|
|
2475
|
+
*/
|
|
2476
|
+
sortOrder?: 'asc' | 'desc';
|
|
2477
|
+
/**
|
|
2478
|
+
* Maximum number of directives to return per page.
|
|
2479
|
+
* Default: 50, Max: 100
|
|
2480
|
+
*/
|
|
2481
|
+
limit?: number;
|
|
2482
|
+
/**
|
|
2483
|
+
* Pagination token from previous search response.
|
|
2484
|
+
* Include your original search criteria when using pagination.
|
|
2485
|
+
*/
|
|
2486
|
+
paginationToken?: Record<string, any>;
|
|
2487
|
+
/**
|
|
2488
|
+
* If true, includes the full directive instructions in response.
|
|
2489
|
+
* If false, returns directive metadata only (scope, id, description, dates, etc).
|
|
2490
|
+
* Default: false (to save bandwidth)
|
|
2491
|
+
*/
|
|
2492
|
+
includeInstructions?: boolean;
|
|
2493
|
+
/**
|
|
2494
|
+
* If true, excludes disabled directives in the response.
|
|
2495
|
+
* Default: false
|
|
2496
|
+
*/
|
|
2497
|
+
excludeDisabled?: boolean;
|
|
2498
|
+
}
|
|
2499
|
+
interface SearchSemanticDirectivesResponse {
|
|
2500
|
+
success: boolean;
|
|
2501
|
+
/** Array of semantic directives matching the search criteria */
|
|
2502
|
+
semanticDirectives: SemanticDirective[];
|
|
2503
|
+
/** Total count of directives found (may be larger than returned array due to pagination) */
|
|
2504
|
+
totalCount?: number;
|
|
2505
|
+
/** If present, there are more results available. Pass this token back in the next request. */
|
|
2506
|
+
paginationToken?: Record<string, any>;
|
|
2507
|
+
}
|
|
2508
|
+
interface SemanticDirectiveDeleteRequest {
|
|
2509
|
+
semanticDirective: {
|
|
2510
|
+
scope: string;
|
|
2511
|
+
id: string;
|
|
2512
|
+
};
|
|
2513
|
+
/**
|
|
2514
|
+
* If you are deleting one of these objects through the CloudFormation custom resource, then you should set this
|
|
2515
|
+
* to be something that is tied to the stack that did the deletion and we ask that you prepend it with 'cloudformation/'
|
|
2516
|
+
* so we understand it was deleted by cloudformation as in 'cloudformation/my-stack-name'.
|
|
2517
|
+
*/
|
|
2518
|
+
userId: string;
|
|
2519
|
+
}
|
|
2520
|
+
interface SemanticDirectiveDeleteResponse {
|
|
2521
|
+
success: boolean;
|
|
2522
|
+
}
|
|
2523
|
+
interface TagsSiteFeature {
|
|
2524
|
+
/**
|
|
2525
|
+
* Whether to enable the tags feature. If this is turned off you will lost a lot of the functionality of the chat app.
|
|
2526
|
+
*/
|
|
2527
|
+
enabled: boolean;
|
|
2528
|
+
/**
|
|
2529
|
+
* The tag definitions that are enabled by default. If not provided, then no tag definitions are enabled.
|
|
2530
|
+
* Each chat app can override this list by providing its own list of tagsEnabled in its chat app config.
|
|
2531
|
+
*/
|
|
2532
|
+
tagsEnabled?: TagDefinitionLite[];
|
|
2533
|
+
/**
|
|
2534
|
+
* The tag definitions that are prohibited by default. If not provided, then no tag definitions are prohibited.
|
|
2535
|
+
* Chat apps may not override this list.
|
|
2536
|
+
*/
|
|
2537
|
+
tagsProhibited?: TagDefinitionLite[];
|
|
1982
2538
|
}
|
|
1983
2539
|
/**
|
|
1984
2540
|
* Configure whether the session insights feature is enabled. When turned on, Pika will
|
|
@@ -2015,6 +2571,14 @@ interface SessionInsightsOpenSearchConfig {
|
|
|
2015
2571
|
/** Defaults to gp3 if not provided. */
|
|
2016
2572
|
volumeType?: string;
|
|
2017
2573
|
}
|
|
2574
|
+
interface TagsFeatureForChatApp extends Feature {
|
|
2575
|
+
featureId: 'tags';
|
|
2576
|
+
/**
|
|
2577
|
+
* The tag definitions that are enabled by default. If not provided, then no tag definitions are enabled.
|
|
2578
|
+
* Each chat app can override this list by providing its own list of tagsEnabled in its chat app config.
|
|
2579
|
+
*/
|
|
2580
|
+
tagsEnabled?: TagDefinitionLite[];
|
|
2581
|
+
}
|
|
2018
2582
|
interface SessionInsightsFeatureForChatApp extends Feature {
|
|
2019
2583
|
featureId: 'sessionInsights';
|
|
2020
2584
|
}
|
|
@@ -2236,5 +2800,221 @@ interface NameValueDescTriple<T> {
|
|
|
2236
2800
|
value: T;
|
|
2237
2801
|
desc?: string;
|
|
2238
2802
|
}
|
|
2803
|
+
/**
|
|
2804
|
+
* A component that renders a tag is expected to have a tag definition that defines the tag and the instructions for how to render it.
|
|
2805
|
+
*
|
|
2806
|
+
*/
|
|
2807
|
+
interface ComponentTagDefinition<T extends TagDefinitionWidget> {
|
|
2808
|
+
definition: TagDefinition<T>;
|
|
2809
|
+
}
|
|
2810
|
+
interface TagDefinition<T extends TagDefinitionWidget> {
|
|
2811
|
+
/**
|
|
2812
|
+
* The tag type this definition is for. If the tag is one of the built-in pika tags, then you are overriding the built-in pika tag instructions
|
|
2813
|
+
* that will be included in the prompt assistance language.
|
|
2814
|
+
*
|
|
2815
|
+
* If the tag is a custom tag, then you are adding a new custom tag to the agent prompt definition.
|
|
2816
|
+
*
|
|
2817
|
+
* Do not include your scope on the tag name, we will add it for you.
|
|
2818
|
+
*/
|
|
2819
|
+
tag: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* We didn't start with the expectation that tags would have a scope that prefixes the tag name. We are now requiring it. However,
|
|
2822
|
+
* a few of our initial tags were not scoped and so we are allowing you to provide a legacy alias for the tag. This is not recommended
|
|
2823
|
+
* and you should use the scope instead.
|
|
2824
|
+
*
|
|
2825
|
+
* Here is the complete set of legacy tag aliases: download, chart, prompt, image. If you try to set this to anything but one of these, we will
|
|
2826
|
+
* error out and not take your tag definition.
|
|
2827
|
+
*
|
|
2828
|
+
* We will remove this in the near future. You've been warned.
|
|
2829
|
+
*/
|
|
2830
|
+
legacyTagName?: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* The scope of the tag. This is used to group tags together and prevent collisions with other tags.
|
|
2833
|
+
*
|
|
2834
|
+
* Inside the system, your tag will be known as `<scope>.<tag>`. For example, the chart tag will be known as `<pika.chart></pika.chart>`.
|
|
2835
|
+
*
|
|
2836
|
+
* As a result, scope must not include punctuation of any kind to be valid xml and keep things simple. All lower case is recommended but it's up to you.
|
|
2837
|
+
* Your aim is to ensure uniqueness of the tag name across all tags in the system and to keep it short and simple to use as few characters as possible within reason.
|
|
2838
|
+
*
|
|
2839
|
+
* This will be `pika` for built in tags the platform natively supports. If you are adding a custom tag, you should use a
|
|
2840
|
+
* scope that is unique to your application, chat app or agent.
|
|
2841
|
+
*/
|
|
2842
|
+
scope: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* This should be a pluralized noun that represents the tag and be capitalized.
|
|
2845
|
+
*
|
|
2846
|
+
* For example, the chart tag title is "Charts". The prompt tag title is "Follow-up Prompts". The image tag title is "Images".
|
|
2847
|
+
*
|
|
2848
|
+
* Do not use markdown in this title.
|
|
2849
|
+
*/
|
|
2850
|
+
tagTitle: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* This should be a short example of the tag structure. It may be used in the prompt assistance language injected into your prompt in a quick list of tags available for the LLM to generate.
|
|
2853
|
+
*
|
|
2854
|
+
* For example, the chart tag structure example is `<pika.chart></pika.chart>`. The prompt tag structure example is `<pika.prompt></pika.prompt>`. The image tag structure example is `<pika.image></pika.image>`.
|
|
2855
|
+
*
|
|
2856
|
+
* Be sure that you use `${scope}.` in front of the tag name.
|
|
2857
|
+
*
|
|
2858
|
+
* Do not use markdown in this example and don't surround with backticks, just the tag structure itself. Don't include a body to the tag, even if it has one.
|
|
2859
|
+
*/
|
|
2860
|
+
shortTagEx: string;
|
|
2861
|
+
/**
|
|
2862
|
+
* If true, the tag can be generated by the LLM.
|
|
2863
|
+
*/
|
|
2864
|
+
canBeGeneratedByLlm: boolean;
|
|
2865
|
+
/**
|
|
2866
|
+
* If true, the tag will be generated by a tool of an agent.
|
|
2867
|
+
*/
|
|
2868
|
+
canBeGeneratedByTool: boolean;
|
|
2869
|
+
/**
|
|
2870
|
+
* A description of the tag. This will be used to describe the tag in admin-facing UI. Don't use markdown in this description.
|
|
2871
|
+
*/
|
|
2872
|
+
description: string;
|
|
2873
|
+
/** Cache configuration for testing and debugging, used in lambdas/ecs containers that create LRU caches for tag definitions */
|
|
2874
|
+
dontCacheThis?: boolean;
|
|
2875
|
+
/** You must be explicit about whether this tag is a widget or not and if so what kind. */
|
|
2876
|
+
widget: T;
|
|
2877
|
+
/** If true, the tag will be disabled and not available to the LLM or tools. */
|
|
2878
|
+
disabled?: boolean;
|
|
2879
|
+
/**
|
|
2880
|
+
* If `canBeGeneratedByLlm` is true, you must provide instructions for the LLM to generate the tag since chat app/agent builders can choose
|
|
2881
|
+
* to have the instructions injected into the agent instructions prompt for a given tag.
|
|
2882
|
+
*
|
|
2883
|
+
* When we inject your instructions into the agent instructions prompt, we will do the following:
|
|
2884
|
+
*
|
|
2885
|
+
* 1. We will use the `tagTitle` as the bullet title for your tag instructions: `- **tagTitle:**`
|
|
2886
|
+
* 2. We will wrap your markdown instructions in XML tags to prevent formatting conflicts with the rest of the injected instructions
|
|
2887
|
+
*
|
|
2888
|
+
* Here's a complete example of what we will generate for you:
|
|
2889
|
+
*
|
|
2890
|
+
* ```markdown
|
|
2891
|
+
* - **Charts:**
|
|
2892
|
+
* <tag-instructions type="chart">
|
|
2893
|
+
* To include a pika chart, use the `<pika.chart></pika.chart>` tags.
|
|
2894
|
+
* The content within the tags MUST be valid Chart.js version 4 JSON, including `type` and `data` properties.
|
|
2895
|
+
*
|
|
2896
|
+
* **Example:** `<pika.chart>{"type":"line","data":{"labels":["May","June","July","August"],"datasets":[{"label":"Avg Temperature (°C)","data":[2,3,7,12]}]}}</pika.chart>`
|
|
2897
|
+
*
|
|
2898
|
+
* **Usage:** Include pika charts whenever they can visually represent data, trends, or comparisons effectively.
|
|
2899
|
+
* </tag-instructions>
|
|
2900
|
+
* ```
|
|
2901
|
+
*
|
|
2902
|
+
* The markdown you provide should be well-formatted and can use any standard markdown features (lists, bold, code blocks, etc.).
|
|
2903
|
+
* The XML wrapper ensures that your formatting doesn't interfere with the overall instruction structure.
|
|
2904
|
+
*/
|
|
2905
|
+
llmInstructionsMd?: string;
|
|
2906
|
+
/** The user id of the user who created the tag definition */
|
|
2907
|
+
createdBy: string;
|
|
2908
|
+
/** The user id of the user who last updated the tag definition */
|
|
2909
|
+
lastUpdatedBy: string;
|
|
2910
|
+
/** ISO 8601 formatted timestamp of when the session was created */
|
|
2911
|
+
createDate: string;
|
|
2912
|
+
/** ISO 8601 formatted timestamp of the last session update */
|
|
2913
|
+
lastUpdate: string;
|
|
2914
|
+
}
|
|
2915
|
+
interface TagDefinitionLite {
|
|
2916
|
+
tag: string;
|
|
2917
|
+
scope: string;
|
|
2918
|
+
}
|
|
2919
|
+
type TagDefinitionForCreateOrUpdate<T extends TagDefinitionWidget = TagDefinitionWidget> = Omit<TagDefinition<T>, 'createdBy' | 'lastUpdatedBy' | 'createDate' | 'lastUpdate'>;
|
|
2920
|
+
/**
|
|
2921
|
+
* Pika compiled-in components are those defined as part of the compiled svelte front end code in `apps/pika-chat/src/lib/client/features/chat/message-segments/default-components/index.ts`.
|
|
2922
|
+
*
|
|
2923
|
+
* Custom compiled-in components are those defined by the user in their app as a svelte component. They are defined in `apps/pika-chat/src/lib/client/features/chat/message-segments/custom-components/index.ts`.
|
|
2924
|
+
*
|
|
2925
|
+
* Web components are those that are defined as standalone js files that are uploaded to s3 and then dynamically loaded into the front end.
|
|
2926
|
+
* If web-component then the `webComponent` property must be provided.
|
|
2927
|
+
*
|
|
2928
|
+
* Pass through means we will simply pass this through and not process the tag in any way. This is useful for tags that are not meant to be rendered in the front end.
|
|
2929
|
+
*/
|
|
2930
|
+
type TagDefinitionWidgetType = 'pass-through' | 'pika-compiled-in' | 'custom-compiled-in' | 'web-component';
|
|
2931
|
+
interface TagDefinitionWidgetPikaCompiledIn extends TagDefinitionWidgetBase {
|
|
2932
|
+
type: 'pika-compiled-in';
|
|
2933
|
+
}
|
|
2934
|
+
interface TagDefinitionWidgetCustomCompiledIn extends TagDefinitionWidgetBase {
|
|
2935
|
+
type: 'custom-compiled-in';
|
|
2936
|
+
}
|
|
2937
|
+
interface TagDefinitionWidgetWebComponent extends TagDefinitionWidgetBase {
|
|
2938
|
+
type: 'web-component';
|
|
2939
|
+
webComponent: TagDefinitionWebComponent;
|
|
2940
|
+
}
|
|
2941
|
+
interface TagDefinitionWidgetPassThrough extends TagDefinitionWidgetBase {
|
|
2942
|
+
type: 'pass-through';
|
|
2943
|
+
}
|
|
2944
|
+
interface TagDefinitionWidgetBase {
|
|
2945
|
+
/**
|
|
2946
|
+
* The type of widget that will be used to render this tag.
|
|
2947
|
+
*/
|
|
2948
|
+
type: TagDefinitionWidgetType;
|
|
2949
|
+
}
|
|
2950
|
+
type TagDefinitionWidget = TagDefinitionWidgetPassThrough | TagDefinitionWidgetPikaCompiledIn | TagDefinitionWidgetCustomCompiledIn | TagDefinitionWidgetWebComponent;
|
|
2951
|
+
type TagWebComponentEncoding = 'gzip+base64';
|
|
2952
|
+
interface TagDefinitionWebComponent {
|
|
2953
|
+
type: 'web-component';
|
|
2954
|
+
s3Bucket: string;
|
|
2955
|
+
s3Key: string;
|
|
2956
|
+
encoding: TagWebComponentEncoding;
|
|
2957
|
+
mediaType: 'application/javascript';
|
|
2958
|
+
encodedSizeBytes: number;
|
|
2959
|
+
/** Hash of EXACT S3 object bytes (post-encoding) */
|
|
2960
|
+
encodedSha256Base64: string;
|
|
2961
|
+
}
|
|
2962
|
+
interface TagDefinitionCreateOrUpdateRequest {
|
|
2963
|
+
tagDefinition: TagDefinitionForCreateOrUpdate;
|
|
2964
|
+
/**
|
|
2965
|
+
* If you are creating one of these objects through the CloudFormation custom resource, then you should set this
|
|
2966
|
+
* to be something that is tied to the stack that did the creation/update and we ask that you prepend it with 'cloudformation/'
|
|
2967
|
+
* so we understand it was created/updated by cloudformation as in 'cloudformation/my-stack-name'.
|
|
2968
|
+
*/
|
|
2969
|
+
userId: string;
|
|
2970
|
+
}
|
|
2971
|
+
interface TagDefinitionCreateOrUpdateResponse {
|
|
2972
|
+
success: boolean;
|
|
2973
|
+
tagDefinition: TagDefinition<TagDefinitionWidget>;
|
|
2974
|
+
}
|
|
2975
|
+
/**
|
|
2976
|
+
* You don't have to provide anything in this request if you don't want to. If you don't pass in tagsDesire...
|
|
2977
|
+
*
|
|
2978
|
+
* If this is being used in the context of admin API then
|
|
2979
|
+
* you will get all tag definitions. If this is being used in the context of a chat app user, then you will get all tag defs not disabled.
|
|
2980
|
+
*
|
|
2981
|
+
*
|
|
2982
|
+
* If you do pass in tagsDesired, then our dynamodb query will scan the table for all rows (should be performant since there won't be more than a
|
|
2983
|
+
* few hundred tag defs at absolute most) and then will filter them to only those that match the tagsDesired. Note if this is being called in the
|
|
2984
|
+
* context of a chat app user, then you will get all tag defs not disabled even if you pass in tagsDesired.
|
|
2985
|
+
*
|
|
2986
|
+
* Instructions can be big so unless you ask for them, we will not return them.
|
|
2987
|
+
*/
|
|
2988
|
+
interface TagDefinitionSearchRequest {
|
|
2989
|
+
tagsDesired?: TagDefinitionLite[];
|
|
2990
|
+
/** If not true, instructions will not be returned to save space. */
|
|
2991
|
+
includeInstructions?: boolean;
|
|
2992
|
+
/**
|
|
2993
|
+
* If you pass in a pagination token, we will return the next page of tag defs. Be sure to include your original
|
|
2994
|
+
* request (tagsDesired, includeInstructions) if they were present in the original request.
|
|
2995
|
+
*/
|
|
2996
|
+
paginationToken?: Record<string, any> | undefined;
|
|
2997
|
+
}
|
|
2998
|
+
interface TagDefinitionSearchResponse {
|
|
2999
|
+
success: boolean;
|
|
3000
|
+
tagDefinitions: TagDefinition<TagDefinitionWidget>[];
|
|
3001
|
+
/** If this is present, there are more records that could be returned. Pass this token in to get the next page with the same request. */
|
|
3002
|
+
paginationToken?: Record<string, any> | undefined;
|
|
3003
|
+
}
|
|
3004
|
+
interface TagDefinitionDeleteRequest {
|
|
3005
|
+
tagDefinition: TagDefinitionLite;
|
|
3006
|
+
userId: string;
|
|
3007
|
+
}
|
|
3008
|
+
interface TagDefinitionDeleteResponse {
|
|
3009
|
+
success: boolean;
|
|
3010
|
+
}
|
|
3011
|
+
interface TagDefinitionsJsonFile {
|
|
3012
|
+
tagDefs: TagDefInJsonFile[];
|
|
3013
|
+
}
|
|
3014
|
+
interface TagDefInJsonFile {
|
|
3015
|
+
tag: string;
|
|
3016
|
+
scope: string;
|
|
3017
|
+
gzippedBase64EncodedString: string;
|
|
3018
|
+
}
|
|
2239
3019
|
|
|
2240
|
-
export { type AccessRule, type AccessRules, Accurate, AccurateWithStatedAssumptions, AccurateWithUnstatedAssumptions, type AddChatSessionFeedbackAdminRequest, type AddChatSessionFeedbackRequest, type AddChatSessionFeedbackResponse, type AgentAndTools, type AgentDataRequest, type AgentDataResponse, type AgentDefinition, type AgentDefinitionForCreate, type AgentDefinitionForIdempotentCreateOrUpdate, type AgentDefinitionForUpdate, type AgentFramework, type ApplyRulesAs, type Attachment, type AuthenticateResult, type AuthenticatedUser, type BaseRequestData, type BaseStackConfig, type ChatApp, type ChatAppDataRequest, type ChatAppDataResponse, type ChatAppFeature, type ChatAppForCreate, type ChatAppForIdempotentCreateOrUpdate, type ChatAppForUpdate, type ChatAppLite, type ChatAppMode, type ChatAppOverridableFeatures, type ChatAppOverridableFeaturesForConverseFn, type ChatAppOverride, type ChatAppOverrideDdb, type ChatAppOverrideForCreateOrUpdate, type ChatDisclaimerNoticeFeature, type ChatDisclaimerNoticeFeatureForChatApp, type ChatMessage, type ChatMessageFile, type ChatMessageFileBase, ChatMessageFileLocationType, type ChatMessageFileS3, ChatMessageFileUseCase, type ChatMessageForCreate, type ChatMessageForRendering, type ChatMessageResponse, type ChatMessageUsage, type ChatMessagesResponse, type ChatSession, type ChatSessionFeedback, type ChatSessionFeedbackForCreate, type ChatSessionFeedbackForUpdate, type ChatSessionForCreate, type ChatSessionLiteForUpdate, type ChatSessionResponse, type ChatSessionsResponse, type ChatTitleUpdateRequest, type ChatUser, type ChatUserAddOrUpdateResponse, type ChatUserFeature, type ChatUserFeatureBase, type ChatUserLite, type ChatUserResponse, type ChatUserSearchResponse, type ClearChatAppCacheRequest, type ClearChatAppCacheResponse, type ClearUserOverrideDataRequest, type ClearUserOverrideDataResponse, type CompanyType, ContentAdminCommand, type ContentAdminCommandRequestBase, type ContentAdminCommandResponseBase, type ContentAdminData, type ContentAdminRequest, type ContentAdminResponse, type ContentAdminSiteFeature, type ConverseRequest, type ConverseRequestWithCommand, type CreateAgentRequest, type CreateChatAppRequest, type CreateOrUpdateChatAppOverrideRequest, type CreateOrUpdateChatAppOverrideResponse, type CreateToolRequest, type CustomDataUiRepresentation, type DeleteChatAppOverrideRequest, type DeleteChatAppOverrideResponse, EndToEndFeatureIdList, type EndToEndFeatureIdType, type EntitySiteFeature, type ExecutionType, FEATURE_NAMES, FEEDBACK_INTERNAL_COMMENT_STATUS, FEEDBACK_INTERNAL_COMMENT_STATUS_VALUES, FEEDBACK_INTERNAL_COMMENT_TYPE, FEEDBACK_INTERNAL_COMMENT_TYPE_VALUES, type Feature, type FeatureError, FeatureIdList, type FeatureIdType, type FeatureType, FeatureTypeArr, type FeedbackInternalComment, type FeedbackInternalCommentStatus, type FeedbackInternalCommentType, type FileUploadFeature, type FileUploadFeatureForChatApp, type GetChatAppsByRulesRequest, type GetChatAppsByRulesResponse, type GetChatMessagesAsAdminRequest, type GetChatMessagesAsAdminResponse, type GetChatSessionFeedbackResponse, type GetChatUserPrefsResponse, type GetInitialDataRequest, type GetInitialDataResponse, type GetInitialDialogDataRequest, type GetInitialDialogDataResponse, type GetValuesForAutoCompleteRequest, type GetValuesForAutoCompleteResponse, type GetValuesForContentAdminAutoCompleteRequest, type GetValuesForContentAdminAutoCompleteResponse, type GetValuesForEntityAutoCompleteRequest, type GetValuesForEntityAutoCompleteResponse, type GetValuesForUserAutoCompleteRequest, type GetValuesForUserAutoCompleteResponse, type GetViewingContentForUserResponse, type HistoryFeature, type HomePageLinksToChatAppsSiteFeature, type HomePageSiteFeature, INSIGHT_STATUS_NEEDS_INSIGHTS_ANALYSIS, Inaccurate, type InsightStatusNeedsInsightsAnalysis, type InsightsSearchParams, type InstructionFeature, type KnowledgeBase, type LifecycleStatus, type LogoutFeature, type LogoutFeatureForChatApp, type MessageSegment, type MessageSegmentBase, MessageSource, type NameValueDescTriple, type NameValuePair, type PikaConfig, type PikaStack, type PikaUserRole, PikaUserRoles, type PromptInputFieldLabelFeature, type PromptInputFieldLabelFeatureForChatApp, type RecordOrUndef, type RefreshChatAppRequest, type RefreshChatAppResponse, type RetryableVerifyResponseClassification, RetryableVerifyResponseClassifications, type RolloutPolicy, SCORE_SEARCH_OPERATORS, SCORE_SEARCH_OPERATORS_VALUES, SESSION_FEEDBACK_SEVERITY, SESSION_FEEDBACK_SEVERITY_VALUES, SESSION_FEEDBACK_STATUS, SESSION_FEEDBACK_STATUS_VALUES, SESSION_FEEDBACK_TYPE, SESSION_FEEDBACK_TYPE_VALUES, SESSION_INSIGHT_GOAL_COMPLETION_STATUS, SESSION_INSIGHT_GOAL_COMPLETION_STATUS_VALUES, SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL, SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL_VALUES, SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL, SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL_VALUES, SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE, SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE_VALUES, SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED, SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED_VALUES, SESSION_INSIGHT_SATISFACTION_LEVEL, SESSION_INSIGHT_SATISFACTION_LEVEL_VALUES, SESSION_INSIGHT_USER_SENTIMENT, SESSION_INSIGHT_USER_SENTIMENT_VALUES, SESSION_SEARCH_DATE_PRESETS, SESSION_SEARCH_DATE_PRESETS_SHORT_VALUES, SESSION_SEARCH_DATE_PRESETS_VALUES, SESSION_SEARCH_DATE_TYPES, SESSION_SEARCH_DATE_TYPES_VALUES, SESSION_SEARCH_SORT_FIELDS, SESSION_SEARCH_SORT_FIELDS_VALUES, type SaveUserOverrideDataRequest, type SaveUserOverrideDataResponse, type ScoreSearchOperator, type ScoreSearchParams, type SearchToolsRequest, type SegmentType, type SessionAttributes, type SessionAttributesWithoutToken, type SessionData, type SessionDataWithChatUserCustomDataSpreadIn, type SessionFeedbackSeverity, type SessionFeedbackStatus, type SessionFeedbackType, type SessionInsightGoalCompletionStatus, type SessionInsightMetricsAiConfidenceLevel, type SessionInsightMetricsComplexityLevel, type SessionInsightMetricsSessionDurationEstimate, type SessionInsightMetricsUserEffortRequired, type SessionInsightSatisfactionLevel, type SessionInsightScoring, type SessionInsightUsage, type SessionInsightUserSentiment, type SessionInsights, type SessionInsightsFeature, type SessionInsightsFeatureForChatApp, type SessionInsightsOpenSearchConfig, type SessionSearchAdminRequest, type SessionSearchDateFilter, type SessionSearchDatePreset, type SessionSearchDateType, type SessionSearchRequest, type SessionSearchResponse, type SessionSearchSortField, type SetChatUserPrefsRequest, type SetChatUserPrefsResponse, type SimpleAuthenticatedUser, type SimpleOption, SiteAdminCommand, type SiteAdminCommandRequestBase, type SiteAdminCommandResponseBase, type SiteAdminFeature, type SiteAdminRequest, type SiteAdminResponse, type SiteFeatures, type StopViewingContentForUserRequest, type StopViewingContentForUserResponse, type StreamingStatus, type SuggestionsFeature, type SuggestionsFeatureForChatApp, type TagMessageSegment, type TextMessageSegment, type ToolDefinition, type ToolDefinitionForCreate, type ToolDefinitionForIdempotentCreateOrUpdate, type ToolDefinitionForUpdate, type ToolIdToLambdaArnMap, type ToolLifecycle, type TracesFeature, type TracesFeatureForChatApp, UPDATEABLE_FEEDBACK_FIELDS, type UiCustomizationFeature, type UiCustomizationFeatureForChatApp, Unclassified, type UpdateAgentRequest, type UpdateChatAppRequest, type UpdateChatSessionFeedbackAdminRequest, type UpdateChatSessionFeedbackRequest, type UpdateChatSessionFeedbackResponse, type UpdateToolRequest, type UpdateableAgentDefinitionFields, type UpdateableChatAppFields, type UpdateableChatAppOverrideFields, type UpdateableFeedbackFields, type UpdateableToolDefinitionFields, type UserChatAppRule, type UserDataOverrideFeatureForChatApp, type UserDataOverrideSettings, type UserDataOverridesSiteFeature, type UserOverrideData, UserOverrideDataCommand, type UserOverrideDataCommandRequest, type UserOverrideDataCommandRequestBase, type UserOverrideDataCommandResponse, type UserOverrideDataCommandResponseBase, type UserPrefs, type UserRole, type UserType, UserTypes, type VerifyResponseClassification, type VerifyResponseClassificationDescription, VerifyResponseClassificationDescriptions, VerifyResponseClassifications, type VerifyResponseFeature, type VerifyResponseFeatureForChatApp, type VerifyResponseRetryableClassificationDescription, VerifyResponseRetryableClassificationDescriptions, type ViewContentForUserRequest, type ViewContentForUserResponse, type VitePreviewConfig, type ViteServerConfig };
|
|
3020
|
+
export { type AccessRule, type AccessRules, Accurate, AccurateWithStatedAssumptions, AccurateWithUnstatedAssumptions, type AddChatSessionFeedbackAdminRequest, type AddChatSessionFeedbackRequest, type AddChatSessionFeedbackResponse, type AgentAndTools, type AgentDataRequest, type AgentDataResponse, type AgentDefinition, type AgentDefinitionForCreate, type AgentDefinitionForIdempotentCreateOrUpdate, type AgentDefinitionForUpdate, type AgentFramework, type AgentInstructionAssistanceFeature, type AgentInstructionAssistanceFeatureForChatApp, type AgentInstructionChatAppOverridableFeature, type ApplyRulesAs, type Attachment, type AuthenticateResult, type AuthenticatedUser, type BaseRequestData, type BaseStackConfig, type ChatApp, type ChatAppDataRequest, type ChatAppDataResponse, type ChatAppFeature, type ChatAppForCreate, type ChatAppForIdempotentCreateOrUpdate, type ChatAppForUpdate, type ChatAppLite, type ChatAppMode, type ChatAppOverridableFeatures, type ChatAppOverridableFeaturesForConverseFn, type ChatAppOverride, type ChatAppOverrideDdb, type ChatAppOverrideForCreateOrUpdate, type ChatDisclaimerNoticeFeature, type ChatDisclaimerNoticeFeatureForChatApp, type ChatMessage, type ChatMessageFile, type ChatMessageFileBase, ChatMessageFileLocationType, type ChatMessageFileS3, ChatMessageFileUseCase, type ChatMessageForCreate, type ChatMessageForRendering, type ChatMessageResponse, type ChatMessageUsage, type ChatMessagesResponse, type ChatSession, type ChatSessionFeedback, type ChatSessionFeedbackForCreate, type ChatSessionFeedbackForUpdate, type ChatSessionForCreate, type ChatSessionLiteForUpdate, type ChatSessionResponse, type ChatSessionsResponse, type ChatTitleUpdateRequest, type ChatUser, type ChatUserAddOrUpdateResponse, type ChatUserFeature, type ChatUserFeatureBase, type ChatUserLite, type ChatUserResponse, type ChatUserSearchResponse, type ClearConverseLambdaCacheRequest, type ClearConverseLambdaCacheResponse, type ClearConverseLambdaCacheType, ClearConverseLambdaCacheTypes, type ClearSvelteKitCacheType, ClearSvelteKitCacheTypes, type ClearSvelteKitCachesRequest, type ClearSvelteKitCachesResponse, type ClearUserOverrideDataRequest, type ClearUserOverrideDataResponse, type CompanyType, type ComponentTagDefinition, ContentAdminCommand, type ContentAdminCommandRequestBase, type ContentAdminCommandResponseBase, type ContentAdminData, type ContentAdminRequest, type ContentAdminResponse, type ContentAdminSiteFeature, type ConverseInvocationMode, ConverseInvocationModes, type ConverseRequest, type ConverseRequestWithCommand, type CreateAgentRequest, type CreateChatAppRequest, type CreateOrUpdateChatAppOverrideRequest, type CreateOrUpdateChatAppOverrideResponse, type CreateOrUpdateTagDefinitionAdminRequest, type CreateToolRequest, type CustomDataUiRepresentation, type DeleteChatAppOverrideRequest, type DeleteChatAppOverrideResponse, type DeleteTagDefinitionAdminRequest, EndToEndFeatureIdList, type EndToEndFeatureIdType, type EntitySiteFeature, type ExecutionType, FEATURE_NAMES, FEEDBACK_INTERNAL_COMMENT_STATUS, FEEDBACK_INTERNAL_COMMENT_STATUS_VALUES, FEEDBACK_INTERNAL_COMMENT_TYPE, FEEDBACK_INTERNAL_COMMENT_TYPE_VALUES, type Feature, type FeatureError, FeatureIdList, type FeatureIdType, type FeatureType, FeatureTypeArr, type FeedbackInternalComment, type FeedbackInternalCommentStatus, type FeedbackInternalCommentType, type FileUploadFeature, type FileUploadFeatureForChatApp, type GetAgentRequest, type GetAgentResponse, type GetAllAgentsAdminRequest, type GetAllAgentsAdminResponse, type GetAllChatAppsAdminRequest, type GetAllChatAppsAdminResponse, type GetAllToolsAdminRequest, type GetAllToolsAdminResponse, type GetChatAppsByRulesRequest, type GetChatAppsByRulesResponse, type GetChatMessagesAsAdminRequest, type GetChatMessagesAsAdminResponse, type GetChatSessionFeedbackResponse, type GetChatUserPrefsResponse, type GetInitialDataRequest, type GetInitialDataResponse, type GetInitialDialogDataRequest, type GetInitialDialogDataResponse, type GetInstructionAssistanceConfigFromSsmRequest, type GetInstructionAssistanceConfigFromSsmResponse, type GetValuesForAutoCompleteRequest, type GetValuesForAutoCompleteResponse, type GetValuesForContentAdminAutoCompleteRequest, type GetValuesForContentAdminAutoCompleteResponse, type GetValuesForEntityAutoCompleteRequest, type GetValuesForEntityAutoCompleteResponse, type GetValuesForUserAutoCompleteRequest, type GetValuesForUserAutoCompleteResponse, type GetViewingContentForUserResponse, type HistoryFeature, type HomePageLinksToChatAppsSiteFeature, type HomePageSiteFeature, INSIGHT_STATUS_NEEDS_INSIGHTS_ANALYSIS, Inaccurate, type InsightStatusNeedsInsightsAnalysis, type InsightsSearchParams, type InstructionAssistanceConfig, type InstructionAugmentationFeature, type InstructionAugmentationFeatureForChatApp, type InstructionAugmentationScopeType, type InstructionAugmentationScopeTypeDisplayName, InstructionAugmentationScopeTypeDisplayNames, InstructionAugmentationScopeTypes, type InstructionAugmentationType, type InstructionAugmentationTypeDisplayName, InstructionAugmentationTypeDisplayNames, InstructionAugmentationTypes, type InstructionFeature, type InvocationScopes, type KnowledgeBase, type LambdaToolDefinition, type LifecycleStatus, type LogoutFeature, type LogoutFeatureForChatApp, type McpToolDefinition, type MessageSegment, type MessageSegmentBase, MessageSource, type NameValueDescTriple, type NameValuePair, type OAuth, type PikaConfig, type PikaStack, type PikaUserRole, PikaUserRoles, type PromptInputFieldLabelFeature, type PromptInputFieldLabelFeatureForChatApp, type RecordOrUndef, type RefreshChatAppRequest, type RefreshChatAppResponse, type RetryableVerifyResponseClassification, RetryableVerifyResponseClassifications, type RolloutPolicy, SCORE_SEARCH_OPERATORS, SCORE_SEARCH_OPERATORS_VALUES, SESSION_FEEDBACK_SEVERITY, SESSION_FEEDBACK_SEVERITY_VALUES, SESSION_FEEDBACK_STATUS, SESSION_FEEDBACK_STATUS_VALUES, SESSION_FEEDBACK_TYPE, SESSION_FEEDBACK_TYPE_VALUES, SESSION_INSIGHT_GOAL_COMPLETION_STATUS, SESSION_INSIGHT_GOAL_COMPLETION_STATUS_VALUES, SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL, SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL_VALUES, SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL, SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL_VALUES, SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE, SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE_VALUES, SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED, SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED_VALUES, SESSION_INSIGHT_SATISFACTION_LEVEL, SESSION_INSIGHT_SATISFACTION_LEVEL_VALUES, SESSION_INSIGHT_USER_SENTIMENT, SESSION_INSIGHT_USER_SENTIMENT_VALUES, SESSION_SEARCH_DATE_PRESETS, SESSION_SEARCH_DATE_PRESETS_SHORT_VALUES, SESSION_SEARCH_DATE_PRESETS_VALUES, SESSION_SEARCH_DATE_TYPES, SESSION_SEARCH_DATE_TYPES_VALUES, SESSION_SEARCH_SORT_FIELDS, SESSION_SEARCH_SORT_FIELDS_VALUES, type SaveUserOverrideDataRequest, type SaveUserOverrideDataResponse, type ScoreSearchOperator, type ScoreSearchParams, type SearchSemanticDirectivesAdminRequest, type SearchSemanticDirectivesRequest, type SearchSemanticDirectivesResponse, type SearchTagDefinitionsAdminRequest, type SearchToolsRequest, type SegmentType, type SemanticDirective, type SemanticDirectiveCreateOrUpdateAdminRequest, type SemanticDirectiveCreateOrUpdateRequest, type SemanticDirectiveCreateOrUpdateResponse, type SemanticDirectiveDataRequest, type SemanticDirectiveDeleteAdminRequest, type SemanticDirectiveDeleteRequest, type SemanticDirectiveDeleteResponse, type SemanticDirectiveForCreateOrUpdate, type SemanticDirectiveScope, type SessionAttributes, type SessionAttributesWithoutToken, type SessionData, type SessionDataWithChatUserCustomDataSpreadIn, type SessionFeedbackSeverity, type SessionFeedbackStatus, type SessionFeedbackType, type SessionInsightGoalCompletionStatus, type SessionInsightMetricsAiConfidenceLevel, type SessionInsightMetricsComplexityLevel, type SessionInsightMetricsSessionDurationEstimate, type SessionInsightMetricsUserEffortRequired, type SessionInsightSatisfactionLevel, type SessionInsightScoring, type SessionInsightUsage, type SessionInsightUserSentiment, type SessionInsights, type SessionInsightsFeature, type SessionInsightsFeatureForChatApp, type SessionInsightsOpenSearchConfig, type SessionSearchAdminRequest, type SessionSearchDateFilter, type SessionSearchDatePreset, type SessionSearchDateType, type SessionSearchRequest, type SessionSearchResponse, type SessionSearchSortField, type SetChatUserPrefsRequest, type SetChatUserPrefsResponse, type SimpleAuthenticatedUser, type SimpleOption, SiteAdminCommand, type SiteAdminCommandRequestBase, type SiteAdminCommandResponseBase, type SiteAdminFeature, type SiteAdminRequest, type SiteAdminResponse, type SiteFeatures, type StopViewingContentForUserRequest, type StopViewingContentForUserResponse, type StreamingStatus, type SuggestionsFeature, type SuggestionsFeatureForChatApp, type TagDefInJsonFile, type TagDefinition, type TagDefinitionCreateOrUpdateRequest, type TagDefinitionCreateOrUpdateResponse, type TagDefinitionDeleteRequest, type TagDefinitionDeleteResponse, type TagDefinitionForCreateOrUpdate, type TagDefinitionLite, type TagDefinitionSearchRequest, type TagDefinitionSearchResponse, type TagDefinitionWebComponent, type TagDefinitionWidget, type TagDefinitionWidgetBase, type TagDefinitionWidgetCustomCompiledIn, type TagDefinitionWidgetPassThrough, type TagDefinitionWidgetPikaCompiledIn, type TagDefinitionWidgetType, type TagDefinitionWidgetWebComponent, type TagDefinitionsJsonFile, type TagMessageSegment, type TagWebComponentEncoding, type TagsChatAppOverridableFeature, type TagsFeatureForChatApp, type TagsSiteFeature, type TextMessageSegment, type ToolDefinition, type ToolDefinitionBase, type ToolDefinitionForCreate, type ToolDefinitionForIdempotentCreateOrUpdate, type ToolDefinitionForUpdate, type ToolIdToLambdaArnMap, type ToolLifecycle, type TracesFeature, type TracesFeatureForChatApp, UPDATEABLE_FEEDBACK_FIELDS, type UiCustomizationFeature, type UiCustomizationFeatureForChatApp, Unclassified, type UpdateAgentRequest, type UpdateChatAppRequest, type UpdateChatSessionFeedbackAdminRequest, type UpdateChatSessionFeedbackRequest, type UpdateChatSessionFeedbackResponse, type UpdateToolRequest, type UpdateableAgentDefinitionFields, type UpdateableChatAppFields, type UpdateableChatAppOverrideFields, type UpdateableFeedbackFields, type UpdateableToolDefinitionFields, type UserChatAppRule, type UserDataOverrideFeatureForChatApp, type UserDataOverrideSettings, type UserDataOverridesSiteFeature, type UserOverrideData, UserOverrideDataCommand, type UserOverrideDataCommandRequest, type UserOverrideDataCommandRequestBase, type UserOverrideDataCommandResponse, type UserOverrideDataCommandResponseBase, type UserPrefs, type UserRole, type UserType, UserTypes, type VerifyResponseClassification, type VerifyResponseClassificationDescription, VerifyResponseClassificationDescriptions, VerifyResponseClassifications, type VerifyResponseFeature, type VerifyResponseFeatureForChatApp, type VerifyResponseRetryableClassificationDescription, VerifyResponseRetryableClassificationDescriptions, type ViewContentForUserRequest, type ViewContentForUserResponse, type VitePreviewConfig, type ViteServerConfig };
|