NAME
OpenSearch::Client::Core::3_0::Direct::ML
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->ml-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Machine Learning APIs
OpenSearch supports ML models that you can use to enhance search relevance through semantic understanding. You can either deploy models directly within your OpenSearch cluster or connect to models hosted on external platforms. These models can transform text into vector embeddings, enabling semantic search capabilities, or provide advanced features like text generation and question answering.
See OpenSearch documentation for ml.
METHODS
add_agentic_memory
Add agentic memory to a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->add_agentic_memory(
'body' => $body, # optional
# path parameters
'memory_container_id' => $memory_container_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->add_agentic_memory
chunk_model
Uploads model chunk.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->chunk_model(
'body' => $body, # optional
# path parameters
'chunk_number' => $chunk_number, # required
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->chunk_model
create_connector
Creates a standalone connector.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->create_connector(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_connector
create_controller
Creates a controller.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->create_controller(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_controller
create_memory
Create a memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->create_memory(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_memory
create_memory_container
Create a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->create_memory_container(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_memory_container
create_memory_container_session
Create session in a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->create_memory_container_session(
'body' => $body, # optional
# path parameters
'memory_container_id' => $memory_container_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_memory_container_session
create_message
Create a message.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->create_message(
'body' => $body, # optional
# path parameters
'memory_id' => $memory_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_message
create_model_meta
Registers model metadata.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->create_model_meta(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->create_model_meta
delete_agent
Delete an agent.
Paths served by this method:
Method added in OpenSearch version 2.13
$resp = $client->ml->delete_agent(
# path parameters
'agent_id' => $agent_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_agent
delete_agentic_memory
Delete a specific memory by its type and ID.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->delete_agentic_memory(
# path parameters
'id' => $id, # required
'memory_container_id' => $memory_container_id, # required
'type' => $type, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_agentic_memory
delete_agentic_memory_query
Delete multiple memories using a query to match specific criteria.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->delete_agentic_memory_query(
'body' => $body, # optional
# path parameters
'memory_container_id' => $memory_container_id, # required
'type' => $type, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_agentic_memory_query
delete_connector
Deletes a standalone connector.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->delete_connector(
# path parameters
'connector_id' => $connector_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_connector
delete_controller
Deletes a controller.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->delete_controller(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_controller
delete_memory
Delete a memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->delete_memory(
# path parameters
'memory_id' => $memory_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_memory
delete_memory_container
Delete a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->delete_memory_container(
# path parameters
'memory_container_id' => $memory_container_id, # required
# Endpoint specific query string parameters
'delete_all_memories' => $qval1, # boolean
'delete_memories' => $qval2, # list
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for ml->delete_memory_container
delete_model
Deletes a model.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->delete_model(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_model
delete_model_group
Deletes a model group.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->delete_model_group(
# path parameters
'model_group_id' => $model_group_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_model_group
delete_task
Deletes a task.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->delete_task(
# path parameters
'task_id' => $task_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->delete_task
deploy_model
Deploys a model.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->ml->deploy_model(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->deploy_model
execute_agent
Execute an agent.
Paths served by this method:
Method added in OpenSearch version 2.13
$resp = $client->ml->execute_agent(
'body' => $body, # optional
# path parameters
'agent_id' => $agent_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->execute_agent
execute_agent_stream
Execute an agent in streaming mode.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->execute_agent_stream(
'body' => $body, # optional
# path parameters
'agent_id' => $agent_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->execute_agent_stream
execute_algorithm
Execute an algorithm.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->ml->execute_algorithm(
'body' => $body, # optional
# path parameters
'algorithm_name' => $algorithm_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->execute_algorithm
execute_tool
Execute a tool.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->execute_tool(
'body' => $body, # optional
# path parameters
'tool_name' => $tool_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->execute_tool
get_agent
Get an agent.
Paths served by this method:
Method added in OpenSearch version 2.13
$resp = $client->ml->get_agent(
# path parameters
'agent_id' => $agent_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_agent
get_agentic_memory
Get a specific memory by its type and ID.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->get_agentic_memory(
# path parameters
'id' => $id, # required
'memory_container_id' => $memory_container_id, # required
'type' => $type, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_agentic_memory
get_all_memories
Get all memories.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_all_memories(
# Endpoint specific query string parameters
'max_results' => $qval1, # number
'next_token' => $qval2, # number
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for ml->get_all_memories
get_all_messages
Get all messages in a memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_all_messages(
# path parameters
'memory_id' => $memory_id, # required
# Endpoint specific query string parameters
'max_results' => $qval1, # number
'next_token' => $qval2, # number
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for ml->get_all_messages
get_all_tools
Get tools.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_all_tools(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_all_tools
get_connector
Retrieves a standalone connector.
Paths served by this method:
Method added in OpenSearch version 2.11
$resp = $client->ml->get_connector(
# path parameters
'connector_id' => $connector_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_connector
get_controller
Retrieves a controller.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_controller(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_controller
get_memory
Get a memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_memory(
# path parameters
'memory_id' => $memory_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_memory
get_memory_container
Get a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->get_memory_container(
# path parameters
'memory_container_id' => $memory_container_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_memory_container
get_message
Get a message.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_message(
# path parameters
'message_id' => $message_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_message
get_message_traces
Get a message traces.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_message_traces(
# path parameters
'message_id' => $message_id, # required
# Endpoint specific query string parameters
'max_results' => $qval1, # number
'next_token' => $qval2, # number
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for ml->get_message_traces
get_model
Retrieves a model.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->get_model(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_model
get_model_group
Retrieves a model group.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->get_model_group(
# path parameters
'model_group_id' => $model_group_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_model_group
get_profile
Get a profile.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->ml->get_profile(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_profile
get_profile_models
Get a profile models.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->ml->get_profile_models(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_profile_models
get_profile_tasks
Get a profile tasks.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->ml->get_profile_tasks(
'body' => $body, # optional
# path parameters
'task_id' => $task_id, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_profile_tasks
get_stats
Get stats.
Paths served by this method:
GET /_plugins/_ml/statsGET /_plugins/_ml/stats/{stat}GET /_plugins/_ml/{node_id}/statsGET /_plugins/_ml/{node_id}/stats/{stat}
Method added in OpenSearch version 1.3
$resp = $client->ml->get_stats(
# path parameters
'node_id' => $node_id, # optional
'stat' => $stat, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_stats
get_task
Retrieves a task.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->get_task(
# path parameters
'task_id' => $task_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_task
get_tool
Get tools.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->get_tool(
# path parameters
'tool_name' => $tool_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->get_tool
load_model
Deploys a model.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->load_model(
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->load_model
predict
Predicts new data with trained model.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->predict(
'body' => $body, # optional
# path parameters
'algorithm_name' => $algorithm_name, # required
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->predict
predict_model
Predicts a model.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->predict_model(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->predict_model
predict_model_stream
Predicts a model in streaming mode.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->predict_model_stream(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->predict_model_stream
register_agents
Register an agent.
Paths served by this method:
Method added in OpenSearch version 2.13
$resp = $client->ml->register_agents(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->register_agents
register_model
Registers a model.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->ml->register_model(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->register_model
register_model_group
Registers a model group.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->register_model_group(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->register_model_group
register_model_meta
Registers model metadata.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->ml->register_model_meta(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->register_model_meta
search_agentic_memory
Search for memories of a specific type within a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->search_agentic_memory(
'body' => $body, # optional
# path parameters
'memory_container_id' => $memory_container_id, # required
'type' => $type, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_agentic_memory
search_agents
Search agents.
Paths served by this method:
Method added in OpenSearch version 2.13
$resp = $client->ml->search_agents(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_agents
search_connectors
Searches for standalone connectors.
Paths served by this method:
Method added in OpenSearch version 2.11
$resp = $client->ml->search_connectors(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_connectors
search_memory
Search memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->search_memory(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_memory
search_memory_container
Search memory containers.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->search_memory_container(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_memory_container
search_message
Search messages.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->search_message(
'body' => $body, # optional
# path parameters
'memory_id' => $memory_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_message
search_model_group
Searches for model groups.
Paths served by this method:
Method added in OpenSearch version 2.9
$resp = $client->ml->search_model_group(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_model_group
search_models
Searches for models.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->search_models(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_models
search_tasks
Searches for tasks.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->search_tasks(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->search_tasks
train
Trains a model synchronously.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->train(
'body' => $body, # optional
# path parameters
'algorithm_name' => $algorithm_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->train
train_predict
Trains a model and predicts against the same training dataset.
Paths served by this method:
Method added in OpenSearch version 1.3
$resp = $client->ml->train_predict(
'body' => $body, # optional
# path parameters
'algorithm_name' => $algorithm_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->train_predict
undeploy_model
Undeploys a model.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->ml->undeploy_model(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->undeploy_model
unload_model
Unloads a model.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->unload_model(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->unload_model
update_agentic_memory
Update a specific memory by its type and ID.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->update_agentic_memory(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'memory_container_id' => $memory_container_id, # required
'type' => $type, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_agentic_memory
update_connector
Updates a standalone connector.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->update_connector(
'body' => $body, # optional
# path parameters
'connector_id' => $connector_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_connector
update_controller
Updates a controller.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->update_controller(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_controller
update_memory
Update a memory.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->update_memory(
'body' => $body, # optional
# path parameters
'memory_id' => $memory_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_memory
update_memory_container
Update a memory container.
Paths served by this method:
Method added in OpenSearch version 3.3
$resp = $client->ml->update_memory_container(
'body' => $body, # optional
# path parameters
'memory_container_id' => $memory_container_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_memory_container
update_message
Update a message.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->update_message(
'body' => $body, # optional
# path parameters
'message_id' => $message_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_message
update_model
Updates a model.
Paths served by this method:
Method added in OpenSearch version 2.12
$resp = $client->ml->update_model(
'body' => $body, # optional
# path parameters
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_model
update_model_group
Updates a model group.
Paths served by this method:
Method added in OpenSearch version 2.9
$resp = $client->ml->update_model_group(
'body' => $body, # optional
# path parameters
'model_group_id' => $model_group_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->update_model_group
upload_chunk
Uploads model chunk.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->ml->upload_chunk(
'body' => $body, # optional
# path parameters
'chunk_number' => $chunk_number, # required
'model_id' => $model_id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->upload_chunk
upload_model
Registers a model.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->ml->upload_model(
'body' => $body, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ml->upload_model
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->ml->method_supported_in_version(
method => 'add_agentic_memory',
version => '2.4.0'
);Both method and version are required.
See also global_method_supported_in_version
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004