Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentChunkResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentChunkResponse

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentChunkResponse
extends Object
implements Serializable

KnowledgeDocumentChunkResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentChunkResponse()
KnowledgeDocumentChunkResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentChunkResponse	application(KnowledgeSearchClientApplication application)	The client application details from which chunks search happened.
KnowledgeDocumentChunkResponse	confidenceThreshold(Float confidenceThreshold)	The confidence threshold for the chunk results.
KnowledgeDocumentChunkResponse	conversationContext(KnowledgeConversationContextResponse conversationContext)	Conversation context information if the chunks search is initiated in the context of a conversation.
boolean	equals(Object o)
KnowledgeSearchClientApplication	getApplication()
Float	getConfidenceThreshold()
KnowledgeConversationContextResponse	getConversationContext()
Integer	getPageCount()
Integer	getPageNumber()
Integer	getPageSize()
Boolean	getPreprocessQuery()
String	getQuery()
KnowledgeDocumentChunkResponse.QueryTypeEnum	getQueryType()
List<DocumentChunkBlock>	getResults()
String	getSearchId()
Integer	getTotal()
int	hashCode()
KnowledgeDocumentChunkResponse	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentChunkResponse	pageSize(Integer pageSize)	Page size of the returned results.
KnowledgeDocumentChunkResponse	preprocessQuery(Boolean preprocessQuery)	Indicates whether the chunks search query should be preprocessed.
KnowledgeDocumentChunkResponse	query(String query)	Query to search chunks in the knowledge base.
KnowledgeDocumentChunkResponse	queryType(KnowledgeDocumentChunkResponse.QueryTypeEnum queryType)	The type of the query that initiates the chunks search.
KnowledgeDocumentChunkResponse	results(List<DocumentChunkBlock> results)	Chunks matching the search query.
void	setApplication(KnowledgeSearchClientApplication application)
void	setConfidenceThreshold(Float confidenceThreshold)
void	setConversationContext(KnowledgeConversationContextResponse conversationContext)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setPreprocessQuery(Boolean preprocessQuery)
void	setQuery(String query)
void	setQueryType(KnowledgeDocumentChunkResponse.QueryTypeEnum queryType)
void	setResults(List<DocumentChunkBlock> results)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentChunkResponse

public KnowledgeDocumentChunkResponse()

KnowledgeDocumentChunkResponse

public KnowledgeDocumentChunkResponse(Boolean initWithEmptyList)

Method Details

query

public KnowledgeDocumentChunkResponse query(String query)

Query to search chunks in the knowledge base.

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

getTotal

public Integer getTotal()

getPageCount

public Integer getPageCount()

pageSize

public KnowledgeDocumentChunkResponse pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public KnowledgeDocumentChunkResponse pageNumber(Integer pageNumber)

Page number of the returned results.

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

queryType

public KnowledgeDocumentChunkResponse queryType(KnowledgeDocumentChunkResponse.QueryTypeEnum queryType)

The type of the query that initiates the chunks search.

getQueryType

public KnowledgeDocumentChunkResponse.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentChunkResponse.QueryTypeEnum queryType)

getSearchId

public String getSearchId()

preprocessQuery

public KnowledgeDocumentChunkResponse preprocessQuery(Boolean preprocessQuery)

Indicates whether the chunks search query should be preprocessed.

getPreprocessQuery

public Boolean getPreprocessQuery()

setPreprocessQuery

public void setPreprocessQuery(Boolean preprocessQuery)

confidenceThreshold

public KnowledgeDocumentChunkResponse confidenceThreshold(Float confidenceThreshold)

The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher chunk confidence than the threshold.

getConfidenceThreshold

public Float getConfidenceThreshold()

setConfidenceThreshold

public void setConfidenceThreshold(Float confidenceThreshold)

results

public KnowledgeDocumentChunkResponse results(List<DocumentChunkBlock> results)

Chunks matching the search query.

getResults

public List<DocumentChunkBlock> getResults()

setResults

public void setResults(List<DocumentChunkBlock> results)

application

public KnowledgeDocumentChunkResponse application(KnowledgeSearchClientApplication application)

The client application details from which chunks search happened.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentChunkResponse conversationContext(KnowledgeConversationContextResponse conversationContext)

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

getConversationContext

public KnowledgeConversationContextResponse getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContextResponse conversationContext)

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