Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentFeedback

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentFeedback

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentFeedback
extends Object
implements Serializable

KnowledgeDocumentFeedback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentFeedback()
KnowledgeDocumentFeedback(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentFeedback	application(KnowledgeSearchClientApplication application)	The client application from which feedback was given.
KnowledgeDocumentFeedback	comment(String comment)	Free-text comment of the feedback.
KnowledgeDocumentFeedback	conversationContext(KnowledgeConversationContext conversationContext)	Conversation context information if the feedback is given in the context of a conversation.
KnowledgeDocumentFeedback	document(KnowledgeDocumentVersionReference document)	The document on which feedback was given.
KnowledgeDocumentFeedback	documentVariation(EntityReference documentVariation)	The variation of the document on which feedback was given.
boolean	equals(Object o)
KnowledgeSearchClientApplication	getApplication()
String	getComment()
KnowledgeConversationContext	getConversationContext()
Date	getDateCreated()
KnowledgeDocumentVersionReference	getDocument()
EntityReference	getDocumentVariation()
String	getId()
KnowledgeDocumentFeedback.QueryTypeEnum	getQueryType()
KnowledgeDocumentFeedback.RatingEnum	getRating()
KnowledgeDocumentFeedback.ReasonEnum	getReason()
EntityReference	getSearch()
String	getSelfUri()
String	getSessionId()
KnowledgeDocumentFeedback.StateEnum	getState()
KnowledgeDocumentFeedback.SurfacingMethodEnum	getSurfacingMethod()
String	getUserId()
int	hashCode()
KnowledgeDocumentFeedback	queryType(KnowledgeDocumentFeedback.QueryTypeEnum queryType)	The type of the query that surfaced the document on which the feedback was given.
KnowledgeDocumentFeedback	rating(KnowledgeDocumentFeedback.RatingEnum rating)	Feedback rating.
KnowledgeDocumentFeedback	reason(KnowledgeDocumentFeedback.ReasonEnum reason)	Feedback reason.
KnowledgeDocumentFeedback	search(EntityReference search)	The search that surfaced the document on which feedback was given.
void	setApplication(KnowledgeSearchClientApplication application)
void	setComment(String comment)
void	setConversationContext(KnowledgeConversationContext conversationContext)
void	setDocument(KnowledgeDocumentVersionReference document)
void	setDocumentVariation(EntityReference documentVariation)
void	setQueryType(KnowledgeDocumentFeedback.QueryTypeEnum queryType)
void	setRating(KnowledgeDocumentFeedback.RatingEnum rating)
void	setReason(KnowledgeDocumentFeedback.ReasonEnum reason)
void	setSearch(EntityReference search)
void	setState(KnowledgeDocumentFeedback.StateEnum state)
void	setSurfacingMethod(KnowledgeDocumentFeedback.SurfacingMethodEnum surfacingMethod)
KnowledgeDocumentFeedback	state(KnowledgeDocumentFeedback.StateEnum state)	The state of the feedback.
KnowledgeDocumentFeedback	surfacingMethod(KnowledgeDocumentFeedback.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

KnowledgeDocumentFeedback

public KnowledgeDocumentFeedback()

KnowledgeDocumentFeedback

public KnowledgeDocumentFeedback(Boolean initWithEmptyList)

Method Details

getId

public String getId()

documentVariation

public KnowledgeDocumentFeedback 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 KnowledgeDocumentFeedback rating(KnowledgeDocumentFeedback.RatingEnum rating)

Feedback rating.

getRating

public KnowledgeDocumentFeedback.RatingEnum getRating()

setRating

public void setRating(KnowledgeDocumentFeedback.RatingEnum rating)

reason

public KnowledgeDocumentFeedback reason(KnowledgeDocumentFeedback.ReasonEnum reason)

Feedback reason.

getReason

public KnowledgeDocumentFeedback.ReasonEnum getReason()

setReason

public void setReason(KnowledgeDocumentFeedback.ReasonEnum reason)

comment

public KnowledgeDocumentFeedback 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 KnowledgeDocumentFeedback 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 KnowledgeDocumentFeedback queryType(KnowledgeDocumentFeedback.QueryTypeEnum queryType)

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

getQueryType

public KnowledgeDocumentFeedback.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentFeedback.QueryTypeEnum queryType)

surfacingMethod

public KnowledgeDocumentFeedback surfacingMethod(KnowledgeDocumentFeedback.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 KnowledgeDocumentFeedback.SurfacingMethodEnum getSurfacingMethod()

setSurfacingMethod

public void setSurfacingMethod(KnowledgeDocumentFeedback.SurfacingMethodEnum surfacingMethod)

state

public KnowledgeDocumentFeedback state(KnowledgeDocumentFeedback.StateEnum state)

The state of the feedback.

getState

public KnowledgeDocumentFeedback.StateEnum getState()

setState

public void setState(KnowledgeDocumentFeedback.StateEnum state)

document

public KnowledgeDocumentFeedback document(KnowledgeDocumentVersionReference document)

The document on which feedback was given.

getDocument

public KnowledgeDocumentVersionReference getDocument()

setDocument

public void setDocument(KnowledgeDocumentVersionReference document)

application

public KnowledgeDocumentFeedback application(KnowledgeSearchClientApplication application)

The client application from which feedback was given.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentFeedback conversationContext(KnowledgeConversationContext conversationContext)

Conversation context information if the feedback is given in the context of a conversation.

getConversationContext

public KnowledgeConversationContext getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContext conversationContext)

getUserId

public String getUserId()

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