docs: responses examples

Author: TomerAberbach

README.md

@@ -48,6 +48,27 @@ This library requires Java 8 or later.
 
 See the [`openai-java-example`](openai-java-example/src/main/java/com/openai/example) directory for complete and runnable examples.
 
+The primary API for interacting with OpenAI models is the [Responses API](https://platform.openai.com/docs/api-reference/responses). You can generate text from the model with the code below.
+
+```java
+import com.openai.client.OpenAIClient;
+import com.openai.client.okhttp.OpenAIOkHttpClient;
+import com.openai.models.ChatModel;
+import com.openai.models.responses.Response;
+import com.openai.models.responses.ResponseCreateParams;
+
+// Configures using the `OPENAI_API_KEY`, `OPENAI_ORG_ID` and `OPENAI_PROJECT_ID` environment variables
+OpenAIClient client = OpenAIOkHttpClient.fromEnv();
+
+ResponseCreateParams params = ResponseCreateParams.builder()
+        .input("Say this is a test")
+        .model(ChatModel.GPT_4O)
+        .build();
+Response response = client.responses().create(params);
+```
+
+The previous standard (supported indefinitely) for generating text is the [Chat Completions API](https://platform.openai.com/docs/api-reference/chat). You can use that API to generate text from the model with the code below.
+
 ```java
 import com.openai.client.OpenAIClient;
 import com.openai.client.okhttp.OpenAIOkHttpClient;

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

@@ -0,0 +1,31 @@
+package com.openai.example;
+
+import com.openai.client.OpenAIClientAsync;
+import com.openai.client.okhttp.OpenAIOkHttpClientAsync;
+import com.openai.models.ChatModel;
+import com.openai.models.responses.ResponseCreateParams;
+
+public final class ResponsesAsyncExample {
+    private ResponsesAsyncExample() {}
+
+    public static void main(String[] args) {
+        // Configures using one of:
+        // - The `OPENAI_API_KEY` environment variable
+        // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
+        OpenAIClientAsync client = OpenAIOkHttpClientAsync.fromEnv();
+
+        ResponseCreateParams createParams = ResponseCreateParams.builder()
+                .input("Tell me a story about building the best SDK!")
+                .model(ChatModel.GPT_4O)
+                .build();
+
+        client.responses()
+                .create(createParams)
+                .thenAccept(response -> response.output().stream()
+                        .flatMap(item -> item.message().stream())
+                        .flatMap(message -> message.content().stream())
+                        .flatMap(content -> content.outputText().stream())
+                        .forEach(outputText -> System.out.println(outputText.text())))
+                .join();
+    }
+}

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

@@ -0,0 +1,28 @@
+package com.openai.example;
+
+import com.openai.client.OpenAIClient;
+import com.openai.client.okhttp.OpenAIOkHttpClient;
+import com.openai.models.ChatModel;
+import com.openai.models.responses.ResponseCreateParams;
+
+public final class ResponsesExample {
+    private ResponsesExample() {}
+
+    public static void main(String[] args) {
+        // Configures using one of:
+        // - The `OPENAI_API_KEY` environment variable
+        // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
+        OpenAIClient client = OpenAIOkHttpClient.fromEnv();
+
+        ResponseCreateParams createParams = ResponseCreateParams.builder()
+                .input("Tell me a story about building the best SDK!")
+                .model(ChatModel.GPT_4O)
+                .build();
+
+        client.responses().create(createParams).output().stream()
+                .flatMap(item -> item.message().stream())
+                .flatMap(message -> message.content().stream())
+                .flatMap(content -> content.outputText().stream())
+                .forEach(outputText -> System.out.println(outputText.text()));
+    }
+}

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

@@ -0,0 +1,28 @@
+package com.openai.example;
+
+import com.openai.client.OpenAIClientAsync;
+import com.openai.client.okhttp.OpenAIOkHttpClientAsync;
+import com.openai.models.ChatModel;
+import com.openai.models.responses.ResponseCreateParams;
+
+public final class ResponsesStreamingAsyncExample {
+    private ResponsesStreamingAsyncExample() {}
+
+    public static void main(String[] args) {
+        // Configures using one of:
+        // - The `OPENAI_API_KEY` environment variable
+        // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
+        OpenAIClientAsync client = OpenAIOkHttpClientAsync.fromEnv();
+
+        ResponseCreateParams createParams = ResponseCreateParams.builder()
+                .input("Tell me a story about building the best SDK!")
+                .model(ChatModel.GPT_4O)
+                .build();
+
+        client.responses()
+                .createStreaming(createParams)
+                .subscribe(event -> event.outputTextDelta().ifPresent(textEvent -> System.out.print(textEvent.delta())))
+                .onCompleteFuture()
+                .join();
+    }
+}

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

@@ -0,0 +1,31 @@
+package com.openai.example;
+
+import com.openai.client.OpenAIClient;
+import com.openai.client.okhttp.OpenAIOkHttpClient;
+import com.openai.core.http.StreamResponse;
+import com.openai.models.ChatModel;
+import com.openai.models.responses.ResponseCreateParams;
+import com.openai.models.responses.ResponseStreamEvent;
+
+public final class ResponsesStreamingExample {
+    private ResponsesStreamingExample() {}
+
+    public static void main(String[] args) {
+        // Configures using one of:
+        // - The `OPENAI_API_KEY` environment variable
+        // - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
+        OpenAIClient client = OpenAIOkHttpClient.fromEnv();
+
+        ResponseCreateParams createParams = ResponseCreateParams.builder()
+                .input("Tell me a story about building the best SDK!")
+                .model(ChatModel.GPT_4O)
+                .build();
+
+        try (StreamResponse<ResponseStreamEvent> streamResponse =
+                client.responses().createStreaming(createParams)) {
+            streamResponse.stream()
+                    .flatMap(event -> event.outputTextDelta().stream())
+                    .forEach(textEvent -> System.out.print(textEvent.delta()));
+        }
+    }
+}