HiddenLayer Java API Library

The HiddenLayer Java SDK provides convenient access to the HiddenLayer REST API from applications written in Java.

It is generated with Stainless.

The REST API documentation can be found on dev.hiddenlayer.ai. Javadocs are available on javadoc.io.

Beta APIs

Some HiddenLayer APIs are marked as Beta, meaning they are not yet generally available (GA) or production ready. Beta APIs can be used in a production environment, but at your own risk and discretion. For full details, see the Beta API Guidelines on the developer portal.

HiddenLayer does not provide compatibility guarantees for Beta APIs. Breaking changes may occur at any time.
SDK functions and types associated with Beta APIs are excluded when determining semver release versions.

Installation

Gradle

implementation("com.hiddenlayer.api:hiddenlayer-java:2.4.0")

Maven

<dependency>
  <groupId>com.hiddenlayer.api</groupId>
  <artifactId>hiddenlayer-java</artifactId>
  <version>2.4.0</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

// Configures using the `hiddenlayer.token`, `hiddenlayer.clientId`, `hiddenlayer.clientSecret` and `hiddenlayer.baseUrl` system properties
// Or configures using the `HIDDENLAYER_TOKEN`, `HIDDENLAYER_CLIENT_ID`, `HIDDENLAYER_CLIENT_SECRET` and `HIDDENLAYER_BASE_URL` environment variables
HiddenLayerClient client = HiddenLayerOkHttpClient.fromEnv();

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(InteractionAnalyzeParams.Metadata.builder()
        .model("REPLACE_ME")
        .requesterId("REPLACE_ME")
        .build())
    .input(InteractionAnalyzeParams.Input.builder()
        .addMessage(InteractionAnalyzeParams.Input.Message.builder()
            .role("user")
            .content("REPLACE_ME")
            .build())
        .build())
    .build();
InteractionAnalyzeResponse response = client.interactions().analyze(params);

Client configuration

Configure the client using system properties or environment variables:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

// Configures using the `hiddenlayer.token`, `hiddenlayer.clientId`, `hiddenlayer.clientSecret` and `hiddenlayer.baseUrl` system properties
// Or configures using the `HIDDENLAYER_TOKEN`, `HIDDENLAYER_CLIENT_ID`, `HIDDENLAYER_CLIENT_SECRET` and `HIDDENLAYER_BASE_URL` environment variables
HiddenLayerClient client = HiddenLayerOkHttpClient.fromEnv();

Or manually:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .bearerToken("My Bearer Token")
    .build();

Or using a combination of the two approaches:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    // Configures using the `hiddenlayer.token`, `hiddenlayer.clientId`, `hiddenlayer.clientSecret` and `hiddenlayer.baseUrl` system properties
    // Or configures using the `HIDDENLAYER_TOKEN`, `HIDDENLAYER_CLIENT_ID`, `HIDDENLAYER_CLIENT_SECRET` and `HIDDENLAYER_BASE_URL` environment variables
    .fromEnv()
    .bearerToken("My Bearer Token")
    .build();

See this table for the available options:

Setter	System property	Environment variable	Required	Default value
`bearerToken`	`hiddenlayer.token`	`HIDDENLAYER_TOKEN`	false	-
`clientId`	`hiddenlayer.clientId`	`HIDDENLAYER_CLIENT_ID`	false	-
`clientSecret`	`hiddenlayer.clientSecret`	`HIDDENLAYER_CLIENT_SECRET`	false	-
`baseUrl`	`hiddenlayer.baseUrl`	`HIDDENLAYER_BASE_URL`	true	`"https://api.us.hiddenlayer.ai"`

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:

import com.hiddenlayer.api.client.HiddenLayerClient;

HiddenLayerClient 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 HiddenLayer 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.interactions().analyze(...) should be called with an instance of InteractionAnalyzeParams, and it will return an instance of InteractionAnalyzeResponse.

Immutability

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.

Asynchronous execution

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

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;
import java.util.concurrent.CompletableFuture;

