Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Inference.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::Inference;
19 $Search::Elasticsearch::Client::8_0::Direct::Inference::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('inference');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::Inference - The inference APIs enable you to use certain services,
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head2 DESCRIPTION
42
43 The full documentation for Inference is available here:
44 L<https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html>
45
46 =head1 FOLLOW METHODS
47
48 =head2 C<follow()>
49
50 my $response = $es->inference->put_model(
51 'task_type' => 'sparse_embedding',
52 'model_id' => 'my-elser-model',
53 'body' => {
54 'service' => 'elser',
55 'service_settings' => {
56 'num_allocations' => 1,
57 'num_threads' => 1
58 },
59 'task_settings' => {}
60 }
61 );
62
63 =head1 AUTHOR
64
65 Enrico Zimuel <[email protected]>
66
67 =head1 COPYRIGHT AND LICENSE
68
69 This software is Copyright (c) 2024 by Elasticsearch BV.
70
71 This is free software, licensed under:
72
73 The Apache License, Version 2.0, January 2004
74
75 =cut
76
77 __END__
78
79 # ABSTRACT: The inference APIs enable you to use certain services,
80 such as ELSER, OpenAI, or Hugging Face, in your cluster.
81