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

ChunkModelAsync<TResponse>(string, long?, PostData, ChunkModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/{model_id}/chunk/{chunk_number}

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `upload_chunk` instead.")]
public Task<TResponse> ChunkModelAsync<TResponse>(string modelId, long? chunkNumber, PostData body, ChunkModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId
long?	chunkNumber
PostData	body
ChunkModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ChunkModel<TResponse>(string, long?, PostData, ChunkModelRequestParameters)

POST on /_plugins/_ml/models/{model_id}/chunk/{chunk_number}

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `upload_chunk` instead.")]
public TResponse ChunkModel<TResponse>(string modelId, long? chunkNumber, PostData body, ChunkModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId
long?	chunkNumber
PostData	body
ChunkModelRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

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

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

CreateControllerAsync<TResponse>(string, PostData, CreateControllerRequestParameters, CancellationToken)

POST on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateController<TResponse>(string, PostData, CreateControllerRequestParameters)

POST on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateMemoryAsync<TResponse>(PostData, CreateMemoryRequestParameters, CancellationToken)

POST on /_plugins/_ml/memory

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateMemory<TResponse>(PostData, CreateMemoryRequestParameters)

POST on /_plugins/_ml/memory

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateMessageAsync<TResponse>(string, PostData, CreateMessageRequestParameters, CancellationToken)

POST on /_plugins/_ml/memory/{memory_id}/messages

Declaration

public Task<TResponse> CreateMessageAsync<TResponse>(string memoryId, PostData body, CreateMessageRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateMessage<TResponse>(string, PostData, CreateMessageRequestParameters)

POST on /_plugins/_ml/memory/{memory_id}/messages

Declaration

public TResponse CreateMessage<TResponse>(string memoryId, PostData body, CreateMessageRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

CreateModelMetaAsync<TResponse>(PostData, CreateModelMetaRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/meta

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `_register_meta` instead.")]
public Task<TResponse> CreateModelMetaAsync<TResponse>(PostData body, CreateModelMetaRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CreateModelMeta<TResponse>(PostData, CreateModelMetaRequestParameters)

POST on /_plugins/_ml/models/meta

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `_register_meta` instead.")]
public TResponse CreateModelMeta<TResponse>(PostData body, CreateModelMetaRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

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

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

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

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

DeleteControllerAsync<TResponse>(string, DeleteControllerRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

DeleteController<TResponse>(string, DeleteControllerRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

DeleteMemoryAsync<TResponse>(string, DeleteMemoryRequestParameters, CancellationToken)

DELETE on /_plugins/_ml/memory/{memory_id}

Declaration

public Task<TResponse> DeleteMemoryAsync<TResponse>(string memoryId, DeleteMemoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

DeleteMemory<TResponse>(string, DeleteMemoryRequestParameters)

DELETE on /_plugins/_ml/memory/{memory_id}

Declaration

public TResponse DeleteMemory<TResponse>(string memoryId, DeleteMemoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

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

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

ExecuteAgentAsync<TResponse>(string, PostData, ExecuteAgentRequestParameters, CancellationToken)

POST on /_plugins/_ml/agents/{agent_id}/_execute

Declaration

public Task<TResponse> ExecuteAgentAsync<TResponse>(string agentId, PostData body, ExecuteAgentRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

ExecuteAgent<TResponse>(string, PostData, ExecuteAgentRequestParameters)

POST on /_plugins/_ml/agents/{agent_id}/_execute

Declaration

public TResponse ExecuteAgent<TResponse>(string agentId, PostData body, ExecuteAgentRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

ExecuteAlgorithmAsync<TResponse>(string, PostData, ExecuteAlgorithmRequestParameters, CancellationToken)

POST on /_plugins/_ml/_execute/{algorithm_name}

Declaration

public Task<TResponse> ExecuteAlgorithmAsync<TResponse>(string algorithmName, PostData body, ExecuteAlgorithmRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

ExecuteAlgorithm<TResponse>(string, PostData, ExecuteAlgorithmRequestParameters)

POST on /_plugins/_ml/_execute/{algorithm_name}

Declaration

public TResponse ExecuteAlgorithm<TResponse>(string algorithmName, PostData body, ExecuteAlgorithmRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

GetAgentAsync<TResponse>(string, GetAgentRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

GetAgent<TResponse>(string, GetAgentRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

GetAllMemoriesAsync<TResponse>(GetAllMemoriesRequestParameters, CancellationToken)

GET on /_plugins/_ml/memory

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetAllMemories<TResponse>(GetAllMemoriesRequestParameters)

GET on /_plugins/_ml/memory

Declaration

public TResponse GetAllMemories<TResponse>(GetAllMemoriesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetAllMessagesAsync<TResponse>(string, GetAllMessagesRequestParameters, CancellationToken)

GET on /_plugins/_ml/memory/{memory_id}/messages

Declaration

public Task<TResponse> GetAllMessagesAsync<TResponse>(string memoryId, GetAllMessagesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetAllMessages<TResponse>(string, GetAllMessagesRequestParameters)

GET on /_plugins/_ml/memory/{memory_id}/messages

Declaration

public TResponse GetAllMessages<TResponse>(string memoryId, GetAllMessagesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetAllToolsAsync<TResponse>(GetAllToolsRequestParameters, CancellationToken)

GET on /_plugins/_ml/tools

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetAllTools<TResponse>(GetAllToolsRequestParameters)

GET on /_plugins/_ml/tools

Declaration

public TResponse GetAllTools<TResponse>(GetAllToolsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetConnectorAsync<TResponse>(string, GetConnectorRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetConnector<TResponse>(string, GetConnectorRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetControllerAsync<TResponse>(string, GetControllerRequestParameters, CancellationToken)

GET on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetController<TResponse>(string, GetControllerRequestParameters)

GET on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMemoryAsync<TResponse>(string, GetMemoryRequestParameters, CancellationToken)

GET on /_plugins/_ml/memory/{memory_id}

Declaration

public Task<TResponse> GetMemoryAsync<TResponse>(string memoryId, GetMemoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMemory<TResponse>(string, GetMemoryRequestParameters)

GET on /_plugins/_ml/memory/{memory_id}

Declaration

public TResponse GetMemory<TResponse>(string memoryId, GetMemoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMessageAsync<TResponse>(string, GetMessageRequestParameters, CancellationToken)

GET on /_plugins/_ml/memory/message/{message_id}

Declaration

public Task<TResponse> GetMessageAsync<TResponse>(string messageId, GetMessageRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMessageTracesAsync<TResponse>(string, GetMessageTracesRequestParameters, CancellationToken)

GET on /_plugins/_ml/memory/message/{message_id}/traces

Declaration

public Task<TResponse> GetMessageTracesAsync<TResponse>(string messageId, GetMessageTracesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMessageTraces<TResponse>(string, GetMessageTracesRequestParameters)

GET on /_plugins/_ml/memory/message/{message_id}/traces

Declaration

public TResponse GetMessageTraces<TResponse>(string messageId, GetMessageTracesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetMessage<TResponse>(string, GetMessageRequestParameters)

GET on /_plugins/_ml/memory/message/{message_id}

Declaration

public TResponse GetMessage<TResponse>(string messageId, GetMessageRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetModelAsync<TResponse>(string, GetModelRequestParameters, CancellationToken)

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

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

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

GetModel<TResponse>(string, GetModelRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetProfileAsync<TResponse>(PostData, GetProfileRequestParameters, CancellationToken)

GET on /_plugins/_ml/profile

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetProfileModelsAsync<TResponse>(PostData, GetProfileModelsRequestParameters, CancellationToken)

GET on /_plugins/_ml/profile/models

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetProfileModelsAsync<TResponse>(string, PostData, GetProfileModelsRequestParameters, CancellationToken)

GET on /_plugins/_ml/profile/models/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetProfileModels<TResponse>(PostData, GetProfileModelsRequestParameters)

GET on /_plugins/_ml/profile/models

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetProfileModels<TResponse>(string, PostData, GetProfileModelsRequestParameters)

GET on /_plugins/_ml/profile/models/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetProfileTasksAsync<TResponse>(PostData, GetProfileTasksRequestParameters, CancellationToken)

GET on /_plugins/_ml/profile/tasks

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetProfileTasksAsync<TResponse>(string, PostData, GetProfileTasksRequestParameters, CancellationToken)

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

Declaration

public Task<TResponse> GetProfileTasksAsync<TResponse>(string taskId, PostData body, GetProfileTasksRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetProfileTasks<TResponse>(PostData, GetProfileTasksRequestParameters)

GET on /_plugins/_ml/profile/tasks

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetProfileTasks<TResponse>(string, PostData, GetProfileTasksRequestParameters)

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

Declaration

public TResponse GetProfileTasks<TResponse>(string taskId, PostData body, GetProfileTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

GetProfile<TResponse>(PostData, GetProfileRequestParameters)

GET on /_plugins/_ml/profile

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetStatsAsync<TResponse>(string, GetStatsRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStatsAsync<TResponse>(string, string, GetStatsRequestParameters, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
string	nodeId
string	stat
GetStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStatsForAllAsync<TResponse>(GetStatsRequestParameters, CancellationToken)

GET on /_plugins/_ml/stats

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStatsForAllAsync<TResponse>(string, GetStatsRequestParameters, CancellationToken)

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

Declaration

public Task<TResponse> GetStatsForAllAsync<TResponse>(string stat, GetStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStatsForAll<TResponse>(GetStatsRequestParameters)

GET on /_plugins/_ml/stats

Declaration

public TResponse GetStatsForAll<TResponse>(GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStatsForAll<TResponse>(string, GetStatsRequestParameters)

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

Declaration

public TResponse GetStatsForAll<TResponse>(string stat, GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStats<TResponse>(string, GetStatsRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetStats<TResponse>(string, string, GetStatsRequestParameters)

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

Declaration

public TResponse GetStats<TResponse>(string nodeId, string stat, GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId
string	stat
GetStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

GetToolAsync<TResponse>(string, GetToolRequestParameters, CancellationToken)

GET on /_plugins/_ml/tools/{tool_name}

Declaration

public Task<TResponse> GetToolAsync<TResponse>(string toolName, GetToolRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

GetTool<TResponse>(string, GetToolRequestParameters)

GET on /_plugins/_ml/tools/{tool_name}

Declaration

public TResponse GetTool<TResponse>(string toolName, GetToolRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

LoadModelAsync<TResponse>(string, LoadModelRequestParameters, CancellationToken)

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

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `deploy_model` instead.")]
public Task<TResponse> LoadModelAsync<TResponse>(string modelId, LoadModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

LoadModel<TResponse>(string, LoadModelRequestParameters)

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

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `deploy_model` instead.")]
public TResponse LoadModel<TResponse>(string modelId, LoadModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PredictAsync<TResponse>(string, string, PostData, PredictRequestParameters, CancellationToken)

POST on /_plugins/_ml/_predict/{algorithm_name}/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

PredictModelAsync<TResponse>(string, PostData, PredictModelRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

PredictModel<TResponse>(string, PostData, PredictModelRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

Predict<TResponse>(string, string, PostData, PredictRequestParameters)

POST on /_plugins/_ml/_predict/{algorithm_name}/{model_id}

Declaration

public TResponse Predict<TResponse>(string algorithmName, string modelId, PostData body, PredictRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	algorithmName
string	modelId
PostData	body
PredictRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

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

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

RegisterModelMetaAsync<TResponse>(PostData, RegisterModelMetaRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/_register_meta

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

RegisterModelMeta<TResponse>(PostData, RegisterModelMetaRequestParameters)

POST on /_plugins/_ml/models/_register_meta

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

SearchAgentsAsync<TResponse>(PostData, SearchAgentsRequestParameters, CancellationToken)

POST on /_plugins/_ml/agents/_search

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

SearchAgents<TResponse>(PostData, SearchAgentsRequestParameters)

POST on /_plugins/_ml/agents/_search

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

SearchConnectorsAsync<TResponse>(PostData, SearchConnectorsRequestParameters, CancellationToken)

POST on /_plugins/_ml/connectors/_search

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

SearchConnectors<TResponse>(PostData, SearchConnectorsRequestParameters)

POST on /_plugins/_ml/connectors/_search

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

SearchMemoryAsync<TResponse>(PostData, SearchMemoryRequestParameters, CancellationToken)

POST on /_plugins/_ml/memory/_search

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

SearchMemory<TResponse>(PostData, SearchMemoryRequestParameters)

POST on /_plugins/_ml/memory/_search

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

SearchMessageAsync<TResponse>(string, PostData, SearchMessageRequestParameters, CancellationToken)

POST on /_plugins/_ml/memory/{memory_id}/_search

Declaration

public Task<TResponse> SearchMessageAsync<TResponse>(string memoryId, PostData body, SearchMessageRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

SearchMessage<TResponse>(string, PostData, SearchMessageRequestParameters)

POST on /_plugins/_ml/memory/{memory_id}/_search

Declaration

public TResponse SearchMessage<TResponse>(string memoryId, PostData body, SearchMessageRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

SearchModelGroupAsync<TResponse>(PostData, SearchModelGroupRequestParameters, CancellationToken)

POST on /_plugins/_ml/model_groups/_search

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

SearchModelGroup<TResponse>(PostData, SearchModelGroupRequestParameters)

POST on /_plugins/_ml/model_groups/_search

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

SearchModelsAsync<TResponse>(PostData, SearchModelsRequestParameters, CancellationToken)

POST 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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

SearchModels<TResponse>(PostData, SearchModelsRequestParameters)

POST 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

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

SearchTasksAsync<TResponse>(PostData, SearchTasksRequestParameters, CancellationToken)

POST on /_plugins/_ml/tasks/_search

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

SearchTasks<TResponse>(PostData, SearchTasksRequestParameters)

POST on /_plugins/_ml/tasks/_search

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

TrainAsync<TResponse>(string, PostData, TrainRequestParameters, CancellationToken)

POST on /_plugins/_ml/_train/{algorithm_name}

Declaration

public Task<TResponse> TrainAsync<TResponse>(string algorithmName, PostData body, TrainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

TrainPredictAsync<TResponse>(string, PostData, TrainPredictRequestParameters, CancellationToken)

POST on /_plugins/_ml/_train_predict/{algorithm_name}

Declaration

public Task<TResponse> TrainPredictAsync<TResponse>(string algorithmName, PostData body, TrainPredictRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

TrainPredict<TResponse>(string, PostData, TrainPredictRequestParameters)

POST on /_plugins/_ml/_train_predict/{algorithm_name}

Declaration

public TResponse TrainPredict<TResponse>(string algorithmName, PostData body, TrainPredictRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

Train<TResponse>(string, PostData, TrainRequestParameters)

POST on /_plugins/_ml/_train/{algorithm_name}

Declaration

public TResponse Train<TResponse>(string algorithmName, PostData body, TrainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 1.3.0 or greater.

UndeployModelAsync<TResponse>(PostData, UndeployModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/_undeploy

Declaration

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

Parameters

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UndeployModelAsync<TResponse>(string, PostData, UndeployModelRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UndeployModel<TResponse>(PostData, UndeployModelRequestParameters)

POST on /_plugins/_ml/models/_undeploy

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UndeployModel<TResponse>(string, PostData, UndeployModelRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UnloadModelAsync<TResponse>(PostData, UnloadModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/_unload

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `undeploy_model` instead.")]
public Task<TResponse> UnloadModelAsync<TResponse>(PostData body, UnloadModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UnloadModelAsync<TResponse>(string, PostData, UnloadModelRequestParameters, CancellationToken)

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

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `undeploy_model` instead.")]
public Task<TResponse> UnloadModelAsync<TResponse>(string modelId, PostData body, UnloadModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UnloadModel<TResponse>(PostData, UnloadModelRequestParameters)

POST on /_plugins/_ml/models/_unload

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `undeploy_model` instead.")]
public TResponse UnloadModel<TResponse>(PostData body, UnloadModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UnloadModel<TResponse>(string, PostData, UnloadModelRequestParameters)

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

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `undeploy_model` instead.")]
public TResponse UnloadModel<TResponse>(string modelId, PostData body, UnloadModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UpdateConnectorAsync<TResponse>(string, PostData, UpdateConnectorRequestParameters, CancellationToken)

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

Declaration

public Task<TResponse> UpdateConnectorAsync<TResponse>(string connectorId, PostData body, UpdateConnectorRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateConnector<TResponse>(string, PostData, UpdateConnectorRequestParameters)

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

Declaration

public TResponse UpdateConnector<TResponse>(string connectorId, PostData body, UpdateConnectorRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateControllerAsync<TResponse>(string, PostData, UpdateControllerRequestParameters, CancellationToken)

PUT on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateController<TResponse>(string, PostData, UpdateControllerRequestParameters)

PUT on /_plugins/_ml/controllers/{model_id}

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateMemoryAsync<TResponse>(string, PostData, UpdateMemoryRequestParameters, CancellationToken)

PUT on /_plugins/_ml/memory/{memory_id}

Declaration

public Task<TResponse> UpdateMemoryAsync<TResponse>(string memoryId, PostData body, UpdateMemoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateMemory<TResponse>(string, PostData, UpdateMemoryRequestParameters)

PUT on /_plugins/_ml/memory/{memory_id}

Declaration

public TResponse UpdateMemory<TResponse>(string memoryId, PostData body, UpdateMemoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateMessageAsync<TResponse>(string, PostData, UpdateMessageRequestParameters, CancellationToken)

PUT on /_plugins/_ml/memory/message/{message_id}

Declaration

public Task<TResponse> UpdateMessageAsync<TResponse>(string messageId, PostData body, UpdateMessageRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateMessage<TResponse>(string, PostData, UpdateMessageRequestParameters)

PUT on /_plugins/_ml/memory/message/{message_id}

Declaration

public TResponse UpdateMessage<TResponse>(string messageId, PostData body, UpdateMessageRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateModelAsync<TResponse>(string, PostData, UpdateModelRequestParameters, CancellationToken)

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UpdateModelGroupAsync<TResponse>(string, PostData, UpdateModelGroupRequestParameters, CancellationToken)

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

Declaration

public Task<TResponse> UpdateModelGroupAsync<TResponse>(string modelGroupId, PostData body, UpdateModelGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

UpdateModelGroup<TResponse>(string, PostData, UpdateModelGroupRequestParameters)

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

Declaration

public TResponse UpdateModelGroup<TResponse>(string modelGroupId, PostData body, UpdateModelGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

UpdateModel<TResponse>(string, PostData, UpdateModelRequestParameters)

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

UploadChunkAsync<TResponse>(string, long?, PostData, UploadChunkRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/{model_id}/upload_chunk/{chunk_number}

Declaration

public Task<TResponse> UploadChunkAsync<TResponse>(string modelId, long? chunkNumber, PostData body, UploadChunkRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId
long?	chunkNumber
PostData	body
UploadChunkRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UploadChunk<TResponse>(string, long?, PostData, UploadChunkRequestParameters)

POST on /_plugins/_ml/models/{model_id}/upload_chunk/{chunk_number}

Declaration

public TResponse UploadChunk<TResponse>(string modelId, long? chunkNumber, PostData body, UploadChunkRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	modelId
long?	chunkNumber
PostData	body
UploadChunkRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

UploadModelAsync<TResponse>(PostData, UploadModelRequestParameters, CancellationToken)

POST on /_plugins/_ml/models/_upload

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `register_model` instead.")]
public Task<TResponse> UploadModelAsync<TResponse>(PostData body, UploadModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UploadModel<TResponse>(PostData, UploadModelRequestParameters)

POST on /_plugins/_ml/models/_upload

Declaration

[Obsolete("Deprecated in version 2.7.0: Use `register_model` instead.")]
public TResponse UploadModel<TResponse>(PostData body, UploadModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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