Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentSearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentSearchRequest

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentSearchRequest
extends Object
implements Serializable

KnowledgeDocumentSearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentSearchRequest.AnswerModeEnum	Gets or Sets answerMode
static enum	KnowledgeDocumentSearchRequest.QueryTypeEnum	The type of the query that initiates the search.
static enum	KnowledgeDocumentSearchRequest.SortByEnum	The field in the documents that you want to sort the search results by.
static enum	KnowledgeDocumentSearchRequest.SortOrderEnum	The sort order for search results.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentSearchRequest()
KnowledgeDocumentSearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentSearchRequest	answerHighlightTopResults(Integer answerHighlightTopResults)	The number of articles to be sent for answer-highlighting.
KnowledgeDocumentSearchRequest	answerMode(List<KnowledgeDocumentSearchRequest.AnswerModeEnum> answerMode)	Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration).
KnowledgeDocumentSearchRequest	application(KnowledgeSearchClientApplication application)	The client application details from which search request was sent.
KnowledgeDocumentSearchRequest	confidenceThreshold(Float confidenceThreshold)	The confidence threshold for the search results.
KnowledgeDocumentSearchRequest	conversationContext(KnowledgeConversationContext conversationContext)	Conversation context information if the search is initiated in the context of a conversation.
boolean	equals(Object o)
KnowledgeDocumentSearchRequest	filter(DocumentQuery filter)	Filter for the document search.
Integer	getAnswerHighlightTopResults()
List<KnowledgeDocumentSearchRequest.AnswerModeEnum>	getAnswerMode()
KnowledgeSearchClientApplication	getApplication()
Float	getConfidenceThreshold()
KnowledgeConversationContext	getConversationContext()
DocumentQuery	getFilter()
Boolean	getIncludeDraftDocuments()
DocumentQueryInterval	getInterval()
Integer	getPageCount()
Integer	getPageNumber()
Integer	getPageSize()
Boolean	getPreprocessQuery()
String	getQuery()
KnowledgeDocumentSearchRequest.QueryTypeEnum	getQueryType()
String	getSearchId()
KnowledgeDocumentSearchRequest.SortByEnum	getSortBy()
KnowledgeDocumentSearchRequest.SortOrderEnum	getSortOrder()
Integer	getTotal()
int	hashCode()
KnowledgeDocumentSearchRequest	includeDraftDocuments(Boolean includeDraftDocuments)	Indicates whether the search results would also include draft documents.
KnowledgeDocumentSearchRequest	interval(DocumentQueryInterval interval)	Retrieves the documents created/modified/published in specified date and time range.
KnowledgeDocumentSearchRequest	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentSearchRequest	pageSize(Integer pageSize)	Page size of the returned results.
KnowledgeDocumentSearchRequest	preprocessQuery(Boolean preprocessQuery)	Indicates whether the search query should be preprocessed.
KnowledgeDocumentSearchRequest	query(String query)	Query to search content in the knowledge base.
KnowledgeDocumentSearchRequest	queryType(KnowledgeDocumentSearchRequest.QueryTypeEnum queryType)	The type of the query that initiates the search.
void	setAnswerHighlightTopResults(Integer answerHighlightTopResults)
void	setAnswerMode(List<KnowledgeDocumentSearchRequest.AnswerModeEnum> answerMode)
void	setApplication(KnowledgeSearchClientApplication application)
void	setConfidenceThreshold(Float confidenceThreshold)
void	setConversationContext(KnowledgeConversationContext conversationContext)
void	setFilter(DocumentQuery filter)
void	setIncludeDraftDocuments(Boolean includeDraftDocuments)
void	setInterval(DocumentQueryInterval interval)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setPreprocessQuery(Boolean preprocessQuery)
void	setQuery(String query)
void	setQueryType(KnowledgeDocumentSearchRequest.QueryTypeEnum queryType)
void	setSortBy(KnowledgeDocumentSearchRequest.SortByEnum sortBy)
void	setSortOrder(KnowledgeDocumentSearchRequest.SortOrderEnum sortOrder)
KnowledgeDocumentSearchRequest	sortBy(KnowledgeDocumentSearchRequest.SortByEnum sortBy)	The field in the documents that you want to sort the search results by.
KnowledgeDocumentSearchRequest	sortOrder(KnowledgeDocumentSearchRequest.SortOrderEnum sortOrder)	The sort order for search results.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentSearchRequest

