meeting_ai_companion_interface.h File Reference

Meeting Service AI Companion Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures
class	IMeetingEnableSmartSummaryHandler
	Interface to handle enable smart summary. More...
class	IMeetingStartSmartSummaryHandler
	Interface to handle starting the smart summary. More...
class	IMeetingStopSmartSummaryHandler
	Interface to handle stopping the smart summary. More...
class	IMeetingEnableSmartSummaryActionHandler
	The handler to confirm enabling smart summary. More...
class	IMeetingApproveStartSmartSummaryHandler
	The handler to approve the smart summary started request. More...
class	IMeetingApproveEnableSmartSummaryHandler
	The handler to approve the smart summary enablement request. More...
class	IMeetingAICompanionSmartSummaryHelperEvent
	Meeting smart summary callback event. More...
class	IMeetingAICompanionSmartSummaryHelper
	Smart summary helper in meeting. More...
class	ISmartSummaryPrivilegeHandler
	Interface to handle start smart summary request. More...
class	IMeetingSmartSummaryHelperEvent
	Meeting smart summary callback event. More...
class	IMeetingSmartSummaryHelper
	Meeting smart summary helper interface. More...
class	IMeetingAICompanionQueryItem
	Interface to get AI companion query item information. More...
class	IMeetingEnableQueryHandler
	Interface to enable AI companion query. More...
class	IMeetingStartQueryHandler
	Interface to start AI companion query. More...
class	IMeetingApproveEnableQueryHandler
	Interface to appprove enable AI companion query. More...
class	IMeetingApproveStartQueryHandler
	Interface to appprove start AI companion query. More...
class	IMeetingSendQueryHandler
	Interface to send query. More...
class	IMeetingEnableQueryActionHandler
	Interface to enable query action. More...
class	IMeetingApproveSendQueryHandler
class	IMeetingAICompanionQueryHelperEvent
	Meeting AI companion query callback event. More...
class	IMeetingAICompanionQueryHelper
	Meeting AI companion query helper interface. More...
class	IAICompanionFeatureTurnOnAgainHandler
class	IAICompanionFeatureSwitchHandler
	The handler to handle a user request to turn the AI Companion features on or off. More...
class	IMeetingAICompanionCtrlEvent
class	IMeetingAICompanionController
	Meeting AI Companion controller interface. More...

Enumerations
enum	AICompanionFeature { SMART_SUMMARY , QUERY , SMART_RECORDING }
enum	MeetingAICompanionQueryFeedbackType { MeetingAICompanionQueryFeedbackType_None = 0 , MeetingAICompanionQueryFeedbackType_Good , MeetingAICompanionQueryFeedbackType_Bad }
	Enumerations of the type for query feedback. More...
enum	MeetingAICompanionQueryRequestError {   MeetingAICompanionQueryRequestError_OK = 0 , MeetingAICompanionQueryRequestError_InvalidParam , MeetingAICompanionQueryRequestError_SendFailed , MeetingAICompanionQueryRequestError_WebUnAvailable ,   MeetingAICompanionQueryRequestError_PermissionVerifyFailed , MeetingAICompanionQueryRequestError_QueryRateLimitError , MeetingAICompanionQueryRequestError_Timeout , MeetingAICompanionQueryRequestError_Unknown = 100 }
	Enumerations of the type for query request error. More...
enum	MeetingAICompanionQuerySettingOptions {   MeetingAICompanionQuerySettingOptions_None = 0 , MeetingAICompanionQuerySettingOptions_WhenQueryStarted , MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin , MeetingAICompanionQuerySettingOptions_OnlyHost ,   MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization , MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin }
	Enumerations of the type for query setting options. More...

Detailed Description

Meeting Service AI Companion Interface.

Definition in file meeting_ai_companion_interface.h.

Enumeration Type Documentation

AICompanionFeature

enum AICompanionFeature

Enumerator
SMART_SUMMARY	Meeting summary with AI Companion generates summary assets.
QUERY	Meeting questions with AI Companion generates transcript assets.
SMART_RECORDING	Smart recording with AI Companion generates recording assets.

Definition at line 11 of file meeting_ai_companion_interface.h.

{
    SMART_SUMMARY,    
    QUERY,            
    SMART_RECORDING,  
};

MeetingAICompanionQueryFeedbackType

enum MeetingAICompanionQueryFeedbackType

Enumerations of the type for query feedback.

Enumerator
MeetingAICompanionQueryFeedbackType_None	Initialization.
MeetingAICompanionQueryFeedbackType_Good	Good.
MeetingAICompanionQueryFeedbackType_Bad	Bad.

Definition at line 21 of file meeting_ai_companion_interface.h.

{
    MeetingAICompanionQueryFeedbackType_None = 0,   
    MeetingAICompanionQueryFeedbackType_Good,       
    MeetingAICompanionQueryFeedbackType_Bad         
};

MeetingAICompanionQueryRequestError

enum MeetingAICompanionQueryRequestError

Enumerations of the type for query request error.

Enumerator
MeetingAICompanionQueryRequestError_OK	OK.
MeetingAICompanionQueryRequestError_InvalidParam	InvalidParam.
MeetingAICompanionQueryRequestError_SendFailed	SendFailed.
MeetingAICompanionQueryRequestError_WebUnAvailable	WebUnAvailable.
MeetingAICompanionQueryRequestError_PermissionVerifyFailed	PermissionVerifyFailed.
MeetingAICompanionQueryRequestError_QueryRateLimitError	QueryRateLimitError.
MeetingAICompanionQueryRequestError_Timeout	Timeout.
MeetingAICompanionQueryRequestError_Unknown	Unknown.

Definition at line 31 of file meeting_ai_companion_interface.h.

{
    MeetingAICompanionQueryRequestError_OK = 0,                 
    MeetingAICompanionQueryRequestError_InvalidParam,           
    MeetingAICompanionQueryRequestError_SendFailed,             
    MeetingAICompanionQueryRequestError_WebUnAvailable,         
    MeetingAICompanionQueryRequestError_PermissionVerifyFailed, 
    MeetingAICompanionQueryRequestError_QueryRateLimitError,    
    MeetingAICompanionQueryRequestError_Timeout,                
    MeetingAICompanionQueryRequestError_Unknown = 100           
};

MeetingAICompanionQuerySettingOptions

enum MeetingAICompanionQuerySettingOptions

Enumerations of the type for query setting options.

Enumerator
MeetingAICompanionQuerySettingOptions_None	Initialization.
MeetingAICompanionQuerySettingOptions_WhenQueryStarted	All participants can ask question, and answers are based on the meeting's start until now.
MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin	All participants can ask question, and answers are based on the current user's joining time until now.
MeetingAICompanionQuerySettingOptions_OnlyHost	Only hosts and users with host privileges assigned before the meeting starts can ask question.
MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization
MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin

Definition at line 46 of file meeting_ai_companion_interface.h.

{
    MeetingAICompanionQuerySettingOptions_None = 0,             
    MeetingAICompanionQuerySettingOptions_WhenQueryStarted,     
    MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin, 
    MeetingAICompanionQuerySettingOptions_OnlyHost,             
    MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization,  //All participants in our organization can ask questions, and answers include everything from the meeting's start until now.
    MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin        //All participants in our organization can ask questions, and answers only includes the meeting content after current user's join time until now.
};