Interface HiddenLayerClient
-
- All Implemented Interfaces:
public interface HiddenLayerClientA client for interacting with the HiddenLayer REST API synchronously. You can also switch to asynchronous execution via the async method.
This client performs best when you create a single instance and reuse it for all interactions with the REST API. This is because each client holds its own connection pool and thread pools. Reusing connections and threads reduces latency and saves memory. The client also handles rate limiting per client. This means that creating and using multiple instances at the same time will not respect rate limits.
The threads and connections that are held will be released automatically if they remain idle. But if you are writing an application that needs to aggressively release unused resources, then you may call close.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceHiddenLayerClient.WithRawResponseA view of HiddenLayerClient that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract HiddenLayerClientAsyncasync()Returns a version of this client that uses asynchronous execution. abstract HiddenLayerClient.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract HiddenLayerClientwithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. abstract ModelServicemodels()abstract PromptAnalyzerServicepromptAnalyzer()abstract InteractionServiceinteractions()abstract SensorServicesensors()abstract ScanServicescans()abstract CommunityScannercommunityScanner()Community scanner that provides the communityScan method with polling functionality. abstract ModelScannermodelScanner()Model scanner that provides file and folder scanning functionality. abstract Unitclose()Closes this client, relinquishing any underlying resources. -
-
Method Detail
-
async
abstract HiddenLayerClientAsync async()
Returns a version of this client that uses asynchronous execution.
The returned client shares its resources, like its connection pool and thread pools, with this client.
-
withRawResponse
abstract HiddenLayerClient.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract HiddenLayerClient withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
models
abstract ModelService models()
-
promptAnalyzer
abstract PromptAnalyzerService promptAnalyzer()
-
interactions
abstract InteractionService interactions()
-
sensors
abstract SensorService sensors()
-
scans
abstract ScanService scans()
-
communityScanner
abstract CommunityScanner communityScanner()
Community scanner that provides the communityScan method with polling functionality.
This extends the generated SDK to provide the same functionality as the old SDK's communityScan method, which initiates a scan and optionally waits for results.
-
modelScanner
abstract ModelScanner modelScanner()
Model scanner that provides file and folder scanning functionality.
This extends the generated SDK to provide the same functionality as the old SDK's ModelScanAPI, including multipart upload functionality for files and folders.
-
close
abstract Unit close()
Closes this client, relinquishing any underlying resources.
This is purposefully not inherited from AutoCloseable because the client is long-lived and usually should not be synchronously closed via try-with-resources.
It's also usually not necessary to call this method at all. the default HTTP client automatically releases threads and connections if they remain idle, but if you are writing an application that needs to aggressively release unused resources, then you may call this method.
-
-
-
-