release: 0.16.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.15.1"
+  ".": "0.16.0"
 }

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.16.0 (2025-01-28)
+
+Full Changelog: [v0.15.1...v0.16.0](https://github.com/openai/openai-java/compare/v0.15.1...v0.16.0)
+
+### Features
+
+* **client:** add some more builder helpers ([#173](https://github.com/openai/openai-java/issues/173)) ([f314e68](https://github.com/openai/openai-java/commit/f314e68915560703970c9acc16e96030202de9d1))
+
+
+### Chores
+
+* **internal:** shorten `model` method impl ([f314e68](https://github.com/openai/openai-java/commit/f314e68915560703970c9acc16e96030202de9d1))
+
+
+### Documentation
+
+* mark more methods as deprecated ([f314e68](https://github.com/openai/openai-java/commit/f314e68915560703970c9acc16e96030202de9d1))
+* more examples and cleanup ([#159](https://github.com/openai/openai-java/issues/159)) ([fa2a1fc](https://github.com/openai/openai-java/commit/fa2a1fc2983131bac40988049dd3b0e7c730442c))
+
 ## 0.15.1 (2025-01-27)
 
 Full Changelog: [v0.15.0...v0.15.1](https://github.com/openai/openai-java/compare/v0.15.0...v0.15.1)

README.md

@@ -9,8 +9,8 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.15.1)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.15.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.15.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.16.0)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.16.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.16.0)
 
 <!-- x-release-please-end -->
 
@@ -25,7 +25,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
 ### Gradle
 
 ```kotlin
-implementation("com.openai:openai-java:0.15.1")
+implementation("com.openai:openai-java:0.16.0")
 ```
 
 ### Maven
@@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.15.1")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.15.1</version>
+    <version>0.16.0</version>
 </dependency>
 ```
 
@@ -46,6 +46,8 @@ This library requires Java 8 or later.
 
 ## Usage
 
+See the [`openai-java-example`](openai-java-example/src/main/java/com/openai/example) directory for complete and runnable examples.
+
 ### Configure the client
 
 Use `OpenAIOkHttpClient.builder()` to configure the client. At a minimum you need to set `.apiKey()`:
@@ -290,41 +292,19 @@ This library throws exceptions in a single hierarchy for easy handling:
 ## Microsoft Azure OpenAI
 
 To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the same 
-OpenAI client builder but with the Azure-specific configuration. 
+OpenAI client builder but with the Azure-specific configuration.
 
 ```java
-OpenAIOkHttpClient.Builder clientBuilder = OpenAIOkHttpClient.builder();
-
-/* Azure-specific code starts here */
-// You can either set 'endpoint' directly in the builder.
-// or set the env var "AZURE_OPENAI_ENDPOINT" and use fromEnv() method instead
-clientBuilder
-    .baseUrl(System.getenv("AZURE_OPENAI_ENDPOINT"))
-    .credential(BearerTokenCredential.create(
-        AuthenticationUtil.getBearerTokenSupplier(
-            new DefaultAzureCredentialBuilder().build(), "https://cognitiveservices.azure.com/.default")
-    ));
-/* Azure-specific code ends here */
-
-OpenAIClient client = clientBuilder.build();
-
-ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
-    .addMessage(ChatCompletionMessageParam.ofChatCompletionUserMessageParam(
-        ChatCompletionUserMessageParam.builder()
-            .content(ChatCompletionUserMessageParam.Content.ofTextContent("Who won the world series in 2020?"))
-            .build()))
-    .model("gpt-4o")
-    .build();
-
-ChatCompletion chatCompletion = client.chat().completions().create(params);
-
-List<ChatCompletion.Choice> choices = chatCompletion.choices();
-for (ChatCompletion.Choice choice : choices) {
-    System.out.println("Choice content: " + choice.message().content().get());
-}
+OpenAIClient client = OpenAIOkHttpClient.builder()
+        // Gets the API key from the `AZURE_OPENAI_KEY` environment variable
+        .fromEnv()
+        // Set the Azure Entra ID
+        .credential(BearerTokenCredential.create(AuthenticationUtil.getBearerTokenSupplier(
+                new DefaultAzureCredentialBuilder().build(), "https://cognitiveservices.azure.com/.default")))
+        .build();
 ```
 
-See the complete Azure OpenAI examples in the [Azure OpenAI example](https://github.com/openai/openai-java/tree/next/openai-azure-java-example/src/main/java/com.openai.azure.examples).
+See the complete Azure OpenAI example in the [`openai-java-example`](openai-java-example/src/main/java/com/openai/example/AzureEntraIdExample.java) directory. The other examples in the directory also work with Azure as long as the client is configured to use it.  
 
 ## Network options
 

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.openai"
-    version = "0.15.1" // x-release-please-version
+    version = "0.16.0" // x-release-please-version
 }
 
 subprojects {

openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantCreateParams.kt

@@ -468,7 +468,7 @@ private constructor(
              * all of your available models, or see our
              * [Model overview](https://platform.openai.com/docs/models) for descriptions of them.
              */
-            fun model(value: String) = apply { model(ChatModel.of(value)) }
+            fun model(value: String) = model(ChatModel.of(value))
 
             /** The description of the assistant. The maximum length is 512 characters. */
             fun description(description: String?) = description(JsonField.ofNullable(description))

openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateAndRunParams.kt

@@ -822,7 +822,7 @@ private constructor(
              * associated with the assistant. If not, the model associated with the assistant will
              * be used.
              */
-            fun model(value: String) = apply { model(ChatModel.of(value)) }
+            fun model(value: String) = model(ChatModel.of(value))
 
             /**
              * Whether to enable
@@ -2728,6 +2728,9 @@ private constructor(
                     fun addTool(codeInterpreter: CodeInterpreterTool) =
                         addTool(Tool.ofCodeInterpreter(codeInterpreter))
 
+                    /** The tools to add this file to. */
+                    fun addToolFileSearch() = addTool(Tool.ofFileSearch())
+
                     fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
                         this.additionalProperties.clear()
                         putAllAdditionalProperties(additionalProperties)