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

    Cloud context value

    interface CloudContextValue {
        acknowledgeAlert: (
            alertId: string,
            note?: string,
        ) => Promise<CloudMeetingAlert>;
        baseUrl: string;
        cancelMeeting: (meetingId: string) => Promise<void>;
        createMeeting: (options: CreateMeetingOptions) => Promise<CloudMeeting>;
        credential: string | null;
        enhanceNote: (text: string, options: EnhanceOptions) => Promise<string>;
        environment: CloudEnvironment;
        getActionItems: (
            transcript: string,
            options: ActionItemsOptions,
        ) => Promise<CloudActionItem[]>;
        getAlertHistory: (
            roomId: string,
            options?: AlertHistoryOptions,
        ) => Promise<CloudMeetingAlert[]>;
        getAlertSettings: (roomId: string) => Promise<CloudAlertSettings>;
        getMeeting: (meetingId: string) => Promise<CloudMeeting>;
        getMeetings: (
            options?: {
                limit?: number;
                startAfter?: string | Date;
                startBefore?: string | Date;
                status?: string;
            },
        ) => Promise<CloudMeeting[]>;
        getSummary: (
            transcript: string,
            options: SummaryOptions,
        ) => Promise<string>;
        isConfigured: boolean;
        pushMoodToResponse: (
            responseId: string,
            userId: string,
            sentimentContext: SentimentContext,
        ) => Promise<{ responseId: string }>;
        query: (query: string, options: QueryOptions) => Promise<AIResponse>;
        queryResponse: (
            responseId: string,
            userId: string,
            query: string,
            options?: { model?: string; promptKey?: string },
        ) => Promise<AIResponse>;
        sendMeetingNotification: (
            meetingId: string,
            type?: NotificationType,
        ) => Promise<void>;
        updateAlertSettings: (
            roomId: string,
            settings: Partial<CloudAlertSettings>,
        ) => Promise<CloudAlertSettings>;
        updateMeeting: (
            meetingId: string,
            updates: Partial<CreateMeetingOptions>,
        ) => Promise<CloudMeeting>;
    }
    Index

    Properties

    acknowledgeAlert: (alertId: string, note?: string) => Promise<CloudMeetingAlert>
    baseUrl: string

    Base URL

    cancelMeeting: (meetingId: string) => Promise<void>
    createMeeting: (options: CreateMeetingOptions) => Promise<CloudMeeting>
    credential: string | null

    Masked authentication credential

    enhanceNote: (text: string, options: EnhanceOptions) => Promise<string>
    environment: CloudEnvironment

    Current environment

    getActionItems: (
        transcript: string,
        options: ActionItemsOptions,
    ) => Promise<CloudActionItem[]>
    getAlertHistory: (
        roomId: string,
        options?: AlertHistoryOptions,
    ) => Promise<CloudMeetingAlert[]>
    getAlertSettings: (roomId: string) => Promise<CloudAlertSettings>
    getMeeting: (meetingId: string) => Promise<CloudMeeting>
    getMeetings: (
        options?: {
            limit?: number;
            startAfter?: string | Date;
            startBefore?: string | Date;
            status?: string;
        },
    ) => Promise<CloudMeeting[]>
    getSummary: (transcript: string, options: SummaryOptions) => Promise<string>
    isConfigured: boolean

    Whether the provider is configured

    pushMoodToResponse: (
        responseId: string,
        userId: string,
        sentimentContext: SentimentContext,
    ) => Promise<{ responseId: string }>
    query: (query: string, options: QueryOptions) => Promise<AIResponse>
    queryResponse: (
        responseId: string,
        userId: string,
        query: string,
        options?: { model?: string; promptKey?: string },
    ) => Promise<AIResponse>
    sendMeetingNotification: (
        meetingId: string,
        type?: NotificationType,
    ) => Promise<void>
    updateAlertSettings: (
        roomId: string,
        settings: Partial<CloudAlertSettings>,
    ) => Promise<CloudAlertSettings>
    updateMeeting: (
        meetingId: string,
        updates: Partial<CreateMeetingOptions>,
    ) => Promise<CloudMeeting>