Package org.opensearch.client.opensearch.knn

Class OpenSearchKnnAsyncClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchKnnAsyncClient>

org.opensearch.client.opensearch.knn.OpenSearchKnnAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchKnnAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchKnnAsyncClient>

Client for the knn namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchKnnAsyncClient(OpenSearchTransport transport)
OpenSearchKnnAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<DeleteModelResponse>	deleteModel(Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)	Used to delete a particular model in the cluster.
CompletableFuture<DeleteModelResponse>	deleteModel(DeleteModelRequest request)	Used to delete a particular model in the cluster.
final CompletableFuture<GetModelResponse>	getModel(Function<GetModelRequest.Builder,ObjectBuilder<GetModelRequest>> fn)	Used to retrieve information about models present in the cluster.
CompletableFuture<GetModelResponse>	getModel(GetModelRequest request)	Used to retrieve information about models present in the cluster.
final CompletableFuture<SearchModelsResponse>	searchModels()	Use an OpenSearch query to search for models in the index.
final CompletableFuture<SearchModelsResponse>	searchModels(Function<SearchModelsRequest.Builder,ObjectBuilder<SearchModelsRequest>> fn)	Use an OpenSearch query to search for models in the index.
CompletableFuture<SearchModelsResponse>	searchModels(SearchModelsRequest request)	Use an OpenSearch query to search for models in the index.
final CompletableFuture<KnnStatsResponse>	stats()	Provides information about the current status of the k-NN plugin.
final CompletableFuture<KnnStatsResponse>	stats(Function<KnnStatsRequest.Builder,ObjectBuilder<KnnStatsRequest>> fn)	Provides information about the current status of the k-NN plugin.
CompletableFuture<KnnStatsResponse>	stats(KnnStatsRequest request)	Provides information about the current status of the k-NN plugin.
final CompletableFuture<TrainModelResponse>	trainModel(Function<TrainModelRequest.Builder,ObjectBuilder<TrainModelRequest>> fn)	Create and train a model that can be used for initializing k-NN native library indexes during indexing.
CompletableFuture<TrainModelResponse>	trainModel(TrainModelRequest request)	Create and train a model that can be used for initializing k-NN native library indexes during indexing.
final CompletableFuture<WarmupResponse>	warmup(Function<WarmupRequest.Builder,ObjectBuilder<WarmupRequest>> fn)	Preloads native library files into memory, reducing initial search latency for specified indexes.
CompletableFuture<WarmupResponse>	warmup(WarmupRequest request)	Preloads native library files into memory, reducing initial search latency for specified indexes.
OpenSearchKnnAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenSearchKnnAsyncClient

public OpenSearchKnnAsyncClient(OpenSearchTransport transport)

OpenSearchKnnAsyncClient

public OpenSearchKnnAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchKnnAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchKnnAsyncClient>

deleteModel

public CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest request)
                                                   throws IOException,
OpenSearchException

Used to delete a particular model in the cluster.

Throws:

IOException

OpenSearchException

deleteModel

public final CompletableFuture<DeleteModelResponse> deleteModel(Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)
                                                         throws IOException,
OpenSearchException

Used to delete a particular model in the cluster.

Parameters:

fn - a function that initializes a builder to create the DeleteModelRequest

Throws:

IOException

OpenSearchException

getModel

public CompletableFuture<GetModelResponse> getModel(GetModelRequest request)
                                             throws IOException,
OpenSearchException

Used to retrieve information about models present in the cluster.

Throws:

IOException

OpenSearchException

getModel

public final CompletableFuture<GetModelResponse> getModel(Function<GetModelRequest.Builder,ObjectBuilder<GetModelRequest>> fn)
                                                   throws IOException,
OpenSearchException

Used to retrieve information about models present in the cluster.

Parameters:

fn - a function that initializes a builder to create the GetModelRequest

Throws:

IOException

OpenSearchException

searchModels

public CompletableFuture<SearchModelsResponse> searchModels(SearchModelsRequest request)
                                                     throws IOException,
OpenSearchException

Use an OpenSearch query to search for models in the index.

Throws:

IOException

OpenSearchException

searchModels

public final CompletableFuture<SearchModelsResponse> searchModels(Function<SearchModelsRequest.Builder,ObjectBuilder<SearchModelsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Use an OpenSearch query to search for models in the index.

Parameters:

fn - a function that initializes a builder to create the SearchModelsRequest

Throws:

IOException

OpenSearchException

searchModels

public final CompletableFuture<SearchModelsResponse> searchModels()
                                                           throws IOException,
OpenSearchException

Use an OpenSearch query to search for models in the index.

Throws:

IOException

OpenSearchException

stats

public CompletableFuture<KnnStatsResponse> stats(KnnStatsRequest request)
                                          throws IOException,
OpenSearchException

Provides information about the current status of the k-NN plugin.

Throws:

IOException

OpenSearchException

stats

public final CompletableFuture<KnnStatsResponse> stats(Function<KnnStatsRequest.Builder,ObjectBuilder<KnnStatsRequest>> fn)
                                                throws IOException,
OpenSearchException

Provides information about the current status of the k-NN plugin.

Parameters:

fn - a function that initializes a builder to create the KnnStatsRequest

Throws:

IOException

OpenSearchException

stats

public final CompletableFuture<KnnStatsResponse> stats()
                                                throws IOException,
OpenSearchException

Provides information about the current status of the k-NN plugin.

Throws:

IOException

OpenSearchException

trainModel

public CompletableFuture<TrainModelResponse> trainModel(TrainModelRequest request)
                                                 throws IOException,
OpenSearchException

Create and train a model that can be used for initializing k-NN native library indexes during indexing.

Throws:

IOException

OpenSearchException

trainModel

public final CompletableFuture<TrainModelResponse> trainModel(Function<TrainModelRequest.Builder,ObjectBuilder<TrainModelRequest>> fn)
                                                       throws IOException,
OpenSearchException

Create and train a model that can be used for initializing k-NN native library indexes during indexing.

Parameters:

fn - a function that initializes a builder to create the TrainModelRequest

Throws:

IOException

OpenSearchException

warmup

public CompletableFuture<WarmupResponse> warmup(WarmupRequest request)
                                         throws IOException,
OpenSearchException

Preloads native library files into memory, reducing initial search latency for specified indexes.

Throws:

IOException

OpenSearchException

warmup

public final CompletableFuture<WarmupResponse> warmup(Function<WarmupRequest.Builder,ObjectBuilder<WarmupRequest>> fn)
                                               throws IOException,
OpenSearchException

Preloads native library files into memory, reducing initial search latency for specified indexes.

Parameters:

fn - a function that initializes a builder to create the WarmupRequest

Throws:

IOException

OpenSearchException