summaryrefslogtreecommitdiffstats
path: root/model-evaluation/src/main/java/ai/vespa/models/handler/ModelsEvaluationHandler.java
blob: e224d4a50dc9aafc35cc0e9e9729476569534975 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
package ai.vespa.models.handler;

import ai.vespa.models.evaluation.FunctionEvaluator;
import ai.vespa.models.evaluation.Model;
import ai.vespa.models.evaluation.ModelsEvaluator;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.container.jdisc.HttpResponse;
import com.yahoo.container.jdisc.ThreadedHttpRequestHandler;
import com.yahoo.searchlib.rankingexpression.ExpressionFunction;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.Slime;
import com.yahoo.tensor.Tensor;
import com.yahoo.tensor.serialization.JsonFormat;

import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.nio.charset.Charset;
import java.util.Optional;
import java.util.concurrent.Executor;

public class ModelsEvaluationHandler extends ThreadedHttpRequestHandler {

    public static final String API_ROOT = "model-evaluation";
    public static final String VERSION_V1 = "v1";
    public static final String EVALUATE = "eval";

    private final ModelsEvaluator modelsEvaluator;

    public ModelsEvaluationHandler(ModelsEvaluator modelsEvaluator, Executor executor) {
        super(executor);
        this.modelsEvaluator = modelsEvaluator;
    }

    @Override
    public HttpResponse handle(HttpRequest request) {
        Path path = new Path(request);
        Optional<String> apiName = path.segment(0);
        Optional<String> version = path.segment(1);
        Optional<String> modelName = path.segment(2);

        try {
            if ( ! apiName.isPresent() || ! apiName.get().equalsIgnoreCase(API_ROOT)) {
                throw new IllegalArgumentException("unknown API");
            }
            if ( ! version.isPresent() || ! version.get().equalsIgnoreCase(VERSION_V1)) {
                throw new IllegalArgumentException("unknown API version");
            }
            if ( ! modelName.isPresent()) {
                return listAllModels(request);
            }
            if ( ! modelsEvaluator.models().containsKey(modelName.get())) {
                throw new IllegalArgumentException("no model with name '" + modelName.get() + "' found");
            }

            Model model = modelsEvaluator.models().get(modelName.get());

            // The following logic follows from the spec, in that signature and
            // output are optional if the model only has a single function.

            if (path.segments() == 3) {
                if (model.functions().size() > 1) {
                    return listModelDetails(request, modelName.get());
                }
                return listTypeDetails(request, modelName.get());
            }

            if (path.segments() == 4) {
                if ( ! path.segment(3).get().equalsIgnoreCase(EVALUATE)) {
                    return listTypeDetails(request, modelName.get(), path.segment(3).get());
                }
                if (model.functions().stream().anyMatch(f -> f.getName().equalsIgnoreCase(EVALUATE))) {
                    return listTypeDetails(request, modelName.get(), path.segment(3).get());  // model has a function "eval"
                }
                if (model.functions().size() <= 1) {
                    return evaluateModel(request, modelName.get());
                }
                throw new IllegalArgumentException("attempt to evaluate model without specifying function");
            }

            if (path.segments() == 5) {
                if (path.segment(4).get().equalsIgnoreCase(EVALUATE)) {
                    return evaluateModel(request, modelName.get(), path.segment(3).get());
                }
            }

        } catch (IllegalArgumentException e) {
            return new ErrorResponse(404, e.getMessage());
        }

        return new ErrorResponse(404, "unrecognized request");
    }

    private HttpResponse listAllModels(HttpRequest request) {
        Slime slime = new Slime();
        Cursor root = slime.setObject();
        for (String modelName: modelsEvaluator.models().keySet()) {
            root.setString(modelName, baseUrl(request) + modelName);
        }
        return new Response(200, com.yahoo.slime.JsonFormat.toJsonBytes(slime));
    }

