Package com.bytedesk.kbase.llm_faq

Class FaqRestService

java.lang.Object

com.bytedesk.core.base.BaseRestService<T,TRequest,TResponse>

com.bytedesk.core.base.BaseRestServiceWithExport<FaqEntity,FaqRequest,FaqResponse,FaqExcel>

com.bytedesk.kbase.llm_faq.FaqRestService

@Service
public class FaqRestService
extends BaseRestServiceWithExport<FaqEntity,FaqRequest,FaqResponse,FaqExcel>

Field Summary

Fields

Modifier and Type	Field	Description
private final BytedeskEventPublisher	bytedeskEventPublisher
private final CategoryRestService	categoryRestService
private final FaqJsonLoader	faqJsonLoader
private final FaqRepository	faqRepository
private final KbaseRestService	kbaseRestService
private final MessageRestService	messageRestService
private final org.modelmapper.ModelMapper	modelMapper
private final ThreadRestService	threadRestService
private final UidUtils	uidUtils

Fields inherited from class com.bytedesk.core.base.BaseRestService

authService

Constructor Summary

Constructors

Constructor	Description
FaqRestService()

Method Summary

Modifier and Type	Method	Description
FaqResponse	clickFaq(FaqRequest request)
FaqEntity	convertExcelToFaq(FaqExcel excel, String kbType, String fileUid, String kbUid, String orgUid)
FaqExcel	convertToExcel(FaqEntity faq)	转换为Excel对象 子类必须实现此方法
FaqResponse	convertToResponse(FaqEntity entity)
FaqResponse	create(FaqRequest request)
protected org.springframework.data.jpa.domain.Specification<FaqEntity>	createSpecification(FaqRequest request)	创建Specification对象，子类必须实现 用于queryByOrg的通用实现
void	delateAll(FaqRequest request)
void	delete(FaqRequest entity)
void	deleteByUid(String uid)
protected FaqEntity	doSave(FaqEntity entity)	子类实现具体的保存逻辑
FaqResponse	enable(FaqRequest request)
protected org.springframework.data.domain.Page<FaqEntity>	executePageQuery(org.springframework.data.jpa.domain.Specification<FaqEntity> spec, org.springframework.data.domain.Pageable pageable)	执行分页查询，子类必须实现 用于queryByOrg的通用实现
Boolean	existsByQuestionAndAnswerAndKbUidAndOrgUid(String question, String answer, String kbUid, String orgUid)
Boolean	existsByUid(String uid)
List<FaqEntity>	findByKbUid(String kbUid)
List<FaqEntity>	findByQuestionContains(String question)
Optional<FaqEntity>	findByUid(String uid)
Optional<FaqEntity>	findRandomFaq()	获取一个随机FAQ，用于测试
static MessageEntity	getFaqAnswerMessage(FaqResponse faqResponse, ThreadEntity threadEntity)
static MessageEntity	getFaqQuestionMessage(FaqResponse faqResponse, ThreadEntity threadEntity)
FaqEntity	handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e, FaqEntity entity)
void	importFaqs(String orgUid, String kbUid)	导入FAQ数据 从JSON文件加载数据并存储到数据库
FaqResponse	queryByUid(FaqRequest request)	通用的queryByUid实现
void	save(List<FaqEntity> entities)
void	saveFaqPairs(String qaPairs, String kbUid, String orgUid)
FaqResponse	update(FaqRequest request)

Methods inherited from class com.bytedesk.core.base.BaseRestServiceWithExport

queryByOrgEntity

Methods inherited from class com.bytedesk.core.base.BaseRestService

deleteByOrgUid, findByOrgUid, getUidFromRequest, queryByOrg, queryByUser, recover, save, setUserUidToRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

faqRepository

private final FaqRepository faqRepository

modelMapper

private final org.modelmapper.ModelMapper modelMapper

uidUtils

private final UidUtils uidUtils

categoryRestService

private final CategoryRestService categoryRestService

faqJsonLoader

private final FaqJsonLoader faqJsonLoader

kbaseRestService

private final KbaseRestService kbaseRestService

threadRestService

private final ThreadRestService threadRestService

messageRestService

private final MessageRestService messageRestService

bytedeskEventPublisher

