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: about 1 month 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.1.0-alpha.11)



The Openlayer Java SDK provides convenient access to the Openlayer REST API from applications written in Java. It includes helper classes with helpful types and documentation for every request and response property.



The Openlayer Java SDK is similar to the Openlayer Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.



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



## Documentation



The REST API documentation can be found on [openlayer.com](https://openlayer.com/docs/api-reference/rest/overview).



---



## Getting started



### Install dependencies



#### Gradle



```kotlin

implementation("com.openlayer.api:openlayer-java:0.1.0-alpha.11")

```



#### Maven



```xml



    com.openlayer.api

    openlayer-java

    0.1.0-alpha.11



```



### Configure the client



Use `OpenlayerOkHttpClient.builder()` to configure the client.



Alternately, set the environment with `OPENLAYER_API_KEY`, and use `OpenlayerOkHttpClient.fromEnv()` to read from the environment.



```java

import com.openlayer.api.client.OpenlayerClient;

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



OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();



// Note: you can also call fromEnv() from the client builder, for example if you need to set additional properties

OpenlayerClient client = OpenlayerOkHttpClient.builder()

    .fromEnv()

    // ... set properties on the builder

    .build();

```



| Property | Environment variable | Required | Default value |

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

| apiKey   | `OPENLAYER_API_KEY`  | false    | —             |



Read the documentation for more configuration options.



---



### Example: creating a resource



To create a new inference pipeline data, first use the `InferencePipelineDataStreamParams` builder to specify attributes, then pass that to the `stream` method of the `data` service.



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.InferencePipelineDataStreamParams;

import com.openlayer.api.models.InferencePipelineDataStreamResponse;

import java.util.List;



InferencePipelineDataStreamParams params = InferencePipelineDataStreamParams.builder()

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

    .config(InferencePipelineDataStreamParams.Config.ofLlmData(InferencePipelineDataStreamParams.Config.LlmData.builder()

        .inputVariableNames(List.of("user_query"))

        .outputColumnName("output")

        .numOfTokenColumnName("tokens")

        .costColumnName("cost")

        .timestampColumnName("timestamp")

        .build()))

    .rows(List.of(InferencePipelineDataStreamParams.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();

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

```



---



## Requests



### Parameters and bodies



To make a request to the Openlayer API, you generally build an instance of the appropriate `Params` class.



In [Example: creating a resource](#example-creating-a-resource) above, we used the `InferencePipelineDataStreamParams.builder()` to pass to the `stream` method of the `data` service.



Sometimes, the API may support other properties that are not yet supported in the Java SDK types. In that case, you can attach them using the `putAdditionalProperty` method.



```java

import com.openlayer.api.core.JsonValue;

import com.openlayer.api.models.InferencePipelineDataStreamParams;



InferencePipelineDataStreamParams params = InferencePipelineDataStreamParams.builder()

    // ... normal properties

    .putAdditionalProperty("secret_param", JsonValue.from("4242"))

    .build();

```



## Responses



### Response validation



When receiving a response, the Openlayer Java SDK will deserialize it into instances of the typed model classes. In rare cases, the API may return a response property that doesn't match the expected Java type. If you directly access the mistaken property, the SDK will throw an unchecked `OpenlayerInvalidDataException` at runtime. If you would prefer to check in advance that that response is completely well-typed, call `.validate()` on the returned model.



```java

import com.openlayer.api.models.InferencePipelineDataStreamResponse;



InferencePipelineDataStreamResponse response = client.inferencePipelines().data().stream().validate();

```



### Response properties as JSON



In rare cases, you may want to access the underlying JSON value for a response property rather than using the typed version provided by this SDK. Each model property has a corresponding JSON version, with an underscore before the method name, which returns a `JsonField` value.



```java

import com.openlayer.api.core.JsonField;

import java.util.Optional;



JsonField field = responseObj._field();



if (field.isMissing()) {

  // Value was not specified in the JSON response

} else if (field.isNull()) {

  // Value was provided as a literal null

} else {

  // See if value was provided as a string

  Optional jsonString = field.asString();



  // If the value given by the API did not match the shape that the SDK expects

  // you can deserialise into a custom type

  MyClass myObj = responseObj._field().asUnknown().orElseThrow().convert(MyClass.class);

}

```



### Additional model properties



Sometimes, the server response may include additional properties that are not yet available in this library's types. You can access them using the model's `_additionalProperties` method:



```java

import com.openlayer.api.core.JsonValue;



JsonValue secret = projectCreateResponse._additionalProperties().get("secret_field");

```



---



---



## Error handling



This library throws exceptions in a single hierarchy for easy handling:



- **`OpenlayerException`** - Base exception for all exceptions



- **`OpenlayerServiceException`** - HTTP errors with a well-formed response body we were able to parse. The exception message and the `.debuggingRequestId()` will be set by the server.



  | 400    | BadRequestException           |

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

  | 401    | AuthenticationException       |

  | 403    | PermissionDeniedException     |

  | 404    | NotFoundException             |

  | 422    | UnprocessableEntityException  |

  | 429    | RateLimitException            |

  | 5xx    | InternalServerException       |

  | others | UnexpectedStatusCodeException |



- **`OpenlayerIoException`** - I/O networking errors

- **`OpenlayerInvalidDataException`** - any other exceptions on the client side, e.g.:

  - We failed to serialize the request body

  - We failed to parse the response body (has access to response code and body)



## Network options



### Retries



Requests that experience certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default. You can provide a `maxRetries` on the client builder to configure this:



```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. You can configure this on the client builder:



```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



Requests can be routed through a proxy. You can configure this on the client builder:



```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("example.com", 8080)))

    .build();

```



## Making custom/undocumented requests



This library is typed for convenient access to the documented API. If you need to access undocumented params or response properties, the library can still be used.



### Undocumented request params



To make requests using undocumented parameters, you can provide or override parameters on the params object while building it.



```kotlin

FooCreateParams address = FooCreateParams.builder()

    .id("my_id")

    .putAdditionalProperty("secret_prop", JsonValue.from("hello"))

    .build();

```



### Undocumented response properties



To access undocumented response properties, you can use `res._additionalProperties()` on a response object to get a map of untyped fields of type `Map`. You can then access fields like `._additionalProperties().get("secret_prop").asString()` or use other helpers defined on the `JsonValue` class to extract it to a desired type.



## Logging



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



You can enable logging by setting the environment variable `OPENLAYER_LOG` to `info`.



```sh

$ export OPENLAYER_LOG=info

```



Or to `debug` for more verbose logging.



```sh

$ export OPENLAYER_LOG=debug

```



## 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.



## Requirements



This library requires Java 8 or later.