Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentChunkRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentChunkRequest

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentChunkRequest
extends Object
implements Serializable

KnowledgeDocumentChunkRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentChunkRequest.QueryTypeEnum	The type of the query that initiates the chunks search.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentChunkRequest()
KnowledgeDocumentChunkRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentChunkRequest	application(KnowledgeSearchClientApplication application)	The client application details from which chunks request was sent.
KnowledgeDocumentChunkRequest	confidenceThreshold(Float confidenceThreshold)	The confidence threshold for the chunk results.
KnowledgeDocumentChunkRequest	conversationContext(KnowledgeConversationContext conversationContext)	Conversation context information if the chunks search is initiated in the context of a conversation.
boolean	equals(Object o)
KnowledgeDocumentChunkRequest	filter(DocumentQuery filter)	Filter for the document chunks.
KnowledgeSearchClientApplication	getApplication()
Float	getConfidenceThreshold()
KnowledgeConversationContext	getConversationContext()
DocumentQuery	getFilter()
Boolean	getIncludeDraftDocuments()
Integer	getPageNumber()
Integer	getPageSize()
Boolean	getPreprocessQuery()
String	getQuery()
KnowledgeDocumentChunkRequest.QueryTypeEnum	getQueryType()
int	hashCode()
KnowledgeDocumentChunkRequest	includeDraftDocuments(Boolean includeDraftDocuments)	Indicates whether the chunk results would also include draft documents.
KnowledgeDocumentChunkRequest	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentChunkRequest	pageSize(Integer pageSize)	Page size of the returned results.
KnowledgeDocumentChunkRequest	preprocessQuery(Boolean preprocessQuery)	Indicates whether the chunks search query should be preprocessed.
KnowledgeDocumentChunkRequest	query(String query)	Query to search chunks in the knowledge base.
KnowledgeDocumentChunkRequest	queryType(KnowledgeDocumentChunkRequest.QueryTypeEnum queryType)	The type of the query that initiates the chunks search.
void	setApplication(KnowledgeSearchClientApplication application)
void	setConfidenceThreshold(Float confidenceThreshold)
void	setConversationContext(KnowledgeConversationContext conversationContext)
void	setFilter(DocumentQuery filter)
void	setIncludeDraftDocuments(Boolean includeDraftDocuments)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setPreprocessQuery(Boolean preprocessQuery)
void	setQuery(String query)
void	setQueryType(KnowledgeDocumentChunkRequest.QueryTypeEnum queryType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentChunkRequest

public KnowledgeDocumentChunkRequest()

KnowledgeDocumentChunkRequest

public KnowledgeDocumentChunkRequest(Boolean initWithEmptyList)

Method Details

query

public KnowledgeDocumentChunkRequest query(String query)

Query to search chunks in the knowledge base.

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

pageSize

public KnowledgeDocumentChunkRequest pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public KnowledgeDocumentChunkRequest pageNumber(Integer pageNumber)

Page number of the returned results.

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

filter

public KnowledgeDocumentChunkRequest filter(DocumentQuery filter)

Filter for the document chunks.

getFilter

public DocumentQuery getFilter()

setFilter

public void setFilter(DocumentQuery filter)

queryType

public KnowledgeDocumentChunkRequest queryType(KnowledgeDocumentChunkRequest.QueryTypeEnum queryType)

The type of the query that initiates the chunks search.

getQueryType

public KnowledgeDocumentChunkRequest.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentChunkRequest.QueryTypeEnum queryType)

preprocessQuery

public KnowledgeDocumentChunkRequest preprocessQuery(Boolean preprocessQuery)

Indicates whether the chunks search query should be preprocessed.

getPreprocessQuery

public Boolean getPreprocessQuery()

setPreprocessQuery

public void setPreprocessQuery(Boolean preprocessQuery)

includeDraftDocuments

public KnowledgeDocumentChunkRequest includeDraftDocuments(Boolean includeDraftDocuments)

Indicates whether the chunk results would also include draft documents.

getIncludeDraftDocuments

public Boolean getIncludeDraftDocuments()

setIncludeDraftDocuments

public void setIncludeDraftDocuments(Boolean includeDraftDocuments)

application

public KnowledgeDocumentChunkRequest application(KnowledgeSearchClientApplication application)

The client application details from which chunks request was sent.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentChunkRequest conversationContext(KnowledgeConversationContext conversationContext)

Conversation context information if the chunks search is initiated in the context of a conversation.

getConversationContext

public KnowledgeConversationContext getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContext conversationContext)

confidenceThreshold

public KnowledgeDocumentChunkRequest confidenceThreshold(Float confidenceThreshold)

The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1.

getConfidenceThreshold

public Float getConfidenceThreshold()

setConfidenceThreshold

public void setConfidenceThreshold(Float confidenceThreshold)

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