Package org.opensearch.client.opensearch.knn

Class OpenSearchKnnClient

java.lang.Object

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

org.opensearch.client.opensearch.knn.OpenSearchKnnClient

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

Client for the knn namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchKnnClient

public OpenSearchKnnClient(OpenSearchTransport transport)

OpenSearchKnnClient

public OpenSearchKnnClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchKnnClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchKnnClient>

deleteModel

public DeleteModelResponse deleteModel(DeleteModelRequest request)
                                throws IOException,
OpenSearchException

Used to delete a particular model in the cluster.

Throws:

IOException

OpenSearchException

deleteModel

public final 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 GetModelResponse getModel(GetModelRequest request)
                          throws IOException,
OpenSearchException

Used to retrieve information about models present in the cluster.

Throws:

IOException

OpenSearchException

getModel

public final 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 SearchModelsResponse searchModels(SearchModelsRequest request)
                                  throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

searchModels

public final 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 SearchModelsResponse searchModels()
                                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

stats

public KnnStatsResponse stats(KnnStatsRequest request)
                       throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

stats

public final 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 KnnStatsResponse stats()
                             throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

trainModel

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