Class ApiAIAssistant

ApiAIAssistant provides AI Assistant APIs for transcript controls.

Constructors

constructor

Properties

aiFeature metricsManager webex

Methods

fetchHistoricTranscripts getRealTimeAssistance sendEvent sendRealTimeAssistanceUserAction setAIFeatureFlags getBaseUrl

Constructors

constructor

Properties

Private aiFeature

aiFeature: AIFeatureFlags

Private metricsManager

metricsManager: default

Private webex

webex: WebexSDK

Methods

fetchHistoricTranscripts

  • fetchHistoricTranscripts(agentId, interactionId): Promise<HistoricTranscriptsResponse>

  • Fetches historic transcripts for an interaction. This API is allowed only when real-time transcription feature is enabled.

    Parameters

    • agentId: string
    • interactionId: string

      interaction/conversation identifier

    Returns Promise<HistoricTranscriptsResponse>

getRealTimeAssistance

  • getRealTimeAssistance(params): Promise<Record<string, unknown>>

  • Requests real-time assistance for an interaction.

    Parameters

    • params: RealTimeAssistanceParams

      Real-time assistance request parameters

    Returns Promise<Record<string, unknown>>

    HTTP response body from the AI Assistant event API

sendEvent

  • sendEvent(agentId, interactionId, eventType, eventName, eventMetaData?, languageCode?, trackingId?): Promise<Record<string, unknown>>

  • Sends an event to the AI Assistant service.

    Parameters

    • agentId: string

      agent identifier

    • interactionId: string

      interaction/conversation identifier

    • eventType: AIAssistantEventType

      the type of event (e.g. 'CUSTOM_EVENT')

    • eventName: AIAssistantEventName

      the name of the event (e.g. 'GET_TRANSCRIPTS')

    • Optional eventMetaData: Record<string, unknown>

      event-specific fields to include in eventDetails.data

    • Optional languageCode: string

      language code within eventDetails.data

    • Optional trackingId: string

      tracking identifier within eventDetails.data

    Returns Promise<Record<string, unknown>>

sendRealTimeAssistanceUserAction

  • sendRealTimeAssistanceUserAction(params): Promise<Record<string, unknown>>

  • Sends user action feedback for a real-time assistance adaptive card.

    Parameters

    • params: RealTimeAssistanceUserActionParams

      Real-time assistance user action parameters

    Returns Promise<Record<string, unknown>>

    HTTP response body from the AI Assistant event API

setAIFeatureFlags

Private getBaseUrl

Settings

Member Visibility

Theme

On This Page

constructoraiFeaturemetricsManagerwebexfetchHistoricTranscriptsgetRealTimeAssistancesendEventsendRealTimeAssistanceUserActionsetAIFeatureFlagsgetBaseUrl