/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::Neural

NAME

OpenSearch::Client::Core::3_0::Direct::Neural

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->neural-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Neural Search API

The Neural Search plugin provides several APIs for monitoring semantic and hybrid search features.

See OpenSearch documentation for neural.

METHODS

stats

Provides information about the current status of the neural-search plugin.

Paths served by this method:

GET /_plugins/_neural/stats
GET /_plugins/_neural/stats/{stat}
GET /_plugins/_neural/{node_id}/stats
GET /_plugins/_neural/{node_id}/stats/{stat}

Method added in OpenSearch version 3.0

$resp = $client->neural->stats(
    
     # path parameters
    
    'node_id'                   =>  $node_id,   # optional
    'stat'                      =>  $stat,      # optional
    
     # Endpoint specific query string parameters
    
    'flat_stat_paths'           =>  $qval1,     # boolean
    'include_all_nodes'         =>  $qval2,     # boolean
    'include_individual_nodes'  =>  $qval3,     # boolean
    'include_info'              =>  $qval4,     # boolean
    'include_metadata'          =>  $qval5,     # boolean
    
     # Common API query string parameters
    
    'error_trace'               =>  $qval6,     # boolean
    'filter_path'               =>  $qval7,     # list
    'human'                     =>  $qval8,     # boolean
    'pretty'                    =>  $qval9,     # boolean
    'source'                    =>  $qval10,    # string
);

OpenSearch documentation for neural->stats

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->neural->method_supported_in_version(
    method  => 'stats',
    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