# Feature: web console api

- 标注相关API支持

Author: hodge

README.md

@@ -41,12 +41,12 @@ implementation group: 'io.github.yuanbaobaoo', name: 'dify-java-client', version
 /**
  * 创建一个对话类型客户端对象，支持 base()、chat()、flow()、completion() 其对应返回类型也是不一致的
  */
-IAppChatClient appClient = DifyClientBuilder.app().chat().apiKey("app-xxx").baseUrl("https://api.dify.ai").build();
+IAppChatClient appClient = DifyClientBuilder.app().chat().apiKey("app-xxx").baseUrl("https://api.dify.ai/v1").build();
 
 /**
  * 创建一个知识库类型客户端对象
  */
-IDatasetClient datasetClient = DifyClientBuilder.dataset().apiKey("app-xxx").baseUrl("https://api.dify.ai").build();
+IDatasetClient datasetClient = DifyClientBuilder.dataset().apiKey("app-xxx").baseUrl("https://api.dify.ai/v1").build();
 
 /**
  * 创建一个WebConsole类型客户端对象，用于模拟Dify控制台操作（试验特性）
@@ -65,7 +65,7 @@ App客户端是指适用于 ChatBot、Agent、ChatFlow、Completion 类型的应
 ### 1、IAppBaseClient
 基础Client，提供Dify公共API，具体可查阅 ```IAppBaseClient```
 ```java
-IAppBaseClient client = DifyClientBuilder.app().base().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppBaseClient client = DifyClientBuilder.app().base().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // 调用接口
 String metaInfo = client.getAppMetaInfo();
@@ -76,7 +76,7 @@ DifyFileResult result = client.uploadFile(new File("pom.xml"), "abc-123");
 ### 2、IAppChatClient
 适用于 ChatBot、Agent、ChatFlow 类型应用，继承自 ```IAppBaseClient```，提供了会话相关的API：
 ```java
-IAppChatClient client = DifyClientBuilder.app().chat().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppChatClient client = DifyClientBuilder.app().chat().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // 创建消息
 ParamMessage m = ParamMessage.builder().query("你是谁").user("abc-123").inputs(Map.of(
@@ -99,7 +99,7 @@ CompletableFuture<Void> future = client.sendMessagesAsync(m, (r) -> {
 ### 3、IAppFlowClient
 适用于 WorkFlow 类型应用，继承自 ```IAppBaseClient```，提供了工作流相关的API：
 ```java
-IAppFlowClient flowClient = DifyClientBuilder.app().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppFlowClient flowClient = DifyClientBuilder.app().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // 创建消息
 ParamMessage m = ParamMessage.builder().user("abc-123").inputs(Map.of(
@@ -119,7 +119,7 @@ CompletableFuture<Void> future = client.runStreaming(m, (r) -> {
 ### 4、IAppCompletion
 适用于 Completion 类型应用，继承自 ```IAppBaseClient```，提供了文本生成相关的API：
 ```java
-IAppCompletion completion = DifyClientBuilder.completion().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppCompletion completion = DifyClientBuilder.completion().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // 创建消息
 ParamMessage m = ParamMessage.builder().query("Java为什么叫Java").user("abc-123").build();
@@ -141,7 +141,7 @@ CompletableFuture<Void> future = completion.sendMessagesAsync(m, (r) -> {
 
 #### 参考案例
 ```java
-IDatasetClient client = DifyClientBuilder.dataset().apiKey("dataset-xxxx").baseUrl("https://api.dify.ai").build();
+IDatasetClient client = DifyClientBuilder.dataset().apiKey("dataset-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // 声明参数
 ParamDataset dataset = ParamDataset.builder()
@@ -159,7 +159,7 @@ client.create(dataset);
 - 案例一：新增文档
 ```java
 // dify 配置
-DifyConfig config = DifyConfig.builder().server("https://api.dify.ai").apiKey("dataset-xxxx").build();
+DifyConfig config = DifyConfig.builder().server("https://api.dify.ai/v1").apiKey("dataset-xxxx").build();
 
 // 声明参数
 ParamDocument document = ParamDocument.builder()
@@ -188,7 +188,7 @@ dataset.insertTxt(document);
 - 案例2：更新文档
 ```java
 // dify 配置
-DifyConfig config = DifyConfig.builder().server("http://localhost:4000").apiKey("dataset-xxxx").build();
+DifyConfig config = DifyConfig.builder().server("https://api.dify.ai/v1").apiKey("dataset-xxxx").build();
 
 // 声明参数
 ParamDocument document = ParamDocument.builder()

README_EN.md

@@ -41,12 +41,12 @@ Create client instances using ```DifyClientBuilder```
 /**
  * Create a chat-type client for ChatBot/Agent/ChatFlow/Completion apps
  */
