com.coze.openapi.api

Interface ChatAPI

public interface ChatAPI

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<BaseResponse<Chat>>	cancel(CancelChatReq req, BaseReq baseReq)
retrofit2.Call<BaseResponse<Chat>>	chat(String conversationID, CreateChatReq req, BaseReq baseReq)
retrofit2.Call<BaseResponse<Chat>>	retrieve(String conversationID, String chatID, BaseReq baseReq)
retrofit2.Call<okhttp3.ResponseBody>	stream(String conversationID, CreateChatReq req, BaseReq baseReq)
retrofit2.Call<okhttp3.ResponseBody>	streamSubmitToolOutputs(String conversationID, String chatID, SubmitToolOutputsReq req, BaseReq baseReq)
retrofit2.Call<BaseResponse<Chat>>	submitToolOutputs(String conversationID, String chatID, SubmitToolOutputsReq req, BaseReq baseReq)

Method Detail

chat

@POST(value="/v3/chat")
retrofit2.Call<BaseResponse<Chat>> chat(@Query(value="conversation_id")
                                                                String conversationID,
                                                                @Body
                                                                CreateChatReq req,
                                                                @Tag
                                                                BaseReq baseReq)

stream

@POST(value="/v3/chat")
 @Streaming
retrofit2.Call<okhttp3.ResponseBody> stream(@Query(value="conversation_id")
                                                                                String conversationID,
                                                                                @Body
                                                                                CreateChatReq req,
                                                                                @Tag
                                                                                BaseReq baseReq)

retrieve

@GET(value="/v3/chat/retrieve")
retrofit2.Call<BaseResponse<Chat>> retrieve(@Query(value="conversation_id")
                                                                            String conversationID,
                                                                            @Query(value="chat_id")
                                                                            String chatID,
                                                                            @Tag
                                                                            BaseReq baseReq)

cancel

@POST(value="/v3/chat/cancel")
retrofit2.Call<BaseResponse<Chat>> cancel(@Body
                                                                         CancelChatReq req,
                                                                         @Tag
                                                                         BaseReq baseReq)

streamSubmitToolOutputs

@POST(value="/v3/chat/submit_tool_outputs")
 @Streaming
retrofit2.Call<okhttp3.ResponseBody> streamSubmitToolOutputs(@Query(value="conversation_id")
                                                                                                                     String conversationID,
                                                                                                                     @Query(value="chat_id")
                                                                                                                     String chatID,
                                                                                                                     @Body
                                                                                                                     SubmitToolOutputsReq req,
                                                                                                                     @Tag
                                                                                                                     BaseReq baseReq)

submitToolOutputs

@POST(value="/v3/chat/submit_tool_outputs")
retrofit2.Call<BaseResponse<Chat>> submitToolOutputs(@Query(value="conversation_id")
                                                                                                 String conversationID,
                                                                                                 @Query(value="chat_id")
                                                                                                 String chatID,
                                                                                                 @Body
                                                                                                 SubmitToolOutputsReq req,
                                                                                                 @Tag
                                                                                                 BaseReq baseReq)