Java code provided in examples is incorrect

[tilperion2]

ISSUE DETAILS:
I've tried to explore these OCI OpenAI examples in Java, but seems they are not correct and do not compile.

OpenAIClient client = OpenAIOkHttpClient.builder()
        .baseUrl("https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1")
        **.okHttpClient(ociHttpClient)**
        .apiKey("not-used")
        .build();

Current OpenAIOkHttpClient builder API does not expose an okHttpClient(...) method. In the current source, build() creates the underlying HTTP client itself via OkHttpClient.builder()...build(), and a search of OpenAIOkHttpClient.kt does not show a fun okHttpClient(...) builder method.

The official README also shows the supported manual builder pattern as things like .fromEnv(), .apiKey(...), .baseUrl(...), etc., but not .okHttpClient(...).

I've tried to use OpenAI clients of different version as well, v4, v3. But it is just not present there.

DESIRED SOLUTION:
Specify what OpenAI version are you using
Please update examples to be compilable, and semantically and functionally correct.
Also update Readme.MD to display actual example usages from Java files you have in examples.

[OpheliaLjh]

Thanks for the report! Here's what's wrong and what the fix is:

Root cause

OpenAIOkHttpClient.Builder in openai-java 4.x does not have an okHttpClient() method. The builder only exposes connection-pool settings (proxy, maxIdleConnections, keepAliveDuration, etc.) and does not accept a custom OkHttpClient instance. Because of this, all IAM-auth examples fail to compile.

The version in use is openai-java 4.26.0 (declared in oci-genai-auth-java-core/pom.xml).

Correct approach

The OpenAI Java SDK exposes ClientOptions.builder().httpClient(com.openai.core.http.HttpClient) for plugging in a custom transport. The right pattern is:

String baseUrl = "https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1";

OkHttpClient ociHttpClient = OciOkHttpClientFactory.build(config);

OpenAIClient client = new OpenAIClientImpl(ClientOptions.builder()
        .httpClient(OciOpenAIHttpClient.of(ociHttpClient, baseUrl))
        .baseUrl(baseUrl)
        .apiKey("not-used")
        .build());

Fix

PR #10 addresses this:

• Adds OciOpenAIHttpClient — a new public class in the library that implements com.openai.core.http.HttpClient and wraps the OCI-signed OkHttpClient.
• Fixes both README code snippets and all five IAM-auth example files.
• Removes the duplicated private adapter class from both integration tests (they now use OciOpenAIHttpClient directly).
• Adds openai-java-core as an optional compile dependency so OciOpenAIHttpClient is available without being forced on consumers who don't use the OpenAI SDK.

[OpheliaLjh]

@tilperion2 Thanks for reporting this. I’ve pushed a fix for the issue. Could you please pull the latest version and retry on your side?

Please let me know if you still see any blocker after the update.

[OpheliaLjh]

Addressing the 404 on /openai/v1

The https://inference.generativeai.<region>.oci.oraclecloud.com/openai/v1 endpoint is the OCI Enterprise AI Agents endpoint and requires an openai-project header containing your project OCID. Without it the service returns 404 — this is expected behavior.

The deprecated /20231130/actions/v1 endpoint has different routing, which is why it works without the header.

Make sure your client includes the project header:

OpenAIClient client = new OpenAIClientImpl(ClientOptions.builder()
        .httpClient(OciOpenAIHttpClient.of(ociHttpClient, baseUrl))
        .baseUrl(baseUrl)
        .apiKey("not-used")
        .putHeader("openai-project", "ocid1.generativeaiproject.oc1.us-chicago-1.xxx")  // required
        .build());

If you don't have a project OCID yet, create a Generative AI Project in the OCI Console first.

Release status of OciOpenAIHttpClient

The fix is on main but not yet published to Maven Central — the current release is 1.0.4. A new release is being prepared. Until then, the local copy workaround is the right approach. The class only depends on okhttp3 and com.openai.core.http.HttpClient (from openai-java-core), so it is compatible with any recent version of openai-java, including 4.9.0.