Class ApiAIAssistant

ApiAIAssistant provides AI Assistant APIs for transcript controls.

Constructors

constructor

Properties

aiFeature metricsManager webex

Methods

fetchHistoricTranscripts getSuggestedResponse sendEvent 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>

getSuggestedResponse

  • getSuggestedResponse(params): Promise<any>

  • Requests a suggested response for an interaction.

    Parameters

    • params: SuggestedResponseParams

      Suggestion request parameters

    Returns Promise<any>

    HTTP response body from the AI Assistant event API

sendEvent

  • sendEvent(agentId, interactionId, eventType, eventName, action?, context?, 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 action: TranscriptAction

      action within eventDetails (e.g. 'START' or 'STOP')

    • Optional context: string
    • Optional languageCode: string
    • Optional trackingId: string

    Returns Promise<Record<string, unknown>>

setAIFeatureFlags

Private getBaseUrl

Settings

Member Visibility

Theme

On This Page

constructoraiFeaturemetricsManagerwebexfetchHistoricTranscriptsgetSuggestedResponsesendEventsetAIFeatureFlagsgetBaseUrl