// Configures using the `hiddenlayer.token`, `hiddenlayer.clientId`, `hiddenlayer.clientSecret` and `hiddenlayer.baseUrl` system properties
// Or configures using the `HIDDENLAYER_TOKEN`, `HIDDENLAYER_CLIENT_ID`, `HIDDENLAYER_CLIENT_SECRET` and `HIDDENLAYER_BASE_URL` environment variables
HiddenLayerClient client = HiddenLayerOkHttpClient.fromEnv();

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(InteractionAnalyzeParams.Metadata.builder()
        .model("REPLACE_ME")
        .requesterId("REPLACE_ME")
        .build())
    .input(InteractionAnalyzeParams.Input.builder()
        .addMessage(InteractionAnalyzeParams.Input.Message.builder()
            .role("user")
            .content("REPLACE_ME")
            .build())
        .build())
    .build();
CompletableFuture<InteractionAnalyzeResponse> response = client.async().interactions().analyze(params);

Or create an asynchronous client from the beginning:

import com.hiddenlayer.api.client.HiddenLayerClientAsync;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClientAsync;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;
import java.util.concurrent.CompletableFuture;

// Configures using the `hiddenlayer.token`, `hiddenlayer.clientId`, `hiddenlayer.clientSecret` and `hiddenlayer.baseUrl` system properties
// Or configures using the `HIDDENLAYER_TOKEN`, `HIDDENLAYER_CLIENT_ID`, `HIDDENLAYER_CLIENT_SECRET` and `HIDDENLAYER_BASE_URL` environment variables
HiddenLayerClientAsync client = HiddenLayerOkHttpClientAsync.fromEnv();

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(InteractionAnalyzeParams.Metadata.builder()
        .model("REPLACE_ME")
        .requesterId("REPLACE_ME")
        .build())
    .input(InteractionAnalyzeParams.Input.builder()
        .addMessage(InteractionAnalyzeParams.Input.Message.builder()
            .role("user")
            .content("REPLACE_ME")
            .build())
        .build())
    .build();
CompletableFuture<InteractionAnalyzeResponse> response = client.interactions().analyze(params);

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

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():

import com.hiddenlayer.api.core.http.Headers;
import com.hiddenlayer.api.core.http.HttpResponseFor;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(InteractionAnalyzeParams.Metadata.builder()
        .model("REPLACE_ME")
        .requesterId("REPLACE_ME")
        .build())
    .input(InteractionAnalyzeParams.Input.builder()
        .addMessage(InteractionAnalyzeParams.Input.Message.builder()
            .role("user")
            .content("REPLACE_ME")
            .build())
        .build())
    .build();
HttpResponseFor<InteractionAnalyzeResponse> response = client.interactions().withRawResponse().analyze(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.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

InteractionAnalyzeResponse parsedResponse = response.parse();

Error handling

The SDK throws custom unchecked exception types:

HiddenLayerServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:

Status	Exception
400	`BadRequestException`
401	`UnauthorizedException`
403	`PermissionDeniedException`
404	`NotFoundException`
422	`UnprocessableEntityException`
429	`RateLimitException`
5xx	`InternalServerException`
others	`UnexpectedStatusCodeException`

HiddenLayerIoException: I/O networking errors.
HiddenLayerRetryableException: Generic error indicating a failure that could be retried by the client.
HiddenLayerInvalidDataException: 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.
HiddenLayerException: 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.

Pagination

The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, use the autoPager() method, which automatically fetches more pages as needed.

When using the synchronous client, the method returns an Iterable

import com.hiddenlayer.api.models.models.cards.CardListPage;
import com.hiddenlayer.api.models.models.cards.CardListResponse;

CardListPage page = client.models().cards().list();

// Process as an Iterable
for (CardListResponse card : page.autoPager()) {
    System.out.println(card);
}

// Process as a Stream
page.autoPager()
    .stream()
    .limit(50)
    .forEach(card -> System.out.println(card));

When using the asynchronous client, the method returns an AsyncStreamResponse:

import com.hiddenlayer.api.core.http.AsyncStreamResponse;
import com.hiddenlayer.api.models.models.cards.CardListPageAsync;
import com.hiddenlayer.api.models.models.cards.CardListResponse;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

CompletableFuture<CardListPageAsync> pageFuture = client.async().models().cards().list();

pageFuture.thenRun(page -> page.autoPager().subscribe(card -> {
    System.out.println(card);
}));

// If you need to handle errors or completion of the stream
pageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {
    @Override
    public void onNext(CardListResponse card) {
        System.out.println(card);
    }

    @Override
    public void onComplete(Optional<Throwable> error) {
        if (error.isPresent()) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error.get());
        } else {
            System.out.println("No more!");
        }
    }
}));

