UNPKG

axiom

Version:

Axiom AI SDK provides - an API to wrap your AI calls with observability instrumentation. - offline evals - online evals

github.com/axiomhq/ai

axiomhq/ai

156 lines (80 loc) • 2.27 kB
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
[**axiom v0.51.1**](../../README.md) *** [axiom](../../README.md) / [feedback](../README.md) / Feedback # Variable: Feedback > `const` **Feedback**: `object` Helper functions for creating feedback input objects. ## Type Declaration ### bool() > **bool**: (`input`) => `FeedbackInputBoolean` = `boolFeedback` Creates a boolean feedback with a true/false value. #### Parameters ##### input `FeedbackParamsBoolean` #### Returns `FeedbackInputBoolean` ### enum() > **enum**: \<`T`\>(`input`) => `FeedbackInputText` = `enumFeedback` Creates a text feedback from a string enum value. #### Type Parameters ##### T `T` *extends* `string` #### Parameters ##### input `FeedbackInputBase` & `object` #### Returns `FeedbackInputText` ### number() > **number**: (`input`) => `FeedbackInputNumber` = `numberFeedback` Creates a number feedback with a number value. #### Parameters ##### input `FeedbackParamsNumber` #### Returns `FeedbackInputNumber` ### signal() > **signal**: (`input`) => `FeedbackInputSignal` = `signalFeedback` Creates a signal feedback (no value, just indicates an event occurred). #### Parameters ##### input `FeedbackParamsSignal` #### Returns `FeedbackInputSignal` ### text() > **text**: (`input`) => `FeedbackInputText` = `textFeedback` Creates a text feedback with a free-form string value. #### Parameters ##### input `FeedbackParamsText` #### Returns `FeedbackInputText` ### thumb() > **thumb**: (`__namedParameters`) => `FeedbackInputThumb` = `thumbFeedback` Creates a thumb feedback with 'up' or 'down' value. #### Parameters ##### \_\_namedParameters `FeedbackInputBase` & `object` #### Returns `FeedbackInputThumb` ### thumbDown() > **thumbDown**: (`input`) => `FeedbackInputThumb` = `thumbDownFeedback` Creates a thumbs down (-1) feedback. #### Parameters ##### input `FeedbackInputBase` #### Returns `FeedbackInputThumb` ### thumbUp() > **thumbUp**: (`input`) => `FeedbackInputThumb` = `thumbUpFeedback` Creates a thumbs up (+1) feedback. #### Parameters ##### input `FeedbackInputBase` #### Returns `FeedbackInputThumb` ## Example ```ts Feedback.thumbUp({ name: 'response-quality' }) Feedback.number({ name: 'rating', value: 4 }) Feedback.signal({ name: 'completed' }) ```