Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Synonyms.pm

raw
1 # Licensed to Elasticsearch B.V. under one or more contributor
2 # license agreements. See the NOTICE file distributed with
3 # this work for additional information regarding copyright
4 # ownership. Elasticsearch B.V. licenses this file to you under
5 # the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing,
12 # software distributed under the License is distributed on an
13 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 # KIND, either express or implied. See the License for the
15 # specific language governing permissions and limitations
16 # under the License.
17
18 package Search::Elasticsearch::Client::8_0::Direct::Synonyms;
19 $Search::Elasticsearch::Client::8_0::Direct::Synonyms::VERSION = '8.12';
20 use Moo;
21 with 'Search::Elasticsearch::Client::8_0::Role::API';
22 with 'Search::Elasticsearch::Role::Client::Direct';
23 use namespace::clean;
24
25 __PACKAGE__->_install_api('synonyms');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::Synonyms - The synonyms management API provides a convenient way
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head2 DESCRIPTION
42
43 The full documentation for Synonyms API is available here:
44 L<https://www.elastic.co/guide/en/elasticsearch/reference/current/synonyms-apis.html>
45
46 =head1 FOLLOW METHODS
47
48 =head2 C<follow()>
49
50 my $response = $es->synonyms->put_synonym(
51 'id' => 'my-synonyms-set',
52 'body' => {
53 synonyms_set' => [
54 {
55 'id' => 'test-1',
56 'synonyms' => 'hello, hi'
57 },
58 {
59 'synonyms' => 'bye, goodbye'
60 },
61 {
62 'id' => 'test-2',
63 'synonyms' => 'test => check'
64 },
65 ]
66 }
67 );
68
69 An introduction to synonyms in Elasticsearch is available here:
70 L<https://www.elastic.co/blog/update-synonyms-elasticsearch-introducing-synonyms-api>
71
72 =head1 AUTHOR
73
74 Enrico Zimuel <[email protected]>
75
76 =head1 COPYRIGHT AND LICENSE
77
78 This software is Copyright (c) 2024 by Elasticsearch BV.
79
80 This is free software, licensed under:
81
82 The Apache License, Version 2.0, January 2004
83
84 =cut
85
86 __END__
87
88 # ABSTRACT: The synonyms management API provides a convenient way
89 to define and manage synonyms in an internal system index.
90 Related synonyms can be grouped in a "synonyms set".
91 Create as many synonym sets as you need.
92