blob: ff0188fe36e6e4efa43d70ffc6243e0216505d78 (
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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include <vespa/vespalib/stllike/string.h>
#include <memory>
namespace vespalib::eval { struct ConstantValue; }
namespace search::fef {
class Properties;
class FieldInfo;
class ITableManager;
class OnnxModel;
/**
* Abstract view of index related information available to the
* framework.
**/
class IIndexEnvironment
{
public:
using string = vespalib::string;
/**
* This enum defines the different motivations the framework has
* for configuring a feature blueprint. RANK means the feature is
* needed for ranking calculations in normal operation. DUMP means
* the feature is needed to perform a feature dump. VERIFY_SETUP
* means that we are just trying to figure out if this setup is
* valid; the feature will never actually be executed.
**/
enum FeatureMotivation {
UNKNOWN = 0,
RANK = 1,
DUMP = 2,
VERIFY_SETUP = 3
};
/**
* Obtain the set of properties associated with this index
* environment.
*
* @return properties
**/
virtual const Properties &getProperties() const = 0;
/**
* Obtain the number of fields
*
* @return number of fields
**/
virtual uint32_t getNumFields() const = 0;
/**
* Obtain a field by using the field enumeration. The legal range
* for id is [0, getNumFields>. If id is out of bounds, 0 will be
* returned.
*
* @return information about a single field
**/
virtual const FieldInfo *getField(uint32_t id) const = 0;
/**
* Obtain a field by using the field name. If the field is not
* found, 0 will be returned.
*
* @return information about a single field
**/
virtual const FieldInfo *getFieldByName(const string &name) const = 0;
/**
* Obtain the table manager associated with this index environment.
*
* @return table manager
**/
virtual const ITableManager &getTableManager() const = 0;
/**
* Obtain the current motivation behind feature setup. The
* motivation is typically that we want to set up features for
* ranking or dumping. In some cases we are also setting things up
* just to verify that it is possible.
*
* @return current feature motivation
**/
virtual FeatureMotivation getFeatureMotivation() const = 0;
/**
* Hint about the nature of the feature blueprints we are about to
* configure. This method provides additional information that may
* be useful when interpreting hints about future field and
* attribute access.
*
* @param motivation the motivation behind the feature blueprints
* the framework is about to configure.
**/
virtual void hintFeatureMotivation(FeatureMotivation motivation) const = 0;
/**
* Hint about the future access of a field. This method may be
* used by blueprints during setup to hint the enclosing system
* that a feature executor created by it might try to access the
* field iterator for a specific field during execution.
*
* @param fieldId field id
**/
virtual void hintFieldAccess(uint32_t fieldId) const = 0;
/**
* Hint about the future access of an attribute. This method may
* be used by blueprints during setup to hint the enclosing system
* that a feature executor created by it might try to access a
* specific attribute during execution.
*
* @param name attribute name
**/
virtual void hintAttributeAccess(const string &name) const = 0;
/**
* Returns a constant rank value with the given name or null ptr if no such value exists.
*/
virtual std::unique_ptr<vespalib::eval::ConstantValue> getConstantValue(const vespalib::string &name) const = 0;
/**
* Returns the ranking expression with the given name or empty string if not found.
**/
virtual vespalib::string getRankingExpression(const vespalib::string &name) const = 0;
/**
* Get configuration for the given onnx model.
**/
virtual const OnnxModel *getOnnxModel(const vespalib::string &name) const = 0;
virtual uint32_t getDistributionKey() const = 0;
/**
* Virtual destructor to allow safe subclassing.
**/
virtual ~IIndexEnvironment() {}
};
}
|
