Package com.mypurecloud.sdk.v2.model

Class SummarySetting

java.lang.Object

com.mypurecloud.sdk.v2.model.SummarySetting

All Implemented Interfaces:

Serializable

public class SummarySetting
extends Object
implements Serializable

SummarySetting

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SummarySetting.FormatEnum	Format of the generated summary.
static enum	SummarySetting.InteractionTypeEnum	The interaction type the setting can be used for
static enum	SummarySetting.PredefinedInsightsEnum	Gets or Sets predefinedInsights
static enum	SummarySetting.ServiceTypeEnum	Service type for summarization.
static enum	SummarySetting.SettingTypeEnum	Type of the summary setting.
static enum	SummarySetting.SummaryTypeEnum	Level of detail of the generated summary.

Constructor Summary

Constructors

Constructor	Description
SummarySetting()
SummarySetting(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
SummarySetting	customEntities(List<SummarySettingCustomEntity> customEntities)	Custom entity definition.
boolean	equals(Object o)
SummarySetting	format(SummarySetting.FormatEnum format)	Format of the generated summary.
List<SummarySettingCustomEntity>	getCustomEntities()
Date	getDateCreated()
Date	getDateModified()
SummarySetting.FormatEnum	getFormat()
String	getId()
String	getIntegrationId()
SummarySetting.InteractionTypeEnum	getInteractionType()
String	getLanguage()
SummarySettingPII	getMaskPII()
String	getName()
SummarySettingParticipantLabels	getParticipantLabels()
List<SummarySetting.PredefinedInsightsEnum>	getPredefinedInsights()
String	getPrompt()
String	getSelfUri()
SummarySetting.ServiceTypeEnum	getServiceType()
SummarySetting.SettingTypeEnum	getSettingType()
SummarySetting.SummaryTypeEnum	getSummaryType()
Integer	getTimeoutDuration()
int	hashCode()
SummarySetting	integrationId(String integrationId)	Integration ID for the external summarization service.
SummarySetting	language(String language)	Language of the generated summary, e.g. en-US, it-IT.
SummarySetting	maskPII(SummarySettingPII maskPII)	Displaying PII in the generated summary.
SummarySetting	name(String name)	Name of the summary setting.
SummarySetting	participantLabels(SummarySettingParticipantLabels participantLabels)	How to refer to interaction participants in the generated summary.
SummarySetting	predefinedInsights(List<SummarySetting.PredefinedInsightsEnum> predefinedInsights)	Set which insights to include in the generated summary by default.
SummarySetting	prompt(String prompt)	Custom prompt of summary setting.
SummarySetting	serviceType(SummarySetting.ServiceTypeEnum serviceType)	Service type for summarization.
void	setCustomEntities(List<SummarySettingCustomEntity> customEntities)
void	setFormat(SummarySetting.FormatEnum format)
void	setIntegrationId(String integrationId)
void	setLanguage(String language)
void	setMaskPII(SummarySettingPII maskPII)
void	setName(String name)
void	setParticipantLabels(SummarySettingParticipantLabels participantLabels)
void	setPredefinedInsights(List<SummarySetting.PredefinedInsightsEnum> predefinedInsights)
void	setPrompt(String prompt)
void	setServiceType(SummarySetting.ServiceTypeEnum serviceType)
void	setSettingType(SummarySetting.SettingTypeEnum settingType)
void	setSummaryType(SummarySetting.SummaryTypeEnum summaryType)
void	setTimeoutDuration(Integer timeoutDuration)
SummarySetting	settingType(SummarySetting.SettingTypeEnum settingType)	Type of the summary setting.
SummarySetting	summaryType(SummarySetting.SummaryTypeEnum summaryType)	Level of detail of the generated summary.
SummarySetting	timeoutDuration(Integer timeoutDuration)	Timeout duration in seconds for the external summarization service request.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SummarySetting

public SummarySetting()

SummarySetting

public SummarySetting(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public SummarySetting name(String name)

Name of the summary setting.

getName

public String getName()

setName

public void setName(String name)

getDateModified

public Date getDateModified()

getInteractionType

public SummarySetting.InteractionTypeEnum getInteractionType()

language

public SummarySetting language(String language)

Language of the generated summary, e.g. en-US, it-IT.

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

summaryType

public SummarySetting summaryType(SummarySetting.SummaryTypeEnum summaryType)

Level of detail of the generated summary.

getSummaryType

public SummarySetting.SummaryTypeEnum getSummaryType()

setSummaryType

public void setSummaryType(SummarySetting.SummaryTypeEnum summaryType)

format

public SummarySetting format(SummarySetting.FormatEnum format)

Format of the generated summary.

getFormat

public SummarySetting.FormatEnum getFormat()

setFormat

public void setFormat(SummarySetting.FormatEnum format)

maskPII

public SummarySetting maskPII(SummarySettingPII maskPII)

Displaying PII in the generated summary.

getMaskPII

public SummarySettingPII getMaskPII()

setMaskPII

public void setMaskPII(SummarySettingPII maskPII)

getDateCreated

public Date getDateCreated()

participantLabels

public SummarySetting participantLabels(SummarySettingParticipantLabels participantLabels)

How to refer to interaction participants in the generated summary.

getParticipantLabels

public SummarySettingParticipantLabels getParticipantLabels()

setParticipantLabels

public void setParticipantLabels(SummarySettingParticipantLabels participantLabels)

predefinedInsights

public SummarySetting predefinedInsights(List<SummarySetting.PredefinedInsightsEnum> predefinedInsights)

Set which insights to include in the generated summary by default.

getPredefinedInsights

public List<SummarySetting.PredefinedInsightsEnum> getPredefinedInsights()

setPredefinedInsights

public void setPredefinedInsights(List<SummarySetting.PredefinedInsightsEnum> predefinedInsights)

customEntities

public SummarySetting customEntities(List<SummarySettingCustomEntity> customEntities)

Custom entity definition.

getCustomEntities

public List<SummarySettingCustomEntity> getCustomEntities()

setCustomEntities

public void setCustomEntities(List<SummarySettingCustomEntity> customEntities)

settingType

public SummarySetting settingType(SummarySetting.SettingTypeEnum settingType)

Type of the summary setting.

getSettingType

public SummarySetting.SettingTypeEnum getSettingType()

setSettingType

public void setSettingType(SummarySetting.SettingTypeEnum settingType)

prompt

public SummarySetting prompt(String prompt)

Custom prompt of summary setting.

getPrompt

public String getPrompt()

setPrompt

public void setPrompt(String prompt)

serviceType

public SummarySetting serviceType(SummarySetting.ServiceTypeEnum serviceType)

Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided.

getServiceType

public SummarySetting.ServiceTypeEnum getServiceType()

setServiceType

public void setServiceType(SummarySetting.ServiceTypeEnum serviceType)

integrationId

public SummarySetting integrationId(String integrationId)

Integration ID for the external summarization service. Required when serviceType is External.

getIntegrationId

public String getIntegrationId()

setIntegrationId

public void setIntegrationId(String integrationId)

timeoutDuration

public SummarySetting timeoutDuration(Integer timeoutDuration)

Timeout duration in seconds for the external summarization service request.

getTimeoutDuration

public Integer getTimeoutDuration()

setTimeoutDuration

public void setTimeoutDuration(Integer timeoutDuration)

getSelfUri

public String getSelfUri()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object