Search Results for

    Show / Hide Table of Contents

    Class MlNamespace

    Ml implementation.

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

    Inheritance
    object
    NamespacedClientProxy
    MlNamespace
    Implements
    IMlNamespace
    Inherited Members
    NamespacedClientProxy.DoCat<TRequest, TParams, TCatRecord>(TRequest)
    NamespacedClientProxy.DoCatAsync<TRequest, TParams, TCatRecord>(TRequest, CancellationToken)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client.Specification.MlApi
    Assembly: OpenSearch.Client.dll
    Syntax
    public class MlNamespace : NamespacedClientProxy, IMlNamespace

    Methods

    | Edit this page View Source

    AddAgenticMemory(IAddAgenticMemoryRequest)

    POST request to the ml.add_agentic_memory API, read more about this API online:

    Declaration
    public AddAgenticMemoryResponse AddAgenticMemory(IAddAgenticMemoryRequest request)
    Parameters
    Type Name Description
    IAddAgenticMemoryRequest request
    Returns
    Type Description
    AddAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    AddAgenticMemory(Id, Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest>)

    POST request to the ml.add_agentic_memory API, read more about this API online:

    Declaration
    public AddAgenticMemoryResponse AddAgenticMemory(Id memoryContainerId, Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest> selector
    Returns
    Type Description
    AddAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    AddAgenticMemoryAsync(IAddAgenticMemoryRequest, CancellationToken)

    POST request to the ml.add_agentic_memory API, read more about this API online:

    Declaration
    public Task<AddAgenticMemoryResponse> AddAgenticMemoryAsync(IAddAgenticMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IAddAgenticMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<AddAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    AddAgenticMemoryAsync(Id, Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest>, CancellationToken)

    POST request to the ml.add_agentic_memory API, read more about this API online:

    Declaration
    public Task<AddAgenticMemoryResponse> AddAgenticMemoryAsync(Id memoryContainerId, Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<AddAgenticMemoryDescriptor, IAddAgenticMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<AddAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    ChunkModel(IChunkModelRequest)

    POST request to the ml.chunk_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `upload_chunk` instead.")]
    public ChunkModelResponse ChunkModel(IChunkModelRequest request)
    Parameters
    Type Name Description
    IChunkModelRequest request
    Returns
    Type Description
    ChunkModelResponse
    | Edit this page View Source

    ChunkModel(Func<ChunkModelDescriptor, IChunkModelRequest>)

    POST request to the ml.chunk_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `upload_chunk` instead.")]
    public ChunkModelResponse ChunkModel(Func<ChunkModelDescriptor, IChunkModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<ChunkModelDescriptor, IChunkModelRequest> selector
    Returns
    Type Description
    ChunkModelResponse
    | Edit this page View Source

    ChunkModelAsync(IChunkModelRequest, CancellationToken)

    POST request to the ml.chunk_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `upload_chunk` instead.")]
    public Task<ChunkModelResponse> ChunkModelAsync(IChunkModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IChunkModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<ChunkModelResponse>
    | Edit this page View Source

    ChunkModelAsync(Func<ChunkModelDescriptor, IChunkModelRequest>, CancellationToken)

    POST request to the ml.chunk_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `upload_chunk` instead.")]
    public Task<ChunkModelResponse> ChunkModelAsync(Func<ChunkModelDescriptor, IChunkModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<ChunkModelDescriptor, IChunkModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<ChunkModelResponse>
    | Edit this page View Source

    CreateConnector(ICreateConnectorRequest)

    POST request to the ml.create_connector API, read more about this API online:

    Declaration
    public CreateConnectorResponse CreateConnector(ICreateConnectorRequest request)
    Parameters
    Type Name Description
    ICreateConnectorRequest request
    Returns
    Type Description
    CreateConnectorResponse
    | Edit this page View Source

    CreateConnector(Func<CreateConnectorDescriptor, ICreateConnectorRequest>)

    POST request to the ml.create_connector API, read more about this API online:

    Declaration
    public CreateConnectorResponse CreateConnector(Func<CreateConnectorDescriptor, ICreateConnectorRequest> selector = null)
    Parameters
    Type Name Description
    Func<CreateConnectorDescriptor, ICreateConnectorRequest> selector
    Returns
    Type Description
    CreateConnectorResponse
    | Edit this page View Source

    CreateConnectorAsync(ICreateConnectorRequest, CancellationToken)

    POST request to the ml.create_connector API, read more about this API online:

    Declaration
    public Task<CreateConnectorResponse> CreateConnectorAsync(ICreateConnectorRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateConnectorRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateConnectorResponse>
    | Edit this page View Source

    CreateConnectorAsync(Func<CreateConnectorDescriptor, ICreateConnectorRequest>, CancellationToken)

    POST request to the ml.create_connector API, read more about this API online:

    Declaration
    public Task<CreateConnectorResponse> CreateConnectorAsync(Func<CreateConnectorDescriptor, ICreateConnectorRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CreateConnectorDescriptor, ICreateConnectorRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateConnectorResponse>
    | Edit this page View Source

    CreateController(ICreateControllerRequest)

    POST request to the ml.create_controller API, read more about this API online:

    Declaration
    public CreateControllerResponse CreateController(ICreateControllerRequest request)
    Parameters
    Type Name Description
    ICreateControllerRequest request
    Returns
    Type Description
    CreateControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateController(Id, Func<CreateControllerDescriptor, ICreateControllerRequest>)

    POST request to the ml.create_controller API, read more about this API online:

    Declaration
    public CreateControllerResponse CreateController(Id modelId, Func<CreateControllerDescriptor, ICreateControllerRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<CreateControllerDescriptor, ICreateControllerRequest> selector
    Returns
    Type Description
    CreateControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateControllerAsync(ICreateControllerRequest, CancellationToken)

    POST request to the ml.create_controller API, read more about this API online:

    Declaration
    public Task<CreateControllerResponse> CreateControllerAsync(ICreateControllerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateControllerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateControllerAsync(Id, Func<CreateControllerDescriptor, ICreateControllerRequest>, CancellationToken)

    POST request to the ml.create_controller API, read more about this API online:

    Declaration
    public Task<CreateControllerResponse> CreateControllerAsync(Id modelId, Func<CreateControllerDescriptor, ICreateControllerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<CreateControllerDescriptor, ICreateControllerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMemory(ICreateMemoryRequest)

    POST request to the ml.create_memory API, read more about this API online:

    Declaration
    public CreateMemoryResponse CreateMemory(ICreateMemoryRequest request)
    Parameters
    Type Name Description
    ICreateMemoryRequest request
    Returns
    Type Description
    CreateMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMemory(Func<CreateMemoryDescriptor, ICreateMemoryRequest>)

    POST request to the ml.create_memory API, read more about this API online:

    Declaration
    public CreateMemoryResponse CreateMemory(Func<CreateMemoryDescriptor, ICreateMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Func<CreateMemoryDescriptor, ICreateMemoryRequest> selector
    Returns
    Type Description
    CreateMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMemoryAsync(ICreateMemoryRequest, CancellationToken)

    POST request to the ml.create_memory API, read more about this API online:

    Declaration
    public Task<CreateMemoryResponse> CreateMemoryAsync(ICreateMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMemoryAsync(Func<CreateMemoryDescriptor, ICreateMemoryRequest>, CancellationToken)

    POST request to the ml.create_memory API, read more about this API online:

    Declaration
    public Task<CreateMemoryResponse> CreateMemoryAsync(Func<CreateMemoryDescriptor, ICreateMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CreateMemoryDescriptor, ICreateMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMemoryContainer(ICreateMemoryContainerRequest)

    POST request to the ml.create_memory_container API, read more about this API online:

    Declaration
    public CreateMemoryContainerResponse CreateMemoryContainer(ICreateMemoryContainerRequest request)
    Parameters
    Type Name Description
    ICreateMemoryContainerRequest request
    Returns
    Type Description
    CreateMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainer(Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest>)

    POST request to the ml.create_memory_container API, read more about this API online:

    Declaration
    public CreateMemoryContainerResponse CreateMemoryContainer(Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest> selector = null)
    Parameters
    Type Name Description
    Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest> selector
    Returns
    Type Description
    CreateMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerAsync(ICreateMemoryContainerRequest, CancellationToken)

    POST request to the ml.create_memory_container API, read more about this API online:

    Declaration
    public Task<CreateMemoryContainerResponse> CreateMemoryContainerAsync(ICreateMemoryContainerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateMemoryContainerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerAsync(Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest>, CancellationToken)

    POST request to the ml.create_memory_container API, read more about this API online:

    Declaration
    public Task<CreateMemoryContainerResponse> CreateMemoryContainerAsync(Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CreateMemoryContainerDescriptor, ICreateMemoryContainerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerSession(ICreateMemoryContainerSessionRequest)

    POST request to the ml.create_memory_container_session API, read more about this API online:

    Declaration
    public CreateMemoryContainerSessionResponse CreateMemoryContainerSession(ICreateMemoryContainerSessionRequest request)
    Parameters
    Type Name Description
    ICreateMemoryContainerSessionRequest request
    Returns
    Type Description
    CreateMemoryContainerSessionResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerSession(Id, Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest>)

    POST request to the ml.create_memory_container_session API, read more about this API online:

    Declaration
    public CreateMemoryContainerSessionResponse CreateMemoryContainerSession(Id memoryContainerId, Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest> selector
    Returns
    Type Description
    CreateMemoryContainerSessionResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerSessionAsync(ICreateMemoryContainerSessionRequest, CancellationToken)

    POST request to the ml.create_memory_container_session API, read more about this API online:

    Declaration
    public Task<CreateMemoryContainerSessionResponse> CreateMemoryContainerSessionAsync(ICreateMemoryContainerSessionRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateMemoryContainerSessionRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryContainerSessionResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMemoryContainerSessionAsync(Id, Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest>, CancellationToken)

    POST request to the ml.create_memory_container_session API, read more about this API online:

    Declaration
    public Task<CreateMemoryContainerSessionResponse> CreateMemoryContainerSessionAsync(Id memoryContainerId, Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<CreateMemoryContainerSessionDescriptor, ICreateMemoryContainerSessionRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMemoryContainerSessionResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    CreateMessage(ICreateMessageRequest)

    POST request to the ml.create_message API, read more about this API online:

    Declaration
    public CreateMessageResponse CreateMessage(ICreateMessageRequest request)
    Parameters
    Type Name Description
    ICreateMessageRequest request
    Returns
    Type Description
    CreateMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMessage(Id, Func<CreateMessageDescriptor, ICreateMessageRequest>)

    POST request to the ml.create_message API, read more about this API online:

    Declaration
    public CreateMessageResponse CreateMessage(Id memoryId, Func<CreateMessageDescriptor, ICreateMessageRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<CreateMessageDescriptor, ICreateMessageRequest> selector
    Returns
    Type Description
    CreateMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMessageAsync(ICreateMessageRequest, CancellationToken)

    POST request to the ml.create_message API, read more about this API online:

    Declaration
    public Task<CreateMessageResponse> CreateMessageAsync(ICreateMessageRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateMessageRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateMessageAsync(Id, Func<CreateMessageDescriptor, ICreateMessageRequest>, CancellationToken)

    POST request to the ml.create_message API, read more about this API online:

    Declaration
    public Task<CreateMessageResponse> CreateMessageAsync(Id memoryId, Func<CreateMessageDescriptor, ICreateMessageRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<CreateMessageDescriptor, ICreateMessageRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    CreateModelMeta(ICreateModelMetaRequest)

    POST request to the ml.create_model_meta API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `_register_meta` instead.")]
    public CreateModelMetaResponse CreateModelMeta(ICreateModelMetaRequest request)
    Parameters
    Type Name Description
    ICreateModelMetaRequest request
    Returns
    Type Description
    CreateModelMetaResponse
    | Edit this page View Source

    CreateModelMeta(Func<CreateModelMetaDescriptor, ICreateModelMetaRequest>)

    POST request to the ml.create_model_meta API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `_register_meta` instead.")]
    public CreateModelMetaResponse CreateModelMeta(Func<CreateModelMetaDescriptor, ICreateModelMetaRequest> selector = null)
    Parameters
    Type Name Description
    Func<CreateModelMetaDescriptor, ICreateModelMetaRequest> selector
    Returns
    Type Description
    CreateModelMetaResponse
    | Edit this page View Source

    CreateModelMetaAsync(ICreateModelMetaRequest, CancellationToken)

    POST request to the ml.create_model_meta API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `_register_meta` instead.")]
    public Task<CreateModelMetaResponse> CreateModelMetaAsync(ICreateModelMetaRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICreateModelMetaRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CreateModelMetaResponse>
    | Edit this page View Source

    CreateModelMetaAsync(Func<CreateModelMetaDescriptor, ICreateModelMetaRequest>, CancellationToken)

    POST request to the ml.create_model_meta API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `_register_meta` instead.")]
    public Task<CreateModelMetaResponse> CreateModelMetaAsync(Func<CreateModelMetaDescriptor, ICreateModelMetaRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CreateModelMetaDescriptor, ICreateModelMetaRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CreateModelMetaResponse>
    | Edit this page View Source

    DeleteAgent(IDeleteAgentRequest)

    DELETE request to the ml.delete_agent API, read more about this API online:

    Declaration
    public DeleteAgentResponse DeleteAgent(IDeleteAgentRequest request)
    Parameters
    Type Name Description
    IDeleteAgentRequest request
    Returns
    Type Description
    DeleteAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    DeleteAgent(Id, Func<DeleteAgentDescriptor, IDeleteAgentRequest>)

    DELETE request to the ml.delete_agent API, read more about this API online:

    Declaration
    public DeleteAgentResponse DeleteAgent(Id agentId, Func<DeleteAgentDescriptor, IDeleteAgentRequest> selector = null)
    Parameters
    Type Name Description
    Id agentId
    Func<DeleteAgentDescriptor, IDeleteAgentRequest> selector
    Returns
    Type Description
    DeleteAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    DeleteAgentAsync(IDeleteAgentRequest, CancellationToken)

    DELETE request to the ml.delete_agent API, read more about this API online:

    Declaration
    public Task<DeleteAgentResponse> DeleteAgentAsync(IDeleteAgentRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteAgentRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    DeleteAgentAsync(Id, Func<DeleteAgentDescriptor, IDeleteAgentRequest>, CancellationToken)

    DELETE request to the ml.delete_agent API, read more about this API online:

    Declaration
    public Task<DeleteAgentResponse> DeleteAgentAsync(Id agentId, Func<DeleteAgentDescriptor, IDeleteAgentRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id agentId
    Func<DeleteAgentDescriptor, IDeleteAgentRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemory(IDeleteAgenticMemoryRequest)

    DELETE request to the ml.delete_agentic_memory API, read more about this API online:

    Declaration
    public DeleteAgenticMemoryResponse DeleteAgenticMemory(IDeleteAgenticMemoryRequest request)
    Parameters
    Type Name Description
    IDeleteAgenticMemoryRequest request
    Returns
    Type Description
    DeleteAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemory(Id, Names, Id, Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest>)

    DELETE request to the ml.delete_agentic_memory API, read more about this API online:

    Declaration
    public DeleteAgenticMemoryResponse DeleteAgenticMemory(Id memoryContainerId, Names type, Id id, Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest> selector
    Returns
    Type Description
    DeleteAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryAsync(IDeleteAgenticMemoryRequest, CancellationToken)

    DELETE request to the ml.delete_agentic_memory API, read more about this API online:

    Declaration
    public Task<DeleteAgenticMemoryResponse> DeleteAgenticMemoryAsync(IDeleteAgenticMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteAgenticMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryAsync(Id, Names, Id, Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest>, CancellationToken)

    DELETE request to the ml.delete_agentic_memory API, read more about this API online:

    Declaration
    public Task<DeleteAgenticMemoryResponse> DeleteAgenticMemoryAsync(Id memoryContainerId, Names type, Id id, Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<DeleteAgenticMemoryDescriptor, IDeleteAgenticMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryQuery(IDeleteAgenticMemoryQueryRequest)

    POST request to the ml.delete_agentic_memory_query API, read more about this API online:

    Declaration
    public DeleteAgenticMemoryQueryResponse DeleteAgenticMemoryQuery(IDeleteAgenticMemoryQueryRequest request)
    Parameters
    Type Name Description
    IDeleteAgenticMemoryQueryRequest request
    Returns
    Type Description
    DeleteAgenticMemoryQueryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryQuery(Id, Names, Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest>)

    POST request to the ml.delete_agentic_memory_query API, read more about this API online:

    Declaration
    public DeleteAgenticMemoryQueryResponse DeleteAgenticMemoryQuery(Id memoryContainerId, Names type, Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest> selector
    Returns
    Type Description
    DeleteAgenticMemoryQueryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryQueryAsync(IDeleteAgenticMemoryQueryRequest, CancellationToken)

    POST request to the ml.delete_agentic_memory_query API, read more about this API online:

    Declaration
    public Task<DeleteAgenticMemoryQueryResponse> DeleteAgenticMemoryQueryAsync(IDeleteAgenticMemoryQueryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteAgenticMemoryQueryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgenticMemoryQueryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteAgenticMemoryQueryAsync(Id, Names, Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest>, CancellationToken)

    POST request to the ml.delete_agentic_memory_query API, read more about this API online:

    Declaration
    public Task<DeleteAgenticMemoryQueryResponse> DeleteAgenticMemoryQueryAsync(Id memoryContainerId, Names type, Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Func<DeleteAgenticMemoryQueryDescriptor, IDeleteAgenticMemoryQueryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteAgenticMemoryQueryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteConnector(IDeleteConnectorRequest)

    DELETE request to the ml.delete_connector API, read more about this API online:

    Declaration
    public DeleteConnectorResponse DeleteConnector(IDeleteConnectorRequest request)
    Parameters
    Type Name Description
    IDeleteConnectorRequest request
    Returns
    Type Description
    DeleteConnectorResponse
    | Edit this page View Source

    DeleteConnector(Id, Func<DeleteConnectorDescriptor, IDeleteConnectorRequest>)

    DELETE request to the ml.delete_connector API, read more about this API online:

    Declaration
    public DeleteConnectorResponse DeleteConnector(Id connectorId, Func<DeleteConnectorDescriptor, IDeleteConnectorRequest> selector = null)
    Parameters
    Type Name Description
    Id connectorId
    Func<DeleteConnectorDescriptor, IDeleteConnectorRequest> selector
    Returns
    Type Description
    DeleteConnectorResponse
    | Edit this page View Source

    DeleteConnectorAsync(IDeleteConnectorRequest, CancellationToken)

    DELETE request to the ml.delete_connector API, read more about this API online:

    Declaration
    public Task<DeleteConnectorResponse> DeleteConnectorAsync(IDeleteConnectorRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteConnectorRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteConnectorResponse>
    | Edit this page View Source

    DeleteConnectorAsync(Id, Func<DeleteConnectorDescriptor, IDeleteConnectorRequest>, CancellationToken)

    DELETE request to the ml.delete_connector API, read more about this API online:

    Declaration
    public Task<DeleteConnectorResponse> DeleteConnectorAsync(Id connectorId, Func<DeleteConnectorDescriptor, IDeleteConnectorRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id connectorId
    Func<DeleteConnectorDescriptor, IDeleteConnectorRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteConnectorResponse>
    | Edit this page View Source

    DeleteController(IDeleteControllerRequest)

    DELETE request to the ml.delete_controller API, read more about this API online:

    Declaration
    public DeleteControllerResponse DeleteController(IDeleteControllerRequest request)
    Parameters
    Type Name Description
    IDeleteControllerRequest request
    Returns
    Type Description
    DeleteControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteController(Id, Func<DeleteControllerDescriptor, IDeleteControllerRequest>)

    DELETE request to the ml.delete_controller API, read more about this API online:

    Declaration
    public DeleteControllerResponse DeleteController(Id modelId, Func<DeleteControllerDescriptor, IDeleteControllerRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<DeleteControllerDescriptor, IDeleteControllerRequest> selector
    Returns
    Type Description
    DeleteControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteControllerAsync(IDeleteControllerRequest, CancellationToken)

    DELETE request to the ml.delete_controller API, read more about this API online:

    Declaration
    public Task<DeleteControllerResponse> DeleteControllerAsync(IDeleteControllerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteControllerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteControllerAsync(Id, Func<DeleteControllerDescriptor, IDeleteControllerRequest>, CancellationToken)

    DELETE request to the ml.delete_controller API, read more about this API online:

    Declaration
    public Task<DeleteControllerResponse> DeleteControllerAsync(Id modelId, Func<DeleteControllerDescriptor, IDeleteControllerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<DeleteControllerDescriptor, IDeleteControllerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteMemory(IDeleteMemoryRequest)

    DELETE request to the ml.delete_memory API, read more about this API online:

    Declaration
    public DeleteMemoryResponse DeleteMemory(IDeleteMemoryRequest request)
    Parameters
    Type Name Description
    IDeleteMemoryRequest request
    Returns
    Type Description
    DeleteMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteMemory(Id, Func<DeleteMemoryDescriptor, IDeleteMemoryRequest>)

    DELETE request to the ml.delete_memory API, read more about this API online:

    Declaration
    public DeleteMemoryResponse DeleteMemory(Id memoryId, Func<DeleteMemoryDescriptor, IDeleteMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<DeleteMemoryDescriptor, IDeleteMemoryRequest> selector
    Returns
    Type Description
    DeleteMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteMemoryAsync(IDeleteMemoryRequest, CancellationToken)

    DELETE request to the ml.delete_memory API, read more about this API online:

    Declaration
    public Task<DeleteMemoryResponse> DeleteMemoryAsync(IDeleteMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteMemoryAsync(Id, Func<DeleteMemoryDescriptor, IDeleteMemoryRequest>, CancellationToken)

    DELETE request to the ml.delete_memory API, read more about this API online:

    Declaration
    public Task<DeleteMemoryResponse> DeleteMemoryAsync(Id memoryId, Func<DeleteMemoryDescriptor, IDeleteMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<DeleteMemoryDescriptor, IDeleteMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    DeleteMemoryContainer(IDeleteMemoryContainerRequest)

    DELETE request to the ml.delete_memory_container API, read more about this API online:

    Declaration
    public DeleteMemoryContainerResponse DeleteMemoryContainer(IDeleteMemoryContainerRequest request)
    Parameters
    Type Name Description
    IDeleteMemoryContainerRequest request
    Returns
    Type Description
    DeleteMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteMemoryContainer(Id, Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest>)

    DELETE request to the ml.delete_memory_container API, read more about this API online:

    Declaration
    public DeleteMemoryContainerResponse DeleteMemoryContainer(Id memoryContainerId, Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest> selector
    Returns
    Type Description
    DeleteMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteMemoryContainerAsync(IDeleteMemoryContainerRequest, CancellationToken)

    DELETE request to the ml.delete_memory_container API, read more about this API online:

    Declaration
    public Task<DeleteMemoryContainerResponse> DeleteMemoryContainerAsync(IDeleteMemoryContainerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteMemoryContainerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteMemoryContainerAsync(Id, Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest>, CancellationToken)

    DELETE request to the ml.delete_memory_container API, read more about this API online:

    Declaration
    public Task<DeleteMemoryContainerResponse> DeleteMemoryContainerAsync(Id memoryContainerId, Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<DeleteMemoryContainerDescriptor, IDeleteMemoryContainerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    DeleteModel(IDeleteModelRequest)

    DELETE request to the ml.delete_model API, read more about this API online:

    Declaration
    public DeleteModelResponse DeleteModel(IDeleteModelRequest request)
    Parameters
    Type Name Description
    IDeleteModelRequest request
    Returns
    Type Description
    DeleteModelResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteModel(Id, Func<DeleteModelDescriptor, IDeleteModelRequest>)

    DELETE request to the ml.delete_model API, read more about this API online:

    Declaration
    public DeleteModelResponse DeleteModel(Id modelId, Func<DeleteModelDescriptor, IDeleteModelRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<DeleteModelDescriptor, IDeleteModelRequest> selector
    Returns
    Type Description
    DeleteModelResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteModelAsync(IDeleteModelRequest, CancellationToken)

    DELETE request to the ml.delete_model API, read more about this API online:

    Declaration
    public Task<DeleteModelResponse> DeleteModelAsync(IDeleteModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteModelResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteModelAsync(Id, Func<DeleteModelDescriptor, IDeleteModelRequest>, CancellationToken)

    DELETE request to the ml.delete_model API, read more about this API online:

    Declaration
    public Task<DeleteModelResponse> DeleteModelAsync(Id modelId, Func<DeleteModelDescriptor, IDeleteModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<DeleteModelDescriptor, IDeleteModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteModelResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteModelGroup(IDeleteModelGroupRequest)

    DELETE request to the ml.delete_model_group API, read more about this API online:

    Declaration
    public DeleteModelGroupResponse DeleteModelGroup(IDeleteModelGroupRequest request)
    Parameters
    Type Name Description
    IDeleteModelGroupRequest request
    Returns
    Type Description
    DeleteModelGroupResponse
    | Edit this page View Source

    DeleteModelGroup(Id, Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest>)

    DELETE request to the ml.delete_model_group API, read more about this API online:

    Declaration
    public DeleteModelGroupResponse DeleteModelGroup(Id modelGroupId, Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest> selector = null)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest> selector
    Returns
    Type Description
    DeleteModelGroupResponse
    | Edit this page View Source

    DeleteModelGroupAsync(IDeleteModelGroupRequest, CancellationToken)

    DELETE request to the ml.delete_model_group API, read more about this API online:

    Declaration
    public Task<DeleteModelGroupResponse> DeleteModelGroupAsync(IDeleteModelGroupRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteModelGroupRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteModelGroupResponse>
    | Edit this page View Source

    DeleteModelGroupAsync(Id, Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest>, CancellationToken)

    DELETE request to the ml.delete_model_group API, read more about this API online:

    Declaration
    public Task<DeleteModelGroupResponse> DeleteModelGroupAsync(Id modelGroupId, Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<DeleteModelGroupDescriptor, IDeleteModelGroupRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteModelGroupResponse>
    | Edit this page View Source

    DeleteTask(IDeleteTaskRequest)

    DELETE request to the ml.delete_task API, read more about this API online:

    Declaration
    public DeleteTaskResponse DeleteTask(IDeleteTaskRequest request)
    Parameters
    Type Name Description
    IDeleteTaskRequest request
    Returns
    Type Description
    DeleteTaskResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteTask(Id, Func<DeleteTaskDescriptor, IDeleteTaskRequest>)

    DELETE request to the ml.delete_task API, read more about this API online:

    Declaration
    public DeleteTaskResponse DeleteTask(Id taskId, Func<DeleteTaskDescriptor, IDeleteTaskRequest> selector = null)
    Parameters
    Type Name Description
    Id taskId
    Func<DeleteTaskDescriptor, IDeleteTaskRequest> selector
    Returns
    Type Description
    DeleteTaskResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteTaskAsync(IDeleteTaskRequest, CancellationToken)

    DELETE request to the ml.delete_task API, read more about this API online:

    Declaration
    public Task<DeleteTaskResponse> DeleteTaskAsync(IDeleteTaskRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeleteTaskRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteTaskResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeleteTaskAsync(Id, Func<DeleteTaskDescriptor, IDeleteTaskRequest>, CancellationToken)

    DELETE request to the ml.delete_task API, read more about this API online:

    Declaration
    public Task<DeleteTaskResponse> DeleteTaskAsync(Id taskId, Func<DeleteTaskDescriptor, IDeleteTaskRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id taskId
    Func<DeleteTaskDescriptor, IDeleteTaskRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeleteTaskResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    DeployModel(IDeployModelRequest)

    POST request to the ml.deploy_model API, read more about this API online:

    Declaration
    public DeployModelResponse DeployModel(IDeployModelRequest request)
    Parameters
    Type Name Description
    IDeployModelRequest request
    Returns
    Type Description
    DeployModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    DeployModel(Id, Func<DeployModelDescriptor, IDeployModelRequest>)

    POST request to the ml.deploy_model API, read more about this API online:

    Declaration
    public DeployModelResponse DeployModel(Id modelId, Func<DeployModelDescriptor, IDeployModelRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<DeployModelDescriptor, IDeployModelRequest> selector
    Returns
    Type Description
    DeployModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    DeployModelAsync(IDeployModelRequest, CancellationToken)

    POST request to the ml.deploy_model API, read more about this API online:

    Declaration
    public Task<DeployModelResponse> DeployModelAsync(IDeployModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IDeployModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<DeployModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    DeployModelAsync(Id, Func<DeployModelDescriptor, IDeployModelRequest>, CancellationToken)

    POST request to the ml.deploy_model API, read more about this API online:

    Declaration
    public Task<DeployModelResponse> DeployModelAsync(Id modelId, Func<DeployModelDescriptor, IDeployModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<DeployModelDescriptor, IDeployModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<DeployModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    ExecuteAgent(IExecuteAgentRequest)

    POST request to the ml.execute_agent API, read more about this API online:

    Declaration
    public ExecuteAgentResponse ExecuteAgent(IExecuteAgentRequest request)
    Parameters
    Type Name Description
    IExecuteAgentRequest request
    Returns
    Type Description
    ExecuteAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    ExecuteAgent(Id, Func<ExecuteAgentDescriptor, IExecuteAgentRequest>)

    POST request to the ml.execute_agent API, read more about this API online:

    Declaration
    public ExecuteAgentResponse ExecuteAgent(Id agentId, Func<ExecuteAgentDescriptor, IExecuteAgentRequest> selector = null)
    Parameters
    Type Name Description
    Id agentId
    Func<ExecuteAgentDescriptor, IExecuteAgentRequest> selector
    Returns
    Type Description
    ExecuteAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    ExecuteAgentAsync(IExecuteAgentRequest, CancellationToken)

    POST request to the ml.execute_agent API, read more about this API online:

    Declaration
    public Task<ExecuteAgentResponse> ExecuteAgentAsync(IExecuteAgentRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IExecuteAgentRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    ExecuteAgentAsync(Id, Func<ExecuteAgentDescriptor, IExecuteAgentRequest>, CancellationToken)

    POST request to the ml.execute_agent API, read more about this API online:

    Declaration
    public Task<ExecuteAgentResponse> ExecuteAgentAsync(Id agentId, Func<ExecuteAgentDescriptor, IExecuteAgentRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id agentId
    Func<ExecuteAgentDescriptor, IExecuteAgentRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    ExecuteAlgorithm(IExecuteAlgorithmRequest)

    POST request to the ml.execute_algorithm API, read more about this API online:

    Declaration
    public ExecuteAlgorithmResponse ExecuteAlgorithm(IExecuteAlgorithmRequest request)
    Parameters
    Type Name Description
    IExecuteAlgorithmRequest request
    Returns
    Type Description
    ExecuteAlgorithmResponse
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ExecuteAlgorithm(Name, Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest>)

    POST request to the ml.execute_algorithm API, read more about this API online:

    Declaration
    public ExecuteAlgorithmResponse ExecuteAlgorithm(Name algorithmName, Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest> selector = null)
    Parameters
    Type Name Description
    Name algorithmName
    Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest> selector
    Returns
    Type Description
    ExecuteAlgorithmResponse
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ExecuteAlgorithmAsync(IExecuteAlgorithmRequest, CancellationToken)

    POST request to the ml.execute_algorithm API, read more about this API online:

    Declaration
    public Task<ExecuteAlgorithmResponse> ExecuteAlgorithmAsync(IExecuteAlgorithmRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IExecuteAlgorithmRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteAlgorithmResponse>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ExecuteAlgorithmAsync(Name, Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest>, CancellationToken)

    POST request to the ml.execute_algorithm API, read more about this API online:

    Declaration
    public Task<ExecuteAlgorithmResponse> ExecuteAlgorithmAsync(Name algorithmName, Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name algorithmName
    Func<ExecuteAlgorithmDescriptor, IExecuteAlgorithmRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteAlgorithmResponse>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ExecuteTool(IExecuteToolRequest)

    POST request to the ml.execute_tool API, read more about this API online:

    Declaration
    public ExecuteToolResponse ExecuteTool(IExecuteToolRequest request)
    Parameters
    Type Name Description
    IExecuteToolRequest request
    Returns
    Type Description
    ExecuteToolResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    ExecuteTool(Name, Func<ExecuteToolDescriptor, IExecuteToolRequest>)

    POST request to the ml.execute_tool API, read more about this API online:

    Declaration
    public ExecuteToolResponse ExecuteTool(Name toolName, Func<ExecuteToolDescriptor, IExecuteToolRequest> selector = null)
    Parameters
    Type Name Description
    Name toolName
    Func<ExecuteToolDescriptor, IExecuteToolRequest> selector
    Returns
    Type Description
    ExecuteToolResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    ExecuteToolAsync(IExecuteToolRequest, CancellationToken)

    POST request to the ml.execute_tool API, read more about this API online:

    Declaration
    public Task<ExecuteToolResponse> ExecuteToolAsync(IExecuteToolRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IExecuteToolRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteToolResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    ExecuteToolAsync(Name, Func<ExecuteToolDescriptor, IExecuteToolRequest>, CancellationToken)

    POST request to the ml.execute_tool API, read more about this API online:

    Declaration
    public Task<ExecuteToolResponse> ExecuteToolAsync(Name toolName, Func<ExecuteToolDescriptor, IExecuteToolRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name toolName
    Func<ExecuteToolDescriptor, IExecuteToolRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<ExecuteToolResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetAgent(IGetAgentRequest)

    GET request to the ml.get_agent API, read more about this API online:

    Declaration
    public GetAgentResponse GetAgent(IGetAgentRequest request)
    Parameters
    Type Name Description
    IGetAgentRequest request
    Returns
    Type Description
    GetAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    GetAgent(Id, Func<GetAgentDescriptor, IGetAgentRequest>)

    GET request to the ml.get_agent API, read more about this API online:

    Declaration
    public GetAgentResponse GetAgent(Id agentId, Func<GetAgentDescriptor, IGetAgentRequest> selector = null)
    Parameters
    Type Name Description
    Id agentId
    Func<GetAgentDescriptor, IGetAgentRequest> selector
    Returns
    Type Description
    GetAgentResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    GetAgentAsync(IGetAgentRequest, CancellationToken)

    GET request to the ml.get_agent API, read more about this API online:

    Declaration
    public Task<GetAgentResponse> GetAgentAsync(IGetAgentRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetAgentRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    GetAgentAsync(Id, Func<GetAgentDescriptor, IGetAgentRequest>, CancellationToken)

    GET request to the ml.get_agent API, read more about this API online:

    Declaration
    public Task<GetAgentResponse> GetAgentAsync(Id agentId, Func<GetAgentDescriptor, IGetAgentRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id agentId
    Func<GetAgentDescriptor, IGetAgentRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetAgentResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    GetAgenticMemory(IGetAgenticMemoryRequest)

    GET request to the ml.get_agentic_memory API, read more about this API online:

    Declaration
    public GetAgenticMemoryResponse GetAgenticMemory(IGetAgenticMemoryRequest request)
    Parameters
    Type Name Description
    IGetAgenticMemoryRequest request
    Returns
    Type Description
    GetAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetAgenticMemory(Id, Names, Id, Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest>)

    GET request to the ml.get_agentic_memory API, read more about this API online:

    Declaration
    public GetAgenticMemoryResponse GetAgenticMemory(Id memoryContainerId, Names type, Id id, Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest> selector
    Returns
    Type Description
    GetAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetAgenticMemoryAsync(IGetAgenticMemoryRequest, CancellationToken)

    GET request to the ml.get_agentic_memory API, read more about this API online:

    Declaration
    public Task<GetAgenticMemoryResponse> GetAgenticMemoryAsync(IGetAgenticMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetAgenticMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetAgenticMemoryAsync(Id, Names, Id, Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest>, CancellationToken)

    GET request to the ml.get_agentic_memory API, read more about this API online:

    Declaration
    public Task<GetAgenticMemoryResponse> GetAgenticMemoryAsync(Id memoryContainerId, Names type, Id id, Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<GetAgenticMemoryDescriptor, IGetAgenticMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetAllMemories(IGetAllMemoriesRequest)

    GET request to the ml.get_all_memories API, read more about this API online:

    Declaration
    public GetAllMemoriesResponse GetAllMemories(IGetAllMemoriesRequest request)
    Parameters
    Type Name Description
    IGetAllMemoriesRequest request
    Returns
    Type Description
    GetAllMemoriesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMemories(Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest>)

    GET request to the ml.get_all_memories API, read more about this API online:

    Declaration
    public GetAllMemoriesResponse GetAllMemories(Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest> selector
    Returns
    Type Description
    GetAllMemoriesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMemoriesAsync(IGetAllMemoriesRequest, CancellationToken)

    GET request to the ml.get_all_memories API, read more about this API online:

    Declaration
    public Task<GetAllMemoriesResponse> GetAllMemoriesAsync(IGetAllMemoriesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetAllMemoriesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllMemoriesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMemoriesAsync(Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest>, CancellationToken)

    GET request to the ml.get_all_memories API, read more about this API online:

    Declaration
    public Task<GetAllMemoriesResponse> GetAllMemoriesAsync(Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetAllMemoriesDescriptor, IGetAllMemoriesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllMemoriesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMessages(IGetAllMessagesRequest)

    GET request to the ml.get_all_messages API, read more about this API online:

    Declaration
    public GetAllMessagesResponse GetAllMessages(IGetAllMessagesRequest request)
    Parameters
    Type Name Description
    IGetAllMessagesRequest request
    Returns
    Type Description
    GetAllMessagesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMessages(Id, Func<GetAllMessagesDescriptor, IGetAllMessagesRequest>)

    GET request to the ml.get_all_messages API, read more about this API online:

    Declaration
    public GetAllMessagesResponse GetAllMessages(Id memoryId, Func<GetAllMessagesDescriptor, IGetAllMessagesRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<GetAllMessagesDescriptor, IGetAllMessagesRequest> selector
    Returns
    Type Description
    GetAllMessagesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMessagesAsync(IGetAllMessagesRequest, CancellationToken)

    GET request to the ml.get_all_messages API, read more about this API online:

    Declaration
    public Task<GetAllMessagesResponse> GetAllMessagesAsync(IGetAllMessagesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetAllMessagesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllMessagesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllMessagesAsync(Id, Func<GetAllMessagesDescriptor, IGetAllMessagesRequest>, CancellationToken)

    GET request to the ml.get_all_messages API, read more about this API online:

    Declaration
    public Task<GetAllMessagesResponse> GetAllMessagesAsync(Id memoryId, Func<GetAllMessagesDescriptor, IGetAllMessagesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<GetAllMessagesDescriptor, IGetAllMessagesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllMessagesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllTools(IGetAllToolsRequest)

    GET request to the ml.get_all_tools API, read more about this API online:

    Declaration
    public GetAllToolsResponse GetAllTools(IGetAllToolsRequest request)
    Parameters
    Type Name Description
    IGetAllToolsRequest request
    Returns
    Type Description
    GetAllToolsResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllTools(Func<GetAllToolsDescriptor, IGetAllToolsRequest>)

    GET request to the ml.get_all_tools API, read more about this API online:

    Declaration
    public GetAllToolsResponse GetAllTools(Func<GetAllToolsDescriptor, IGetAllToolsRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetAllToolsDescriptor, IGetAllToolsRequest> selector
    Returns
    Type Description
    GetAllToolsResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllToolsAsync(IGetAllToolsRequest, CancellationToken)

    GET request to the ml.get_all_tools API, read more about this API online:

    Declaration
    public Task<GetAllToolsResponse> GetAllToolsAsync(IGetAllToolsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetAllToolsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllToolsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetAllToolsAsync(Func<GetAllToolsDescriptor, IGetAllToolsRequest>, CancellationToken)

    GET request to the ml.get_all_tools API, read more about this API online:

    Declaration
    public Task<GetAllToolsResponse> GetAllToolsAsync(Func<GetAllToolsDescriptor, IGetAllToolsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetAllToolsDescriptor, IGetAllToolsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetAllToolsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetConnector(IGetConnectorRequest)

    GET request to the ml.get_connector API, read more about this API online:

    Declaration
    public GetConnectorResponse GetConnector(IGetConnectorRequest request)
    Parameters
    Type Name Description
    IGetConnectorRequest request
    Returns
    Type Description
    GetConnectorResponse
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    GetConnector(Id, Func<GetConnectorDescriptor, IGetConnectorRequest>)

    GET request to the ml.get_connector API, read more about this API online:

    Declaration
    public GetConnectorResponse GetConnector(Id connectorId, Func<GetConnectorDescriptor, IGetConnectorRequest> selector = null)
    Parameters
    Type Name Description
    Id connectorId
    Func<GetConnectorDescriptor, IGetConnectorRequest> selector
    Returns
    Type Description
    GetConnectorResponse
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    GetConnectorAsync(IGetConnectorRequest, CancellationToken)

    GET request to the ml.get_connector API, read more about this API online:

    Declaration
    public Task<GetConnectorResponse> GetConnectorAsync(IGetConnectorRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetConnectorRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetConnectorResponse>
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    GetConnectorAsync(Id, Func<GetConnectorDescriptor, IGetConnectorRequest>, CancellationToken)

    GET request to the ml.get_connector API, read more about this API online:

    Declaration
    public Task<GetConnectorResponse> GetConnectorAsync(Id connectorId, Func<GetConnectorDescriptor, IGetConnectorRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id connectorId
    Func<GetConnectorDescriptor, IGetConnectorRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetConnectorResponse>
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    GetController(IGetControllerRequest)

    GET request to the ml.get_controller API, read more about this API online:

    Declaration
    public GetControllerResponse GetController(IGetControllerRequest request)
    Parameters
    Type Name Description
    IGetControllerRequest request
    Returns
    Type Description
    GetControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetController(Id, Func<GetControllerDescriptor, IGetControllerRequest>)

    GET request to the ml.get_controller API, read more about this API online:

    Declaration
    public GetControllerResponse GetController(Id modelId, Func<GetControllerDescriptor, IGetControllerRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<GetControllerDescriptor, IGetControllerRequest> selector
    Returns
    Type Description
    GetControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetControllerAsync(IGetControllerRequest, CancellationToken)

    GET request to the ml.get_controller API, read more about this API online:

    Declaration
    public Task<GetControllerResponse> GetControllerAsync(IGetControllerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetControllerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetControllerAsync(Id, Func<GetControllerDescriptor, IGetControllerRequest>, CancellationToken)

    GET request to the ml.get_controller API, read more about this API online:

    Declaration
    public Task<GetControllerResponse> GetControllerAsync(Id modelId, Func<GetControllerDescriptor, IGetControllerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<GetControllerDescriptor, IGetControllerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMLTask(IGetMLTaskRequest)

    GET request to the ml.get_task API, read more about this API online:

    Declaration
    public GetMLTaskResponse GetMLTask(IGetMLTaskRequest request)
    Parameters
    Type Name Description
    IGetMLTaskRequest request
    Returns
    Type Description
    GetMLTaskResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetMLTask(Id, Func<GetMLTaskDescriptor, IGetMLTaskRequest>)

    GET request to the ml.get_task API, read more about this API online:

    Declaration
    public GetMLTaskResponse GetMLTask(Id taskId, Func<GetMLTaskDescriptor, IGetMLTaskRequest> selector = null)
    Parameters
    Type Name Description
    Id taskId
    Func<GetMLTaskDescriptor, IGetMLTaskRequest> selector
    Returns
    Type Description
    GetMLTaskResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetMLTaskAsync(IGetMLTaskRequest, CancellationToken)

    GET request to the ml.get_task API, read more about this API online:

    Declaration
    public Task<GetMLTaskResponse> GetMLTaskAsync(IGetMLTaskRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetMLTaskRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetMLTaskResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetMLTaskAsync(Id, Func<GetMLTaskDescriptor, IGetMLTaskRequest>, CancellationToken)

    GET request to the ml.get_task API, read more about this API online:

    Declaration
    public Task<GetMLTaskResponse> GetMLTaskAsync(Id taskId, Func<GetMLTaskDescriptor, IGetMLTaskRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id taskId
    Func<GetMLTaskDescriptor, IGetMLTaskRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetMLTaskResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetMemory(IGetMemoryRequest)

    GET request to the ml.get_memory API, read more about this API online:

    Declaration
    public GetMemoryResponse GetMemory(IGetMemoryRequest request)
    Parameters
    Type Name Description
    IGetMemoryRequest request
    Returns
    Type Description
    GetMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMemory(Id, Func<GetMemoryDescriptor, IGetMemoryRequest>)

    GET request to the ml.get_memory API, read more about this API online:

    Declaration
    public GetMemoryResponse GetMemory(Id memoryId, Func<GetMemoryDescriptor, IGetMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<GetMemoryDescriptor, IGetMemoryRequest> selector
    Returns
    Type Description
    GetMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMemoryAsync(IGetMemoryRequest, CancellationToken)

    GET request to the ml.get_memory API, read more about this API online:

    Declaration
    public Task<GetMemoryResponse> GetMemoryAsync(IGetMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMemoryAsync(Id, Func<GetMemoryDescriptor, IGetMemoryRequest>, CancellationToken)

    GET request to the ml.get_memory API, read more about this API online:

    Declaration
    public Task<GetMemoryResponse> GetMemoryAsync(Id memoryId, Func<GetMemoryDescriptor, IGetMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<GetMemoryDescriptor, IGetMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMemoryContainer(IGetMemoryContainerRequest)

    GET request to the ml.get_memory_container API, read more about this API online:

    Declaration
    public GetMemoryContainerResponse GetMemoryContainer(IGetMemoryContainerRequest request)
    Parameters
    Type Name Description
    IGetMemoryContainerRequest request
    Returns
    Type Description
    GetMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetMemoryContainer(Id, Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest>)

    GET request to the ml.get_memory_container API, read more about this API online:

    Declaration
    public GetMemoryContainerResponse GetMemoryContainer(Id memoryContainerId, Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest> selector
    Returns
    Type Description
    GetMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetMemoryContainerAsync(IGetMemoryContainerRequest, CancellationToken)

    GET request to the ml.get_memory_container API, read more about this API online:

    Declaration
    public Task<GetMemoryContainerResponse> GetMemoryContainerAsync(IGetMemoryContainerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetMemoryContainerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetMemoryContainerAsync(Id, Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest>, CancellationToken)

    GET request to the ml.get_memory_container API, read more about this API online:

    Declaration
    public Task<GetMemoryContainerResponse> GetMemoryContainerAsync(Id memoryContainerId, Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<GetMemoryContainerDescriptor, IGetMemoryContainerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    GetMessage(IGetMessageRequest)

    GET request to the ml.get_message API, read more about this API online:

    Declaration
    public GetMessageResponse GetMessage(IGetMessageRequest request)
    Parameters
    Type Name Description
    IGetMessageRequest request
    Returns
    Type Description
    GetMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessage(Id, Func<GetMessageDescriptor, IGetMessageRequest>)

    GET request to the ml.get_message API, read more about this API online:

    Declaration
    public GetMessageResponse GetMessage(Id messageId, Func<GetMessageDescriptor, IGetMessageRequest> selector = null)
    Parameters
    Type Name Description
    Id messageId
    Func<GetMessageDescriptor, IGetMessageRequest> selector
    Returns
    Type Description
    GetMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageAsync(IGetMessageRequest, CancellationToken)

    GET request to the ml.get_message API, read more about this API online:

    Declaration
    public Task<GetMessageResponse> GetMessageAsync(IGetMessageRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetMessageRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageAsync(Id, Func<GetMessageDescriptor, IGetMessageRequest>, CancellationToken)

    GET request to the ml.get_message API, read more about this API online:

    Declaration
    public Task<GetMessageResponse> GetMessageAsync(Id messageId, Func<GetMessageDescriptor, IGetMessageRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id messageId
    Func<GetMessageDescriptor, IGetMessageRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageTraces(IGetMessageTracesRequest)

    GET request to the ml.get_message_traces API, read more about this API online:

    Declaration
    public GetMessageTracesResponse GetMessageTraces(IGetMessageTracesRequest request)
    Parameters
    Type Name Description
    IGetMessageTracesRequest request
    Returns
    Type Description
    GetMessageTracesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageTraces(Id, Func<GetMessageTracesDescriptor, IGetMessageTracesRequest>)

    GET request to the ml.get_message_traces API, read more about this API online:

    Declaration
    public GetMessageTracesResponse GetMessageTraces(Id messageId, Func<GetMessageTracesDescriptor, IGetMessageTracesRequest> selector = null)
    Parameters
    Type Name Description
    Id messageId
    Func<GetMessageTracesDescriptor, IGetMessageTracesRequest> selector
    Returns
    Type Description
    GetMessageTracesResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageTracesAsync(IGetMessageTracesRequest, CancellationToken)

    GET request to the ml.get_message_traces API, read more about this API online:

    Declaration
    public Task<GetMessageTracesResponse> GetMessageTracesAsync(IGetMessageTracesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetMessageTracesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetMessageTracesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetMessageTracesAsync(Id, Func<GetMessageTracesDescriptor, IGetMessageTracesRequest>, CancellationToken)

    GET request to the ml.get_message_traces API, read more about this API online:

    Declaration
    public Task<GetMessageTracesResponse> GetMessageTracesAsync(Id messageId, Func<GetMessageTracesDescriptor, IGetMessageTracesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id messageId
    Func<GetMessageTracesDescriptor, IGetMessageTracesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetMessageTracesResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetModel(IGetModelRequest)

    GET request to the ml.get_model API, read more about this API online:

    Declaration
    public GetModelResponse GetModel(IGetModelRequest request)
    Parameters
    Type Name Description
    IGetModelRequest request
    Returns
    Type Description
    GetModelResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetModel(Id, Func<GetModelDescriptor, IGetModelRequest>)

    GET request to the ml.get_model API, read more about this API online:

    Declaration
    public GetModelResponse GetModel(Id modelId, Func<GetModelDescriptor, IGetModelRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<GetModelDescriptor, IGetModelRequest> selector
    Returns
    Type Description
    GetModelResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetModelAsync(IGetModelRequest, CancellationToken)

    GET request to the ml.get_model API, read more about this API online:

    Declaration
    public Task<GetModelResponse> GetModelAsync(IGetModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetModelResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetModelAsync(Id, Func<GetModelDescriptor, IGetModelRequest>, CancellationToken)

    GET request to the ml.get_model API, read more about this API online:

    Declaration
    public Task<GetModelResponse> GetModelAsync(Id modelId, Func<GetModelDescriptor, IGetModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<GetModelDescriptor, IGetModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetModelResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetModelGroup(IGetModelGroupRequest)

    GET request to the ml.get_model_group API, read more about this API online:

    Declaration
    public GetModelGroupResponse GetModelGroup(IGetModelGroupRequest request)
    Parameters
    Type Name Description
    IGetModelGroupRequest request
    Returns
    Type Description
    GetModelGroupResponse
    | Edit this page View Source

    GetModelGroup(Id, Func<GetModelGroupDescriptor, IGetModelGroupRequest>)

    GET request to the ml.get_model_group API, read more about this API online:

    Declaration
    public GetModelGroupResponse GetModelGroup(Id modelGroupId, Func<GetModelGroupDescriptor, IGetModelGroupRequest> selector = null)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<GetModelGroupDescriptor, IGetModelGroupRequest> selector
    Returns
    Type Description
    GetModelGroupResponse
    | Edit this page View Source

    GetModelGroupAsync(IGetModelGroupRequest, CancellationToken)

    GET request to the ml.get_model_group API, read more about this API online:

    Declaration
    public Task<GetModelGroupResponse> GetModelGroupAsync(IGetModelGroupRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetModelGroupRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetModelGroupResponse>
    | Edit this page View Source

    GetModelGroupAsync(Id, Func<GetModelGroupDescriptor, IGetModelGroupRequest>, CancellationToken)

    GET request to the ml.get_model_group API, read more about this API online:

    Declaration
    public Task<GetModelGroupResponse> GetModelGroupAsync(Id modelGroupId, Func<GetModelGroupDescriptor, IGetModelGroupRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<GetModelGroupDescriptor, IGetModelGroupRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetModelGroupResponse>
    | Edit this page View Source

    GetProfile(IGetProfileRequest)

    GET request to the ml.get_profile API, read more about this API online:

    Declaration
    public GetProfileResponse GetProfile(IGetProfileRequest request)
    Parameters
    Type Name Description
    IGetProfileRequest request
    Returns
    Type Description
    GetProfileResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfile(Func<GetProfileDescriptor, IGetProfileRequest>)

    GET request to the ml.get_profile API, read more about this API online:

    Declaration
    public GetProfileResponse GetProfile(Func<GetProfileDescriptor, IGetProfileRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetProfileDescriptor, IGetProfileRequest> selector
    Returns
    Type Description
    GetProfileResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileAsync(IGetProfileRequest, CancellationToken)

    GET request to the ml.get_profile API, read more about this API online:

    Declaration
    public Task<GetProfileResponse> GetProfileAsync(IGetProfileRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetProfileRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileAsync(Func<GetProfileDescriptor, IGetProfileRequest>, CancellationToken)

    GET request to the ml.get_profile API, read more about this API online:

    Declaration
    public Task<GetProfileResponse> GetProfileAsync(Func<GetProfileDescriptor, IGetProfileRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetProfileDescriptor, IGetProfileRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileModels(IGetProfileModelsRequest)

    GET request to the ml.get_profile_models API, read more about this API online:

    Declaration
    public GetProfileModelsResponse GetProfileModels(IGetProfileModelsRequest request)
    Parameters
    Type Name Description
    IGetProfileModelsRequest request
    Returns
    Type Description
    GetProfileModelsResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileModels(Func<GetProfileModelsDescriptor, IGetProfileModelsRequest>)

    GET request to the ml.get_profile_models API, read more about this API online:

    Declaration
    public GetProfileModelsResponse GetProfileModels(Func<GetProfileModelsDescriptor, IGetProfileModelsRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetProfileModelsDescriptor, IGetProfileModelsRequest> selector
    Returns
    Type Description
    GetProfileModelsResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileModelsAsync(IGetProfileModelsRequest, CancellationToken)

    GET request to the ml.get_profile_models API, read more about this API online:

    Declaration
    public Task<GetProfileModelsResponse> GetProfileModelsAsync(IGetProfileModelsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetProfileModelsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileModelsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileModelsAsync(Func<GetProfileModelsDescriptor, IGetProfileModelsRequest>, CancellationToken)

    GET request to the ml.get_profile_models API, read more about this API online:

    Declaration
    public Task<GetProfileModelsResponse> GetProfileModelsAsync(Func<GetProfileModelsDescriptor, IGetProfileModelsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetProfileModelsDescriptor, IGetProfileModelsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileModelsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileTasks(IGetProfileTasksRequest)

    GET request to the ml.get_profile_tasks API, read more about this API online:

    Declaration
    public GetProfileTasksResponse GetProfileTasks(IGetProfileTasksRequest request)
    Parameters
    Type Name Description
    IGetProfileTasksRequest request
    Returns
    Type Description
    GetProfileTasksResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileTasks(Func<GetProfileTasksDescriptor, IGetProfileTasksRequest>)

    GET request to the ml.get_profile_tasks API, read more about this API online:

    Declaration
    public GetProfileTasksResponse GetProfileTasks(Func<GetProfileTasksDescriptor, IGetProfileTasksRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetProfileTasksDescriptor, IGetProfileTasksRequest> selector
    Returns
    Type Description
    GetProfileTasksResponse
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileTasksAsync(IGetProfileTasksRequest, CancellationToken)

    GET request to the ml.get_profile_tasks API, read more about this API online:

    Declaration
    public Task<GetProfileTasksResponse> GetProfileTasksAsync(IGetProfileTasksRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetProfileTasksRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileTasksResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetProfileTasksAsync(Func<GetProfileTasksDescriptor, IGetProfileTasksRequest>, CancellationToken)

    GET request to the ml.get_profile_tasks API, read more about this API online:

    Declaration
    public Task<GetProfileTasksResponse> GetProfileTasksAsync(Func<GetProfileTasksDescriptor, IGetProfileTasksRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetProfileTasksDescriptor, IGetProfileTasksRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetProfileTasksResponse>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    GetStats(IGetStatsRequest)

    GET request to the ml.get_stats API, read more about this API online:

    Declaration
    public GetStatsResponse GetStats(IGetStatsRequest request)
    Parameters
    Type Name Description
    IGetStatsRequest request
    Returns
    Type Description
    GetStatsResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetStats(Func<GetStatsDescriptor, IGetStatsRequest>)

    GET request to the ml.get_stats API, read more about this API online:

    Declaration
    public GetStatsResponse GetStats(Func<GetStatsDescriptor, IGetStatsRequest> selector = null)
    Parameters
    Type Name Description
    Func<GetStatsDescriptor, IGetStatsRequest> selector
    Returns
    Type Description
    GetStatsResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetStatsAsync(IGetStatsRequest, CancellationToken)

    GET request to the ml.get_stats API, read more about this API online:

    Declaration
    public Task<GetStatsResponse> GetStatsAsync(IGetStatsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetStatsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetStatsResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetStatsAsync(Func<GetStatsDescriptor, IGetStatsRequest>, CancellationToken)

    GET request to the ml.get_stats API, read more about this API online:

    Declaration
    public Task<GetStatsResponse> GetStatsAsync(Func<GetStatsDescriptor, IGetStatsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<GetStatsDescriptor, IGetStatsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetStatsResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    GetTool(IGetToolRequest)

    GET request to the ml.get_tool API, read more about this API online:

    Declaration
    public GetToolResponse GetTool(IGetToolRequest request)
    Parameters
    Type Name Description
    IGetToolRequest request
    Returns
    Type Description
    GetToolResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetTool(Name, Func<GetToolDescriptor, IGetToolRequest>)

    GET request to the ml.get_tool API, read more about this API online:

    Declaration
    public GetToolResponse GetTool(Name toolName, Func<GetToolDescriptor, IGetToolRequest> selector = null)
    Parameters
    Type Name Description
    Name toolName
    Func<GetToolDescriptor, IGetToolRequest> selector
    Returns
    Type Description
    GetToolResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetToolAsync(IGetToolRequest, CancellationToken)

    GET request to the ml.get_tool API, read more about this API online:

    Declaration
    public Task<GetToolResponse> GetToolAsync(IGetToolRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IGetToolRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<GetToolResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    GetToolAsync(Name, Func<GetToolDescriptor, IGetToolRequest>, CancellationToken)

    GET request to the ml.get_tool API, read more about this API online:

    Declaration
    public Task<GetToolResponse> GetToolAsync(Name toolName, Func<GetToolDescriptor, IGetToolRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name toolName
    Func<GetToolDescriptor, IGetToolRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<GetToolResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    LoadModel(ILoadModelRequest)

    POST request to the ml.load_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `deploy_model` instead.")]
    public LoadModelResponse LoadModel(ILoadModelRequest request)
    Parameters
    Type Name Description
    ILoadModelRequest request
    Returns
    Type Description
    LoadModelResponse
    | Edit this page View Source

    LoadModel(Func<LoadModelDescriptor, ILoadModelRequest>)

    POST request to the ml.load_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `deploy_model` instead.")]
    public LoadModelResponse LoadModel(Func<LoadModelDescriptor, ILoadModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<LoadModelDescriptor, ILoadModelRequest> selector
    Returns
    Type Description
    LoadModelResponse
    | Edit this page View Source

    LoadModelAsync(ILoadModelRequest, CancellationToken)

    POST request to the ml.load_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `deploy_model` instead.")]
    public Task<LoadModelResponse> LoadModelAsync(ILoadModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ILoadModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<LoadModelResponse>
    | Edit this page View Source

    LoadModelAsync(Func<LoadModelDescriptor, ILoadModelRequest>, CancellationToken)

    POST request to the ml.load_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `deploy_model` instead.")]
    public Task<LoadModelResponse> LoadModelAsync(Func<LoadModelDescriptor, ILoadModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<LoadModelDescriptor, ILoadModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<LoadModelResponse>
    | Edit this page View Source

    Predict(IPredictRequest)

    POST request to the ml.predict API, read more about this API online:

    Declaration
    public PredictResponse Predict(IPredictRequest request)
    Parameters
    Type Name Description
    IPredictRequest request
    Returns
    Type Description
    PredictResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    Predict(Name, Id, Func<PredictDescriptor, IPredictRequest>)

    POST request to the ml.predict API, read more about this API online:

    Declaration
    public PredictResponse Predict(Name algorithmName, Id modelId, Func<PredictDescriptor, IPredictRequest> selector = null)
    Parameters
    Type Name Description
    Name algorithmName
    Id modelId
    Func<PredictDescriptor, IPredictRequest> selector
    Returns
    Type Description
    PredictResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    PredictAsync(IPredictRequest, CancellationToken)

    POST request to the ml.predict API, read more about this API online:

    Declaration
    public Task<PredictResponse> PredictAsync(IPredictRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IPredictRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<PredictResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    PredictAsync(Name, Id, Func<PredictDescriptor, IPredictRequest>, CancellationToken)

    POST request to the ml.predict API, read more about this API online:

    Declaration
    public Task<PredictResponse> PredictAsync(Name algorithmName, Id modelId, Func<PredictDescriptor, IPredictRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name algorithmName
    Id modelId
    Func<PredictDescriptor, IPredictRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<PredictResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    PredictModel(IPredictModelRequest)

    POST request to the ml.predict_model API, read more about this API online:

    Declaration
    public PredictModelResponse PredictModel(IPredictModelRequest request)
    Parameters
    Type Name Description
    IPredictModelRequest request
    Returns
    Type Description
    PredictModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    PredictModel(Id, Func<PredictModelDescriptor, IPredictModelRequest>)

    POST request to the ml.predict_model API, read more about this API online:

    Declaration
    public PredictModelResponse PredictModel(Id modelId, Func<PredictModelDescriptor, IPredictModelRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<PredictModelDescriptor, IPredictModelRequest> selector
    Returns
    Type Description
    PredictModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    PredictModelAsync(IPredictModelRequest, CancellationToken)

    POST request to the ml.predict_model API, read more about this API online:

    Declaration
    public Task<PredictModelResponse> PredictModelAsync(IPredictModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IPredictModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<PredictModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    PredictModelAsync(Id, Func<PredictModelDescriptor, IPredictModelRequest>, CancellationToken)

    POST request to the ml.predict_model API, read more about this API online:

    Declaration
    public Task<PredictModelResponse> PredictModelAsync(Id modelId, Func<PredictModelDescriptor, IPredictModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<PredictModelDescriptor, IPredictModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<PredictModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    RegisterAgents(IRegisterAgentsRequest)

    POST request to the ml.register_agents API, read more about this API online:

    Declaration
    public RegisterAgentsResponse RegisterAgents(IRegisterAgentsRequest request)
    Parameters
    Type Name Description
    IRegisterAgentsRequest request
    Returns
    Type Description
    RegisterAgentsResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    RegisterAgents(Func<RegisterAgentsDescriptor, IRegisterAgentsRequest>)

    POST request to the ml.register_agents API, read more about this API online:

    Declaration
    public RegisterAgentsResponse RegisterAgents(Func<RegisterAgentsDescriptor, IRegisterAgentsRequest> selector = null)
    Parameters
    Type Name Description
    Func<RegisterAgentsDescriptor, IRegisterAgentsRequest> selector
    Returns
    Type Description
    RegisterAgentsResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    RegisterAgentsAsync(IRegisterAgentsRequest, CancellationToken)

    POST request to the ml.register_agents API, read more about this API online:

    Declaration
    public Task<RegisterAgentsResponse> RegisterAgentsAsync(IRegisterAgentsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IRegisterAgentsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterAgentsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    RegisterAgentsAsync(Func<RegisterAgentsDescriptor, IRegisterAgentsRequest>, CancellationToken)

    POST request to the ml.register_agents API, read more about this API online:

    Declaration
    public Task<RegisterAgentsResponse> RegisterAgentsAsync(Func<RegisterAgentsDescriptor, IRegisterAgentsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<RegisterAgentsDescriptor, IRegisterAgentsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterAgentsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    RegisterModel(IRegisterModelRequest)

    POST request to the ml.register_model API, read more about this API online:

    Declaration
    public RegisterModelResponse RegisterModel(IRegisterModelRequest request)
    Parameters
    Type Name Description
    IRegisterModelRequest request
    Returns
    Type Description
    RegisterModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModel(Func<RegisterModelDescriptor, IRegisterModelRequest>)

    POST request to the ml.register_model API, read more about this API online:

    Declaration
    public RegisterModelResponse RegisterModel(Func<RegisterModelDescriptor, IRegisterModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<RegisterModelDescriptor, IRegisterModelRequest> selector
    Returns
    Type Description
    RegisterModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelAsync(IRegisterModelRequest, CancellationToken)

    POST request to the ml.register_model API, read more about this API online:

    Declaration
    public Task<RegisterModelResponse> RegisterModelAsync(IRegisterModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IRegisterModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelAsync(Func<RegisterModelDescriptor, IRegisterModelRequest>, CancellationToken)

    POST request to the ml.register_model API, read more about this API online:

    Declaration
    public Task<RegisterModelResponse> RegisterModelAsync(Func<RegisterModelDescriptor, IRegisterModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<RegisterModelDescriptor, IRegisterModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelGroup(IRegisterModelGroupRequest)

    POST request to the ml.register_model_group API, read more about this API online:

    Declaration
    public RegisterModelGroupResponse RegisterModelGroup(IRegisterModelGroupRequest request)
    Parameters
    Type Name Description
    IRegisterModelGroupRequest request
    Returns
    Type Description
    RegisterModelGroupResponse
    | Edit this page View Source

    RegisterModelGroup(Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest>)

    POST request to the ml.register_model_group API, read more about this API online:

    Declaration
    public RegisterModelGroupResponse RegisterModelGroup(Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest> selector = null)
    Parameters
    Type Name Description
    Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest> selector
    Returns
    Type Description
    RegisterModelGroupResponse
    | Edit this page View Source

    RegisterModelGroupAsync(IRegisterModelGroupRequest, CancellationToken)

    POST request to the ml.register_model_group API, read more about this API online:

    Declaration
    public Task<RegisterModelGroupResponse> RegisterModelGroupAsync(IRegisterModelGroupRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IRegisterModelGroupRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelGroupResponse>
    | Edit this page View Source

    RegisterModelGroupAsync(Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest>, CancellationToken)

    POST request to the ml.register_model_group API, read more about this API online:

    Declaration
    public Task<RegisterModelGroupResponse> RegisterModelGroupAsync(Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<RegisterModelGroupDescriptor, IRegisterModelGroupRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelGroupResponse>
    | Edit this page View Source

    RegisterModelMeta(IRegisterModelMetaRequest)

    POST request to the ml.register_model_meta API, read more about this API online:

    Declaration
    public RegisterModelMetaResponse RegisterModelMeta(IRegisterModelMetaRequest request)
    Parameters
    Type Name Description
    IRegisterModelMetaRequest request
    Returns
    Type Description
    RegisterModelMetaResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelMeta(Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest>)

    POST request to the ml.register_model_meta API, read more about this API online:

    Declaration
    public RegisterModelMetaResponse RegisterModelMeta(Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest> selector = null)
    Parameters
    Type Name Description
    Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest> selector
    Returns
    Type Description
    RegisterModelMetaResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelMetaAsync(IRegisterModelMetaRequest, CancellationToken)

    POST request to the ml.register_model_meta API, read more about this API online:

    Declaration
    public Task<RegisterModelMetaResponse> RegisterModelMetaAsync(IRegisterModelMetaRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IRegisterModelMetaRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelMetaResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    RegisterModelMetaAsync(Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest>, CancellationToken)

    POST request to the ml.register_model_meta API, read more about this API online:

    Declaration
    public Task<RegisterModelMetaResponse> RegisterModelMetaAsync(Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<RegisterModelMetaDescriptor, IRegisterModelMetaRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<RegisterModelMetaResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    SearchAgenticMemory(ISearchAgenticMemoryRequest)

    GET request to the ml.search_agentic_memory API, read more about this API online:

    Declaration
    public SearchAgenticMemoryResponse SearchAgenticMemory(ISearchAgenticMemoryRequest request)
    Parameters
    Type Name Description
    ISearchAgenticMemoryRequest request
    Returns
    Type Description
    SearchAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchAgenticMemory(Id, Name, Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest>)

    GET request to the ml.search_agentic_memory API, read more about this API online:

    Declaration
    public SearchAgenticMemoryResponse SearchAgenticMemory(Id memoryContainerId, Name type, Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Name type
    Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest> selector
    Returns
    Type Description
    SearchAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchAgenticMemoryAsync(ISearchAgenticMemoryRequest, CancellationToken)

    GET request to the ml.search_agentic_memory API, read more about this API online:

    Declaration
    public Task<SearchAgenticMemoryResponse> SearchAgenticMemoryAsync(ISearchAgenticMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchAgenticMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchAgenticMemoryAsync(Id, Name, Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest>, CancellationToken)

    GET request to the ml.search_agentic_memory API, read more about this API online:

    Declaration
    public Task<SearchAgenticMemoryResponse> SearchAgenticMemoryAsync(Id memoryContainerId, Name type, Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Name type
    Func<SearchAgenticMemoryDescriptor, ISearchAgenticMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchAgents(ISearchAgentsRequest)

    POST request to the ml.search_agents API, read more about this API online:

    Declaration
    public SearchAgentsResponse SearchAgents(ISearchAgentsRequest request)
    Parameters
    Type Name Description
    ISearchAgentsRequest request
    Returns
    Type Description
    SearchAgentsResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    SearchAgents(Func<SearchAgentsDescriptor, ISearchAgentsRequest>)

    POST request to the ml.search_agents API, read more about this API online:

    Declaration
    public SearchAgentsResponse SearchAgents(Func<SearchAgentsDescriptor, ISearchAgentsRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchAgentsDescriptor, ISearchAgentsRequest> selector
    Returns
    Type Description
    SearchAgentsResponse
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    SearchAgentsAsync(ISearchAgentsRequest, CancellationToken)

    POST request to the ml.search_agents API, read more about this API online:

    Declaration
    public Task<SearchAgentsResponse> SearchAgentsAsync(ISearchAgentsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchAgentsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchAgentsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    SearchAgentsAsync(Func<SearchAgentsDescriptor, ISearchAgentsRequest>, CancellationToken)

    POST request to the ml.search_agents API, read more about this API online:

    Declaration
    public Task<SearchAgentsResponse> SearchAgentsAsync(Func<SearchAgentsDescriptor, ISearchAgentsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchAgentsDescriptor, ISearchAgentsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchAgentsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.13.0 or greater.

    | Edit this page View Source

    SearchConnectors(ISearchConnectorsRequest)

    POST request to the ml.search_connectors API, read more about this API online:

    Declaration
    public SearchConnectorsResponse SearchConnectors(ISearchConnectorsRequest request)
    Parameters
    Type Name Description
    ISearchConnectorsRequest request
    Returns
    Type Description
    SearchConnectorsResponse
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    SearchConnectors(Func<SearchConnectorsDescriptor, ISearchConnectorsRequest>)

    POST request to the ml.search_connectors API, read more about this API online:

    Declaration
    public SearchConnectorsResponse SearchConnectors(Func<SearchConnectorsDescriptor, ISearchConnectorsRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchConnectorsDescriptor, ISearchConnectorsRequest> selector
    Returns
    Type Description
    SearchConnectorsResponse
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    SearchConnectorsAsync(ISearchConnectorsRequest, CancellationToken)

    POST request to the ml.search_connectors API, read more about this API online:

    Declaration
    public Task<SearchConnectorsResponse> SearchConnectorsAsync(ISearchConnectorsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchConnectorsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchConnectorsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    SearchConnectorsAsync(Func<SearchConnectorsDescriptor, ISearchConnectorsRequest>, CancellationToken)

    POST request to the ml.search_connectors API, read more about this API online:

    Declaration
    public Task<SearchConnectorsResponse> SearchConnectorsAsync(Func<SearchConnectorsDescriptor, ISearchConnectorsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchConnectorsDescriptor, ISearchConnectorsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchConnectorsResponse>
    Remarks

    Supported by OpenSearch servers of version 2.11.0 or greater.

    | Edit this page View Source

    SearchMemory(ISearchMemoryRequest)

    POST request to the ml.search_memory API, read more about this API online:

    Declaration
    public SearchMemoryResponse SearchMemory(ISearchMemoryRequest request)
    Parameters
    Type Name Description
    ISearchMemoryRequest request
    Returns
    Type Description
    SearchMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMemory(Func<SearchMemoryDescriptor, ISearchMemoryRequest>)

    POST request to the ml.search_memory API, read more about this API online:

    Declaration
    public SearchMemoryResponse SearchMemory(Func<SearchMemoryDescriptor, ISearchMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchMemoryDescriptor, ISearchMemoryRequest> selector
    Returns
    Type Description
    SearchMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMemoryAsync(ISearchMemoryRequest, CancellationToken)

    POST request to the ml.search_memory API, read more about this API online:

    Declaration
    public Task<SearchMemoryResponse> SearchMemoryAsync(ISearchMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMemoryAsync(Func<SearchMemoryDescriptor, ISearchMemoryRequest>, CancellationToken)

    POST request to the ml.search_memory API, read more about this API online:

    Declaration
    public Task<SearchMemoryResponse> SearchMemoryAsync(Func<SearchMemoryDescriptor, ISearchMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchMemoryDescriptor, ISearchMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMemoryContainer(ISearchMemoryContainerRequest)

    POST request to the ml.search_memory_container API, read more about this API online:

    Declaration
    public SearchMemoryContainerResponse SearchMemoryContainer(ISearchMemoryContainerRequest request)
    Parameters
    Type Name Description
    ISearchMemoryContainerRequest request
    Returns
    Type Description
    SearchMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchMemoryContainer(Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest>)

    POST request to the ml.search_memory_container API, read more about this API online:

    Declaration
    public SearchMemoryContainerResponse SearchMemoryContainer(Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest> selector
    Returns
    Type Description
    SearchMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchMemoryContainerAsync(ISearchMemoryContainerRequest, CancellationToken)

    POST request to the ml.search_memory_container API, read more about this API online:

    Declaration
    public Task<SearchMemoryContainerResponse> SearchMemoryContainerAsync(ISearchMemoryContainerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchMemoryContainerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchMemoryContainerAsync(Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest>, CancellationToken)

    POST request to the ml.search_memory_container API, read more about this API online:

    Declaration
    public Task<SearchMemoryContainerResponse> SearchMemoryContainerAsync(Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchMemoryContainerDescriptor, ISearchMemoryContainerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    SearchMessage(ISearchMessageRequest)

    POST request to the ml.search_message API, read more about this API online:

    Declaration
    public SearchMessageResponse SearchMessage(ISearchMessageRequest request)
    Parameters
    Type Name Description
    ISearchMessageRequest request
    Returns
    Type Description
    SearchMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMessage(Id, Func<SearchMessageDescriptor, ISearchMessageRequest>)

    POST request to the ml.search_message API, read more about this API online:

    Declaration
    public SearchMessageResponse SearchMessage(Id memoryId, Func<SearchMessageDescriptor, ISearchMessageRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<SearchMessageDescriptor, ISearchMessageRequest> selector
    Returns
    Type Description
    SearchMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMessageAsync(ISearchMessageRequest, CancellationToken)

    POST request to the ml.search_message API, read more about this API online:

    Declaration
    public Task<SearchMessageResponse> SearchMessageAsync(ISearchMessageRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchMessageRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchMessageAsync(Id, Func<SearchMessageDescriptor, ISearchMessageRequest>, CancellationToken)

    POST request to the ml.search_message API, read more about this API online:

    Declaration
    public Task<SearchMessageResponse> SearchMessageAsync(Id memoryId, Func<SearchMessageDescriptor, ISearchMessageRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<SearchMessageDescriptor, ISearchMessageRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    SearchModelGroup(ISearchModelGroupRequest)

    POST request to the ml.search_model_group API, read more about this API online:

    Declaration
    public SearchModelGroupResponse SearchModelGroup(ISearchModelGroupRequest request)
    Parameters
    Type Name Description
    ISearchModelGroupRequest request
    Returns
    Type Description
    SearchModelGroupResponse
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    SearchModelGroup(Func<SearchModelGroupDescriptor, ISearchModelGroupRequest>)

    POST request to the ml.search_model_group API, read more about this API online:

    Declaration
    public SearchModelGroupResponse SearchModelGroup(Func<SearchModelGroupDescriptor, ISearchModelGroupRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchModelGroupDescriptor, ISearchModelGroupRequest> selector
    Returns
    Type Description
    SearchModelGroupResponse
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    SearchModelGroupAsync(ISearchModelGroupRequest, CancellationToken)

    POST request to the ml.search_model_group API, read more about this API online:

    Declaration
    public Task<SearchModelGroupResponse> SearchModelGroupAsync(ISearchModelGroupRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchModelGroupRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchModelGroupResponse>
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    SearchModelGroupAsync(Func<SearchModelGroupDescriptor, ISearchModelGroupRequest>, CancellationToken)

    POST request to the ml.search_model_group API, read more about this API online:

    Declaration
    public Task<SearchModelGroupResponse> SearchModelGroupAsync(Func<SearchModelGroupDescriptor, ISearchModelGroupRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchModelGroupDescriptor, ISearchModelGroupRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchModelGroupResponse>
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    SearchModels(ISearchModelsRequest)

    POST request to the ml.search_models API, read more about this API online:

    Declaration
    public SearchModelsResponse SearchModels(ISearchModelsRequest request)
    Parameters
    Type Name Description
    ISearchModelsRequest request
    Returns
    Type Description
    SearchModelsResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchModels(Func<SearchModelsDescriptor, ISearchModelsRequest>)

    POST request to the ml.search_models API, read more about this API online:

    Declaration
    public SearchModelsResponse SearchModels(Func<SearchModelsDescriptor, ISearchModelsRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchModelsDescriptor, ISearchModelsRequest> selector
    Returns
    Type Description
    SearchModelsResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchModelsAsync(ISearchModelsRequest, CancellationToken)

    POST request to the ml.search_models API, read more about this API online:

    Declaration
    public Task<SearchModelsResponse> SearchModelsAsync(ISearchModelsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchModelsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchModelsResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchModelsAsync(Func<SearchModelsDescriptor, ISearchModelsRequest>, CancellationToken)

    POST request to the ml.search_models API, read more about this API online:

    Declaration
    public Task<SearchModelsResponse> SearchModelsAsync(Func<SearchModelsDescriptor, ISearchModelsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchModelsDescriptor, ISearchModelsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchModelsResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchTasks(ISearchTasksRequest)

    POST request to the ml.search_tasks API, read more about this API online:

    Declaration
    public SearchTasksResponse SearchTasks(ISearchTasksRequest request)
    Parameters
    Type Name Description
    ISearchTasksRequest request
    Returns
    Type Description
    SearchTasksResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchTasks(Func<SearchTasksDescriptor, ISearchTasksRequest>)

    POST request to the ml.search_tasks API, read more about this API online:

    Declaration
    public SearchTasksResponse SearchTasks(Func<SearchTasksDescriptor, ISearchTasksRequest> selector = null)
    Parameters
    Type Name Description
    Func<SearchTasksDescriptor, ISearchTasksRequest> selector
    Returns
    Type Description
    SearchTasksResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchTasksAsync(ISearchTasksRequest, CancellationToken)

    POST request to the ml.search_tasks API, read more about this API online:

    Declaration
    public Task<SearchTasksResponse> SearchTasksAsync(ISearchTasksRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ISearchTasksRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<SearchTasksResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    SearchTasksAsync(Func<SearchTasksDescriptor, ISearchTasksRequest>, CancellationToken)

    POST request to the ml.search_tasks API, read more about this API online:

    Declaration
    public Task<SearchTasksResponse> SearchTasksAsync(Func<SearchTasksDescriptor, ISearchTasksRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<SearchTasksDescriptor, ISearchTasksRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<SearchTasksResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    Train(ITrainRequest)

    POST request to the ml.train API, read more about this API online:

    Declaration
    public TrainResponse Train(ITrainRequest request)
    Parameters
    Type Name Description
    ITrainRequest request
    Returns
    Type Description
    TrainResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    Train(Name, Func<TrainDescriptor, ITrainRequest>)

    POST request to the ml.train API, read more about this API online:

    Declaration
    public TrainResponse Train(Name algorithmName, Func<TrainDescriptor, ITrainRequest> selector = null)
    Parameters
    Type Name Description
    Name algorithmName
    Func<TrainDescriptor, ITrainRequest> selector
    Returns
    Type Description
    TrainResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainAsync(ITrainRequest, CancellationToken)

    POST request to the ml.train API, read more about this API online:

    Declaration
    public Task<TrainResponse> TrainAsync(ITrainRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ITrainRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<TrainResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainAsync(Name, Func<TrainDescriptor, ITrainRequest>, CancellationToken)

    POST request to the ml.train API, read more about this API online:

    Declaration
    public Task<TrainResponse> TrainAsync(Name algorithmName, Func<TrainDescriptor, ITrainRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name algorithmName
    Func<TrainDescriptor, ITrainRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<TrainResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainPredict(ITrainPredictRequest)

    POST request to the ml.train_predict API, read more about this API online:

    Declaration
    public TrainPredictResponse TrainPredict(ITrainPredictRequest request)
    Parameters
    Type Name Description
    ITrainPredictRequest request
    Returns
    Type Description
    TrainPredictResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainPredict(Name, Func<TrainPredictDescriptor, ITrainPredictRequest>)

    POST request to the ml.train_predict API, read more about this API online:

    Declaration
    public TrainPredictResponse TrainPredict(Name algorithmName, Func<TrainPredictDescriptor, ITrainPredictRequest> selector = null)
    Parameters
    Type Name Description
    Name algorithmName
    Func<TrainPredictDescriptor, ITrainPredictRequest> selector
    Returns
    Type Description
    TrainPredictResponse
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainPredictAsync(ITrainPredictRequest, CancellationToken)

    POST request to the ml.train_predict API, read more about this API online:

    Declaration
    public Task<TrainPredictResponse> TrainPredictAsync(ITrainPredictRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ITrainPredictRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<TrainPredictResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    TrainPredictAsync(Name, Func<TrainPredictDescriptor, ITrainPredictRequest>, CancellationToken)

    POST request to the ml.train_predict API, read more about this API online:

    Declaration
    public Task<TrainPredictResponse> TrainPredictAsync(Name algorithmName, Func<TrainPredictDescriptor, ITrainPredictRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Name algorithmName
    Func<TrainPredictDescriptor, ITrainPredictRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<TrainPredictResponse>
    Remarks

    Supported by OpenSearch servers of version 1.3.0 or greater.

    | Edit this page View Source

    UndeployModel(IUndeployModelRequest)

    POST request to the ml.undeploy_model API, read more about this API online:

    Declaration
    public UndeployModelResponse UndeployModel(IUndeployModelRequest request)
    Parameters
    Type Name Description
    IUndeployModelRequest request
    Returns
    Type Description
    UndeployModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UndeployModel(Func<UndeployModelDescriptor, IUndeployModelRequest>)

    POST request to the ml.undeploy_model API, read more about this API online:

    Declaration
    public UndeployModelResponse UndeployModel(Func<UndeployModelDescriptor, IUndeployModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<UndeployModelDescriptor, IUndeployModelRequest> selector
    Returns
    Type Description
    UndeployModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UndeployModelAsync(IUndeployModelRequest, CancellationToken)

    POST request to the ml.undeploy_model API, read more about this API online:

    Declaration
    public Task<UndeployModelResponse> UndeployModelAsync(IUndeployModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUndeployModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UndeployModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UndeployModelAsync(Func<UndeployModelDescriptor, IUndeployModelRequest>, CancellationToken)

    POST request to the ml.undeploy_model API, read more about this API online:

    Declaration
    public Task<UndeployModelResponse> UndeployModelAsync(Func<UndeployModelDescriptor, IUndeployModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<UndeployModelDescriptor, IUndeployModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UndeployModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UnloadModel(IUnloadModelRequest)

    POST request to the ml.unload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `undeploy_model` instead.")]
    public UnloadModelResponse UnloadModel(IUnloadModelRequest request)
    Parameters
    Type Name Description
    IUnloadModelRequest request
    Returns
    Type Description
    UnloadModelResponse
    | Edit this page View Source

    UnloadModel(Func<UnloadModelDescriptor, IUnloadModelRequest>)

    POST request to the ml.unload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `undeploy_model` instead.")]
    public UnloadModelResponse UnloadModel(Func<UnloadModelDescriptor, IUnloadModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<UnloadModelDescriptor, IUnloadModelRequest> selector
    Returns
    Type Description
    UnloadModelResponse
    | Edit this page View Source

    UnloadModelAsync(IUnloadModelRequest, CancellationToken)

    POST request to the ml.unload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `undeploy_model` instead.")]
    public Task<UnloadModelResponse> UnloadModelAsync(IUnloadModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUnloadModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UnloadModelResponse>
    | Edit this page View Source

    UnloadModelAsync(Func<UnloadModelDescriptor, IUnloadModelRequest>, CancellationToken)

    POST request to the ml.unload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `undeploy_model` instead.")]
    public Task<UnloadModelResponse> UnloadModelAsync(Func<UnloadModelDescriptor, IUnloadModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<UnloadModelDescriptor, IUnloadModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UnloadModelResponse>
    | Edit this page View Source

    UpdateAgenticMemory(IUpdateAgenticMemoryRequest)

    PUT request to the ml.update_agentic_memory API, read more about this API online:

    Declaration
    public UpdateAgenticMemoryResponse UpdateAgenticMemory(IUpdateAgenticMemoryRequest request)
    Parameters
    Type Name Description
    IUpdateAgenticMemoryRequest request
    Returns
    Type Description
    UpdateAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateAgenticMemory(Id, Names, Id, Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest>)

    PUT request to the ml.update_agentic_memory API, read more about this API online:

    Declaration
    public UpdateAgenticMemoryResponse UpdateAgenticMemory(Id memoryContainerId, Names type, Id id, Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest> selector
    Returns
    Type Description
    UpdateAgenticMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateAgenticMemoryAsync(IUpdateAgenticMemoryRequest, CancellationToken)

    PUT request to the ml.update_agentic_memory API, read more about this API online:

    Declaration
    public Task<UpdateAgenticMemoryResponse> UpdateAgenticMemoryAsync(IUpdateAgenticMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateAgenticMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateAgenticMemoryAsync(Id, Names, Id, Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest>, CancellationToken)

    PUT request to the ml.update_agentic_memory API, read more about this API online:

    Declaration
    public Task<UpdateAgenticMemoryResponse> UpdateAgenticMemoryAsync(Id memoryContainerId, Names type, Id id, Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Names type
    Id id
    Func<UpdateAgenticMemoryDescriptor, IUpdateAgenticMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateAgenticMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateConnector(IUpdateConnectorRequest)

    PUT request to the ml.update_connector API, read more about this API online:

    Declaration
    public UpdateConnectorResponse UpdateConnector(IUpdateConnectorRequest request)
    Parameters
    Type Name Description
    IUpdateConnectorRequest request
    Returns
    Type Description
    UpdateConnectorResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateConnector(Id, Func<UpdateConnectorDescriptor, IUpdateConnectorRequest>)

    PUT request to the ml.update_connector API, read more about this API online:

    Declaration
    public UpdateConnectorResponse UpdateConnector(Id connectorId, Func<UpdateConnectorDescriptor, IUpdateConnectorRequest> selector = null)
    Parameters
    Type Name Description
    Id connectorId
    Func<UpdateConnectorDescriptor, IUpdateConnectorRequest> selector
    Returns
    Type Description
    UpdateConnectorResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateConnectorAsync(IUpdateConnectorRequest, CancellationToken)

    PUT request to the ml.update_connector API, read more about this API online:

    Declaration
    public Task<UpdateConnectorResponse> UpdateConnectorAsync(IUpdateConnectorRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateConnectorRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateConnectorResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateConnectorAsync(Id, Func<UpdateConnectorDescriptor, IUpdateConnectorRequest>, CancellationToken)

    PUT request to the ml.update_connector API, read more about this API online:

    Declaration
    public Task<UpdateConnectorResponse> UpdateConnectorAsync(Id connectorId, Func<UpdateConnectorDescriptor, IUpdateConnectorRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id connectorId
    Func<UpdateConnectorDescriptor, IUpdateConnectorRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateConnectorResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateController(IUpdateControllerRequest)

    PUT request to the ml.update_controller API, read more about this API online:

    Declaration
    public UpdateControllerResponse UpdateController(IUpdateControllerRequest request)
    Parameters
    Type Name Description
    IUpdateControllerRequest request
    Returns
    Type Description
    UpdateControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateController(Id, Func<UpdateControllerDescriptor, IUpdateControllerRequest>)

    PUT request to the ml.update_controller API, read more about this API online:

    Declaration
    public UpdateControllerResponse UpdateController(Id modelId, Func<UpdateControllerDescriptor, IUpdateControllerRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<UpdateControllerDescriptor, IUpdateControllerRequest> selector
    Returns
    Type Description
    UpdateControllerResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateControllerAsync(IUpdateControllerRequest, CancellationToken)

    PUT request to the ml.update_controller API, read more about this API online:

    Declaration
    public Task<UpdateControllerResponse> UpdateControllerAsync(IUpdateControllerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateControllerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateControllerAsync(Id, Func<UpdateControllerDescriptor, IUpdateControllerRequest>, CancellationToken)

    PUT request to the ml.update_controller API, read more about this API online:

    Declaration
    public Task<UpdateControllerResponse> UpdateControllerAsync(Id modelId, Func<UpdateControllerDescriptor, IUpdateControllerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<UpdateControllerDescriptor, IUpdateControllerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateControllerResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMemory(IUpdateMemoryRequest)

    PUT request to the ml.update_memory API, read more about this API online:

    Declaration
    public UpdateMemoryResponse UpdateMemory(IUpdateMemoryRequest request)
    Parameters
    Type Name Description
    IUpdateMemoryRequest request
    Returns
    Type Description
    UpdateMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMemory(Id, Func<UpdateMemoryDescriptor, IUpdateMemoryRequest>)

    PUT request to the ml.update_memory API, read more about this API online:

    Declaration
    public UpdateMemoryResponse UpdateMemory(Id memoryId, Func<UpdateMemoryDescriptor, IUpdateMemoryRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryId
    Func<UpdateMemoryDescriptor, IUpdateMemoryRequest> selector
    Returns
    Type Description
    UpdateMemoryResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMemoryAsync(IUpdateMemoryRequest, CancellationToken)

    PUT request to the ml.update_memory API, read more about this API online:

    Declaration
    public Task<UpdateMemoryResponse> UpdateMemoryAsync(IUpdateMemoryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateMemoryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMemoryAsync(Id, Func<UpdateMemoryDescriptor, IUpdateMemoryRequest>, CancellationToken)

    PUT request to the ml.update_memory API, read more about this API online:

    Declaration
    public Task<UpdateMemoryResponse> UpdateMemoryAsync(Id memoryId, Func<UpdateMemoryDescriptor, IUpdateMemoryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryId
    Func<UpdateMemoryDescriptor, IUpdateMemoryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMemoryResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMemoryContainer(IUpdateMemoryContainerRequest)

    PUT request to the ml.update_memory_container API, read more about this API online:

    Declaration
    public UpdateMemoryContainerResponse UpdateMemoryContainer(IUpdateMemoryContainerRequest request)
    Parameters
    Type Name Description
    IUpdateMemoryContainerRequest request
    Returns
    Type Description
    UpdateMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateMemoryContainer(Id, Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest>)

    PUT request to the ml.update_memory_container API, read more about this API online:

    Declaration
    public UpdateMemoryContainerResponse UpdateMemoryContainer(Id memoryContainerId, Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest> selector = null)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest> selector
    Returns
    Type Description
    UpdateMemoryContainerResponse
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateMemoryContainerAsync(IUpdateMemoryContainerRequest, CancellationToken)

    PUT request to the ml.update_memory_container API, read more about this API online:

    Declaration
    public Task<UpdateMemoryContainerResponse> UpdateMemoryContainerAsync(IUpdateMemoryContainerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateMemoryContainerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateMemoryContainerAsync(Id, Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest>, CancellationToken)

    PUT request to the ml.update_memory_container API, read more about this API online:

    Declaration
    public Task<UpdateMemoryContainerResponse> UpdateMemoryContainerAsync(Id memoryContainerId, Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id memoryContainerId
    Func<UpdateMemoryContainerDescriptor, IUpdateMemoryContainerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMemoryContainerResponse>
    Remarks

    Supported by OpenSearch servers of version 3.3.0 or greater.

    | Edit this page View Source

    UpdateMessage(IUpdateMessageRequest)

    PUT request to the ml.update_message API, read more about this API online:

    Declaration
    public UpdateMessageResponse UpdateMessage(IUpdateMessageRequest request)
    Parameters
    Type Name Description
    IUpdateMessageRequest request
    Returns
    Type Description
    UpdateMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMessage(Id, Func<UpdateMessageDescriptor, IUpdateMessageRequest>)

    PUT request to the ml.update_message API, read more about this API online:

    Declaration
    public UpdateMessageResponse UpdateMessage(Id messageId, Func<UpdateMessageDescriptor, IUpdateMessageRequest> selector = null)
    Parameters
    Type Name Description
    Id messageId
    Func<UpdateMessageDescriptor, IUpdateMessageRequest> selector
    Returns
    Type Description
    UpdateMessageResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMessageAsync(IUpdateMessageRequest, CancellationToken)

    PUT request to the ml.update_message API, read more about this API online:

    Declaration
    public Task<UpdateMessageResponse> UpdateMessageAsync(IUpdateMessageRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateMessageRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateMessageAsync(Id, Func<UpdateMessageDescriptor, IUpdateMessageRequest>, CancellationToken)

    PUT request to the ml.update_message API, read more about this API online:

    Declaration
    public Task<UpdateMessageResponse> UpdateMessageAsync(Id messageId, Func<UpdateMessageDescriptor, IUpdateMessageRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id messageId
    Func<UpdateMessageDescriptor, IUpdateMessageRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateMessageResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateModel(IUpdateModelRequest)

    PUT request to the ml.update_model API, read more about this API online:

    Declaration
    public UpdateModelResponse UpdateModel(IUpdateModelRequest request)
    Parameters
    Type Name Description
    IUpdateModelRequest request
    Returns
    Type Description
    UpdateModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateModel(Id, Func<UpdateModelDescriptor, IUpdateModelRequest>)

    PUT request to the ml.update_model API, read more about this API online:

    Declaration
    public UpdateModelResponse UpdateModel(Id modelId, Func<UpdateModelDescriptor, IUpdateModelRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    Func<UpdateModelDescriptor, IUpdateModelRequest> selector
    Returns
    Type Description
    UpdateModelResponse
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateModelAsync(IUpdateModelRequest, CancellationToken)

    PUT request to the ml.update_model API, read more about this API online:

    Declaration
    public Task<UpdateModelResponse> UpdateModelAsync(IUpdateModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateModelAsync(Id, Func<UpdateModelDescriptor, IUpdateModelRequest>, CancellationToken)

    PUT request to the ml.update_model API, read more about this API online:

    Declaration
    public Task<UpdateModelResponse> UpdateModelAsync(Id modelId, Func<UpdateModelDescriptor, IUpdateModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    Func<UpdateModelDescriptor, IUpdateModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateModelResponse>
    Remarks

    Supported by OpenSearch servers of version 2.12.0 or greater.

    | Edit this page View Source

    UpdateModelGroup(IUpdateModelGroupRequest)

    PUT request to the ml.update_model_group API, read more about this API online:

    Declaration
    public UpdateModelGroupResponse UpdateModelGroup(IUpdateModelGroupRequest request)
    Parameters
    Type Name Description
    IUpdateModelGroupRequest request
    Returns
    Type Description
    UpdateModelGroupResponse
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    UpdateModelGroup(Id, Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest>)

    PUT request to the ml.update_model_group API, read more about this API online:

    Declaration
    public UpdateModelGroupResponse UpdateModelGroup(Id modelGroupId, Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest> selector = null)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest> selector
    Returns
    Type Description
    UpdateModelGroupResponse
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    UpdateModelGroupAsync(IUpdateModelGroupRequest, CancellationToken)

    PUT request to the ml.update_model_group API, read more about this API online:

    Declaration
    public Task<UpdateModelGroupResponse> UpdateModelGroupAsync(IUpdateModelGroupRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUpdateModelGroupRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateModelGroupResponse>
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    UpdateModelGroupAsync(Id, Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest>, CancellationToken)

    PUT request to the ml.update_model_group API, read more about this API online:

    Declaration
    public Task<UpdateModelGroupResponse> UpdateModelGroupAsync(Id modelGroupId, Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelGroupId
    Func<UpdateModelGroupDescriptor, IUpdateModelGroupRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UpdateModelGroupResponse>
    Remarks

    Supported by OpenSearch servers of version 2.9.0 or greater.

    | Edit this page View Source

    UploadChunk(IUploadChunkRequest)

    POST request to the ml.upload_chunk API, read more about this API online:

    Declaration
    public UploadChunkResponse UploadChunk(IUploadChunkRequest request)
    Parameters
    Type Name Description
    IUploadChunkRequest request
    Returns
    Type Description
    UploadChunkResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UploadChunk(Id, long?, Func<UploadChunkDescriptor, IUploadChunkRequest>)

    POST request to the ml.upload_chunk API, read more about this API online:

    Declaration
    public UploadChunkResponse UploadChunk(Id modelId, long? chunkNumber, Func<UploadChunkDescriptor, IUploadChunkRequest> selector = null)
    Parameters
    Type Name Description
    Id modelId
    long? chunkNumber
    Func<UploadChunkDescriptor, IUploadChunkRequest> selector
    Returns
    Type Description
    UploadChunkResponse
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UploadChunkAsync(IUploadChunkRequest, CancellationToken)

    POST request to the ml.upload_chunk API, read more about this API online:

    Declaration
    public Task<UploadChunkResponse> UploadChunkAsync(IUploadChunkRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUploadChunkRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UploadChunkResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UploadChunkAsync(Id, long?, Func<UploadChunkDescriptor, IUploadChunkRequest>, CancellationToken)

    POST request to the ml.upload_chunk API, read more about this API online:

    Declaration
    public Task<UploadChunkResponse> UploadChunkAsync(Id modelId, long? chunkNumber, Func<UploadChunkDescriptor, IUploadChunkRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Id modelId
    long? chunkNumber
    Func<UploadChunkDescriptor, IUploadChunkRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UploadChunkResponse>
    Remarks

    Supported by OpenSearch servers of version 2.7.0 or greater.

    | Edit this page View Source

    UploadModel(IUploadModelRequest)

    POST request to the ml.upload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `register_model` instead.")]
    public UploadModelResponse UploadModel(IUploadModelRequest request)
    Parameters
    Type Name Description
    IUploadModelRequest request
    Returns
    Type Description
    UploadModelResponse
    | Edit this page View Source

    UploadModel(Func<UploadModelDescriptor, IUploadModelRequest>)

    POST request to the ml.upload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `register_model` instead.")]
    public UploadModelResponse UploadModel(Func<UploadModelDescriptor, IUploadModelRequest> selector = null)
    Parameters
    Type Name Description
    Func<UploadModelDescriptor, IUploadModelRequest> selector
    Returns
    Type Description
    UploadModelResponse
    | Edit this page View Source

    UploadModelAsync(IUploadModelRequest, CancellationToken)

    POST request to the ml.upload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `register_model` instead.")]
    public Task<UploadModelResponse> UploadModelAsync(IUploadModelRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    IUploadModelRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<UploadModelResponse>
    | Edit this page View Source

    UploadModelAsync(Func<UploadModelDescriptor, IUploadModelRequest>, CancellationToken)

    POST request to the ml.upload_model API, read more about this API online:

    Declaration
    [Obsolete("Deprecated as of: 2.7.0, reason: Use `register_model` instead.")]
    public Task<UploadModelResponse> UploadModelAsync(Func<UploadModelDescriptor, IUploadModelRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<UploadModelDescriptor, IUploadModelRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<UploadModelResponse>

    Implements

    IMlNamespace

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX