@glydeunity/voice-sdk 1.5.3 → 1.5.6

package/dist/index.d.ts

@@ -318,6 +318,18 @@ export declare const componentStyles: {
     };
 };
 
+/**
+ * Conversation summary from Unity API
+ */
+declare interface ConversationSummaryResponse {
+    application_uuid: string;
+    has_history: boolean;
+    message_count: number;
+    last_message_date: string | null;
+    summary_text: string;
+    greeting: string;
+}
+
 /**
  * Deepgram agent configuration for LLM and voice settings
  */
@@ -507,6 +519,9 @@ export declare const GlydeChat: {
  *
  * Connects to GLYDE Unity API for text-based conversations.
  * Uses the screening chat endpoints for candidate interactions.
+ *
+ * Note: By default, initializes with a summary instead of loading full history.
+ * The AI greeting will acknowledge previous conversations when resuming.
  */
 export declare class GlydeText {
     private config;
@@ -514,6 +529,7 @@ export declare class GlydeText {
     private history;
     private isTyping;
     private initialized;
+    private conversationSummary;
     /**
      * Create a new GlydeText instance
      * @param config - Configuration options
@@ -533,10 +549,22 @@ export declare class GlydeText {
      */
     private setTyping;
     /**
-     * Initialize the chat session and load existing history
-     * @returns The loaded message history
+     * Initialize the chat session with a summary (not full history).
+     * Returns the greeting message to show the user.
+     *
+     * The summary includes:
+     * - has_history: whether there's previous conversation
+     * - message_count: number of previous messages
+     * - summary_text: brief summary of previous conversation
+     * - greeting: personalized greeting for the candidate
+     *
+     * @returns Array with the greeting message
      */
     initialize(): Promise<ChatMessage[]>;
+    /**
+     * Get the conversation summary (available after initialize)
+     */
+    getSummary(): ConversationSummaryResponse | null;
     /**
      * Send a message and get the agent's response
      * @param message - The message content to send
@@ -545,7 +573,12 @@ export declare class GlydeText {
     sendMessage(message: string): Promise<ChatMessage>;
     /**
      * Get the current conversation history
-     * @returns Array of chat messages
+     *
+     * IMPORTANT: System messages are filtered out - they contain AI context
+     * (summaries, instructions) that should never be displayed to users.
+     * Only user and assistant messages are returned.
+     *
+     * @returns Array of chat messages (user and assistant only)
      */
     getHistory(): ChatMessage[];
     /**
@@ -775,9 +808,27 @@ declare interface GlydeVoiceConfig_2 {
     apiKey?: string;
     /** JWT token for GLYDEBuddy passthrough (Teams app) */
     authToken?: string;
-    /** Voice context type - determines which prompt and tools to use */
+    /**
+     * Voice context type - determines which prompt and tools to use
+     *
+     * - 'screening': Screening interview for known application (contextId = application_uuid)
+     * - 'recruiter': Internal recruiter copilot (no contextId needed)
+     * - 'custom': Custom context with overridden prompts
+     * - 'phone': Phone agent context
+     * - 'discovery': Unknown candidate exploring opportunities (no contextId needed)
+     * - 'job_apply': Unknown candidate applying to specific job (contextId = job_uuid)
+     * - 'candidate_discover': OTP-verified candidate exploring (contextId = candidate_uuid)
+     * - 'candidate_apply': Known candidate applying to job (contextId = candidate_uuid:job_uuid)
+     */
     contextType: VoiceContextType_2;
-    /** Context identifier (e.g., application_uuid) - required for screening */
+    /**
+     * Context identifier - format depends on contextType:
+     * - screening: application_uuid (required)
+     * - job_apply: job_uuid (required)
+     * - candidate_discover: candidate_uuid (required)
+     * - candidate_apply: "candidate_uuid:job_uuid" (required)
+     * - discovery, recruiter, custom, phone: optional
+     */
     contextId?: string;
     /** Unity API base URL - defaults to https://api.glydeunity.com */
     unityBaseUrl?: string;
@@ -1176,8 +1227,18 @@ export declare type VoiceContextType = 'screening' | 'recruiter' | 'custom' | 'p
  * Provides voice interaction capabilities with GLYDE AI agents through Deepgram Voice API.
  * Supports multiple authentication methods: publishableKey, apiKey, and JWT token.
  *
+ * Context Types:
+ * - screening: Known candidate with application_uuid - screening interview
+ * - recruiter: Internal recruiter copilot
+ * - custom: Custom context with overridden prompts
+ * - phone: Phone agent context
+ * - discovery: Unknown candidate, no job - guide to opportunities (publishable_key only)
+ * - job_apply: Unknown candidate, known job - apply to specific job (contextId = job_uuid)
+ * - candidate_discover: Known candidate (OTP verified), no job - explore opportunities (contextId = candidate_uuid)
+ * - candidate_apply: Known candidate, known job - apply and start screening (contextId = candidate_uuid:job_uuid)
+ *
  * @example
- * // Using publishable key (external apps)
+ * // Screening interview for existing application
  * const voice = new GlydeVoice({
  *   publishableKey: 'pk_...',
  *   contextType: 'screening',
@@ -1185,6 +1246,21 @@ export declare type VoiceContextType = 'screening' | 'recruiter' | 'custom' | 'p
  * });
  *
  * @example
+ * // Discovery mode - unknown candidate exploring opportunities
+ * const voice = new GlydeVoice({
+ *   publishableKey: 'pk_...',
+ *   contextType: 'discovery'
+ * });
+ *
+ * @example
+ * // Job apply - unknown candidate applying to specific job
+ * const voice = new GlydeVoice({
+ *   publishableKey: 'pk_...',
+ *   contextType: 'job_apply',
+ *   contextId: 'job-uuid'
+ * });
+ *
+ * @example
  * // Using JWT token (GLYDEBuddy Teams app)
  * const voice = new GlydeVoice({
  *   authToken: userSession.accessToken,
@@ -1193,8 +1269,16 @@ export declare type VoiceContextType = 'screening' | 'recruiter' | 'custom' | 'p
  */
 /**
  * Voice context types supported by the voice agent
- */
-declare type VoiceContextType_2 = 'screening' | 'recruiter' | 'custom' | 'phone';
+ * - screening: Known candidate with application_uuid - screening interview
+ * - recruiter: Internal recruiter copilot
+ * - custom: Custom context with overridden prompts
+ * - phone: Phone agent context
+ * - discovery: Unknown candidate, no job - guide to opportunities
+ * - job_apply: Unknown candidate, known job - apply to specific job
+ * - candidate_discover: Known candidate (OTP verified), no job - explore opportunities
+ * - candidate_apply: Known candidate, known job - apply and start screening
+ */
+declare type VoiceContextType_2 = 'screening' | 'recruiter' | 'custom' | 'phone' | 'discovery' | 'job_apply' | 'candidate_discover' | 'candidate_apply';
 
 /**
  * Voice events emitted by the agent