    private HttpResponse listModelDetails(HttpRequest request, String modelName) {
        Model model = modelsEvaluator.models().get(modelName);
        Slime slime = new Slime();
        Cursor root = slime.setObject();
        for (ExpressionFunction func : model.functions()) {
            root.setString(func.getName(), baseUrl(request) + modelName + "/" + func.getName());
        }
        return new Response(200, com.yahoo.slime.JsonFormat.toJsonBytes(slime));
    }

    private HttpResponse listTypeDetails(HttpRequest request, String modelName) {
        return listTypeDetails(request, modelsEvaluator.evaluatorOf(modelName));
    }

    private HttpResponse listTypeDetails(HttpRequest request, String modelName, String signatureAndOutput) {
        return listTypeDetails(request, modelsEvaluator.evaluatorOf(modelName, signatureAndOutput));
    }

    private HttpResponse listTypeDetails(HttpRequest request, FunctionEvaluator evaluator) {
        Slime slime = new Slime();
        Cursor root = slime.setObject();
        Cursor bindings = root.setArray("bindings");
        for (String bindingName : evaluator.context().names()) {
            // TODO: Use an API which exposes only the external binding names instead of this
            if (bindingName.startsWith("constant(")) {
                continue;
            }
            if (bindingName.startsWith("rankingExpression(")) {
                continue;
            }
            Cursor binding = bindings.addObject();
            binding.setString("name", bindingName);
            binding.setString("type", "");  // TODO: implement type information when available
        }
        return new Response(200, com.yahoo.slime.JsonFormat.toJsonBytes(slime));
    }

    private HttpResponse evaluateModel(HttpRequest request, String modelName)  {
        return evaluateModel(request, modelsEvaluator.evaluatorOf(modelName));
    }

    private HttpResponse evaluateModel(HttpRequest request, String modelName, String signatureAndOutput)  {
        return evaluateModel(request, modelsEvaluator.evaluatorOf(modelName, signatureAndOutput));
    }

    private HttpResponse evaluateModel(HttpRequest request, FunctionEvaluator evaluator)  {
        for (String bindingName : evaluator.context().names()) {
            property(request, bindingName).ifPresent(s -> evaluator.bind(bindingName, Tensor.from(s)));
        }
        Tensor result = evaluator.evaluate();
        return new Response(200, JsonFormat.encode(result));
    }

    private Optional<String> property(HttpRequest request, String name) {
        return Optional.ofNullable(request.getProperty(name));
    }

    private String baseUrl(HttpRequest request) {
       URI uri = request.getUri();
       StringBuilder sb = new StringBuilder();
       sb.append(uri.getScheme()).append("://").append(uri.getHost());
       if (uri.getPort() >= 0) {
           sb.append(":").append(uri.getPort());
       }
       sb.append("/").append(API_ROOT).append("/").append(VERSION_V1).append("/");
       return sb.toString();
    }

    private static class Path {

        private final String[] segments;

        public Path(HttpRequest httpRequest) {
            segments = splitPath(httpRequest);
        }

        Optional<String> segment(int index) {
            return (index < 0 || index >= segments.length) ? Optional.empty() : Optional.of(segments[index]);
        }

        int segments() {
            return segments.length;
        }

        private static String[] splitPath(HttpRequest request) {
            String path = request.getUri().getPath().toLowerCase();
            if (path.startsWith("/")) {
                path = path.substring("/".length());
            }
            if (path.endsWith("/")) {
                path = path.substring(0, path.length() - 1);
            }
            return path.split("/");
        }

    }

    private static class Response extends HttpResponse {

        private final byte[] data;

        Response(int code, byte[] data) {
            super(code);
            this.data = data;
        }

        Response(int code, String data) {
            this(code, data.getBytes(Charset.forName(DEFAULT_CHARACTER_ENCODING)));
        }

        @Override
        public String getContentType() {
            return "application/json";
        }

        @Override
        public void render(OutputStream outputStream) throws IOException {
            outputStream.write(data);
        }
    }

    private static class ErrorResponse extends Response {
        ErrorResponse(int code, String data) {
            super(code, "{\"error\":\"" + data + "\"}");
        }
    }

}