Class LowLevelMlNamespace

Ml APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelMlNamespace

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.MlApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelMlNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

CreateConnectorAsync<TResponse>(PostData, CreateConnectorRequestParameters, CancellationToken)

POST on /_plugins/_ml/connectors/_create

Declaration

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

Parameters

Type	Name	Description
PostData	body
CreateConnectorRequestParameters	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

CreateConnector<TResponse>(PostData, CreateConnectorRequestParameters)

POST on /_plugins/_ml/connectors/_create

Declaration

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

Parameters

Type	Name	Description
PostData	body
CreateConnectorRequestParameters	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

DeleteAgentAsync<TResponse>(string, DeleteAgentRequestParameters, CancellationToken)

DELETE on /_plugins/_ml/agents/{agent_id}

Declaration

public Task<TResponse> DeleteAgentAsync<TResponse>(string agentId, DeleteAgentRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	agentId
DeleteAgentRequestParameters	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

DeleteAgent<TResponse>(string, DeleteAgentRequestParameters)

DELETE on /_plugins/_ml/agents/{agent_id}

Declaration

public TResponse DeleteAgent<TResponse>(string agentId, DeleteAgentRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	agentId
DeleteAgentRequestParameters	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

DeleteConnectorAsync<TResponse>(string, DeleteConnectorRequestParameters, CancellationToken)

DELETE on /_plugins/_ml/connectors/{connector_id}

Declaration

public Task<TResponse> DeleteConnectorAsync<TResponse>(string connectorId, DeleteConnectorRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	connectorId
DeleteConnectorRequestParameters	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

DeleteConnector<TResponse>(string, DeleteConnectorRequestParameters)

DELETE on /_plugins/_ml/connectors/{connector_id}

Declaration

public TResponse DeleteConnector<TResponse>(string connectorId, DeleteConnectorRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	connectorId
DeleteConnectorRequestParameters	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

DeleteModelAsync<TResponse>(string, DeleteModelRequestParameters, CancellationToken)

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

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

DeleteModelGroupAsync<TResponse>(string, DeleteModelGroupRequestParameters, CancellationToken)

DELETE on /_plugins/_ml/model_groups/{model_group_id}

Declaration

public Task<TResponse> DeleteModelGroupAsync<TResponse>(string modelGroupId, DeleteModelGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelGroupId
DeleteModelGroupRequestParameters	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

DeleteModelGroup<TResponse>(string, DeleteModelGroupRequestParameters)

DELETE on /_plugins/_ml/model_groups/{model_group_id}

Declaration

public TResponse DeleteModelGroup<TResponse>(string modelGroupId, DeleteModelGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelGroupId
DeleteModelGroupRequestParameters	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

DeleteModel<TResponse>(string, DeleteModelRequestParameters)

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

Declaration

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

Parameters

Type	Name	Description
string	modelId
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

DeleteTaskAsync<TResponse>(string, DeleteTaskRequestParameters, CancellationToken)

DELETE on /_plugins/_ml/tasks/{task_id}

Declaration

public Task<TResponse> DeleteTaskAsync<TResponse>(string taskId, DeleteTaskRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId
DeleteTaskRequestParameters	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

DeleteTask<TResponse>(string, DeleteTaskRequestParameters)

DELETE on /_plugins/_ml/tasks/{task_id}

Declaration

public TResponse DeleteTask<TResponse>(string taskId, DeleteTaskRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId
DeleteTaskRequestParameters	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

DeployModelAsync<TResponse>(string, DeployModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/{model_id}/_deploy

Declaration

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

Parameters

Type	Name	Description
string	modelId
DeployModelRequestParameters	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

DeployModel<TResponse>(string, DeployModelRequestParameters)

POST on /_plugins/_ml/models/{model_id}/_deploy

Declaration

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

Parameters

Type	Name	Description
string	modelId
DeployModelRequestParameters	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

GetModelGroupAsync<TResponse>(string, GetModelGroupRequestParameters, CancellationToken)

GET on /_plugins/_ml/model_groups/{model_group_id}

Declaration

public Task<TResponse> GetModelGroupAsync<TResponse>(string modelGroupId, GetModelGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelGroupId
GetModelGroupRequestParameters	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

GetModelGroup<TResponse>(string, GetModelGroupRequestParameters)

GET on /_plugins/_ml/model_groups/{model_group_id}

Declaration

public TResponse GetModelGroup<TResponse>(string modelGroupId, GetModelGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelGroupId
GetModelGroupRequestParameters	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

GetTaskAsync<TResponse>(string, GetTaskRequestParameters, CancellationToken)

GET on /_plugins/_ml/tasks/{task_id}

Declaration

public Task<TResponse> GetTaskAsync<TResponse>(string taskId, GetTaskRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId
GetTaskRequestParameters	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

GetTask<TResponse>(string, GetTaskRequestParameters)

GET on /_plugins/_ml/tasks/{task_id}

Declaration

public TResponse GetTask<TResponse>(string taskId, GetTaskRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId
GetTaskRequestParameters	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

RegisterAgentsAsync<TResponse>(PostData, RegisterAgentsRequestParameters, CancellationToken)

POST on /_plugins/_ml/agents/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterAgentsRequestParameters	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

RegisterAgents<TResponse>(PostData, RegisterAgentsRequestParameters)

POST on /_plugins/_ml/agents/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterAgentsRequestParameters	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

RegisterModelAsync<TResponse>(PostData, RegisterModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterModelRequestParameters	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

RegisterModelGroupAsync<TResponse>(PostData, RegisterModelGroupRequestParameters, CancellationToken)

POST on /_plugins/_ml/model_groups/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterModelGroupRequestParameters	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

RegisterModelGroup<TResponse>(PostData, RegisterModelGroupRequestParameters)

POST on /_plugins/_ml/model_groups/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterModelGroupRequestParameters	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

RegisterModel<TResponse>(PostData, RegisterModelRequestParameters)

POST on /_plugins/_ml/models/_register

Declaration

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

Parameters

Type	Name	Description
PostData	body
RegisterModelRequestParameters	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)

GET on /_plugins/_ml/models/_search

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)

GET on /_plugins/_ml/models/_search

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

UndeployModelAsync<TResponse>(string, UndeployModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/{model_id}/_undeploy

Declaration

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

Parameters

Type	Name	Description
string	modelId
UndeployModelRequestParameters	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

UndeployModel<TResponse>(string, UndeployModelRequestParameters)

POST on /_plugins/_ml/models/{model_id}/_undeploy

Declaration

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

Parameters

Type	Name	Description
string	modelId
UndeployModelRequestParameters	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)