Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/openlayer-ai/openlayer-java

The official Java library for Openlayer, the Evaluation Platform for AI. 📈
https://github.com/openlayer-ai/openlayer-java

Last synced: 16 days ago
JSON representation

The official Java library for Openlayer, the Evaluation Platform for AI. 📈

Awesome Lists containing this project

README 

          
# Openlayer Java API Library



[![Maven Central](https://img.shields.io/maven-central/v/com.openlayer.api/openlayer-java)](https://central.sonatype.com/artifact/com.openlayer.api/openlayer-java/0.4.0)

[![javadoc](https://javadoc.io/badge2/com.openlayer.api/openlayer-java/0.4.0/javadoc.svg)](https://javadoc.io/doc/com.openlayer.api/openlayer-java/0.4.0)



The Openlayer Java SDK provides convenient access to the [Openlayer REST API](https://openlayer.com/docs/api-reference/rest/overview) from applications written in Java.



It is generated with [Stainless](https://www.stainless.com/).



The REST API documentation can be found on [openlayer.com](https://openlayer.com/docs/api-reference/rest/overview). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.openlayer.api/openlayer-java/0.4.0).



## Installation



### Gradle



```kotlin

implementation("com.openlayer.api:openlayer-java:0.4.0")

```



### Maven



```xml



  com.openlayer.api

  openlayer-java

  0.4.0



```



## Requirements



This library requires Java 8 or later.



## Usage



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



// Configures using the `openlayer.apiKey` and `openlayer.baseUrl` system properties

// Or configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();



DataStreamParams params = DataStreamParams.builder()

    .inferencePipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

    .config(DataStreamParams.Config.LlmData.builder()

        .addInputVariableName("user_query")

        .outputColumnName("output")

        .numOfTokenColumnName("tokens")

        .costColumnName("cost")

        .timestampColumnName("timestamp")

        .build())

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("what is the meaning of life?"))

        .putAdditionalProperty("output", JsonValue.from("42"))

        .putAdditionalProperty("tokens", JsonValue.from(7))

        .putAdditionalProperty("cost", JsonValue.from(0.02))

        .putAdditionalProperty("timestamp", JsonValue.from(1610000000))

        .build())

    .build();

DataStreamResponse response = client.inferencePipelines().data().stream(params);

```



## Client configuration



Configure the client using system properties or environment variables:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



// Configures using the `openlayer.apiKey` and `openlayer.baseUrl` system properties

// Or configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

```



Or manually:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .apiKey("My API Key")

    .build();

```



Or using a combination of the two approaches:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    // Configures using the `openlayer.apiKey` and `openlayer.baseUrl` system properties

    // Or configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables

    .fromEnv()

    .apiKey("My API Key")

    .build();

```



See this table for the available options:



| Setter    | System property     | Environment variable | Required | Default value                    |

| --------- | ------------------- | -------------------- | -------- | -------------------------------- |

| `apiKey`  | `openlayer.apiKey`  | `OPENLAYER_API_KEY`  | false    | -                                |

| `baseUrl` | `openlayer.baseUrl` | `OPENLAYER_BASE_URL` | true     | `"https://api.openlayer.com/v1"` |



System properties take precedence over environment variables.



> [!TIP]

> Don't create more than one client in the same application. Each client has a connection pool and

> thread pools, which are more efficient to share between requests.



### Modifying configuration



To temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:



```java

import com.openlayer.api.client.OpenlayerClient;



OpenlayerClient clientWithOptions = client.withOptions(optionsBuilder -> {

    optionsBuilder.baseUrl("https://example.com");

    optionsBuilder.maxRetries(42);

});

```



The `withOptions()` method does not affect the original client or service.



## Requests and responses



To send a request to the Openlayer API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.



For example, `client.inferencePipelines().data().stream(...)` should be called with an instance of `DataStreamParams`, and it will return an instance of `DataStreamResponse`.



## Immutability



Each class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.



Each class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.



Because each class is immutable, builder modification will _never_ affect already built class instances.



## Asynchronous execution



The default client is synchronous. To switch to asynchronous execution, call the `async()` method:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;

import java.util.concurrent.CompletableFuture;



// Configures using the `openlayer.apiKey` and `openlayer.baseUrl` system properties

// Or configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();



DataStreamParams params = DataStreamParams.builder()

    .inferencePipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

    .config(DataStreamParams.Config.LlmData.builder()

        .addInputVariableName("user_query")

        .outputColumnName("output")

        .numOfTokenColumnName("tokens")

        .costColumnName("cost")

        .timestampColumnName("timestamp")

        .build())

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("what is the meaning of life?"))

        .putAdditionalProperty("output", JsonValue.from("42"))

        .putAdditionalProperty("tokens", JsonValue.from(7))

        .putAdditionalProperty("cost", JsonValue.from(0.02))

        .putAdditionalProperty("timestamp", JsonValue.from(1610000000))

        .build())

    .build();

CompletableFuture response = client.async().inferencePipelines().data().stream(params);

```



Or create an asynchronous client from the beginning:



```java

import com.openlayer.api.client.OpenlayerClientAsync;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClientAsync;

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;

import java.util.concurrent.CompletableFuture;



// Configures using the `openlayer.apiKey` and `openlayer.baseUrl` system properties

// Or configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables

OpenlayerClientAsync client = OpenlayerOkHttpClientAsync.fromEnv();



DataStreamParams params = DataStreamParams.builder()

    .inferencePipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

    .config(DataStreamParams.Config.LlmData.builder()

        .addInputVariableName("user_query")

        .outputColumnName("output")

        .numOfTokenColumnName("tokens")

        .costColumnName("cost")

        .timestampColumnName("timestamp")

        .build())

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("what is the meaning of life?"))

        .putAdditionalProperty("output", JsonValue.from("42"))

        .putAdditionalProperty("tokens", JsonValue.from(7))

        .putAdditionalProperty("cost", JsonValue.from(0.02))

        .putAdditionalProperty("timestamp", JsonValue.from(1610000000))

        .build())

    .build();

CompletableFuture response = client.inferencePipelines().data().stream(params);

```



The asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.



## Raw responses



The SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.



To access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.core.http.Headers;

import com.openlayer.api.core.http.HttpResponseFor;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



DataStreamParams params = DataStreamParams.builder()

    .inferencePipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

    .config(DataStreamParams.Config.LlmData.builder()

        .addInputVariableName("user_query")

        .outputColumnName("output")

        .numOfTokenColumnName("tokens")

        .costColumnName("cost")

        .timestampColumnName("timestamp")

        .build())

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("what is the meaning of life?"))

        .putAdditionalProperty("output", JsonValue.from("42"))

        .putAdditionalProperty("tokens", JsonValue.from(7))

        .putAdditionalProperty("cost", JsonValue.from(0.02))

        .putAdditionalProperty("timestamp", JsonValue.from(1610000000))

        .build())

    .build();

HttpResponseFor response = client.inferencePipelines().data().withRawResponse().stream(params);



int statusCode = response.statusCode();

Headers headers = response.headers();

```



You can still deserialize the response into an instance of a Java class if needed:



```java

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



DataStreamResponse parsedResponse = response.parse();

```



## Error handling



The SDK throws custom unchecked exception types:



- [`OpenlayerServiceException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:



  | Status | Exception                                                                                                                        |

  | ------ | -------------------------------------------------------------------------------------------------------------------------------- |

  | 400    | [`BadRequestException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/BadRequestException.kt)                     |

  | 401    | [`UnauthorizedException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/UnauthorizedException.kt)                 |

  | 403    | [`PermissionDeniedException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/PermissionDeniedException.kt)         |

  | 404    | [`NotFoundException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/NotFoundException.kt)                         |

  | 422    | [`UnprocessableEntityException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/UnprocessableEntityException.kt)   |

  | 429    | [`RateLimitException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/RateLimitException.kt)                       |

  | 5xx    | [`InternalServerException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/InternalServerException.kt)             |

  | others | [`UnexpectedStatusCodeException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/UnexpectedStatusCodeException.kt) |



- [`OpenlayerIoException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerIoException.kt): I/O networking errors.



- [`OpenlayerRetryableException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerRetryableException.kt): Generic error indicating a failure that could be retried by the client.



- [`OpenlayerInvalidDataException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.



- [`OpenlayerException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.



## Logging



The SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).



Enable logging by setting the `OPENLAYER_LOG` environment variable to `info`:



```sh

export OPENLAYER_LOG=info

```



Or to `debug` for more verbose logging:



```sh

export OPENLAYER_LOG=debug

```



## ProGuard and R8



Although the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `openlayer-java-core` is published with a [configuration file](openlayer-java-core/src/main/resources/META-INF/proguard/openlayer-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).



ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.



## Jackson



The SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.



The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).



If the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`OpenlayerOkHttpClient`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClient.kt) or [`OpenlayerOkHttpClientAsync`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClientAsync.kt).



> [!CAUTION]

> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.



Also note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.



## Network options



### Retries



The SDK automatically retries 2 times by default, with a short exponential backoff between requests.



Only the following error types are retried:



- Connection errors (for example, due to a network connectivity problem)

- 408 Request Timeout

- 409 Conflict

- 429 Rate Limit

- 5xx Internal



The API may also explicitly instruct the SDK to retry or not retry a request.



To set a custom number of retries, configure the client using the `maxRetries` method:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    .maxRetries(4)

    .build();

```



### Timeouts



Requests time out after 1 minute by default.



To set a custom timeout, configure the method call using the `timeout` method:



```java

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



DataStreamResponse response = client.inferencePipelines().data().stream(

  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()

);

```



Or configure the default for all method calls at the client level:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;

import java.time.Duration;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    .timeout(Duration.ofSeconds(30))

    .build();

```



### Proxies



To route requests through a proxy, configure the client using the `proxy` method:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;

import java.net.InetSocketAddress;

import java.net.Proxy;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    .proxy(new Proxy(

      Proxy.Type.HTTP, new InetSocketAddress(

        "https://example.com", 8080

      )

    ))

    .build();

```



### HTTPS



> [!NOTE]

> Most applications should not call these methods, and instead use the system defaults. The defaults include

> special optimizations that can be lost if the implementations are modified.



To configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.

    .sslSocketFactory(yourSSLSocketFactory)

    .trustManager(yourTrustManager)

    .hostnameVerifier(yourHostnameVerifier)

    .build();

```



### Custom HTTP client



The SDK consists of three artifacts:



- `openlayer-java-core`

  - Contains core SDK logic

  - Does not depend on [OkHttp](https://square.github.io/okhttp)

  - Exposes [`OpenlayerClient`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClient.kt), [`OpenlayerClientAsync`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsync.kt), [`OpenlayerClientImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientImpl.kt), and [`OpenlayerClientAsyncImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsyncImpl.kt), all of which can work with any HTTP client

- `openlayer-java-client-okhttp`

  - Depends on [OkHttp](https://square.github.io/okhttp)

  - Exposes [`OpenlayerOkHttpClient`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClient.kt) and [`OpenlayerOkHttpClientAsync`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClientAsync.kt), which provide a way to construct [`OpenlayerClientImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientImpl.kt) and [`OpenlayerClientAsyncImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsyncImpl.kt), respectively, using OkHttp

- `openlayer-java`

  - Depends on and exposes the APIs of both `openlayer-java-core` and `openlayer-java-client-okhttp`

  - Does not have its own logic



This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.



#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)



> [!TIP]

> Try the available [network options](#network-options) before replacing the default client.



To use a customized `OkHttpClient`:



1. Replace your [`openlayer-java` dependency](#installation) with `openlayer-java-core`

2. Copy `openlayer-java-client-okhttp`'s [`OkHttpClient`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OkHttpClient.kt) class into your code and customize it

3. Construct [`OpenlayerClientImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientImpl.kt) or [`OpenlayerClientAsyncImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsyncImpl.kt), similarly to [`OpenlayerOkHttpClient`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClient.kt) or [`OpenlayerOkHttpClientAsync`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClientAsync.kt), using your customized client



### Completely custom HTTP client



To use a completely custom HTTP client:



1. Replace your [`openlayer-java` dependency](#installation) with `openlayer-java-core`

2. Write a class that implements the [`HttpClient`](openlayer-java-core/src/main/kotlin/com/openlayer/api/core/http/HttpClient.kt) interface

3. Construct [`OpenlayerClientImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientImpl.kt) or [`OpenlayerClientAsyncImpl`](openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsyncImpl.kt), similarly to [`OpenlayerOkHttpClient`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClient.kt) or [`OpenlayerOkHttpClientAsync`](openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClientAsync.kt), using your new client class



## Undocumented API functionality



The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.



### Parameters



To set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;



DataStreamParams params = DataStreamParams.builder()

    .putAdditionalHeader("Secret-Header", "42")

    .putAdditionalQueryParam("secret_query_param", "42")

    .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))

    .build();