-IAppChatClient appClient = DifyClientBuilder.app().chat().apiKey("app-xxx").baseUrl("https://api.dify.ai").build();
+IAppChatClient appClient = DifyClientBuilder.app().chat().apiKey("app-xxx").baseUrl("https://api.dify.ai/v1").build();
 
 /**
  * Create a dataset client
  */
-IDatasetClient datasetClient = DifyClientBuilder.dataset().apiKey("app-xxx").baseUrl("https://api.dify.ai").build();
+IDatasetClient datasetClient = DifyClientBuilder.dataset().apiKey("app-xxx").baseUrl("https://api.dify.ai/v1").build();
 
 /**
  * Create a WebConsole client (experimental)
@@ -65,7 +65,7 @@ It provides session related APIs and supports streaming return of sessions. It m
 ### 1、IAppBaseClient
 Base client providing common Dify APIs:
 ```java
-IAppBaseClient client = DifyClientBuilder.app().base().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppBaseClient client = DifyClientBuilder.app().base().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // Call preset API
 String metaInfo = client.getAppMetaInfo();
@@ -76,7 +76,7 @@ DifyFileResult result = client.uploadFile(new File("pom.xml"), "abc-123");
 ### 2、IAppChatClient
 For ChatBot/Agent/ChatFlow apps (extends IAppBaseClient):
 ```java
-IAppChatClient client = DifyClientBuilder.app().chat().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppChatClient client = DifyClientBuilder.app().chat().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // create message
 ParamMessage m = ParamMessage.builder().query("Who are you").user("abc-123").inputs(new HashMap<>() {{
@@ -100,7 +100,7 @@ CompletableFuture<Void> future = client.sendMessagesAsync(m, (r) -> {
 ### 3、IAppFlowClient
 For WorkFlow apps (extends IAppBaseClient):
 ```java
-IAppFlowClient flowClient = DifyClientBuilder.app().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppFlowClient flowClient = DifyClientBuilder.app().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // create message
 ParamMessage m = ParamMessage.builder().user("abc-123").inputs(new HashMap<>() {{
@@ -120,7 +120,7 @@ CompletableFuture<Void> future = client.runStreaming(m, (r) -> {
 ### 4、IAppCompletion
 scope = Completion, extends ```IDifyBaseClient```, provides completion APIs
 ```java
-IAppCompletion completion = DifyClientBuilder.completion().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai").build();
+IAppCompletion completion = DifyClientBuilder.completion().flow().apiKey("app-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // create message
 ParamMessage m = ParamMessage.builder().query("Java为什么叫Java").user("abc-123").build();
@@ -143,7 +143,7 @@ For specific API definitions, please refer to [```io.github.yuanbaobaoo.dify.cli
 
 #### Examples
 ```java
-IDatasetClient client = DifyClientBuilder.dataset().apiKey("dataset-xxxx").baseUrl("https://api.dify.ai").build();
+IDatasetClient client = DifyClientBuilder.dataset().apiKey("dataset-xxxx").baseUrl("https://api.dify.ai/v1").build();
 
 // create params
 ParamDataset dataset = ParamDataset.builder()
@@ -161,7 +161,7 @@ it also provides Hero class to support the operation of the knowledge base.Which
 - Case 1: add document
 ```java
 // dify config
-DifyConfig config = DifyConfig.builder().server("http://localhost:4000").apiKey("dataset-xxxx").build();
+DifyConfig config = DifyConfig.builder().server("https://api.dify.ai/v1").apiKey("dataset-xxxx").build();
 
 // create params
 ParamDocument document = ParamDocument.builder()
@@ -190,7 +190,7 @@ dataset.insertTxt(document);
 - Case 2: update document
 ```java
 // dify config
-DifyConfig config = DifyConfig.builder().server("http://localhost:4000").apiKey("dataset-xxxx").build();
+DifyConfig config = DifyConfig.builder().server("https://api.dify.ai/v1").apiKey("dataset-xxxx").build();
 
 // create params
 ParamDocument document = ParamDocument.builder()