public KnowledgeDocumentSearchRequest()

KnowledgeDocumentSearchRequest

public KnowledgeDocumentSearchRequest(Boolean initWithEmptyList)

Method Details

query

public KnowledgeDocumentSearchRequest 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 KnowledgeDocumentSearchRequest pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

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

The type of the query that initiates the search.

getQueryType

public KnowledgeDocumentSearchRequest.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentSearchRequest.QueryTypeEnum queryType)

includeDraftDocuments

public KnowledgeDocumentSearchRequest includeDraftDocuments(Boolean includeDraftDocuments)

Indicates whether the search results would also include draft documents.

getIncludeDraftDocuments

public Boolean getIncludeDraftDocuments()

setIncludeDraftDocuments

public void setIncludeDraftDocuments(Boolean includeDraftDocuments)

interval

public KnowledgeDocumentSearchRequest interval(DocumentQueryInterval interval)

Retrieves the documents created/modified/published in specified date and time range.

getInterval

public DocumentQueryInterval getInterval()

setInterval

public void setInterval(DocumentQueryInterval interval)

filter

public KnowledgeDocumentSearchRequest filter(DocumentQuery filter)

Filter for the document search.

getFilter

public DocumentQuery getFilter()

setFilter

public void setFilter(DocumentQuery filter)

sortOrder

public KnowledgeDocumentSearchRequest sortOrder(KnowledgeDocumentSearchRequest.SortOrderEnum sortOrder)

The sort order for search results.

getSortOrder

public KnowledgeDocumentSearchRequest.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(KnowledgeDocumentSearchRequest.SortOrderEnum sortOrder)

sortBy

public KnowledgeDocumentSearchRequest sortBy(KnowledgeDocumentSearchRequest.SortByEnum sortBy)

The field in the documents that you want to sort the search results by.

getSortBy

public KnowledgeDocumentSearchRequest.SortByEnum getSortBy()

setSortBy

public void setSortBy(KnowledgeDocumentSearchRequest.SortByEnum sortBy)

application

public KnowledgeDocumentSearchRequest application(KnowledgeSearchClientApplication application)

The client application details from which search request was sent.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

conversationContext

public KnowledgeDocumentSearchRequest conversationContext(KnowledgeConversationContext conversationContext)

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

getConversationContext

public KnowledgeConversationContext getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContext conversationContext)

confidenceThreshold

public KnowledgeDocumentSearchRequest 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. The value should be between 0 to 1.

getConfidenceThreshold

public Float getConfidenceThreshold()

setConfidenceThreshold

public void setConfidenceThreshold(Float confidenceThreshold)

answerHighlightTopResults

public KnowledgeDocumentSearchRequest answerHighlightTopResults(Integer answerHighlightTopResults)

The number of articles to be sent for answer-highlighting. Can range from 1-5. minimum: 1 maximum: 5

getAnswerHighlightTopResults

public Integer getAnswerHighlightTopResults()

setAnswerHighlightTopResults

public void setAnswerHighlightTopResults(Integer answerHighlightTopResults)

answerMode

public KnowledgeDocumentSearchRequest answerMode(List<KnowledgeDocumentSearchRequest.AnswerModeEnum> answerMode)

Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults.

getAnswerMode

public List<KnowledgeDocumentSearchRequest.AnswerModeEnum> getAnswerMode()

setAnswerMode

public void setAnswerMode(List<KnowledgeDocumentSearchRequest.AnswerModeEnum> answerMode)

preprocessQuery

public KnowledgeDocumentSearchRequest 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