```



These can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.



To set undocumented parameters on _nested_ headers, query params, or body classes, call the `putAdditionalProperty` method on the nested class:



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.projects.ProjectCreateParams;



ProjectCreateParams params = ProjectCreateParams.builder()

    .links(ProjectCreateParams.Links.builder()

        .putAdditionalProperty("secretProperty", JsonValue.from("42"))

        .build())

    .build();

```



These properties can be accessed on the nested built object later using the `_additionalProperties()` method.



To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](openlayer-java-core/src/main/kotlin/com/openlayer/api/core/Values.kt) object to its setter:



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;



DataStreamParams params = DataStreamParams.builder()

    .config(JsonValue.from(42))

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("what is the meaning of life?"))

        .putAdditionalProperty("output", JsonValue.from("42"))

        .putAdditionalProperty("tokens", JsonValue.from(7))

        .putAdditionalProperty("cost", JsonValue.from(0.02))

        .putAdditionalProperty("timestamp", JsonValue.from(1610000000))

        .build())

    .build();

```



The most straightforward way to create a [`JsonValue`](openlayer-java-core/src/main/kotlin/com/openlayer/api/core/Values.kt) is using its `from(...)` method:



```java

import com.openlayer.api.core.JsonValue;

import java.util.List;

import java.util.Map;



