Meeting Service AI Companion Interface. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility. More...

#include "zoom_sdk_def.h"

Data Structures
class	IMeetingEnableSmartSummaryHandler
	The handler to enable smart summary. More...
class	IMeetingStartSmartSummaryHandler
	The handler to start the smart summary. More...
class	IMeetingStopSmartSummaryHandler
	The handler 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 enable request. More...
class	IMeetingAICompanionSmartSummaryHelperEvent
	Meeting smart summary callback event. More...
class	IMeetingAICompanionSmartSummaryHelper
	Smart summary helper in meeting. More...
class	ISmartSummaryPrivilegeHandler
	The handler of start smart summary request. More...
class	IMeetingSmartSummaryHelperEvent
	Meeting smart summary callback event. More...
class	IMeetingSmartSummaryHelper
	Meeting smart summary helper interface. More...
class	IMeetingAICompanionQueryItem
	Get AI companion query item information. More...
class	IMeetingEnableQueryHandler
	The handler to enable AI companion query. More...
class	IMeetingStartQueryHandler
	The handler to start AI companion query. More...
class	IMeetingApproveEnableQueryHandler
	The handler to approve enable AI companion query. More...
class	IMeetingApproveStartQueryHandler
	The handler to approve start AI companion query. More...
class	IMeetingSendQueryHandler
	The handler to send query. More...
class	IMeetingEnableQueryActionHandler
	The handler to enable query action. More...
class	IMeetingApproveSendQueryHandler
	The handler to approve send query. More...
class	IMeetingAICompanionQueryHelperEvent
	Meeting AI companion query callback event. More...
class	IMeetingAICompanionQueryHelper
	Meeting AI companion query helper interface. More...
class	IAICompanionFeatureTurnOnAgainHandler
	The handler to turn on AI companion feature again. More...
class	IAICompanionFeatureSwitchHandler
	The handler to handle a user request to turn the AI Companion features on or off. More...
class	IMeetingAICompanionCtrlEvent
	The event of AI companion controller. More...
class	IMeetingAICompanionController
	Meeting AI Companion controller interface. More...

Enumerations
enum	AICompanionFeature { SMART_SUMMARY , QUERY , SMART_RECORDING }
	Enumeration of AI companion feature. More...
enum	MeetingAICompanionQueryFeedbackType { MeetingAICompanionQueryFeedbackType_None = 0 , MeetingAICompanionQueryFeedbackType_Good , MeetingAICompanionQueryFeedbackType_Bad }
	Enumeration of feedback types for AI Companion queries in a meeting. More...
enum	MeetingAICompanionQueryRequestError { MeetingAICompanionQueryRequestError_OK = 0 , MeetingAICompanionQueryRequestError_InvalidParam , MeetingAICompanionQueryRequestError_SendFailed , MeetingAICompanionQueryRequestError_WebUnAvailable , MeetingAICompanionQueryRequestError_PermissionVerifyFailed , MeetingAICompanionQueryRequestError_QueryRateLimitError , MeetingAICompanionQueryRequestError_Timeout , MeetingAICompanionQueryRequestError_Unknown = 100 }
	Enumeration of possible error codes when requesting an AI Companion query during a meeting. More...
enum	MeetingAICompanionQuerySettingOptions { MeetingAICompanionQuerySettingOptions_None = 0 , MeetingAICompanionQuerySettingOptions_WhenQueryStarted , MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin , MeetingAICompanionQuerySettingOptions_OnlyHost , MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization , MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin , MeetingAICompanionQuerySettingOptions_HostAndPanelists = 10 , MeetingAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization }
	Enumeration of config who in the meeting can interact with AI Companion by asking questions about the meeting. please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057749. More...

Detailed Description

Meeting Service AI Companion Interface. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.

Definition in file meeting_ai_companion_interface.h.

Enumeration Type Documentation

◆ AICompanionFeature

enum AICompanionFeature

Enumeration of AI companion feature.

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 15 of file meeting_ai_companion_interface.h.

{
    SMART_SUMMARY,    
    QUERY,            
    SMART_RECORDING,  
};

◆ MeetingAICompanionQueryFeedbackType

enum MeetingAICompanionQueryFeedbackType

Enumeration of feedback types for AI Companion queries in a meeting.

Enumerator
MeetingAICompanionQueryFeedbackType_None	No feedback provided.
MeetingAICompanionQueryFeedbackType_Good	The feedback indicates the query response was helpful or satisfactory.
MeetingAICompanionQueryFeedbackType_Bad	The feedback indicates the query response was unhelpful or unsatisfactory.

Definition at line 28 of file meeting_ai_companion_interface.h.

{
    MeetingAICompanionQueryFeedbackType_None = 0,   
    MeetingAICompanionQueryFeedbackType_Good,       
    MeetingAICompanionQueryFeedbackType_Bad
};

◆ MeetingAICompanionQueryRequestError

enum MeetingAICompanionQueryRequestError

Enumeration of possible error codes when requesting an AI Companion query during a meeting.

Enumerator
MeetingAICompanionQueryRequestError_OK	Request succeeded with no error.
MeetingAICompanionQueryRequestError_InvalidParam	The provided parameter(s) are invalid.
MeetingAICompanionQueryRequestError_SendFailed	Failed to send the query request.
MeetingAICompanionQueryRequestError_WebUnAvailable	The AI Companion web service is unavailable.
MeetingAICompanionQueryRequestError_PermissionVerifyFailed	Permission verification failed for the request.
MeetingAICompanionQueryRequestError_QueryRateLimitError	The query request was rate-limited due to excessive frequency.
MeetingAICompanionQueryRequestError_Timeout	The query request timed out.
MeetingAICompanionQueryRequestError_Unknown	An unknown error occurred.

Definition at line 41 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

Enumeration of config who in the meeting can interact with AI Companion by asking questions about the meeting. please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057749.

Enumerator
MeetingAICompanionQuerySettingOptions_None	Initialization.
MeetingAICompanionQuerySettingOptions_WhenQueryStarted	Allows all participants and attendee to ask questions about all discussions since AI Companion was active.
MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin	Allows all participants to ask questions about the discussion since they joined the current meeting.
MeetingAICompanionQuerySettingOptions_OnlyHost	Allow only the host, alternative host, and users with host privileges assigned before the meeting starts to ask questions about all discussions since AI Companion is active.
MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization	Allows only participants and invitees from your organization to ask questions about all discussions since AI Companion was active.
MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin	Allows only participants from your organization to ask questions about the discussion since they joined the current meeting.
MeetingAICompanionQuerySettingOptions_HostAndPanelists	Hosts and all panelists can ask question, and answers are based on the meeting's start until now.
MeetingAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization	Hosts and all panelists in our organization can ask question, and answers are based on the meeting's start until now.

Definition at line 64 of file meeting_ai_companion_interface.h.

{
    MeetingAICompanionQuerySettingOptions_None = 0,             
    MeetingAICompanionQuerySettingOptions_WhenQueryStarted,     
    MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin, 
    MeetingAICompanionQuerySettingOptions_OnlyHost,             
    MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization, 
    MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin,        
    MeetingAICompanionQuerySettingOptions_HostAndPanelists = 10,  
    MeetingAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization    
};