Interface HiddenLayerClientAsync
-
- All Implemented Interfaces:
public interface HiddenLayerClientAsyncA client for interacting with the HiddenLayer REST API asynchronously. You can also switch to synchronous execution via the sync 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 interfaceHiddenLayerClientAsync.WithRawResponseA view of HiddenLayerClientAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract HiddenLayerClientsync()Returns a version of this client that uses synchronous execution. abstract HiddenLayerClientAsync.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract HiddenLayerClientAsyncwithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. abstract ModelServiceAsyncmodels()abstract PromptAnalyzerServiceAsyncpromptAnalyzer()abstract InteractionServiceAsyncinteractions()abstract SensorServiceAsyncsensors()abstract ScanServiceAsyncscans()abstract AsyncCommunityScannercommunityScanner()Async community scanner that provides the communityScan method with polling functionality. abstract AsyncModelScannermodelScanner()Model scanner that provides file and folder scanning functionality. abstract Unitclose()Closes this client, relinquishing any underlying resources. -
-
Method Detail
-
sync
abstract HiddenLayerClient sync()
Returns a version of this client that uses synchronous execution.
The returned client shares its resources, like its connection pool and thread pools, with this client.
-
withRawResponse
abstract HiddenLayerClientAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract HiddenLayerClientAsync 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 ModelServiceAsync models()
-
promptAnalyzer
abstract PromptAnalyzerServiceAsync promptAnalyzer()
-
interactions
abstract InteractionServiceAsync interactions()
-
sensors
abstract SensorServiceAsync sensors()
-
scans
abstract ScanServiceAsync scans()
-
communityScanner
abstract AsyncCommunityScanner communityScanner()
Async 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 AsyncModelScanner modelScanner()
Model scanner that provides file and folder scanning functionality.
This extends the generated SDK to provide async versions of all model scanning functionality including file and folder scanning with multipart upload functionality.
-
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.
-
-
-
-