feat: Initialize Java SDK with support for all Coze APIs by hanzeINGH · Pull Request #1 · coze-dev/coze-java

hanzeINGH · 2024-12-12T02:59:55Z

Created initial project structure for the Java SDK
Implemented client classes for all Coze API endpoints
Added authentication and authorization mechanisms
Developed request and response models for each API
Implemented error handling and exception classes
Created utility classes for HTTP requests and JSON parsing
Added logging support for debugging and monitoring
Included basic unit tests for core functionality
Created documentation with usage examples and API reference
Set up build configuration and dependency management with Maven/Gradle
Added README with installation and quick start guide

Change-Id: I1a74861a59dfffacbd4e535e5f2c535aa9967387

Change-Id: I9a1213d5f702d9aac8ee4d30828a3ec00d0999a0

chyroc · 2024-12-12T03:34:39Z

在 ApiResponseCallAdapter 中的 TODO 注释（"todo 添加日志"）应该被实现或移除
建议使用日志框架（如 SLF4J）替代直接的 System.out.println

chyroc · 2024-12-12T03:35:00Z

MyInterceptor 中的调试日志可能会记录敏感信息，建议在生产环境中完全移除
建议添加日志级别控制，避免在生产环境中输出过多调试信息

Change-Id: I191e5827d4362dce159c3f2d0306083a7b14cd14

Change-Id: Ia076aa54ad924055486c86e545154aff5c84bb1b

Change-Id: I5b140e44fd8e87850a410ca529c3155723a95b96

Change-Id: If780e3f5b04fd4a5ac4b507cdf4ef27ea0085834

Change-Id: I5c91800473c1031df7f9d3efe5e8f3836a1359cc

Change-Id: Icb1583d6a1bf2e3f4a282afefb428fe634be1d3b

Change-Id: I770693dd42982535b3ccc3e7fb8262121f0251b4

Change-Id: If4a92028dc7a725a865262c59d5e198170720519

Change-Id: Id12c3f2dd5d20b26fe09c22c8c114108ccf935d3

Change-Id: I887361495abb40023197763a197e2b46b0d978e7

Change-Id: Iabfe94f6e3f30dfe05b494469630ac861ad45a9c

Change-Id: I23699ff6e3ca051fda8974ade055baa1e00b75bc

Change-Id: I5df08c090cd52a5535e40e21fc219d82e49fc670

chyroc · 2024-12-12T06:25:58Z

+                                         .botID(botID)
+                                         .voiceID(voiceID)
+                                         .build();
+        CreateRoomResp resp = coze.audio().rooms().create(req);


print 一下

chyroc · 2024-12-12T06:27:05Z

