-
Notifications
You must be signed in to change notification settings - Fork 68
/
function_param_test.exs
424 lines (358 loc) · 12.8 KB
/
function_param_test.exs
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
defmodule LangChain.FunctionParamTest do
use ExUnit.Case
doctest LangChain.FunctionParam
alias LangChain.FunctionParam
describe "new!/1" do
test "creates the function parameter" do
%FunctionParam{} =
param =
FunctionParam.new!(%{
name: "code",
type: :string,
description: "A unique code used to identify the object.",
required: true
})
assert param.name == "code"
assert param.type == :string
assert param.description == "A unique code used to identify the object."
assert param.required == true
end
test "description and required are optional" do
param = FunctionParam.new!(%{name: "code", type: :string})
assert param.name == "code"
assert param.type == :string
assert param.description == nil
assert param.required == false
end
test "supports enum values" do
param = FunctionParam.new!(%{name: "color", type: :string, enum: ["red", "green"]})
assert param.name == "color"
assert param.type == :string
assert param.enum == ["red", "green"]
end
test "supports array type" do
param = FunctionParam.new!(%{name: "colors", type: :array})
assert param.name == "colors"
assert param.type == :array
assert param.item_type == nil
param = FunctionParam.new!(%{name: "colors", type: :array, item_type: "string"})
assert param.name == "colors"
assert param.type == :array
assert param.item_type == "string"
end
test "supports object type" do
person_properties = [
FunctionParam.new!(%{name: "name", type: :string, required: true}),
FunctionParam.new!(%{name: "age", type: :integer}),
FunctionParam.new!(%{name: "employee", type: :boolean})
]
param =
FunctionParam.new!(%{name: "person", type: :object, object_properties: person_properties})
assert param.name == "person"
assert param.type == :object
assert param.object_properties == person_properties
end
test "supports nested objects type" do
education = [
FunctionParam.new!(%{name: "institution_name", type: :string, required: true}),
FunctionParam.new!(%{name: "completed", type: :boolean})
]
person_properties = [
FunctionParam.new!(%{name: "name", type: :string, required: true}),
FunctionParam.new!(%{name: "education", type: :object, object_properties: education})
]
person =
FunctionParam.new!(%{name: "person", type: :object, object_properties: person_properties})
# IO.inspect(person)
assert person.name == "person"
assert person.type == :object
assert person.object_properties == person_properties
end
test "does not allow field data for non-matching types" do
{:error, changeset} =
FunctionParam.new(%{name: "thing", type: :string, item_type: "number"})
assert {"not allowed for type :string", _} = changeset.errors[:item_type]
{:error, changeset} =
FunctionParam.new(%{
name: "thing",
type: :string,
object_properties: [FunctionParam.new!(%{name: "name", type: :string})]
})
assert {"not allowed for type :string", _} = changeset.errors[:object_properties]
end
test "requires object_properties when array of object" do
{:error, changeset} = FunctionParam.new(%{name: "thing", type: :array, item_type: "object"})
assert {"required when array type of object is used", _} =
changeset.errors[:object_properties]
end
end
describe "to_json_schema/2" do
test "basic types - integer, string, number, boolean" do
param = FunctionParam.new!(%{name: "name", type: :string})
expected = %{"name" => %{"type" => "string"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param = FunctionParam.new!(%{name: "age", type: :integer})
expected = %{"age" => %{"type" => "integer"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param = FunctionParam.new!(%{name: "height", type: :number})
expected = %{"height" => %{"type" => "number"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
# includes description
param = FunctionParam.new!(%{name: "name", type: :string, description: "Applicant's name"})
expected = %{"name" => %{"type" => "string", "description" => "Applicant's name"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param = FunctionParam.new!(%{name: "enabled", type: :boolean})
expected = %{"enabled" => %{"type" => "boolean"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param =
FunctionParam.new!(%{name: "enabled", type: :boolean, description: "If option is enabled"})
expected = %{"enabled" => %{"type" => "boolean", "description" => "If option is enabled"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
end
test "basic types support enum values" do
param = FunctionParam.new!(%{name: "name", type: :string, enum: ["John", "Mary"]})
expected = %{"name" => %{"type" => "string", "enum" => ["John", "Mary"]}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param = FunctionParam.new!(%{name: "age", type: :integer, enum: [1, 2, 10]})
expected = %{"age" => %{"type" => "integer", "enum" => [1, 2, 10]}}
assert expected == FunctionParam.to_json_schema(%{}, param)
param = FunctionParam.new!(%{name: "height", type: :number, enum: [5.0, 5.5, 6, 6.5]})
expected = %{"height" => %{"type" => "number", "enum" => [5.0, 5.5, 6, 6.5]}}
assert expected == FunctionParam.to_json_schema(%{}, param)
end
test "array of basic types" do
# no defined item_type
param =
FunctionParam.new!(%{name: "list_data", type: :array, description: "A list of things"})
expected = %{"list_data" => %{"type" => "array", "description" => "A list of things"}}
assert expected == FunctionParam.to_json_schema(%{}, param)
# with a specified item type
param = FunctionParam.new!(%{name: "tags", type: :array, item_type: "string"})
expected = %{"tags" => %{"type" => "array", "items" => %{"type" => "string"}}}
assert expected == FunctionParam.to_json_schema(%{}, param)
# includes description
param =
FunctionParam.new!(%{
name: "tags",
type: :array,
item_type: "string",
description: "tag values"
})
expected = %{
"tags" => %{
"type" => "array",
"items" => %{"type" => "string"},
"description" => "tag values"
}
}
assert expected == FunctionParam.to_json_schema(%{}, param)
end
test "string type with enum values" do
param = FunctionParam.new!(%{name: "color", type: :string, enum: ["red", "green"]})
expected = %{"color" => %{"type" => "string", "enum" => ["red", "green"]}}
assert expected == FunctionParam.to_json_schema(%{}, param)
# includes description
param =
FunctionParam.new!(%{
name: "color",
type: :string,
enum: ["red", "green"],
description: "Allowed colors"
})
expected = %{
"color" => %{
"type" => "string",
"enum" => ["red", "green"],
"description" => "Allowed colors"
}
}
assert expected == FunctionParam.to_json_schema(%{}, param)
end
test "object type" do
param =
FunctionParam.new!(%{
name: "attributes",
type: :object,
description: "Set of attributes for a new thing",
object_properties: [
FunctionParam.new!(%{
name: "name",
type: :string,
description: "The name of the thing"
}),
FunctionParam.new!(%{
name: "code",
type: :string,
description: "Unique code",
required: true
})
]
})
expected = %{
"attributes" => %{
"type" => "object",
"description" => "Set of attributes for a new thing",
"properties" => %{
"name" => %{
"type" => "string",
"description" => "The name of the thing"
},
"code" => %{
"type" => "string",
"description" => "Unique code"
}
},
"required" => ["code"]
}
}
assert expected == FunctionParam.to_json_schema(%{}, param)
end
test "array of objects" do
array =
FunctionParam.new!(%{
name: "info",
type: :array,
item_type: "object",
object_properties: [
FunctionParam.new!(%{name: "name", type: :string}),
FunctionParam.new!(%{name: "age", type: :number})
]
})
schema = FunctionParam.to_json_schema(%{}, array)
assert schema == %{
"info" => %{
"type" => "array",
"items" => %{
"type" => "object",
"properties" => %{
"age" => %{"type" => "number"},
"name" => %{"type" => "string"}
},
"required" => []
}
}
}
end
end
describe "to_parameters_schema/1" do
test "basic example" do
expected = %{
"type" => "object",
"properties" => %{
"code" => %{
"type" => "string",
"description" => "Unique code"
},
"other" => %{
"type" => "string"
}
},
"required" => ["code"]
}
params = [
FunctionParam.new!(%{
name: "code",
type: "string",
description: "Unique code",
required: true
}),
FunctionParam.new!(%{
name: "other",
type: "string"
})
]
assert expected == FunctionParam.to_parameters_schema(params)
end
test "supports nested objects" do
education = [
FunctionParam.new!(%{name: "institution_name", type: :string, required: true}),
FunctionParam.new!(%{name: "completed", type: :boolean})
]
person_properties = [
FunctionParam.new!(%{name: "name", type: :string, required: true}),
FunctionParam.new!(%{name: "age", type: :integer}),
FunctionParam.new!(%{name: "education", type: :object, object_properties: education})
]
person =
FunctionParam.new!(%{name: "person", type: :object, object_properties: person_properties})
schema = FunctionParam.to_parameters_schema([person])
expected = %{
"type" => "object",
"properties" => %{
"person" => %{
"type" => "object",
"properties" => %{
"age" => %{"type" => "integer"},
"education" => %{
"type" => "object",
"properties" => %{
"completed" => %{"type" => "boolean"},
"institution_name" => %{"type" => "string"}
},
"required" => ["institution_name"]
},
"name" => %{"type" => "string"}
},
"required" => ["name"]
}
},
"required" => []
}
assert schema == expected
end
test "supports listing required parameters" do
params = [
FunctionParam.new!(%{
name: "code",
type: "string",
required: true
}),
FunctionParam.new!(%{
name: "other",
type: "string"
})
]
result = FunctionParam.to_parameters_schema(params)
assert result["required"] == ["code"]
params = [
FunctionParam.new!(%{
name: "other",
type: "string"
})
]
result = FunctionParam.to_parameters_schema(params)
assert result["required"] == []
end
end
describe "required_properties/1" do
test "return empty when nothing required" do
params = [
FunctionParam.new!(%{
name: "optional_thing",
type: "string"
})
]
assert [] == FunctionParam.required_properties(params)
end
test "return a list of the property names flagged as required" do
params = [
FunctionParam.new!(%{
name: "code",
type: "string",
description: "Unique code",
required: true
}),
FunctionParam.new!(%{
name: "other",
type: "string"
}),
FunctionParam.new!(%{
name: "important",
type: "integer",
required: true
})
]
assert ["code", "important"] == FunctionParam.required_properties(params)
end
end
end