Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CopilotProfileConfig

Hierarchy

  • CopilotProfileConfig

Index

Properties

Properties

AppTitle

AppTitle: string

Full app title

ContactId

ContactId: string

The ID of the contact.

MediaType

MediaType: string

MediaType of the contact

Params

Params: { agentAssistId?: string; autoSummaryCardFeatures: [] | AutoSummaryCardFeature[]; autoSummaryToOutcomePanel: boolean; cognigyOrigin?: string; cognigySocketUrl?: string; cognigyToken?: string; cognigyUrlToken?: string; emailChannel?: boolean; generativeResponseTone: string; guidanceFeedbackCards: boolean; journeySummary: boolean; journeySummaryDetailView: boolean; journeySummaryInteractionCount: number; journeySummaryInteractionPeriod: number; journeySummaryResponseLength: number; knowledgeHubConfig?: KnowledgeHubConfiguration; language: string; legalDisclosure?: boolean; negativeCommentEnabled: boolean; negativeFeedbackEnabled: boolean; negativeTagEnabled: boolean; negativeTags: string[]; overallSubcard: boolean; positiveCommentEnabled: boolean; positiveFeedbackEnabled: boolean; positiveTagEnabled: boolean; positiveTags: string[]; privateFeedback: boolean; profileType?: string; providerId: string; publicFeedback: boolean; secondaryKnowledgeHubConfig?: KnowledgeHubConfiguration; showAutoSummaryCard: boolean; taskAssistConfig?: TaskAssistConfig; unratedFeedback: boolean }

Parameters

Type declaration

  • Optional agentAssistId?: string
  • autoSummaryCardFeatures: [] | AutoSummaryCardFeature[]

    Features available for the auto summary card.

  • autoSummaryToOutcomePanel: boolean

    Indicates if the auto summary should be shown in the outcome panel.

  • Optional cognigyOrigin?: string

    Cognigy AI Copilot origin header for CORS. Retrieved from the retrieve-aah-config API response.

  • Optional cognigySocketUrl?: string

    Cognigy AI Copilot WebSocket URL. Retrieved from the retrieve-aah-config API response.

  • Optional cognigyToken?: string

    Cognigy AI Copilot short-lived authentication token. Retrieved from the retrieve-aah-config API response.

  • Optional cognigyUrlToken?: string

    Cognigy AI Copilot URL Token for WebSocket authentication. Retrieved from the retrieve-aah-config API response.

  • Optional emailChannel?: boolean

    Indicates if the email channel features (creation / response cards) are enabled for this contact.

  • generativeResponseTone: string

    Indicates generative response tone.

  • guidanceFeedbackCards: boolean

    Determines if there are subcards per suggestion is enable.

  • journeySummary: boolean

    Indicates if journey summary is enabled.

  • journeySummaryDetailView: boolean

    Indicates if the journey summary detail view is enabled.

  • journeySummaryInteractionCount: number

    Indicates the count of the journey summary interaction.

  • journeySummaryInteractionPeriod: number

    Indicates the period of the journey summary interaction.

  • journeySummaryResponseLength: number

    Indicates the length of the journey summary response.

  • Optional knowledgeHubConfig?: KnowledgeHubConfiguration

    Indicates configuration for the Knowledge Hub in the agent assist app.

  • language: string

    Indicates language.

  • Optional legalDisclosure?: boolean

    Indicates if the legal disclosure card should be rendered for this contact.

  • negativeCommentEnabled: boolean

    Determines if the comment section for the negative feedback is enable

  • negativeFeedbackEnabled: boolean

    Determines if the dislike is enable

  • negativeTagEnabled: boolean

    Determines if the negative tags are enable

  • negativeTags: string[]

    Contains an array of negative feedback tags.

  • overallSubcard: boolean

    Determines if there is an overall subcard present.

  • positiveCommentEnabled: boolean

    Determines if the comment section for the positive feedback is enable

  • positiveFeedbackEnabled: boolean

    Determines if the Like is enable

  • positiveTagEnabled: boolean

    Determines if the positive tags are enable

  • positiveTags: string[]

    Contains an array of positive feedback tags.

  • privateFeedback: boolean

    Determines if private feedback is enabled

  • Optional profileType?: string

    Profile type for the copilot configuration. When set to 'agentic', enables the Cognigy AI Copilot grid integration. Retrieved from the retrieve-aah-config API response.

  • providerId: string

    Id of event provider like agentCopilot

  • publicFeedback: boolean

    Determines if public feedback is enabled

  • Optional secondaryKnowledgeHubConfig?: KnowledgeHubConfiguration

    Indicates configuration for the secondary Knowledge Hub in the agent assist app.

  • showAutoSummaryCard: boolean

    Indicates if the auto summary card should be shown.

  • Optional taskAssistConfig?: TaskAssistConfig

    Configuration object for Task Assist feature (virtual agent + intents). Present only when task assist is enabled.

  • unratedFeedback: boolean

    Indicates if the feedback is unrated.

Generated using TypeDoc