// Or use futures
pageFuture.thenRun(page -> page.autoPager()
    .subscribe(card -> {
        System.out.println(card);
    })
    .onCompleteFuture()
    .whenComplete((unused, error) -> {
        if (error != null) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error);
        } else {
            System.out.println("No more!");
        }
    }));

Manual pagination

To access individual page items and manually request the next page, use the items(), hasNextPage(), and nextPage() methods:

import com.hiddenlayer.api.models.models.cards.CardListPage;
import com.hiddenlayer.api.models.models.cards.CardListResponse;

CardListPage page = client.models().cards().list();
while (true) {
    for (CardListResponse card : page.items()) {
        System.out.println(card);
    }

    if (!page.hasNextPage()) {
        break;
    }

    page = page.nextPage();
}

Logging

Enable logging by setting the HIDDENLAYER_LOG environment variable to info:

export HIDDENLAYER_LOG=info

Or to debug for more verbose logging:

export HIDDENLAYER_LOG=debug

Or configure the client manually using the logLevel method:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import com.hiddenlayer.api.core.LogLevel;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .logLevel(LogLevel.INFO)
    .build();

ProGuard and R8

Although the SDK uses reflection, it is still usable with ProGuard and R8 because hiddenlayer-java-core is published with a configuration file containing keep rules.

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 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 HiddenLayerOkHttpClient or HiddenLayerOkHttpClientAsync.

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) 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:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.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:

import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

InteractionAnalyzeResponse response = client.interactions().analyze(
  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
);

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

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import java.time.Duration;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build();

Proxies

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

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import java.net.InetSocketAddress;
import java.net.Proxy;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
      Proxy.Type.HTTP, new InetSocketAddress(
        "https://example.com", 8080
      )
    ))
    .build();

If the proxy responds with 407 Proxy Authentication Required, supply credentials by also configuring proxyAuthenticator:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import com.hiddenlayer.api.core.http.ProxyAuthenticator;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .proxy(...)
    // Or a custom implementation of `ProxyAuthenticator`.
    .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))
    .build();

Connection pooling

To customize the underlying OkHttp connection pool, configure the client using the maxIdleConnections and keepAliveDuration methods:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;
import java.time.Duration;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.
    .maxIdleConnections(10)
    .keepAliveDuration(Duration.ofMinutes(2))
    .build();

If both options are unset, OkHttp's default connection pool settings are used.

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:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
    .sslSocketFactory(yourSSLSocketFactory)
    .trustManager(yourTrustManager)
    .hostnameVerifier(yourHostnameVerifier)
    .build();

Environments

The SDK sends requests to the prod-us by default. To send requests to a different environment, configure the client like so:

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .prodEu()
    .build();

Custom HTTP client

The SDK consists of three artifacts:

