Class LowLevelKnnNamespace

Knn APIs.

Not intended to be instantiated directly. Use the Knn property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelKnnNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.KnnApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelKnnNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

DeleteModelAsync<TResponse>(string, DeleteModelRequestParameters, CancellationToken)

DELETE on /_plugins/_knn/models/{model_id}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#delete-a-model</p>

Declaration

public Task<TResponse> DeleteModelAsync<TResponse>(string modelId, DeleteModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
DeleteModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteModel<TResponse>(string, DeleteModelRequestParameters)

DELETE on /_plugins/_knn/models/{model_id}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#delete-a-model</p>

Declaration

public TResponse DeleteModel<TResponse>(string modelId, DeleteModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
DeleteModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetModelAsync<TResponse>(string, GetModelRequestParameters, CancellationToken)

GET on /_plugins/_knn/models/{model_id}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#get-a-model</p>

Declaration

public Task<TResponse> GetModelAsync<TResponse>(string modelId, GetModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
GetModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetModel<TResponse>(string, GetModelRequestParameters)

GET on /_plugins/_knn/models/{model_id}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#get-a-model</p>

Declaration

public TResponse GetModel<TResponse>(string modelId, GetModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
GetModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SearchModelsAsync<TResponse>(PostData, SearchModelsRequestParameters, CancellationToken)

POST on /_plugins/_knn/models/_search

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#search-for-a-model</p>

Declaration

public Task<TResponse> SearchModelsAsync<TResponse>(PostData body, SearchModelsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
SearchModelsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SearchModels<TResponse>(PostData, SearchModelsRequestParameters)

POST on /_plugins/_knn/models/_search

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#search-for-a-model</p>

Declaration

public TResponse SearchModels<TResponse>(PostData body, SearchModelsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
SearchModelsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsAsync<TResponse>(string, StatsRequestParameters, CancellationToken)

GET on /_plugins/_knn/{node_id}/stats

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsAsync<TResponse>(string, KnnStatName?, StatsRequestParameters, CancellationToken)

GET on /_plugins/_knn/{node_id}/stats/{stat}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, KnnStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
KnnStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsForAllAsync<TResponse>(StatsRequestParameters, CancellationToken)

GET on /_plugins/_knn/stats

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsForAllAsync<TResponse>(KnnStatName?, StatsRequestParameters, CancellationToken)

GET on /_plugins/_knn/stats/{stat}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(KnnStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
KnnStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsForAll<TResponse>(StatsRequestParameters)

GET on /_plugins/_knn/stats

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public TResponse StatsForAll<TResponse>(StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsForAll<TResponse>(KnnStatName?, StatsRequestParameters)

GET on /_plugins/_knn/stats/{stat}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public TResponse StatsForAll<TResponse>(KnnStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
KnnStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Stats<TResponse>(string, StatsRequestParameters)

GET on /_plugins/_knn/{node_id}/stats

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public TResponse Stats<TResponse>(string nodeId, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Stats<TResponse>(string, KnnStatName?, StatsRequestParameters)

GET on /_plugins/_knn/{node_id}/stats/{stat}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#stats</p>

Declaration

public TResponse Stats<TResponse>(string nodeId, KnnStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
KnnStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

TrainModelAsync<TResponse>(PostData, TrainModelRequestParameters, CancellationToken)

POST on /_plugins/_knn/models/_train

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model</p>

Declaration

public Task<TResponse> TrainModelAsync<TResponse>(PostData body, TrainModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
TrainModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

TrainModelAsync<TResponse>(string, PostData, TrainModelRequestParameters, CancellationToken)

POST on /_plugins/_knn/models/{model_id}/_train

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model</p>

Declaration

public Task<TResponse> TrainModelAsync<TResponse>(string modelId, PostData body, TrainModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
PostData	body
TrainModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

TrainModel<TResponse>(PostData, TrainModelRequestParameters)

POST on /_plugins/_knn/models/_train

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model</p>

Declaration

public TResponse TrainModel<TResponse>(PostData body, TrainModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
TrainModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

TrainModel<TResponse>(string, PostData, TrainModelRequestParameters)

POST on /_plugins/_knn/models/{model_id}/_train

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model</p>

Declaration

public TResponse TrainModel<TResponse>(string modelId, PostData body, TrainModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId	The id of the model.
PostData	body
TrainModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

WarmupAsync<TResponse>(string, WarmupRequestParameters, CancellationToken)

GET on /_plugins/_knn/warmup/{index}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#warmup-operation</p>

Declaration

public Task<TResponse> WarmupAsync<TResponse>(string index, WarmupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of indexes; use <c>_all</c> or empty string to perform the operation on all indexes.
WarmupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Warmup<TResponse>(string, WarmupRequestParameters)

GET on /_plugins/_knn/warmup/{index}

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#warmup-operation</p>

Declaration

public TResponse Warmup<TResponse>(string index, WarmupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of indexes; use <c>_all</c> or empty string to perform the operation on all indexes.
WarmupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)