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

NAME

OpenSearch::Client::Core::3_0::Direct::SearchPipeline

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Search pipelines

You can use search pipelines to build new or reuse existing result rerankers, query rewriters, and other components that operate on queries or results. Search pipelines make it easier for you to process search queries and search results within OpenSearch. Moving some of your application functionality into an OpenSearch search pipeline reduces the overall complexity of your application. As part of a search pipeline, you specify a list of search processors that perform modular tasks. You can then easily add or reorder these processors to customize search results for your application.

See OpenSearch documentation for search_pipeline.

METHODS

delete

Deletes the specified search pipeline.

Paths served by this method:

DELETE /_search/pipeline/{id}

Method added in OpenSearch version 2.9

$resp = $client->search_pipeline->delete(
    
     # path parameters
    
    'id'                       =>  $id,        # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'timeout'                  =>  $qval2,     # string
    
     # 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 search_pipeline->delete

get

Retrieves information about a specified search pipeline.

Paths served by this method:

GET /_search/pipeline
GET /_search/pipeline/{id}

Method added in OpenSearch version 2.9

$resp = $client->search_pipeline->get(
    
     # path parameters
    
    'id'                       =>  $id,        # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval2,     # boolean
    'filter_path'              =>  $qval3,     # list
    'human'                    =>  $qval4,     # boolean
    'pretty'                   =>  $qval5,     # boolean
    'source'                   =>  $qval6,     # string
);

OpenSearch documentation for search_pipeline->get

put

Creates or replaces the specified search pipeline.

Paths served by this method:

PUT /_search/pipeline/{id}

Method added in OpenSearch version 2.9

$resp = $client->search_pipeline->put(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'id'                       =>  $id,        # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'timeout'                  =>  $qval2,     # string
    
     # 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 search_pipeline->put

method_supported_in_version

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

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