pika-shared 1.0.2

package/dist/types/chatbot/chatbot-types.mjs

@@ -0,0 +1,301 @@
+// src/types/chatbot/chatbot-types.ts
+var INSIGHT_STATUS_NEEDS_INSIGHTS_ANALYSIS = "NEEDS_INSIGHTS_ANALYSIS";
+var SESSION_FEEDBACK_STATUS = ["open", "in_review", "resolved", "closed"];
+var SESSION_FEEDBACK_STATUS_VALUES = [
+  { name: "Open", value: "open" },
+  { name: "In Review", value: "in_review" },
+  { name: "Resolved", value: "resolved" },
+  { name: "Closed", value: "closed" }
+];
+var SESSION_FEEDBACK_SEVERITY = ["low", "medium", "high", "critical"];
+var SESSION_FEEDBACK_SEVERITY_VALUES = [
+  { name: "Low", value: "low" },
+  { name: "Medium", value: "medium" },
+  { name: "High", value: "high" },
+  { name: "Critical", value: "critical" }
+];
+var SESSION_FEEDBACK_TYPE = [
+  "user_thumbs_up",
+  "user_thumbs_down",
+  "incorrect_information",
+  "incomplete_information",
+  "off_topic",
+  "hallucination",
+  "confusing_response",
+  "outdated_information",
+  "inappropriate_content",
+  "privacy_concern",
+  "harmful_content",
+  "system_error",
+  "timeout_occurred",
+  "tool_failure",
+  "poor_performance",
+  "training_example",
+  "context_awareness_issue",
+  "goal_misalignment",
+  "tool_capability_gap",
+  "tool_performance_issue",
+  "cost_issue",
+  "high_complexity_session",
+  "low_ai_confidence_level",
+  "critical_issues_present",
+  "user_dissatisfied",
+  "user_question_to_chat_author",
+  "other"
+];
+var SESSION_FEEDBACK_TYPE_VALUES = [
+  { name: "Confusing Response", value: "confusing_response", desc: "Session was confusing" },
+  { name: "Context Awareness Issue", value: "context_awareness_issue", desc: "Session had context awareness issue" },
+  { name: "Cost Issue", value: "cost_issue", desc: "Session had cost issue" },
+  { name: "Critical Issues Present", value: "critical_issues_present", desc: "Session had critical issues present" },
+  { name: "Goal Misalignment", value: "goal_misalignment", desc: "Session had goal misalignment" },
+  { name: "Hallucination", value: "hallucination", desc: "Session contained hallucinations" },
+  { name: "Harmful Content", value: "harmful_content", desc: "Session contained harmful content" },
+  { name: "High Complexity Session", value: "high_complexity_session", desc: "Session was high complexity" },
+  { name: "Inappropriate Content", value: "inappropriate_content", desc: "Session contained inappropriate content" },
+  { name: "Incorrect Information", value: "incorrect_information", desc: "Session contained incorrect information" },
+  { name: "Incomplete Information", value: "incomplete_information", desc: "Session contained incomplete information" },
+  { name: "Low AI Confidence Level", value: "low_ai_confidence_level", desc: "Session had low AI confidence level" },
+  { name: "Off Topic", value: "off_topic", desc: "Session was off topic" },
+  { name: "Other", value: "other", desc: "Session had indeterminate issue" },
+  { name: "Outdated Information", value: "outdated_information", desc: "Session contained outdated information" },
+  { name: "Poor Performance", value: "poor_performance", desc: "Session experienced poor performance" },
+  { name: "Privacy Concern", value: "privacy_concern", desc: "Session contained privacy concern" },
+  { name: "System Error", value: "system_error", desc: "Session encountered system error" },
+  { name: "Timeout Occurred", value: "timeout_occurred", desc: "Session timed out" },
+  { name: "Tool Capability Gap", value: "tool_capability_gap", desc: "Session had tool capability gap" },
+  { name: "Tool Failure", value: "tool_failure", desc: "Session encountered tool failure" },
+  { name: "Tool Performance Issue", value: "tool_performance_issue", desc: "Session had tool performance issue" },
+  { name: "Training Example", value: "training_example", desc: "Session was training example" },
+  { name: "User Dissatisfied", value: "user_dissatisfied", desc: "User was dissatisfied with session." },
+  { name: "User Question to Chat Author", value: "user_question_to_chat_author", desc: "User asked question not to AI but to chat app author" },
+  { name: "User Thumbs Down", value: "user_thumbs_down", desc: "User gave thumbs down to session" },
+  { name: "User Thumbs Up", value: "user_thumbs_up", desc: "User gave thumbs up to session" }
+];
+var UPDATEABLE_FEEDBACK_FIELDS = ["status", "severity", "type", "internalComments", "userComment", "attachments"];
+var FEEDBACK_INTERNAL_COMMENT_STATUS = ["open", "closed"];
+var FEEDBACK_INTERNAL_COMMENT_STATUS_VALUES = [
+  { name: "Open", value: "open", desc: "The comment is open and is awaiting action." },
+  { name: "Closed", value: "closed", desc: "The comment is closed and has been resolved." }
+];
+var FEEDBACK_INTERNAL_COMMENT_TYPE = [
+  "comment",
+  "customer_outreach_recommended",
+  "customer_outreach_made",
+  "technical_action_required",
+  "technical_action_completed"
+];
+var FEEDBACK_INTERNAL_COMMENT_TYPE_VALUES = [
+  { name: "Comment", value: "comment", desc: "A comment about the feedback." },
+  { name: "Customer Outreach Recommended", value: "customer_outreach_recommended", desc: "A recommendation to reach out to the customer." },
+  { name: "Customer Outreach Made", value: "customer_outreach_made", desc: "A record that an outreach was made to the customer." },
+  { name: "Technical Action Required", value: "technical_action_required", desc: "A technical action is required to resolve the feedback." },
+  { name: "Technical Action Completed", value: "technical_action_completed", desc: "A record that a technical action was completed to resolve the feedback." }
+];
+var SESSION_INSIGHT_USER_SENTIMENT = ["positive", "neutral", "negative"];
+var SESSION_INSIGHT_USER_SENTIMENT_VALUES = [
+  { name: "Positive", value: "positive", desc: "The user is satisfied with the session." },
+  { name: "Neutral", value: "neutral", desc: "The user is neutral about the session." },
+  { name: "Negative", value: "negative", desc: "The user is dissatisfied with the session." }
+];
+var SESSION_INSIGHT_GOAL_COMPLETION_STATUS = ["completed", "partially_completed", "not_completed"];
+var SESSION_INSIGHT_GOAL_COMPLETION_STATUS_VALUES = [
+  { name: "Completed", value: "completed", desc: "The agent achieved the goal." },
+  { name: "Partially Completed", value: "partially_completed", desc: "The agent partially achieved the goal." },
+  { name: "Not Completed", value: "not_completed", desc: "The agent did not achieve the goal." }
+];
+var SESSION_INSIGHT_SATISFACTION_LEVEL = ["satisfied", "neutral", "dissatisfied"];
+var SESSION_INSIGHT_SATISFACTION_LEVEL_VALUES = [
+  { name: "Satisfied", value: "satisfied", desc: "The user is satisfied with the overall session." },
+  { name: "Neutral", value: "neutral", desc: "The user is neutral about the overall session." },
+  { name: "Dissatisfied", value: "dissatisfied", desc: "The user is dissatisfied with the overall session." }
+];
+var SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE = ["short", "medium", "long"];
+var SESSION_INSIGHT_METRICS_SESSION_DURATION_ESTIMATE_VALUES = [
+  { name: "Short", value: "short", desc: "The session was short." },
+  { name: "Medium", value: "medium", desc: "The session was medium." },
+  { name: "Long", value: "long", desc: "The session was long." }
+];
+var SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL = ["low", "medium", "high"];
+var SESSION_INSIGHT_METRICS_COMPLEXITY_LEVEL_VALUES = [
+  { name: "Low", value: "low", desc: "The session was low complexity." },
+  { name: "Medium", value: "medium", desc: "The session was medium complexity." },
+  { name: "High", value: "high", desc: "The session was high complexity." }
+];
+var SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED = ["low", "medium", "high"];
+var SESSION_INSIGHT_METRICS_USER_EFFORT_REQUIRED_VALUES = [
+  { name: "Low", value: "low", desc: "The user required low effort to get the response they wanted." },
+  { name: "Medium", value: "medium", desc: "The user required medium effort to get the response they wanted." },
+  { name: "High", value: "high", desc: "The user required high effort to get the response they wanted." }
+];
+var SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL = ["low", "medium", "high"];
+var SESSION_INSIGHT_METRICS_AI_CONFIDENCE_LEVEL_VALUES = [
+  { name: "Low", value: "low", desc: "The AI was not confident in the response." },
+  { name: "Medium", value: "medium", desc: "The AI was moderately confident in the response." },
+  { name: "High", value: "high", desc: "The AI was highly confident in the response." }
+];
+var MessageSource = ["user", "assistant"];
+var ChatMessageFileLocationType = ["s3"];
+var ChatMessageFileUseCase = [
+  /** This means the file will be read by the LLM and it will be used to answer the user's question. */
+  "chat",
+  /**
+   * We will append the following to the user's message before we give it to the LLM:
+   *
+   * (if the  file is of type ChatMessageFileS3)
+   * Available S3 files: s3://<s3-bucket-name>/<s3-key>
+   *
+   * You can be certain the <s3-bucket-name> will always be this value from SSM `/stack/chatbot/${this.stage}/s3/pika_bucket_name` so you
+   * can add permissions to allow your lambda tool to have read access to the uploaded files.
+   */
+  "pass-through",
+  /**
+   * This means that the LLM will write and execute Python code to analyze the contents of the file to answer the user's question.
+   */
+  "analytics"
+];
+var UserTypes = ["internal-user", "external-user"];
+var PikaUserRoles = [
+  // A content admin may choose any user in the system and view his chat sessions and messages
+  "pika:content-admin",
+  // A site admin may modify access settings for chat apps and assign roles to users
+  "pika:site-admin"
+];
+var FeatureTypeArr = ["instruction", "history"];
+var SESSION_SEARCH_SORT_FIELDS = ["createDate", "lastUpdate", "sessionId", "inputTokens", "outputTokens", "totalCost", "insightGoalAchievementScore"];
+var SESSION_SEARCH_SORT_FIELDS_VALUES = [
+  { name: "Create Date", value: "createDate" },
+  { name: "Last Update", value: "lastUpdate" },
+  { name: "Session ID", value: "sessionId" },
+  { name: "Input Tokens", value: "inputTokens" },
+  { name: "Output Tokens", value: "outputTokens" },
+  { name: "Total Cost", value: "totalCost" },
+  { name: "Insight Goal Achievement Score", value: "insightGoalAchievementScore" }
+];
+var SESSION_SEARCH_DATE_TYPES = ["created", "updated", "feedback"];
+var SESSION_SEARCH_DATE_TYPES_VALUES = [
+  { name: "Create Date", value: "created" },
+  { name: "Last Update", value: "updated" },
+  { name: "Feedback Created", value: "feedback" }
+];
+var SESSION_SEARCH_DATE_PRESETS = [
+  "1-minute",
+  "5-minutes",
+  "last-hour",
+  "last-day",
+  "last-week",
+  "last-month",
+  "last-3months",
+  "last-6-months",
+  "last-year",
+  "last-2-years"
+];
+var SESSION_SEARCH_DATE_PRESETS_VALUES = [
+  { name: "1 Minute", value: "1-minute" },
+  { name: "5 Minutes", value: "5-minutes" },
+  { name: "Last Hour", value: "last-hour" },
+  { name: "Last Day", value: "last-day" },
+  { name: "Last Week", value: "last-week" },
+  { name: "Last Month", value: "last-month" },
+  { name: "Last 3 Months", value: "last-3months" },
+  { name: "Last 6 Months", value: "last-6-months" },
+  { name: "Last Year", value: "last-year" },
+  { name: "Last 2 Years", value: "last-2-years" }
+];
+var SESSION_SEARCH_DATE_PRESETS_SHORT_VALUES = [
+  { name: "1 Min", value: "1-minute" },
+  { name: "5 Min", value: "5-minutes" },
+  { name: "Hour", value: "last-hour" },
+  { name: "Day", value: "last-day" },
+  { name: "Week", value: "last-week" },
+  { name: "Month", value: "last-month" },
+  { name: "3 Mo", value: "last-3months" },
+  { name: "6 Mo", value: "last-6-months" },
+  { name: "Year", value: "last-year" },
+  { name: "2 Yrs", value: "last-2-years" }
+];
+var SCORE_SEARCH_OPERATORS = ["eq", "gte", "lte"];
+var SCORE_SEARCH_OPERATORS_VALUES = [
+  { name: "=", value: "eq" },
+  { name: ">=", value: "gte" },
+  { name: "<=", value: "lte" }
+];
+var FeatureIdList = [
+  "fileUpload",
+  "promptInputFieldLabel",
+  "suggestions",
+  "uiCustomization",
+  "verifyResponse",
+  "traces",
+  "chatDisclaimerNotice",
+  "logout",
+  "sessionInsights",
+  "userDataOverrides"
+];
+var EndToEndFeatureIdList = ["verifyResponse", "traces"];
+var FEATURE_NAMES = {
+  fileUpload: "File Upload",
+  promptInputFieldLabel: "Prompt Input Field Label",
+  suggestions: "Suggestions",
+  uiCustomization: "UI Customization",
+  verifyResponse: "Verify Response",
+  traces: "Traces",
+  chatDisclaimerNotice: "Chat Disclaimer Notice",
+  logout: "Logout",
+  sessionInsights: "Session Insights",
+  userDataOverrides: "User Data Override"
+};
+var SiteAdminCommand = [
+  "getInitialData",
+  "refreshChatApp",
+  "createOrUpdateChatAppOverride",
+  "deleteChatAppOverride",
+  "getValuesForEntityAutoComplete",
+  "getValuesForUserAutoComplete",
+  "clearChatAppCache",
+  "addChatSessionFeedback",
+  "updateChatSessionFeedback",
+  "sessionSearch",
+  "getChatMessagesAsAdmin"
+];
+var ContentAdminCommand = ["viewContentForUser", "stopViewingContentForUser", "getValuesForAutoComplete"];
+var UserOverrideDataCommand = ["getInitialDialogData", "getValuesForAutoComplete", "saveUserOverrideData", "clearUserOverrideData"];
+var Accurate = "A";
+var AccurateWithStatedAssumptions = "B";
+var AccurateWithUnstatedAssumptions = "C";
+var Inaccurate = "F";
+var Unclassified = "U";
+var VerifyResponseClassifications = [Accurate, AccurateWithStatedAssumptions, AccurateWithUnstatedAssumptions, Inaccurate, Unclassified];
+var RetryableVerifyResponseClassifications = [AccurateWithStatedAssumptions, AccurateWithUnstatedAssumptions, Inaccurate];
+var VerifyResponseClassificationDescriptions = {
+  [Accurate]: { classification: Accurate, label: "Accurate", description: "The response is completely accurate." },
+  [AccurateWithStatedAssumptions]: {
+    classification: AccurateWithStatedAssumptions,
+    label: "Accurate with stated assumptions",
+    description: "The response is accurate but contains clearly stated assumptions"
+  },
+  [AccurateWithUnstatedAssumptions]: {
+    classification: AccurateWithUnstatedAssumptions,
+    label: "Accurate with unstated assumptions",
+    description: "The response is accurate but contains assumptions that are not explicitly stated"
+  },
+  [Inaccurate]: { classification: Inaccurate, label: "Inaccurate", description: "The response is inaccurate or contains made up information" },
+  [Unclassified]: { classification: Unclassified, label: "Unclassified", description: "The response was not given a classification" }
+};
+var VerifyResponseRetryableClassificationDescriptions = {
+  [AccurateWithStatedAssumptions]: {
+    classification: AccurateWithStatedAssumptions,
+    label: "Accurate with stated assumptions",
+    description: "The response is accurate but contains clearly stated assumptions"
+  },
+  [AccurateWithUnstatedAssumptions]: {
+    classification: AccurateWithUnstatedAssumptions,
+    label: "Accurate with unstated assumptions",
+    description: "The response is accurate but contains assumptions that are not explicitly stated"
+  },
+  [Inaccurate]: { classification: Inaccurate, label: "Inaccurate", description: "The response is inaccurate or contains made up information" }
+};
+
+export { Accurate, AccurateWithStatedAssumptions, AccurateWithUnstatedAssumptions, ChatMessageFileLocationType, ChatMessageFileUseCase, ContentAdminCommand, EndToEndFeatureIdList, FEATURE_NAMES, FEEDBACK_INTERNAL_COMMENT_STATUS, FEEDBACK_INTERNAL_COMMENT_STATUS_VALUES, FEEDBACK_INTERNAL_COMMENT_TYPE, FEEDBACK_INTERNAL_COMMENT_TYPE_VALUES, FeatureIdList, FeatureTypeArr, INSIGHT_STATUS_NEEDS_INSIGHTS_ANALYSIS, Inaccurate, MessageSource, PikaUserRoles, RetryableVerifyResponseClassifications, 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, SiteAdminCommand, UPDATEABLE_FEEDBACK_FIELDS, Unclassified, UserOverrideDataCommand, UserTypes, VerifyResponseClassificationDescriptions, VerifyResponseClassifications, VerifyResponseRetryableClassificationDescriptions };
+//# sourceMappingURL=chatbot-types.mjs.map
+//# sourceMappingURL=chatbot-types.mjs.map