The Openlayer Java SDK provides convenient access to the Openlayer REST API from applications written in Java.
It is generated with Stainless.
The REST API documentation can be found on openlayer.com. Javadocs are available on javadoc.io.
implementation("com.openlayer.api:openlayer-java:0.1.0-alpha.11")<dependency>
<groupId>com.openlayer.api</groupId>
<artifactId>openlayer-java</artifactId>
<version>0.1.0-alpha.11</version>
</dependency>This library requires Java 8 or later.
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_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);Configure the client using environment variables:
import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
// Configures using the `OPENLAYER_API_KEY` and `OPENLAYER_BASE_URL` environment variables
OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();Or manually:
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:
import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
OpenlayerClient client = OpenlayerOkHttpClient.builder()
// 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 | Environment variable | Required | Default value |
|---|---|---|---|
apiKey |
OPENLAYER_API_KEY |
false | - |
baseUrl |
OPENLAYER_BASE_URL |
true | "https://api.openlayer.com/v1" |
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.
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.
Each class in the SDK has an associated builder or factory method for constructing it.
Each class is immutable 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.
The default client is synchronous. To switch to asynchronous execution, call the async() method:
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_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<DataStreamResponse> response = client.async().inferencePipelines().data().stream(params);Or create an asynchronous client from the beginning:
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_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<DataStreamResponse> response = client.inferencePipelines().data().stream(params);The asynchronous client supports the same options as the synchronous one, except most methods return CompletableFutures.
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():
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<DataStreamResponse> 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:
import com.openlayer.api.models.inferencepipelines.data.DataStreamResponse;
DataStreamResponse parsedResponse = response.parse();The SDK throws custom unchecked exception types:
-
OpenlayerServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:Status Exception 400 BadRequestException401 UnauthorizedException403 PermissionDeniedException404 NotFoundException422 UnprocessableEntityException429 RateLimitException5xx InternalServerExceptionothers UnexpectedStatusCodeException -
OpenlayerIoException: I/O networking errors. -
OpenlayerInvalidDataException: 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: 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.
The SDK uses the standard OkHttp logging interceptor.
Enable logging by setting the OPENLAYER_LOG environment variable to info:
$ export OPENLAYER_LOG=infoOr to debug for more verbose logging:
$ export OPENLAYER_LOG=debugThe SDK depends on 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 or OpenlayerOkHttpClientAsync.
Caution
We make no guarantee that the SDK works correctly when the Jackson version check is disabled.
The SDK automatically retries 2 times by default, with a short exponential backoff.
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 response.
To set a custom number of retries, configure the client using the maxRetries method:
import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
OpenlayerClient client = OpenlayerOkHttpClient.builder()
.fromEnv()
.maxRetries(4)
.build();Requests time out after 1 minute by default.
To set a custom timeout, configure the method call using the timeout method:
import com.openlayer.api.core.JsonValue;
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
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:
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();To route requests through a proxy, configure the client using the proxy method:
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();The SDK consists of three artifacts:
openlayer-java-core- Contains core SDK logic
- Does not depend on OkHttp
- Exposes
OpenlayerClient,OpenlayerClientAsync,OpenlayerClientImpl, andOpenlayerClientAsyncImpl, all of which can work with any HTTP client
openlayer-java-client-okhttp- Depends on OkHttp
- Exposes
OpenlayerOkHttpClientandOpenlayerOkHttpClientAsync, which provide a way to constructOpenlayerClientImplandOpenlayerClientAsyncImpl, respectively, using OkHttp
openlayer-java- Depends on and exposes the APIs of both
openlayer-java-coreandopenlayer-java-client-okhttp - Does not have its own logic
- Depends on and exposes the APIs of both
This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.
Customized OkHttpClient
Tip
Try the available network options before replacing the default client.
To use a customized OkHttpClient:
- Replace your
openlayer-javadependency withopenlayer-java-core - Copy
openlayer-java-client-okhttp'sOkHttpClientclass into your code and customize it - Construct
OpenlayerClientImplorOpenlayerClientAsyncImpl, similarly toOpenlayerOkHttpClientorOpenlayerOkHttpClientAsync, using your customized client
To use a completely custom HTTP client:
- Replace your
openlayer-javadependency withopenlayer-java-core - Write a class that implements the
HttpClientinterface - Construct
OpenlayerClientImplorOpenlayerClientAsyncImpl, similarly toOpenlayerOkHttpClientorOpenlayerOkHttpClientAsync, using your new client class
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.
To set undocumented parameters, call the putAdditionalHeader, putAdditionalQueryParam, or putAdditionalBodyProperty methods on any Params class:
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:
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 object to its setter:
import com.openlayer.api.core.JsonValue;
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
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())
.rows(JsonValue.from(42))
.build();The most straightforward way to create a JsonValue is using its from(...) method:
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 if any required parameter or property is unset.
To forcibly omit a required parameter or property, pass JsonMissing:
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();To access undocumented response properties, call the _additionalProperties() method:
import com.openlayer.api.core.JsonValue;
import java.util.Map;
Map<String, JsonValue> 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:
import com.openlayer.api.core.JsonField;
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
import java.util.Optional;
JsonField<DataStreamParams.Config> 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<String> jsonString = config.asString();
// Try to deserialize into a custom type
MyClass myObject = config.asUnknown().orElseThrow().convert(MyClass.class);
}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 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():
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:
import com.openlayer.api.core.JsonValue;
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
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:
import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
OpenlayerClient client = OpenlayerOkHttpClient.builder()
.fromEnv()
.responseValidation(true)
.build();Java enum classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.
Using JsonField<T> enables a few features:
- Allowing usage of undocumented API functionality
- Lazily validating the API response against the expected shape
- Representing absent vs explicitly null values
Why don't you use data classes?
It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.
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
- Don't play well with lambdas (also due to the function coloring problem)
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- 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.)
- 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 with questions, bugs, or suggestions.