MobileRTCAICQueryHelper.h File Reference

AI Companion query helper for intelligent meeting features. 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...

import <Foundation/Foundation.h>

Go to the source code of this file.

Classes
class	MobileRTCAICompanionQueryItem
	Represents a query item including question, answer, and error information for AI Companion. More...
class	MobileRTCEnableQueryHandler
	Handler to enable the meeting query feature. More...
class	MobileRTCStartQueryHandler
	Handler to start the meeting query feature. More...
class	MobileRTCApproveEnableQueryHandler
	Handler to approve or continue enabling query request. More...
class	MobileRTCApproveStartQueryHandler
	Handler to start the meeting query feature. More...
class	MobileRTCSendQueryHandler
	Handler for sending queries during the meeting. More...
class	MobileRTCApproveSendQueryHandler
	Handler to approve or decline the send query request. More...
class	MobileRTCEnableQueryActionHandler
	Handler for actions related to enabling meeting query. More...
protocol	<MobileRTCAICompanionQueryHelperDelegate>
	Delegate protocol for receiving AI Companion meeting query related events. More...
class	MobileRTCAICompanionQueryHelper
	Helper class to manage AI Companion meeting query features and related legal notices. More...

Enumerations
enum	MobileRTCAICompanionQueryFeedbackType { MobileRTCAICompanionQueryFeedbackType_None = 0 , MobileRTCAICompanionQueryFeedbackType_Good , MobileRTCAICompanionQueryFeedbackType_Bad }
	Enumeration of the types of feedback for AI Companion query responses. More...
enum	MobileRTCAICompanionQueryRequestError {   MobileRTCAICompanionQueryRequestError_OK = 0 , MobileRTCAICompanionQueryRequestError_InvalidParam , MobileRTCAICompanionQueryRequestError_SendFailed , MobileRTCAICompanionQueryRequestError_WebUnAvailable ,   MobileRTCAICompanionQueryRequestError_PermissionVerifyFailed , MobileRTCAICompanionQueryRequestError_QueryRateLimitError , MobileRTCAICompanionQueryRequestError_Timeout , MobileRTCAICompanionQueryRequestError_Unknown = 100 }
	Enumeration of the error types for AI Companion query requests. More...
enum	MobileRTCAICompanionQuerySettingOptions {   MobileRTCAICompanionQuerySettingOptions_None = 0 , MobileRTCAICompanionQuerySettingOptions_WhenQueryStarted , MobileRTCAICompanionQuerySettingOptions_WhenParticipantsJoin , MobileRTCAICompanionQuerySettingOptions_OnlyHost ,   MobileRTCAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization , MobileRTCAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin , MobileRTCAICompanionQuerySettingOptions_HostAndPanelists = 10 , MobileRTCAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization }
	Enumeration of configuration options for who in the meeting can interact with AI Companion by asking questions about the meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057749. More...

Detailed Description

AI Companion query helper for intelligent meeting features. 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 MobileRTCAICQueryHelper.h.

Enumeration Type Documentation

MobileRTCAICompanionQueryFeedbackType

enum MobileRTCAICompanionQueryFeedbackType

Enumeration of the types of feedback for AI Companion query responses.

Enumerator
MobileRTCAICompanionQueryFeedbackType_None	For initialization.
MobileRTCAICompanionQueryFeedbackType_Good	Indicates the feedback is positive, the query response was good.
MobileRTCAICompanionQueryFeedbackType_Bad	Indicates the feedback is negative, the query response was bad.

Definition at line 12 of file MobileRTCAICQueryHelper.h.

                                                                   {
    MobileRTCAICompanionQueryFeedbackType_None = 0,
    MobileRTCAICompanionQueryFeedbackType_Good,
    MobileRTCAICompanionQueryFeedbackType_Bad
};

MobileRTCAICompanionQueryRequestError

enum MobileRTCAICompanionQueryRequestError

Enumeration of the error types for AI Companion query requests.

Enumerator
MobileRTCAICompanionQueryRequestError_OK	The request was successful, no error.
MobileRTCAICompanionQueryRequestError_InvalidParam	Invalid parameter provided in the query request.
MobileRTCAICompanionQueryRequestError_SendFailed	The request failed to be sent.
MobileRTCAICompanionQueryRequestError_WebUnAvailable	The web service is unavailable.
MobileRTCAICompanionQueryRequestError_PermissionVerifyFailed	Permission verification failed for the query request.
MobileRTCAICompanionQueryRequestError_QueryRateLimitError	The query request exceeded the rate limit.
MobileRTCAICompanionQueryRequestError_Timeout	The query request timed out.
MobileRTCAICompanionQueryRequestError_Unknown	An unknown error occurred.

Definition at line 24 of file MobileRTCAICQueryHelper.h.

                                                                   {
    MobileRTCAICompanionQueryRequestError_OK = 0,
    MobileRTCAICompanionQueryRequestError_InvalidParam,
    MobileRTCAICompanionQueryRequestError_SendFailed,
    MobileRTCAICompanionQueryRequestError_WebUnAvailable,
    MobileRTCAICompanionQueryRequestError_PermissionVerifyFailed,
    MobileRTCAICompanionQueryRequestError_QueryRateLimitError,
    MobileRTCAICompanionQueryRequestError_Timeout,
    MobileRTCAICompanionQueryRequestError_Unknown = 100
};

MobileRTCAICompanionQuerySettingOptions

enum MobileRTCAICompanionQuerySettingOptions

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

Enumerator
MobileRTCAICompanionQuerySettingOptions_None	For initialization.
MobileRTCAICompanionQuerySettingOptions_WhenQueryStarted	Allows all participants and attendee to ask questions about all discussions since AI Companion was active.
MobileRTCAICompanionQuerySettingOptions_WhenParticipantsJoin	Allows all participants to ask questions about the discussion since they joined the current meeting.
MobileRTCAICompanionQuerySettingOptions_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.
MobileRTCAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization	Allows only participants and invitees from your organization to ask questions about all discussions since AI Companion was active.
MobileRTCAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin	Allows only participants from your organization to ask questions about the discussion since they joined the current meeting.
MobileRTCAICompanionQuerySettingOptions_HostAndPanelists	Hosts and all panelists can ask question, and answers are based on the meeting's start until now.
MobileRTCAICompanionQuerySettingOptions_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 46 of file MobileRTCAICQueryHelper.h.

                                                                     {
    MobileRTCAICompanionQuerySettingOptions_None = 0,
    MobileRTCAICompanionQuerySettingOptions_WhenQueryStarted,
    MobileRTCAICompanionQuerySettingOptions_WhenParticipantsJoin,
    MobileRTCAICompanionQuerySettingOptions_OnlyHost,
    MobileRTCAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization,
    MobileRTCAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin,
    MobileRTCAICompanionQuerySettingOptions_HostAndPanelists = 10,
    MobileRTCAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization
};