Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentFeedbackResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentFeedbackResponse

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentFeedbackResponse
extends Object
implements Serializable

KnowledgeDocumentFeedbackResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentFeedbackResponse()
KnowledgeDocumentFeedbackResponse(Boolean initWithEmptyList)

Method Summary

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

KnowledgeDocumentFeedbackResponse

public KnowledgeDocumentFeedbackResponse()

KnowledgeDocumentFeedbackResponse

public KnowledgeDocumentFeedbackResponse(Boolean initWithEmptyList)

Method Details

getId

public String getId()

documentVariation

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

Feedback rating.

getRating

public KnowledgeDocumentFeedbackResponse.RatingEnum getRating()

setRating

public void setRating(KnowledgeDocumentFeedbackResponse.RatingEnum rating)

reason

public KnowledgeDocumentFeedbackResponse reason(KnowledgeDocumentFeedbackResponse.ReasonEnum reason)

Feedback reason.

getReason

public KnowledgeDocumentFeedbackResponse.ReasonEnum getReason()

setReason

public void setReason(KnowledgeDocumentFeedbackResponse.ReasonEnum reason)

comment

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

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

getQueryType

public KnowledgeDocumentFeedbackResponse.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentFeedbackResponse.QueryTypeEnum queryType)

surfacingMethod

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

setSurfacingMethod

public void setSurfacingMethod(KnowledgeDocumentFeedbackResponse.SurfacingMethodEnum surfacingMethod)

state

public KnowledgeDocumentFeedbackResponse state(KnowledgeDocumentFeedbackResponse.StateEnum state)

The state of the feedback.

getState

public KnowledgeDocumentFeedbackResponse.StateEnum getState()

setState

public void setState(KnowledgeDocumentFeedbackResponse.StateEnum state)

document

public KnowledgeDocumentFeedbackResponse document(KnowledgeDocumentVersionReference document)

The document on which feedback was given.

getDocument

public KnowledgeDocumentVersionReference getDocument()

setDocument

public void setDocument(KnowledgeDocumentVersionReference document)

application

public KnowledgeDocumentFeedbackResponse application(KnowledgeSearchClientApplication application)

The client application from which feedback was given.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentFeedbackResponse conversationContext(KnowledgeConversationContextResponse conversationContext)

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

getConversationContext

public KnowledgeConversationContextResponse getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContextResponse conversationContext)

getUser

public AddressableEntityRef getUser()

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