com.livehelps.dify.service

接口 DifyAnnotationApiService

所有已知子接口:

DifyChatFlowApiService, DifyCompletionApiService

public interface DifyAnnotationApiService

方法概要

限定符和类型	方法和说明
retrofit2.Call<AnnotationReplyResponse>	annotationReply(AnnotationReplyAction action, AnnotationReplyRequest request) 启用或禁用标注回复设置，并配置嵌入模型。
retrofit2.Call<Annotation>	createAnnotation(AnnotationRequest request) 创建标注
retrofit2.Call<Void>	deleteAnnotation(String id) 删除标注
retrofit2.Call<AnnotationListResponse>	getAnnotationList(int page, int limit) 获取标注列表
retrofit2.Call<AnnotationReplyResponse>	getAnnotationReplyStatus(AnnotationReplyAction action, String jobId) 查询标注回复初始设置任务状态
retrofit2.Call<Annotation>	updateAnnotation(String id, AnnotationRequest request) 更新标注

方法详细资料

createAnnotation

@POST(value="apps/annotations")
retrofit2.Call<Annotation> createAnnotation(@Body
                                                                             AnnotationRequest request)

创建标注

参数:

request -

返回:

getAnnotationList

@GET(value="apps/annotations")
retrofit2.Call<AnnotationListResponse> getAnnotationList(@Query(value="page")
                                                                                         int page,
                                                                                         @Query(value="limit")
                                                                                         int limit)

获取标注列表

参数:

page -

limit -

返回:

deleteAnnotation

@DELETE(value="apps/annotations/{id}")
retrofit2.Call<Void> deleteAnnotation(@Path(value="id")
                                                                              String id)

删除标注

参数:

id -

返回:

updateAnnotation

@PUT(value="apps/annotations/{id}")
retrofit2.Call<Annotation> updateAnnotation(@Path(value="id")
                                                                                 String id,
                                                                                 @Body
                                                                                 AnnotationRequest request)

更新标注

参数:

id -

request -

返回:

annotationReply

@POST(value="apps/annotation-reply/{action}")
retrofit2.Call<AnnotationReplyResponse> annotationReply(@Path(value="action")
                                                                                                       AnnotationReplyAction action,
                                                                                                       @Body
                                                                                                       AnnotationReplyRequest request)

启用或禁用标注回复设置，并配置嵌入模型。此接口异步执行。 嵌入模型的提供商和模型名称可通过 v1/workspaces/current/models/model-types/text-embedding 接口获取

参数:

action -

request -

返回:

getAnnotationReplyStatus

@GET(value="apps/annotation-reply/{action}/status/{job_id}")
retrofit2.Call<AnnotationReplyResponse> getAnnotationReplyStatus(@Path(value="action")
                                                                                                                               AnnotationReplyAction action,
                                                                                                                               @Path(value="job_id")
                                                                                                                               String jobId)

查询标注回复初始设置任务状态

参数:

action - 动作，只能是 'enable' 或 'disable'，并且必须和标注回复初始设置接口的动作一致

jobId - 任务 ID，从标注回复初始设置接口返回的 job_id

返回: