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

    Interface AIAssistantProps

    Props for AIAssistant component

    interface AIAssistantProps {
        client?: AIAssistantFileClient;
        cloud?: AIAssistantCloudContext;
        colors?: Partial<AIAssistantColors>;
        compact?: boolean;
        hasTranscriptions?: boolean;
        icons?: Partial<AIAssistantIcons>;
        labels?: Partial<AIAssistantLabels>;
        liveContextActive?: boolean;
        messages?: AssistantMessage[];
        model?: string;
        notReadyMessage?: string;
        onError?: (error: Error) => void;
        onMessagesChange?: (messages: AssistantMessage[]) => void;
        onSend?: (message: string) => Promise<string>;
        quickActions?: QuickAction[];
        quickActionsPosition?: "top" | "above-input";
        responseId?: string;
        roomId?: string;
        saveAsNote?: boolean | ChatNoteSaveConfig;
        showHeader?: boolean;
        showHistory?: boolean;
        showQuickActions?: boolean;
        styles?: Partial<AIAssistantStyles>;
        suggestions?: string[];
        sx?: SxProps<Theme>;
        systemPrompt?: string;
        userId?: string;
    }
    Index

    Properties

    client? cloud? colors? compact? hasTranscriptions? icons? labels? liveContextActive? messages? model? notReadyMessage? onError? onMessagesChange? onSend? quickActions? quickActionsPosition? responseId? roomId? saveAsNote? showHeader? showHistory? showQuickActions? styles? suggestions? sx? systemPrompt? userId?

    Properties

    client?: AIAssistantFileClient

    Hiyve client instance for file operations (e.g. note saving). Auto-detected from HiyveProvider when omitted.

    cloud?: AIAssistantCloudContext

    Cloud context for AI queries (query, queryResponse). Auto-detected from CloudProvider when omitted.

    colors?: Partial<AIAssistantColors>

    Custom colors

    compact?: boolean

    Whether to show in compact mode

    hasTranscriptions?: boolean

    Whether transcriptions are available. In meeting mode (roomId provided), AI queries are disabled until this is true.

    icons?: Partial<AIAssistantIcons>

    Custom icons

    labels?: Partial<AIAssistantLabels>

    Custom labels

    liveContextActive?: boolean

    Whether live context is active. In meeting mode (roomId provided), AI queries are disabled until this is true.

    Use responseId instead — liveContextActive={!!responseId}

    messages?: AssistantMessage[]

    External messages state (for persistent storage across unmounts)

    model?: string

    AI model override (e.g., 'gpt-4o-mini', 'grok-4-fast')

    notReadyMessage?: string

    Custom message when AI is not ready (meeting mode only)

    onError?: (error: Error) => void

    Callback on error

    onMessagesChange?: (messages: AssistantMessage[]) => void

    Callback when messages change (required when messages is provided)

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

    Callback when message is sent

    quickActions?: QuickAction[]

    Quick actions to display

    quickActionsPosition?: "top" | "above-input"

    Position of quick actions: 'top' (default, hidden after first message) or 'above-input' (always visible)

    responseId?: string

    OpenAI Responses API context ID from the recording bot. When provided in meeting mode, enables AI queries via queryResponse. In meeting mode (roomId provided), AI queries are disabled until this is truthy.

    roomId?: string

    Room ID for context

    saveAsNote?: boolean | ChatNoteSaveConfig

    Enable auto-saving conversation as a Note. Pass true for defaults, or a config object.

    showHeader?: boolean

    Whether to show header

    showHistory?: boolean

    Whether to show conversation history

    showQuickActions?: boolean

    Whether to show quick actions

    styles?: Partial<AIAssistantStyles>

    Custom styles

    suggestions?: string[]

    Suggested queries

    sx?: SxProps<Theme>

    MUI sx prop

    systemPrompt?: string

    Initial system prompt

    userId?: string

    User ID for cloud integration (required for AI features)

    Settings

    Member Visibility

    On This Page

    Properties