ML Commons Plugin

class opensearchpy.plugins.ml.MlClient(client)[source]

Bases: NamespacedClient

Parameters:: client (Any)

add_agentic_memory(*, memory_container_id, body=None, params=None, headers=None)[source]

Add agentic memory to a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

chunk_model(*, model_id, chunk_number, body=None, params=None, headers=None)[source]

Uploads model chunk.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
chunk_number (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_connector(*, body=None, params=None, headers=None)[source]

Creates a standalone connector.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_controller(*, model_id, body=None, params=None, headers=None)[source]

Creates a controller.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_memory(*, body=None, params=None, headers=None)[source]

Create a memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_memory_container(*, body=None, params=None, headers=None)[source]

Create a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_memory_container_session(*, memory_container_id, body=None, params=None, headers=None)[source]

Create session in a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_message(*, memory_id, body=None, params=None, headers=None)[source]

Create a message.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

create_model_meta(*, body=None, params=None, headers=None)[source]

Registers model metadata.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

delete_agent(*, agent_id, params=None, headers=None)[source]

Delete an agent.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
agent_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_agentic_memory(*, memory_container_id, doc_type, id, params=None, headers=None)[source]

Delete a specific memory by its type and ID.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
doc_type (Any)
id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_agentic_memory_query(*, memory_container_id, doc_type, body=None, params=None, headers=None)[source]

Delete multiple memories using a query to match specific criteria.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
doc_type (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

delete_connector(*, connector_id, params=None, headers=None)[source]

Deletes a standalone connector.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
connector_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_controller(*, model_id, params=None, headers=None)[source]

Deletes a controller.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_memory(*, memory_id, params=None, headers=None)[source]

Delete a memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_memory_container(*, memory_container_id, params=None, headers=None)[source]

Delete a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_model(*, model_id, params=None, headers=None)[source]

Deletes a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_model_group(*, model_group_id, params=None, headers=None)[source]

Deletes a model group.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_group_id (Any)
params (Any)
headers (Any)

Return type:

Any

delete_task(*, task_id, params=None, headers=None)[source]

Deletes a task.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
task_id (Any)
params (Any)
headers (Any)

Return type:

Any

deploy_model(*, model_id, params=None, headers=None)[source]

Deploys a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

execute_agent(*, agent_id, body=None, params=None, headers=None)[source]

Execute an agent.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
agent_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

execute_agent_stream(*, agent_id, body=None, params=None, headers=None)[source]

Execute an agent in streaming mode.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
agent_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

execute_algorithm(*, algorithm_name, body=None, params=None, headers=None)[source]

Execute an algorithm.

Parameters:

algorithm_name (Any) – The function name.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
algorithm_name
body (Any)
params (Any)
headers (Any)

Return type:

Any

execute_tool(*, tool_name, body=None, params=None, headers=None)[source]

Execute a tool.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tool_name (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

get_agent(*, agent_id, params=None, headers=None)[source]

Get an agent.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
agent_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_agentic_memory(*, memory_container_id, doc_type, id, params=None, headers=None)[source]

Get a specific memory by its type and ID.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
doc_type (Any)
id (Any)
params (Any)
headers (Any)

Return type:

Any

get_all_memories(*, params=None, headers=None)[source]

Get all memories.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
max_results – The maximum number of results to return. If there are fewer memories than the number set in max_results, the response returns only the number of memories that exist. Default is 10.
next_token – The index of the first memory in the sorted list of memories to return. Memories are ordered by create_time. For example, if memories A, B, and C exist, next_token=1 returns memories B and C. Default is 0 (return all memories).
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any)
headers (Any)

Return type:

Any

get_all_messages(*, memory_id, params=None, headers=None)[source]

Get all messages in a memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_all_tools(*, params=None, headers=None)[source]

Get tools.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any)
headers (Any)

Return type:

Any

get_connector(*, connector_id, params=None, headers=None)[source]

Retrieves a standalone connector.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
connector_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_controller(*, model_id, params=None, headers=None)[source]

Retrieves a controller.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_memory(*, memory_id, params=None, headers=None)[source]

Get a memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_memory_container(*, memory_container_id, params=None, headers=None)[source]

Get a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_message(*, message_id, params=None, headers=None)[source]

Get a message.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
message_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_message_traces(*, message_id, params=None, headers=None)[source]

Get a message traces.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
message_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_model(*, model_id, params=None, headers=None)[source]

Retrieves a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_model_group(*, model_group_id, params=None, headers=None)[source]

Retrieves a model group.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_group_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_profile(*, body=None, params=None, headers=None)[source]

Get a profile.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

get_profile_models(*, body=None, model_id=None, params=None, headers=None)[source]

Get a profile models.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_profile_tasks(*, body=None, task_id=None, params=None, headers=None)[source]

Get a profile tasks.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
task_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_stats(*, node_id=None, stat=None, params=None, headers=None)[source]

Get stats.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
node_id (Any)
stat (Any)
params (Any)
headers (Any)

Return type:

Any

get_task(*, task_id, params=None, headers=None)[source]

Retrieves a task.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
task_id (Any)
params (Any)
headers (Any)

Return type:

Any

get_tool(*, tool_name, params=None, headers=None)[source]

Get tools.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tool_name (Any)
params (Any)
headers (Any)

Return type:

Any

load_model(*, model_id, params=None, headers=None)[source]

Deploys a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

predict(*, algorithm_name, model_id, body=None, params=None, headers=None)[source]

Predicts new data with trained model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
algorithm_name (Any)
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

predict_model(*, model_id, body=None, params=None, headers=None)[source]

Predicts a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

predict_model_stream(*, model_id, body=None, params=None, headers=None)[source]

Predicts a model in streaming mode.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

register_agents(*, body=None, params=None, headers=None)[source]

Register an agent.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

register_model(*, body=None, params=None, headers=None)[source]

Registers a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

register_model_group(*, body=None, params=None, headers=None)[source]

Registers a model group.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

register_model_meta(*, body=None, params=None, headers=None)[source]

Registers model metadata.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_agentic_memory(*, memory_container_id, doc_type, body=None, params=None, headers=None)[source]

Search for memories of a specific type within a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
doc_type (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_agents(*, body=None, params=None, headers=None)[source]

Search agents.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_connectors(*, body=None, params=None, headers=None)[source]

Searches for standalone connectors.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_memory(*, body=None, params=None, headers=None)[source]

Search memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_memory_container(*, body=None, params=None, headers=None)[source]

Search memory containers.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_message(*, memory_id, body=None, params=None, headers=None)[source]

Search messages.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_model_group(*, body=None, params=None, headers=None)[source]

Searches for model groups.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_models(*, body=None, params=None, headers=None)[source]

Searches for models.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

search_tasks(*, body=None, params=None, headers=None)[source]

Searches for tasks.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any

train(*, algorithm_name, body=None, params=None, headers=None)[source]

Trains a model synchronously.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
algorithm_name (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

train_predict(*, algorithm_name, body=None, params=None, headers=None)[source]

Trains a model and predicts against the same training dataset.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
algorithm_name (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

undeploy_model(*, body=None, model_id=None, params=None, headers=None)[source]

Undeploys a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

unload_model(*, body=None, model_id=None, params=None, headers=None)[source]

Unloads a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
model_id (Any)
params (Any)
headers (Any)

Return type:

Any

update_agentic_memory(*, memory_container_id, doc_type, id, body=None, params=None, headers=None)[source]

Update a specific memory by its type and ID.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
doc_type (Any)
id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_connector(*, connector_id, body=None, params=None, headers=None)[source]

Updates a standalone connector.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
connector_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_controller(*, model_id, body=None, params=None, headers=None)[source]

Updates a controller.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_memory(*, memory_id, body=None, params=None, headers=None)[source]

Update a memory.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_memory_container(*, memory_container_id, body=None, params=None, headers=None)[source]

Update a memory container.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
memory_container_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_message(*, message_id, body=None, params=None, headers=None)[source]

Update a message.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
message_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_model(*, model_id, body=None, params=None, headers=None)[source]

Updates a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

update_model_group(*, model_group_id, body=None, params=None, headers=None)[source]

Updates a model group.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_group_id (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

upload_chunk(*, model_id, chunk_number, body=None, params=None, headers=None)[source]

Uploads model chunk.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
model_id (Any)
chunk_number (Any)
body (Any)
params (Any)
headers (Any)

Return type:

Any

upload_model(*, body=None, params=None, headers=None)[source]

Registers a model.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field’s name. To exclude fields, use -.
human – Whether to return human-readable values for statistics. Default is false.
pretty – Whether to pretty-format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any)
params (Any)
headers (Any)

Return type:

Any