Support File API (#25)

Author: qianmoQ

.gitignore

@@ -3,3 +3,5 @@
 
 target/
 pom.xml.versionsBackup
+
+BaseTest.java

docs/docs/reference/openai/files.md

@@ -78,7 +78,7 @@ Delete a file.
 
 ```java
 String id = "file-XjGxS3KTG0uNmNOK362iJua3";
-this.client.deleteFile(entity.getId());
+        this.client.deleteFile(entity.getId());
 ```
 
 Returns:
@@ -90,3 +90,40 @@ Returns:
   "deleted": true
 }
 ```
+
+### Retrieve file
+
+---
+
+Returns information about a specific file.
+
+```java
+String id = "file-XjGxS3KTG0uNmNOK362iJua3";
+this.client.retrieveFile(entity.getId());
+```
+
+Returns:
+
+```json
+{
+  "id": "file-XjGxS3KTG0uNmNOK362iJua3",
+  "object": "file",
+  "bytes": 140,
+  "created_at": 1613779657,
+  "filename": "test.jsonl",
+  "purpose": "fine-tune"
+}
+```
+
+### Retrieve file content
+
+---
+
+Returns information about a specific file.
+
+```java
+String id = "file-XjGxS3KTG0uNmNOK362iJua3";
+this.client.retrieveFileContent(entity.getId());
+```
+
+Returns the original content of the uploaded file.

docs/docs/reference/openai/files.zh.md

@@ -90,3 +90,40 @@ this.client.deleteFile(entity.getId());
   "deleted": true
 }
 ```
+
+### Retrieve file
+
+---
+
+返回有关特定文件的信息。
+
+```java
+String id = "file-XjGxS3KTG0uNmNOK362iJua3";
+this.client.retrieveFile(entity.getId());
+```
+
+返回:
+
+```json
+{
+  "id": "file-XjGxS3KTG0uNmNOK362iJua3",
+  "object": "file",
+  "bytes": 140,
+  "created_at": 1613779657,
+  "filename": "test.jsonl",
+  "purpose": "fine-tune"
+}
+```
+
+### Retrieve file content
+
+---
+
+返回有关特定文件的信息。
+
+```java
+String id = "file-XjGxS3KTG0uNmNOK362iJua3";
+this.client.retrieveFileContent(entity.getId());
+```
+
+返回上传文件的原始内容。

src/main/java/org/devlive/sdk/openai/DefaultApi.java

@@ -158,4 +158,18 @@ Single<FileEntity> fetchUploadFile(@Url String url,
      */
     @DELETE
     Single<FileResponse> fetchDeleteFile(@Url String url);
+
+    /**
+     * Returns information about a specific file.
+     * 返回有关特定文件的信息。
+     */
+    @GET
+    Single<FileEntity> fetchRetrieveFile(@Url String url);
+
+    /**
+     * Returns the contents of the specified file
+     * 返回指定文件的内容
+     */
+    @GET
+    Single<Object> fetchRetrieveFileContent(@Url String url);
 }

src/main/java/org/devlive/sdk/openai/DefaultClient.java

@@ -132,7 +132,7 @@ public EditResponse edit(EditEntity configure)
                 .blockingGet();
     }
 
-    public FileResponse uploadFile()
+    public FileResponse files()
     {
         return this.api.fetchFiles(ProviderUtils.getUrl(provider, UrlModel.FETCH_FILES))
                 .blockingGet();
@@ -154,6 +154,20 @@ public FileResponse deleteFile(String id)
                 .blockingGet();
     }
 
+    public FileEntity retrieveFile(String id)
+    {
+        String url = String.join("/", ProviderUtils.getUrl(provider, UrlModel.FETCH_FILES), id);
+        return this.api.fetchRetrieveFile(url)
+                .blockingGet();
+    }
+
+    public Object retrieveFileContent(String id)
+    {
+        String url = String.join("/", ProviderUtils.getUrl(provider, UrlModel.FETCH_FILES), id, "content");
+        return this.api.fetchRetrieveFileContent(url)
+                .blockingGet();
+    }
+
     public void close()
     {
         if (ObjectUtils.isNotEmpty(this.client)) {

src/test/java/org/devlive/sdk/openai/BaseTest.java

@@ -11,7 +11,6 @@ public void before()
     {
         client = OpenAiClient.builder()
                 .apiKey(System.getProperty("openai.token"))
-                .apiKey("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")
                 .build();
     }
 }

src/test/java/org/devlive/sdk/openai/FileClientTest.java

@@ -12,7 +12,7 @@ public class FileClientTest
     @Test
     public void testFiles()
     {
-        Assert.assertNotNull(this.client.uploadFile());
+        Assert.assertNotNull(this.client.files());
     }
 
     @Test
@@ -37,4 +37,30 @@ public void testDeleteFile()
         Assert.assertTrue(this.client.deleteFile(entity.getId())
                 .getDeleted());
     }
+
+    @Test
+    public void testRetrieveFile()
+            throws InterruptedException
+    {
+        String file = this.getClass().getResource("/test.jsonl").getFile();
+        FileEntity entity = this.client.uploadFile(FileEntity.builder()
+                .file(new File(file))
+                .build());
+        Thread.sleep(3000);
+
+        Assert.assertNotNull(this.client.retrieveFile(entity.getId()));
+    }
+
+    @Test
+    public void testRetrieveFileContent()
+            throws InterruptedException
+    {
+        String file = this.getClass().getResource("/test.jsonl").getFile();
+        FileEntity entity = this.client.uploadFile(FileEntity.builder()
+                .file(new File(file))
+                .build());
+        Thread.sleep(3000);
+
+        Assert.assertNotNull(this.client.retrieveFileContent(entity.getId()));
+    }
 }