Package com.mypurecloud.sdk.v2.model

Class KnowledgeGuestDocumentFeedback

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentFeedback

All Implemented Interfaces:

Serializable

public class KnowledgeGuestDocumentFeedback
extends Object
implements Serializable

KnowledgeGuestDocumentFeedback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeGuestDocumentFeedback.QueryTypeEnum	The type of the query that surfaced the document on which the feedback was given.
static enum	KnowledgeGuestDocumentFeedback.RatingEnum	Feedback rating.
static enum	KnowledgeGuestDocumentFeedback.ReasonEnum	Feedback reason.
static enum	KnowledgeGuestDocumentFeedback.StateEnum	The state of the feedback.
static enum	KnowledgeGuestDocumentFeedback.SurfacingMethodEnum	The method how knowledge was surfaced.

Constructor Summary

Constructors

Constructor	Description
KnowledgeGuestDocumentFeedback()
KnowledgeGuestDocumentFeedback(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeGuestDocumentFeedback	comment(String comment)	Free-text comment of the feedback.
KnowledgeGuestDocumentFeedback	document(KnowledgeGuestDocumentVersionReference document)	The document on which feedback was given.
KnowledgeGuestDocumentFeedback	documentVariation(EntityReference documentVariation)	The variation of the document on which feedback was given.
boolean	equals(Object o)
KnowledgeGuestSearchClientApplication	getApplication()
String	getComment()
Date	getDateCreated()
KnowledgeGuestDocumentVersionReference	getDocument()
EntityReference	getDocumentVariation()
String	getId()
KnowledgeGuestDocumentFeedback.QueryTypeEnum	getQueryType()
KnowledgeGuestDocumentFeedback.RatingEnum	getRating()
KnowledgeGuestDocumentFeedback.ReasonEnum	getReason()
EntityReference	getSearch()
String	getSessionId()
KnowledgeGuestDocumentFeedback.StateEnum	getState()
KnowledgeGuestDocumentFeedback.SurfacingMethodEnum	getSurfacingMethod()
int	hashCode()
KnowledgeGuestDocumentFeedback	queryType(KnowledgeGuestDocumentFeedback.QueryTypeEnum queryType)	The type of the query that surfaced the document on which the feedback was given.
KnowledgeGuestDocumentFeedback	rating(KnowledgeGuestDocumentFeedback.RatingEnum rating)	Feedback rating.
KnowledgeGuestDocumentFeedback	reason(KnowledgeGuestDocumentFeedback.ReasonEnum reason)	Feedback reason.
KnowledgeGuestDocumentFeedback	search(EntityReference search)	The search that surfaced the document on which feedback was given.
void	setComment(String comment)
void	setDocument(KnowledgeGuestDocumentVersionReference document)
void	setDocumentVariation(EntityReference documentVariation)
void	setQueryType(KnowledgeGuestDocumentFeedback.QueryTypeEnum queryType)
void	setRating(KnowledgeGuestDocumentFeedback.RatingEnum rating)
void	setReason(KnowledgeGuestDocumentFeedback.ReasonEnum reason)
void	setSearch(EntityReference search)
void	setState(KnowledgeGuestDocumentFeedback.StateEnum state)
void	setSurfacingMethod(KnowledgeGuestDocumentFeedback.SurfacingMethodEnum surfacingMethod)
KnowledgeGuestDocumentFeedback	state(KnowledgeGuestDocumentFeedback.StateEnum state)	The state of the feedback.
KnowledgeGuestDocumentFeedback	surfacingMethod(KnowledgeGuestDocumentFeedback.SurfacingMethodEnum surfacingMethod)	The method how knowledge was surfaced.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeGuestDocumentFeedback

public KnowledgeGuestDocumentFeedback()

KnowledgeGuestDocumentFeedback

public KnowledgeGuestDocumentFeedback(Boolean initWithEmptyList)

Method Details

getId

public String getId()

documentVariation

public KnowledgeGuestDocumentFeedback documentVariation(EntityReference documentVariation)

The variation of the document on which feedback was given.

getDocumentVariation

public EntityReference getDocumentVariation()

setDocumentVariation

public void setDocumentVariation(EntityReference documentVariation)

rating

public KnowledgeGuestDocumentFeedback rating(KnowledgeGuestDocumentFeedback.RatingEnum rating)

Feedback rating.

getRating

public KnowledgeGuestDocumentFeedback.RatingEnum getRating()

setRating

public void setRating(KnowledgeGuestDocumentFeedback.RatingEnum rating)

reason

public KnowledgeGuestDocumentFeedback reason(KnowledgeGuestDocumentFeedback.ReasonEnum reason)

Feedback reason.

getReason

public KnowledgeGuestDocumentFeedback.ReasonEnum getReason()

setReason

public void setReason(KnowledgeGuestDocumentFeedback.ReasonEnum reason)

comment

public KnowledgeGuestDocumentFeedback comment(String comment)

Free-text comment of the feedback. Maximum length: 2000 characters.

getComment

public String getComment()

setComment

public void setComment(String comment)

search

public KnowledgeGuestDocumentFeedback search(EntityReference search)

The search that surfaced the document on which feedback was given.

getSearch

public EntityReference getSearch()

setSearch

public void setSearch(EntityReference search)

getSessionId

public String getSessionId()

getDateCreated

public Date getDateCreated()

queryType

public KnowledgeGuestDocumentFeedback queryType(KnowledgeGuestDocumentFeedback.QueryTypeEnum queryType)

The type of the query that surfaced the document on which the feedback was given.

getQueryType

public KnowledgeGuestDocumentFeedback.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeGuestDocumentFeedback.QueryTypeEnum queryType)

surfacingMethod

public KnowledgeGuestDocumentFeedback surfacingMethod(KnowledgeGuestDocumentFeedback.SurfacingMethodEnum surfacingMethod)

The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.

getSurfacingMethod

public KnowledgeGuestDocumentFeedback.SurfacingMethodEnum getSurfacingMethod()

setSurfacingMethod

public void setSurfacingMethod(KnowledgeGuestDocumentFeedback.SurfacingMethodEnum surfacingMethod)

state

public KnowledgeGuestDocumentFeedback state(KnowledgeGuestDocumentFeedback.StateEnum state)

The state of the feedback.

getState

public KnowledgeGuestDocumentFeedback.StateEnum getState()

setState

public void setState(KnowledgeGuestDocumentFeedback.StateEnum state)

document

public KnowledgeGuestDocumentFeedback document(KnowledgeGuestDocumentVersionReference document)

The document on which feedback was given.

getDocument

public KnowledgeGuestDocumentVersionReference getDocument()

setDocument

public void setDocument(KnowledgeGuestDocumentVersionReference document)

getApplication

public KnowledgeGuestSearchClientApplication getApplication()

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