Class ExecuteToolRequest

Request for ExecuteTool

Inheritance
object
RequestBase<ExecuteToolRequestParameters>
PlainRequestBase<ExecuteToolRequestParameters>
ExecuteToolRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ExecuteToolRequest : PlainRequestBase<ExecuteToolRequestParameters>, IExecuteToolRequest, IRequest<ExecuteToolRequestParameters>, IRequest

Constructors

| Edit this page View Source

ExecuteToolRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected ExecuteToolRequest()
| Edit this page View Source

ExecuteToolRequest(Name)

/_plugins/_ml/tools/_execute/{tool_name}

Declaration
public ExecuteToolRequest(Name toolName)
Parameters
Type Name Description
Name toolName

this parameter is required

Fields

| Edit this page View Source

MinimumServerVersion

Minimum OpenSearch version required for this API.

Declaration
public const string MinimumServerVersion = "3.3"
Field Value
Type Description
string

Properties

| Edit this page View Source

Parameters

Declaration
public IParameters Parameters { get; set; }
Property Value
Type Description
IParameters
| Edit this page View Source

Self

Declaration
protected IExecuteToolRequest Self { get; }
Property Value
Type Description
IExecuteToolRequest

Implements

Extension Methods