Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentPresentation

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentPresentation

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentPresentation
extends Object
implements Serializable

KnowledgeDocumentPresentation

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentPresentation.QueryTypeEnum	The type of the query that surfaced the documents.
static enum	KnowledgeDocumentPresentation.SurfacingMethodEnum	The method how knowledge was surfaced.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentPresentation()
KnowledgeDocumentPresentation(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentPresentation	application(KnowledgeSearchClientApplication application)	The client application in which the documents were presented.
KnowledgeDocumentPresentation	conversationContext(KnowledgeConversationContext conversationContext)	Conversation context information if the documents were presented in the context of a conversation.
KnowledgeDocumentPresentation	documents(List<PresentedKnowledgeDocument> documents)	The presented documents
boolean	equals(Object o)
KnowledgeSearchClientApplication	getApplication()
KnowledgeConversationContext	getConversationContext()
List<PresentedKnowledgeDocument>	getDocuments()
KnowledgeDocumentPresentation.QueryTypeEnum	getQueryType()
String	getSearchId()
String	getSessionId()
KnowledgeDocumentPresentation.SurfacingMethodEnum	getSurfacingMethod()
int	hashCode()
KnowledgeDocumentPresentation	queryType(KnowledgeDocumentPresentation.QueryTypeEnum queryType)	The type of the query that surfaced the documents.
KnowledgeDocumentPresentation	searchId(String searchId)	The search that surfaced the documents that were presented.
void	setApplication(KnowledgeSearchClientApplication application)
void	setConversationContext(KnowledgeConversationContext conversationContext)
void	setDocuments(List<PresentedKnowledgeDocument> documents)
void	setQueryType(KnowledgeDocumentPresentation.QueryTypeEnum queryType)
void	setSearchId(String searchId)
void	setSurfacingMethod(KnowledgeDocumentPresentation.SurfacingMethodEnum surfacingMethod)
KnowledgeDocumentPresentation	surfacingMethod(KnowledgeDocumentPresentation.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

KnowledgeDocumentPresentation

public KnowledgeDocumentPresentation()

KnowledgeDocumentPresentation

public KnowledgeDocumentPresentation(Boolean initWithEmptyList)

Method Details

documents

public KnowledgeDocumentPresentation documents(List<PresentedKnowledgeDocument> documents)

The presented documents

getDocuments

public List<PresentedKnowledgeDocument> getDocuments()

setDocuments

public void setDocuments(List<PresentedKnowledgeDocument> documents)

searchId

public KnowledgeDocumentPresentation searchId(String searchId)

The search that surfaced the documents that were presented.

getSearchId

public String getSearchId()

setSearchId

public void setSearchId(String searchId)

queryType

public KnowledgeDocumentPresentation queryType(KnowledgeDocumentPresentation.QueryTypeEnum queryType)

The type of the query that surfaced the documents.

getQueryType

public KnowledgeDocumentPresentation.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentPresentation.QueryTypeEnum queryType)

surfacingMethod

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

setSurfacingMethod

public void setSurfacingMethod(KnowledgeDocumentPresentation.SurfacingMethodEnum surfacingMethod)

getSessionId

public String getSessionId()

conversationContext

public KnowledgeDocumentPresentation conversationContext(KnowledgeConversationContext conversationContext)

Conversation context information if the documents were presented in the context of a conversation.

getConversationContext

public KnowledgeConversationContext getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContext conversationContext)

application

public KnowledgeDocumentPresentation application(KnowledgeSearchClientApplication application)

The client application in which the documents were presented.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

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