Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentSearch

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentSearch

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentSearch
extends Object
implements Serializable

KnowledgeDocumentSearch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentSearch()
KnowledgeDocumentSearch(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentSearch	answerGeneration(KnowledgeAnswerGenerationResponse answerGeneration)	The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".
KnowledgeDocumentSearch	application(KnowledgeSearchClientApplication application)	The client application details from which search happened.
KnowledgeDocumentSearch	confidenceThreshold(Float confidenceThreshold)	The confidence threshold for the search results.
KnowledgeDocumentSearch	conversationContext(KnowledgeConversationContextResponse conversationContext)	Conversation context information if the search is initiated in the context of a conversation.
boolean	equals(Object o)
KnowledgeAnswerGenerationResponse	getAnswerGeneration()
KnowledgeSearchClientApplication	getApplication()
Float	getConfidenceThreshold()
KnowledgeConversationContextResponse	getConversationContext()
Integer	getPageCount()
Integer	getPageNumber()
Integer	getPageSize()
Boolean	getPreprocessQuery()
String	getQuery()
KnowledgeDocumentSearch.QueryTypeEnum	getQueryType()
List<KnowledgeDocumentSearchResult>	getResults()
String	getSearchId()
Integer	getTotal()
int	hashCode()
KnowledgeDocumentSearch	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentSearch	pageSize(Integer pageSize)	Page size of the returned results.
KnowledgeDocumentSearch	preprocessQuery(Boolean preprocessQuery)	Indicates whether the search query should be preprocessed.
KnowledgeDocumentSearch	query(String query)	Query to search content in the knowledge base.
KnowledgeDocumentSearch	queryType(KnowledgeDocumentSearch.QueryTypeEnum queryType)	The type of the query that initiates the search.
void	setAnswerGeneration(KnowledgeAnswerGenerationResponse answerGeneration)
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(KnowledgeDocumentSearch.QueryTypeEnum queryType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentSearch

public KnowledgeDocumentSearch()

KnowledgeDocumentSearch

public KnowledgeDocumentSearch(Boolean initWithEmptyList)

Method Details

query

public KnowledgeDocumentSearch query(String query)

Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

pageSize

public KnowledgeDocumentSearch pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public KnowledgeDocumentSearch pageNumber(Integer pageNumber)

Page number of the returned results.

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

getSearchId

public String getSearchId()

getTotal

public Integer getTotal()

getPageCount

public Integer getPageCount()

queryType

public KnowledgeDocumentSearch queryType(KnowledgeDocumentSearch.QueryTypeEnum queryType)

The type of the query that initiates the search.

getQueryType

public KnowledgeDocumentSearch.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentSearch.QueryTypeEnum queryType)

getResults

public List<KnowledgeDocumentSearchResult> getResults()

application

public KnowledgeDocumentSearch application(KnowledgeSearchClientApplication application)

The client application details from which search happened.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentSearch conversationContext(KnowledgeConversationContextResponse conversationContext)

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

getConversationContext

public KnowledgeConversationContextResponse getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContextResponse conversationContext)

confidenceThreshold

public KnowledgeDocumentSearch confidenceThreshold(Float confidenceThreshold)

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

getConfidenceThreshold

public Float getConfidenceThreshold()

setConfidenceThreshold

public void setConfidenceThreshold(Float confidenceThreshold)

answerGeneration

public KnowledgeDocumentSearch answerGeneration(KnowledgeAnswerGenerationResponse answerGeneration)

The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".

getAnswerGeneration

public KnowledgeAnswerGenerationResponse getAnswerGeneration()

setAnswerGeneration

public void setAnswerGeneration(KnowledgeAnswerGenerationResponse answerGeneration)

preprocessQuery

public KnowledgeDocumentSearch preprocessQuery(Boolean preprocessQuery)

Indicates whether the search query should be preprocessed.

getPreprocessQuery

public Boolean getPreprocessQuery()

setPreprocessQuery

public void setPreprocessQuery(Boolean preprocessQuery)

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