Hiyve Components - v1.0.0
    Preparing search index...

    Interface IntelligenceHubProps

    Props for the IntelligenceHub component.

    interface IntelligenceHubProps {
        alertsAutoRefresh?: boolean;
        alertsAutoRefreshInterval?: number;
        colors?: Partial<IntelligenceHubColors>;
        conversationManagerOptions?: ConversationManagerOptions;
        customTabs?: IntelligenceHubTab[];
        defaultTab?: string;
        hasTranscriptions?: boolean;
        intelligenceConfig?: IntelligenceConfig;
        isOwner?: boolean;
        labels?: Partial<IntelligenceHubLabels>;
        liveContextActive?: boolean;
        onIntelligenceConfigChange?: (config: IntelligenceConfig) => void;
        onSend?: (message: string) => Promise<string>;
        quickActions?: QuickAction[];
        readiness?: UseIntelligenceReadinessResult;
        renderCaptionsContent?: () => ReactNode;
        renderCustomTab?: (tabId: string) => ReactNode;
        responseId?: string;
        roomId: string;
        sentimentAutoSave?: boolean;
        showAlerts?: boolean;
        showAssistant?: boolean;
        showCaptions?: boolean;
        showConversationManager?: boolean;
        showSentiment?: boolean;
        showSettings?: boolean;
        styles?: Partial<IntelligenceHubStyles>;
        sx?: SxProps<Theme>;
        systemPrompt?: string;
        tabOrder?: string[];
        userId: string;
    }
    Index

    Properties

    alertsAutoRefresh? alertsAutoRefreshInterval? colors? conversationManagerOptions? customTabs? defaultTab? hasTranscriptions? intelligenceConfig? isOwner? labels? liveContextActive? onIntelligenceConfigChange? onSend? quickActions? readiness? renderCaptionsContent? renderCustomTab? responseId? roomId sentimentAutoSave? showAlerts? showAssistant? showCaptions? showConversationManager? showSentiment? showSettings? styles? sx? systemPrompt? tabOrder? userId

    Properties

    alertsAutoRefresh?: boolean

    Auto-refresh alerts

    alertsAutoRefreshInterval?: number

    Auto-refresh interval in seconds

    colors?: Partial<IntelligenceHubColors>

    Custom colors

    conversationManagerOptions?: ConversationManagerOptions

    Options for the conversation manager

    customTabs?: IntelligenceHubTab[]

    Custom tabs appended after built-in tabs

    defaultTab?: string

    Default active tab ID

    hasTranscriptions?: boolean

    Whether transcriptions are available

    intelligenceConfig?: IntelligenceConfig

    Current intelligence configuration

    isOwner?: boolean

    Whether the current user is the room owner

    labels?: Partial<IntelligenceHubLabels>

    Custom labels for i18n

    liveContextActive?: boolean

    Whether live context is active

    Use responseId instead

    onIntelligenceConfigChange?: (config: IntelligenceConfig) => void

    Callback when intelligence configuration changes

    onSend?: (message: string) => Promise<string>

    Custom AI query handler

    quickActions?: QuickAction[]

    Quick action buttons

    readiness?: UseIntelligenceReadinessResult

    Intelligence readiness state (from useIntelligenceReadiness)

    renderCaptionsContent?: () => ReactNode

    Custom content for the captions tab. Since TranscriptViewer lives in @hiyve/react-capture (not a dependency of this package), consumers provide their own captions UI via this prop.

    If not provided, a placeholder with readiness status is shown.

    import { TranscriptViewer } from '@hiyve/react-capture';

    <IntelligenceHub
      renderCaptionsContent={() => (
        <TranscriptViewer showTimestamps showSentiment autoScroll />
      )}
    />
    renderCustomTab?: (tabId: string) => ReactNode

    Render function for custom tab content

    responseId?: string

    OpenAI Responses API context ID from the recording bot

    roomId: string

    Room ID for the current session

    sentimentAutoSave?: boolean

    Auto-save sentiment data

    showAlerts?: boolean

    Show the Alerts tab

    showAssistant?: boolean

    Show the AI Assistant tab

    showCaptions?: boolean

    Show the Captions/Transcript tab

    showConversationManager?: boolean

    Enable multi-conversation management

    showSentiment?: boolean

    Show the Sentiment tab

    showSettings?: boolean

    Show the Settings tab (owner-only intelligence settings)

    styles?: Partial<IntelligenceHubStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx prop

    systemPrompt?: string

    System prompt for the AI assistant

    tabOrder?: string[]

    Tab display order (default: ['assistant', 'captions', 'alerts', 'sentiment', 'settings'])

    userId: string

    User ID of the current user

    Settings

    Member Visibility

    On This Page

    Properties