private final BytedeskEventPublisher bytedeskEventPublisher

Constructor Details

FaqRestService

public FaqRestService()

Method Details

createSpecification

protected org.springframework.data.jpa.domain.Specification<FaqEntity> createSpecification(FaqRequest request)

Description copied from class: BaseRestService

创建Specification对象，子类必须实现 用于queryByOrg的通用实现

Specified by:

createSpecification in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

executePageQuery

protected org.springframework.data.domain.Page<FaqEntity> executePageQuery(org.springframework.data.jpa.domain.Specification<FaqEntity> spec,
 org.springframework.data.domain.Pageable pageable)

Description copied from class: BaseRestService

执行分页查询，子类必须实现 用于queryByOrg的通用实现

Specified by:

executePageQuery in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

queryByUid

@Transactional
public FaqResponse queryByUid(FaqRequest request)

Description copied from class: BaseRestService

通用的queryByUid实现

Overrides:

queryByUid in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

clickFaq

public FaqResponse clickFaq(FaqRequest request)

findByUid

@Cacheable(value="faq",
           key="#uid",
           unless="#result == null")
public Optional<FaqEntity> findByUid(String uid)

Specified by:

findByUid in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

findByKbUid

@Cacheable(value="faq",
           key="#kbUid",
           unless="#result == null")
public List<FaqEntity> findByKbUid(String kbUid)

findByQuestionContains

@Cacheable(value="faq",
           key="#question",
           unless="#result == null")
public List<FaqEntity> findByQuestionContains(String question)

existsByQuestionAndAnswerAndKbUidAndOrgUid

public Boolean existsByQuestionAndAnswerAndKbUidAndOrgUid(String question,
 String answer,
 String kbUid,
 String orgUid)

existsByUid

public Boolean existsByUid(String uid)

create

@Transactional
public FaqResponse create(FaqRequest request)

Specified by:

create in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

update

@Transactional
public FaqResponse update(FaqRequest request)

Specified by:

update in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

enable

public FaqResponse enable(FaqRequest request)

doSave

@CachePut(value="faq",
          key="#entity.uid")
protected FaqEntity doSave(FaqEntity entity)

Description copied from class: BaseRestService

子类实现具体的保存逻辑

Specified by:

doSave in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

handleOptimisticLockingFailureException

public FaqEntity handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e,
 FaqEntity entity)

Specified by:

handleOptimisticLockingFailureException in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

save

public void save(List<FaqEntity> entities)

deleteByUid

@CacheEvict(value="faq",
            key="#uid")
public void deleteByUid(String uid)

Specified by:

deleteByUid in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

delete

public void delete(FaqRequest entity)

Specified by:

delete in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

delateAll

public void delateAll(FaqRequest request)

convertToResponse

public FaqResponse convertToResponse(FaqEntity entity)

Specified by:

convertToResponse in class BaseRestService<FaqEntity,FaqRequest,FaqResponse>

convertToExcel

public FaqExcel convertToExcel(FaqEntity faq)

Description copied from class: BaseRestServiceWithExport

转换为Excel对象 子类必须实现此方法

Specified by:

convertToExcel in class BaseRestServiceWithExport<FaqEntity,FaqRequest,FaqResponse,FaqExcel>

convertExcelToFaq

public FaqEntity convertExcelToFaq(FaqExcel excel,
 String kbType,
 String fileUid,
 String kbUid,
 String orgUid)

saveFaqPairs

public void saveFaqPairs(String qaPairs,
 String kbUid,
 String orgUid)

importFaqs

@Transactional
public void importFaqs(String orgUid,
 String kbUid)

导入FAQ数据 从JSON文件加载数据并存储到数据库

Parameters:

orgUid - 组织ID

kbUid - 知识库ID

getFaqQuestionMessage

public static MessageEntity getFaqQuestionMessage(FaqResponse faqResponse,
 ThreadEntity threadEntity)

getFaqAnswerMessage

public static MessageEntity getFaqAnswerMessage(FaqResponse faqResponse,
 ThreadEntity threadEntity)

findRandomFaq

public Optional<FaqEntity> findRandomFaq()

获取一个随机FAQ，用于测试

Returns:

随机FAQ的Optional包装