// Create primitive JSON values

JsonValue nullValue = JsonValue.from(null);

JsonValue booleanValue = JsonValue.from(true);

JsonValue numberValue = JsonValue.from(42);

JsonValue stringValue = JsonValue.from("Hello World!");



// Create a JSON array value equivalent to `["Hello", "World"]`

JsonValue arrayValue = JsonValue.from(List.of(

  "Hello", "World"

));



// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`

JsonValue objectValue = JsonValue.from(Map.of(

  "a", 1,

  "b", 2

));



// Create an arbitrarily nested JSON equivalent to:

// {

//   "a": [1, 2],

//   "b": [3, 4]

// }

JsonValue complexValue = JsonValue.from(Map.of(

  "a", List.of(

    1, 2

  ),

  "b", List.of(

    3, 4

  )

));

```



Normally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.



To forcibly omit a required parameter or property, pass [`JsonMissing`](openlayer-java-core/src/main/kotlin/com/openlayer/api/core/Values.kt):



```java

import com.openlayer.api.core.JsonMissing;

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;



DataStreamParams params = DataStreamParams.builder()

    .config(DataStreamParams.Config.LlmData.builder()

        .outputColumnName("output")

        .build())

    .addRow(DataStreamParams.Row.builder()

        .putAdditionalProperty("user_query", JsonValue.from("bar"))

        .putAdditionalProperty("output", JsonValue.from("bar"))

        .putAdditionalProperty("tokens", JsonValue.from("bar"))

        .putAdditionalProperty("cost", JsonValue.from("bar"))

        .putAdditionalProperty("timestamp", JsonValue.from("bar"))

        .build())

    .inferencePipelineId(JsonMissing.of())

    .build();

