view release on metacpan or  search on metacpan

lib/OpenSearch/Client/Core/3_0/Direct/ML.pm  view on Meta::CPAN

=back

I<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
    );

L<OpenSearch documentation for ml-E<gt>deploy_model|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 execute_agent

Execute an agent.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/agents/{agent_id}/_execute>

=back

I<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
    );

L<OpenSearch documentation for ml-E<gt>execute_agent|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 execute_agent_stream

Execute an agent in streaming mode.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/agents/{agent_id}/_execute/stream>

=back

I<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
    );

L<OpenSearch documentation for ml-E<gt>execute_agent_stream|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 execute_algorithm

Execute an algorithm.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/_execute/{algorithm_name}>

=back

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

lib/OpenSearch/Client/Core/3_0/Direct/ML.pm  view on Meta::CPAN

I<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
    );

L<OpenSearch documentation for ml-E<gt>predict|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 predict_model

Predicts a model.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/models/{model_id}/_predict>

=back

I<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
    );

L<OpenSearch documentation for ml-E<gt>predict_model|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 predict_model_stream

Predicts a model in streaming mode.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/models/{model_id}/_predict/stream>

=back

I<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
    );

L<OpenSearch documentation for ml-E<gt>predict_model_stream|https://docs.opensearch.org/latest/ml-commons-plugin/api/index/>
    
=head2 register_agents

Register an agent.

I<Paths served by this method:>

=over

=item
C<POST /_plugins/_ml/agents/_register>

=back

I<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
    );