+
+import java.io.IOException;
+
+public class CreateSpeechExample {


改成这个格式：
coze.audio().speech().create -> AudioSpeechCreateExample

全改吗，我现在的 Example 都是动词在前，其实也是可以根据包名来区分实体的

Change-Id: Iabd29d9e741fb75f3c8534891ecee0dc9ca41d6c

chyroc · 2024-12-12T06:45:03Z

+                .auth(authCli)
+                .readTimeout(10000)
+                .build();;
+        String saveFilePath = System.getenv("SAVE_FILE_PATH");


这个保存到 Downloads 目录下一个随机的文件

chyroc · 2024-12-12T06:46:06Z

+import com.coze.openapi.service.service.CozeAPI;
+import com.coze.openapi.service.auth.TokenAuth;
+
+public class CloneVoiceExample {


AudioVoicesClone，其他的也改一下

chyroc · 2024-12-12T06:46:40Z

+                                         .language(LanguageCode.ZH)
+                                         .voiceID(System.getenv("COZE_VOICE_ID"))
+                                         .text("your text")
+                                         .previewText("your preview text")


去掉这个，这个不是必填

chyroc · 2024-12-12T06:46:49Z

+                                         .audioFormat(AudioFormat.M4A)
+                                         .language(LanguageCode.ZH)
+                                         .voiceID(System.getenv("COZE_VOICE_ID"))
+                                         .text("your text")


去掉这个

chyroc · 2024-12-12T06:47:16Z

+
+import java.util.Iterator;
+
+public class ListVoiceExample {


chyroc · 2024-12-12T06:48:37Z

+
+        PageResp<Voice> resp = coze.audio().voices().list(ListVoiceReq.builder().pageSize(10).build());
+        Iterator<Voice> iterator = resp.getIterator();
+        while (iterator.hasNext()) {


这个是自带的迭代器吗

对，java 原生的

java 定义了迭代器，是一个 interface，我们可以自定义实现

chyroc · 2024-12-12T06:50:06Z

+        /*
+         * The space permissions for which the Access Token is granted can be specified. As following codes:
+         * */
+        DeviceAuthResp wCodeResp = oauth.getDeviceCode("workspaceID");


这一行是不是应该注释？这个文件可以 run 起来吗，申请了两个 code？

是，我改成注解

chyroc · 2024-12-12T06:51:44Z

+        /*
+        * The space permissions for which the Access Token is granted can be specified. As following codes:
+        * */
+        oauthURL = oauth.getOAuthURL(redirectURI, null, "workspaceID");


还有两个地方，统一改了

chyroc · 2024-12-12T06:56:15Z

+import com.coze.openapi.client.common.BaseReq;
+public interface BotAPI {
+    @GET("/v1/space/published_bots_list")
+    Call<BaseResponse<ListBotResp>> list(@Query("space_id") String spaceID, @Query("page_index") Integer page, @Query("page_size") Integer pageSize, @Tag BaseReq baseReq);


这个参数不是结构体吗

这整个目录对于使用者都是不感知的，这里可以理解成请求我们 openapi 的代码

baseReq 是我用来让用户可以配置请求级别的超时时间的

在执行请求的时候不会写到 Request 里面

Change-Id: I55ef6dfb256e60821a9e6d59b821560179b3813e

chyroc · 2024-12-12T06:56:34Z

+public interface ChatAPI {
+
+    @POST("/v3/chat")
+    Call<BaseResponse<Chat>> chat(@Query("conversation_id") String conversationID, @Body CreateChatReq req, @Tag BaseReq baseReq);


chyroc · 2024-12-12T06:58:32Z

+public interface CozeAuthAPI {
+    @Headers({"Content-Type: application/json"})
+    @POST("/api/permission/oauth2/token")
+    Single<Response<OAuthToken>> retrieve(@HeaderMap Map<String, String> headers, @Body GetAccessTokenReq req);


这个为啥是retrieve

刷新 token，获取 Access token 都是用这个接口，具体是做啥就由入参来控制，我就叫这个了

chyroc · 2024-12-12T06:59:57Z

+
+    @POST("/open_api/knowledge/document/create")
+    @Headers({"Content-Type: application/json","Agw-Js-Conv: str"})
+    Call<CreateDocumentResp> CreateDocument(@Body CreateDocumentReq req, @Tag BaseReq baseReq);


.documents.create

chyroc · 2024-12-12T07:01:09Z

+public interface WorkflowRunAPI {
+
+    @POST("/v1/workflow/run")
+    Call<RunWorkflowResp> run(@Body RunWorkflowReq req, @Tag BaseReq baseReq);


.workflows.runs.create

chyroc · 2024-12-12T07:01:23Z

+
+    @POST("/v1/workflow/stream_run")
+    @Streaming
+    Call<ResponseBody> stream(@Body RunWorkflowReq req, @Tag BaseReq baseReq);


.workflows.runs.stream

chyroc · 2024-12-12T07:01:36Z

+
+    @POST("/v1/workflow/stream_resume")
+    @Streaming
+    Call<ResponseBody> resume(@Body ResumeRunReq req, @Tag BaseReq baseReq);


.workflows.runs.resume

Change-Id: Iacb00780c3eb6ea23a932157b9f74aa41a5ffdbf

hanzeINGH added 2 commits December 12, 2024 10:58

init

7b18e5e

Change-Id: I1a74861a59dfffacbd4e535e5f2c535aa9967387

add ci

2f5acc9

Change-Id: I9a1213d5f702d9aac8ee4d30828a3ec00d0999a0

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/room/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/speech/CreateExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/speech/CreateExample.java

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/audio/voice/CloneExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/auth/DevicesOAuthExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/auth/DevicesOAuthExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/auth/JWTsOauthExample.java Outdated

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/auth/PkceOauthExample.java

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread example/src/main/java/example/auth/PkceOauthExample.java Outdated

hanzeINGH added 10 commits December 12, 2024 11:49

add example&readme

5ab3336

Change-Id: I191e5827d4362dce159c3f2d0306083a7b14cd14

fix bug

7f0319d

Change-Id: Ia076aa54ad924055486c86e545154aff5c84bb1b

fix: cr

7ae8d3b

Change-Id: I5b140e44fd8e87850a410ca529c3155723a95b96

fix cr

50889ea

Change-Id: If780e3f5b04fd4a5ac4b507cdf4ef27ea0085834

add readme and example

fe2e17d

Change-Id: I5c91800473c1031df7f9d3efe5e8f3836a1359cc

add contributing.md

17aed85

Change-Id: Icb1583d6a1bf2e3f4a282afefb428fe634be1d3b

add contributing.md

4a0293c

Change-Id: I770693dd42982535b3ccc3e7fb8262121f0251b4

fix: build.gradle

84d4528

Change-Id: If4a92028dc7a725a865262c59d5e198170720519

add base req and base resp

60f949a

Change-Id: Id12c3f2dd5d20b26fe09c22c8c114108ccf935d3

fix some bug

327f247

Change-Id: I887361495abb40023197763a197e2b46b0d978e7

hanzeINGH added 4 commits December 12, 2024 11:53

fix some bug

260c6bd

Change-Id: I887361495abb40023197763a197e2b46b0d978e7

add ut

2f22025

Change-Id: Iabfe94f6e3f30dfe05b494469630ac861ad45a9c

add user agent

8907f55

Change-Id: I23699ff6e3ca051fda8974ade055baa1e00b75bc

fix cr

156aeb7

Change-Id: I5df08c090cd52a5535e40e21fc219d82e49fc670

chyroc reviewed Dec 12, 2024

View reviewed changes

Comment thread codecov.yaml

chyroc reviewed Dec 12, 2024

View reviewed changes

add conv plugin

836a5e3

Change-Id: Iabd29d9e741fb75f3c8534891ecee0dc9ca41d6c

chyroc reviewed Dec 12, 2024

View reviewed changes

fix cr

8140483

Change-Id: I55ef6dfb256e60821a9e6d59b821560179b3813e

chyroc reviewed Dec 12, 2024

View reviewed changes

chyroc changed the title ~~init sdk~~ feat: Initialize Java SDK with support for all Coze APIs Dec 12, 2024

chyroc added the feature label Dec 12, 2024

fix cr

d5e9878

Change-Id: Iacb00780c3eb6ea23a932157b9f74aa41a5ffdbf

chyroc merged commit b590e05 into coze-dev:main Dec 12, 2024


		import java.io.IOException;

		public class CreateSpeechExample {

Conversation

hanzeINGH commented Dec 12, 2024 • edited by chyroc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chyroc commented Dec 12, 2024

Uh oh!

chyroc commented Dec 12, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chyroc Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

hanzeINGH commented Dec 12, 2024 •

edited by chyroc

Loading

chyroc Dec 12, 2024 •

edited

Loading