```



### Response properties



To access undocumented response properties, call the `_additionalProperties()` method:



```java

import com.openlayer.api.core.JsonValue;

import java.util.Map;



Map additionalProperties = client.inferencePipelines().data().stream(params)._additionalProperties();

JsonValue secretPropertyValue = additionalProperties.get("secretProperty");



String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {

    @Override

    public String visitNull() {

        return "It's null!";

    }



    @Override

    public String visitBoolean(boolean value) {

        return "It's a boolean!";

    }



    @Override

    public String visitNumber(Number value) {

        return "It's a number!";

    }



    // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`

    // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden

});

```



To access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:



```java

import com.openlayer.api.core.JsonField;

import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;

import java.util.Optional;



JsonField config = client.inferencePipelines().data().stream(params)._config();



if (config.isMissing()) {

  // The property is absent from the JSON response

} else if (config.isNull()) {

  // The property was set to literal null

} else {

  // Check if value was provided as a string

  // Other methods include `asNumber()`, `asBoolean()`, etc.

  Optional jsonString = config.asString();



  // Try to deserialize into a custom type

  MyClass myObject = config.asUnknown().orElseThrow().convert(MyClass.class);

}

```



### Response validation



In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.



By default, the SDK will not throw an exception in this case. It will throw [`OpenlayerInvalidDataException`](openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerInvalidDataException.kt) only if you directly access the property.



If you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:



```java

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



DataStreamResponse response = client.inferencePipelines().data().stream(params).validate();

```



Or configure the method call to validate the response using the `responseValidation` method:



```java

import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;



DataStreamResponse response = client.inferencePipelines().data().stream(

  params, RequestOptions.builder().responseValidation(true).build()

);

```



Or configure the default for all method calls at the client level:



```java

import com.openlayer.api.client.OpenlayerClient;

import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;



OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    .responseValidation(true)

    .build();

```



## FAQ



### Why don't you use plain `enum` classes?



Java `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.



### Why do you represent fields using `JsonField` instead of just plain `T`?



Using `JsonField` enables a few features:



- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)

- Lazily [validating the API response against the expected shape](#response-validation)

- Representing absent vs explicitly null values



### Why don't you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?



It is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don't want to introduce a breaking change every time we add a field to a class.



### Why don't you use checked exceptions?



Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.



Checked exceptions:



- Are verbose to handle

- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error

- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)

- Don't play well with lambdas (also due to the function coloring problem)



## Semantic versioning



This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:



1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_

2. Changes that we do not expect to impact the vast majority of users in practice.



We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.



We are keen for your feedback; please open an [issue](https://www.github.com/openlayer-ai/openlayer-java/issues) with questions, bugs, or suggestions.