hiddenlayer-java-core
- Contains core SDK logic
- Does not depend on OkHttp
- Exposes HiddenLayerClient, HiddenLayerClientAsync, HiddenLayerClientImpl, and HiddenLayerClientAsyncImpl, all of which can work with any HTTP client
hiddenlayer-java-client-okhttp
- Depends on OkHttp
- Exposes HiddenLayerOkHttpClient and HiddenLayerOkHttpClientAsync, which provide a way to construct HiddenLayerClientImpl and HiddenLayerClientAsyncImpl, respectively, using OkHttp
hiddenlayer-java
- Depends on and exposes the APIs of both hiddenlayer-java-core and hiddenlayer-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`

Tip

Try the available network options before replacing the default client.

To use a customized OkHttpClient:

Replace your hiddenlayer-java dependency with hiddenlayer-java-core
Copy hiddenlayer-java-client-okhttp's OkHttpClient class into your code and customize it
Construct HiddenLayerClientImpl or HiddenLayerClientAsyncImpl, similarly to HiddenLayerOkHttpClient or HiddenLayerOkHttpClientAsync, using your customized client

Completely custom HTTP client

To use a completely custom HTTP client:

Replace your hiddenlayer-java dependency with hiddenlayer-java-core
Write a class that implements the HttpClient interface
Construct HiddenLayerClientImpl or HiddenLayerClientAsyncImpl, similarly to HiddenLayerOkHttpClient or HiddenLayerOkHttpClientAsync, 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:

import com.hiddenlayer.api.core.JsonValue;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;

InteractionAnalyzeParams params = InteractionAnalyzeParams.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.hiddenlayer.api.core.JsonValue;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(InteractionAnalyzeParams.Metadata.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.hiddenlayer.api.core.JsonValue;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(JsonValue.from(42))
    .input(InteractionAnalyzeParams.Input.builder()
        .addMessage(InteractionAnalyzeParams.Input.Message.builder()
            .role("user")
            .content("REPLACE_ME")
            .build())
        .build())
    .build();

The most straightforward way to create a JsonValue is using its from(...) method:

import com.hiddenlayer.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.hiddenlayer.api.core.JsonMissing;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;

InteractionAnalyzeParams params = InteractionAnalyzeParams.builder()
    .metadata(JsonMissing.of())
    .build();

Response properties

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

import com.hiddenlayer.api.core.JsonValue;
import java.util.Map;

Map<String, JsonValue> additionalProperties = client.interactions().analyze(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.hiddenlayer.api.core.JsonField;
import com.hiddenlayer.api.models.interactions.InteractionAnalyzeParams;
import java.util.Optional;

JsonField<InteractionAnalyzeParams.Metadata> metadata = client.interactions().analyze(params)._metadata();

if (metadata.isMissing()) {
  // The property is absent from the JSON response
} else if (metadata.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 = metadata.asString();

  // Try to deserialize into a custom type
  MyClass myObject = metadata.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 HiddenLayerInvalidDataException only if you directly access the property.

Validating the response is not forwards compatible with new types from the API for existing fields.

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

import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

InteractionAnalyzeResponse response = client.interactions().analyze(params).validate();

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

import com.hiddenlayer.api.models.interactions.InteractionAnalyzeResponse;

InteractionAnalyzeResponse response = client.interactions().analyze(
  params, RequestOptions.builder().responseValidation(true).build()
);

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

import com.hiddenlayer.api.client.HiddenLayerClient;
import com.hiddenlayer.api.client.okhttp.HiddenLayerOkHttpClient;

HiddenLayerClient client = HiddenLayerOkHttpClient.builder()
    .fromEnv()
    .responseValidation(true)
    .build();

FAQ

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

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.

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

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.

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
Don't play well with lambdas (also due to the function coloring problem)

Semantic versioning

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.

Name		Name	Last commit message	Last commit date
.devcontainer		.devcontainer
.github/workflows		.github/workflows
bin		bin
buildSrc		buildSrc
docs		docs
gradle/wrapper		gradle/wrapper
hiddenlayer-java-client-okhttp		hiddenlayer-java-client-okhttp
hiddenlayer-java-core		hiddenlayer-java-core
hiddenlayer-java-example		hiddenlayer-java-example
hiddenlayer-java-lib		hiddenlayer-java-lib
hiddenlayer-java-proguard-test		hiddenlayer-java-proguard-test
hiddenlayer-java		hiddenlayer-java
scripts		scripts
.gitattributes		.gitattributes
.gitignore		.gitignore
.release-please-manifest.json		.release-please-manifest.json
.stats.yml		.stats.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
release-please-config.json		release-please-config.json
settings.gradle.kts		settings.gradle.kts

Latest commit

History

Folders and files

Repository files navigation