docs: add file + completions example (closes #483)

Author: TomerAberbach

openai-java-example/src/main/java/com/openai/example/CompletionsFileExample.java

@@ -0,0 +1,57 @@
+package com.openai.example;
+
+import com.openai.client.OpenAIClient;
+import com.openai.client.okhttp.OpenAIOkHttpClient;
+import com.openai.models.ChatModel;
+import com.openai.models.chat.completions.ChatCompletionContentPart;
+import com.openai.models.chat.completions.ChatCompletionContentPartText;
+import com.openai.models.chat.completions.ChatCompletionCreateParams;
+import com.openai.models.files.FileCreateParams;
+import com.openai.models.files.FileObject;
+import com.openai.models.files.FilePurpose;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
+public final class CompletionsFileExample {
+    private CompletionsFileExample() {}
+
+    public static void main(String[] args) throws URISyntaxException, InterruptedException, IOException {
+        // Configures using one of:
+        // - The `OPENAI_API_KEY` environment variable
+        // - The `OPENAI_BASE_URL` and `AZURE_OPENAI_KEY` environment variables
+        OpenAIClient client = OpenAIOkHttpClient.fromEnv();
+
+        ClassLoader classloader = Thread.currentThread().getContextClassLoader();
+        Path pdfPath = Paths.get(classloader.getResource("pdflatex-image.pdf").toURI());
+
+        FileObject logoFileObject = client.files()
+                .create(FileCreateParams.builder()
+                        .file(pdfPath)
+                        .purpose(FilePurpose.USER_DATA)
+                        .build());
+
+        ChatCompletionContentPart.File logoFile = ChatCompletionContentPart.File.builder()
+                .file(ChatCompletionContentPart.File.FileObject.builder()
+                        .fileId(logoFileObject.id())
+                        .build())
+                .build();
+        ChatCompletionContentPart logoContentPart = ChatCompletionContentPart.ofFile(logoFile);
+
+        ChatCompletionContentPart questionContentPart =
+                ChatCompletionContentPart.ofText(ChatCompletionContentPartText.builder()
+                        .text("Describe this image.")
+                        .build());
+        ChatCompletionCreateParams createParams = ChatCompletionCreateParams.builder()
+                .model(ChatModel.GPT_4O_MINI)
+                .maxCompletionTokens(2048)
+                .addUserMessageOfArrayOfContentParts(List.of(questionContentPart, logoContentPart))
+                .build();
+
+        client.chat().completions().create(createParams).choices().stream()
+                .flatMap(choice -> choice.message().content().stream())
+                .forEach(System.out::println);
+    }
+}

openai-java-example/src/main/java/com/openai/example/CompletionsImageUrlExample.java

@@ -22,7 +22,7 @@ public static void main(String[] args) throws URISyntaxException, InterruptedExc
         OpenAIClient client = OpenAIOkHttpClient.fromEnv();
 
         ClassLoader classloader = Thread.currentThread().getContextClassLoader();
-        byte[] logoBytes = classloader.getResource("logo.png").openStream().readAllBytes();
+        byte[] logoBytes = classloader.getResourceAsStream("logo.png").readAllBytes();
         String logoBase64Url = "data:image/jpeg;base64," + Base64.getEncoder().encodeToString(logoBytes);
 
         ChatCompletionContentPart logoContentPart =

openai-java-example/src/main/java/com/openai/example/ResponsesImageUrlExample.java

@@ -20,7 +20,7 @@ public static void main(String[] args) throws IOException {
         OpenAIClient client = OpenAIOkHttpClient.fromEnv();
 
         ClassLoader classloader = Thread.currentThread().getContextClassLoader();
-        byte[] logoBytes = classloader.getResource("logo.png").openStream().readAllBytes();
+        byte[] logoBytes = classloader.getResourceAsStream("logo.png").readAllBytes();
         String logoBase64Url = "data:image/jpeg;base64," + Base64.getEncoder().encodeToString(logoBytes);
 
         ResponseInputImage logoInputImage = ResponseInputImage.builder()

openai-java-example/src/main/java/com/openai/example/ResponsesInputFileExample.java

@@ -22,7 +22,7 @@ public static void main(String[] args) throws IOException {
 
         ClassLoader classloader = Thread.currentThread().getContextClassLoader();
         String filename = "pdflatex-image.pdf";
-        byte[] pdfBytes = classloader.getResource(filename).openStream().readAllBytes();
+        byte[] pdfBytes = classloader.getResourceAsStream(filename).readAllBytes();
         String pdfBase64Url =
                 "data:application/pdf;base64," + Base64.getEncoder().encodeToString(pdfBytes);