typia 9.2.0 → 9.3.0-dev.20250511

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (534) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +149 -149
  3. package/lib/executable/setup/PluginConfigurator.js +3 -3
  4. package/lib/executable/setup/PluginConfigurator.mjs +3 -3
  5. package/lib/executable/typia.js +15 -15
  6. package/lib/executable/typia.mjs +15 -15
  7. package/lib/factories/ExpressionFactory.d.mts +1 -1
  8. package/lib/factories/ExpressionFactory.d.ts +1 -1
  9. package/lib/factories/ExpressionFactory.js +2 -2
  10. package/lib/factories/ExpressionFactory.js.map +1 -1
  11. package/lib/factories/ExpressionFactory.mjs +2 -2
  12. package/lib/llm.d.mts +6 -4
  13. package/lib/llm.d.ts +6 -4
  14. package/lib/llm.js +7 -0
  15. package/lib/llm.js.map +1 -1
  16. package/lib/llm.mjs +7 -1
  17. package/lib/transformers/CallExpressionTransformer.js +2 -0
  18. package/lib/transformers/CallExpressionTransformer.js.map +1 -1
  19. package/lib/transformers/CallExpressionTransformer.mjs +2 -0
  20. package/lib/transformers/features/llm/LlmApplicationTransformer.js +46 -35
  21. package/lib/transformers/features/llm/LlmApplicationTransformer.js.map +1 -1
  22. package/lib/transformers/features/llm/LlmApplicationTransformer.mjs +44 -34
  23. package/lib/transformers/features/llm/LlmControllerTransformer.d.mts +5 -0
  24. package/lib/transformers/features/llm/LlmControllerTransformer.d.ts +5 -0
  25. package/lib/transformers/features/llm/LlmControllerTransformer.js +67 -0
  26. package/lib/transformers/features/llm/LlmControllerTransformer.js.map +1 -0
  27. package/lib/transformers/features/llm/LlmControllerTransformer.mjs +63 -0
  28. package/lib/transformers/features/llm/LlmControllerTransformer.mjs.map +1 -0
  29. package/package.json +2 -2
  30. package/src/AssertionGuard.ts +1 -1
  31. package/src/CamelCase.ts +75 -75
  32. package/src/IRandomGenerator.ts +49 -49
  33. package/src/IReadableURLSearchParams.ts +9 -9
  34. package/src/IValidation.ts +1 -1
  35. package/src/PascalCase.ts +71 -71
  36. package/src/Primitive.ts +92 -92
  37. package/src/Resolved.ts +74 -74
  38. package/src/SnakeCase.ts +126 -126
  39. package/src/TypeGuardError.ts +37 -37
  40. package/src/executable/TypiaGenerateWizard.ts +83 -83
  41. package/src/executable/TypiaPatchWizard.ts +45 -45
  42. package/src/executable/TypiaSetupWizard.ts +171 -171
  43. package/src/executable/setup/ArgumentParser.ts +42 -42
  44. package/src/executable/setup/CommandExecutor.ts +8 -8
  45. package/src/executable/setup/FileRetriever.ts +19 -19
  46. package/src/executable/setup/PackageManager.ts +87 -87
  47. package/src/executable/setup/PluginConfigurator.ts +69 -69
  48. package/src/executable/typia.ts +55 -55
  49. package/src/factories/CommentFactory.ts +79 -79
  50. package/src/factories/ExpressionFactory.ts +219 -216
  51. package/src/factories/IdentifierFactory.ts +89 -89
  52. package/src/factories/JsonMetadataFactory.ts +83 -83
  53. package/src/factories/LiteralFactory.ts +52 -52
  54. package/src/factories/MetadataCollection.ts +278 -278
  55. package/src/factories/MetadataCommentTagFactory.ts +648 -648
  56. package/src/factories/MetadataFactory.ts +404 -404
  57. package/src/factories/MetadataTypeTagFactory.ts +413 -413
  58. package/src/factories/MetadataTypeTagSchemaFactory.ts +82 -82
  59. package/src/factories/NumericRangeFactory.ts +72 -72
  60. package/src/factories/ProtobufFactory.ts +875 -875
  61. package/src/factories/StatementFactory.ts +90 -90
  62. package/src/factories/TemplateFactory.ts +64 -64
  63. package/src/factories/TypeFactory.ts +140 -140
  64. package/src/factories/ValueFactory.ts +12 -12
  65. package/src/factories/internal/metadata/IMetadataIteratorProps.ts +17 -17
  66. package/src/factories/internal/metadata/MetadataHelper.ts +21 -21
  67. package/src/factories/internal/metadata/emend_metadata_atomics.ts +45 -45
  68. package/src/factories/internal/metadata/emplace_metadata_alias.ts +33 -33
  69. package/src/factories/internal/metadata/emplace_metadata_array_type.ts +39 -39
  70. package/src/factories/internal/metadata/emplace_metadata_object.ts +212 -212
  71. package/src/factories/internal/metadata/emplace_metadata_tuple.ts +57 -57
  72. package/src/factories/internal/metadata/explore_metadata.ts +31 -31
  73. package/src/factories/internal/metadata/iterate_metadata.ts +54 -54
  74. package/src/factories/internal/metadata/iterate_metadata_alias.ts +33 -33
  75. package/src/factories/internal/metadata/iterate_metadata_array.ts +63 -63
  76. package/src/factories/internal/metadata/iterate_metadata_atomic.ts +62 -62
  77. package/src/factories/internal/metadata/iterate_metadata_coalesce.ts +28 -28
  78. package/src/factories/internal/metadata/iterate_metadata_collection.ts +146 -146
  79. package/src/factories/internal/metadata/iterate_metadata_comment_tags.ts +32 -32
  80. package/src/factories/internal/metadata/iterate_metadata_constant.ts +76 -76
  81. package/src/factories/internal/metadata/iterate_metadata_escape.ts +49 -49
  82. package/src/factories/internal/metadata/iterate_metadata_function.ts +91 -91
  83. package/src/factories/internal/metadata/iterate_metadata_intersection.ts +212 -212
  84. package/src/factories/internal/metadata/iterate_metadata_map.ts +57 -57
  85. package/src/factories/internal/metadata/iterate_metadata_native.ts +264 -264
  86. package/src/factories/internal/metadata/iterate_metadata_object.ts +35 -35
  87. package/src/factories/internal/metadata/iterate_metadata_set.ts +57 -57
  88. package/src/factories/internal/metadata/iterate_metadata_sort.ts +87 -87
  89. package/src/factories/internal/metadata/iterate_metadata_template.ts +41 -41
  90. package/src/factories/internal/metadata/iterate_metadata_tuple.ts +26 -26
  91. package/src/factories/internal/metadata/iterate_metadata_union.ts +19 -19
  92. package/src/functional.ts +740 -740
  93. package/src/http.ts +1040 -1040
  94. package/src/index.ts +4 -4
  95. package/src/internal/_IProtobufWriter.ts +18 -18
  96. package/src/internal/_ProtobufReader.ts +194 -194
  97. package/src/internal/_ProtobufSizer.ts +145 -145
  98. package/src/internal/_ProtobufWriter.ts +145 -145
  99. package/src/internal/_accessExpressionAsString.ts +46 -46
  100. package/src/internal/_assertGuard.ts +13 -13
  101. package/src/internal/_createStandardSchema.ts +134 -134
  102. package/src/internal/_functionalTypeGuardErrorFactory.ts +4 -4
  103. package/src/internal/_httpFormDataReadArray.ts +4 -4
  104. package/src/internal/_httpFormDataReadBigint.ts +18 -18
  105. package/src/internal/_httpFormDataReadBlob.ts +10 -10
  106. package/src/internal/_httpFormDataReadBoolean.ts +16 -16
  107. package/src/internal/_httpFormDataReadFile.ts +10 -10
  108. package/src/internal/_httpFormDataReadNumber.ts +15 -15
  109. package/src/internal/_httpFormDataReadString.ts +10 -10
  110. package/src/internal/_httpHeaderReadBigint.ts +10 -10
  111. package/src/internal/_httpHeaderReadBoolean.ts +8 -8
  112. package/src/internal/_httpHeaderReadNumber.ts +7 -7
  113. package/src/internal/_httpParameterReadBigint.ts +10 -10
  114. package/src/internal/_httpParameterReadBoolean.ts +8 -8
  115. package/src/internal/_httpParameterReadNumber.ts +7 -7
  116. package/src/internal/_httpParameterReadString.ts +2 -2
  117. package/src/internal/_httpQueryParseURLSearchParams.ts +12 -12
  118. package/src/internal/_httpQueryReadArray.ts +4 -4
  119. package/src/internal/_httpQueryReadBigint.ts +12 -12
  120. package/src/internal/_httpQueryReadBoolean.ts +14 -14
  121. package/src/internal/_httpQueryReadNumber.ts +9 -9
  122. package/src/internal/_httpQueryReadString.ts +4 -4
  123. package/src/internal/_isBetween.ts +2 -2
  124. package/src/internal/_isBigintString.ts +8 -8
  125. package/src/internal/_isFormatByte.ts +7 -7
  126. package/src/internal/_isFormatDate.ts +3 -3
  127. package/src/internal/_isFormatDateTime.ts +4 -4
  128. package/src/internal/_isFormatDuration.ts +4 -4
  129. package/src/internal/_isFormatEmail.ts +4 -4
  130. package/src/internal/_isFormatHostname.ts +4 -4
  131. package/src/internal/_isFormatIdnEmail.ts +4 -4
  132. package/src/internal/_isFormatIdnHostname.ts +4 -4
  133. package/src/internal/_isFormatIpv4.ts +4 -4
  134. package/src/internal/_isFormatIpv6.ts +4 -4
  135. package/src/internal/_isFormatIri.ts +3 -3
  136. package/src/internal/_isFormatIriReference.ts +4 -4
  137. package/src/internal/_isFormatJsonPointer.ts +3 -3
  138. package/src/internal/_isFormatPassword.ts +1 -1
  139. package/src/internal/_isFormatRegex.ts +8 -8
  140. package/src/internal/_isFormatRelativeJsonPointer.ts +4 -4
  141. package/src/internal/_isFormatTime.ts +4 -4
  142. package/src/internal/_isFormatUri.ts +6 -6
  143. package/src/internal/_isFormatUriReference.ts +5 -5
  144. package/src/internal/_isFormatUriTemplate.ts +4 -4
  145. package/src/internal/_isFormatUrl.ts +4 -4
  146. package/src/internal/_isFormatUuid.ts +3 -3
  147. package/src/internal/_isTypeFloat.ts +5 -5
  148. package/src/internal/_isTypeInt32.ts +5 -5
  149. package/src/internal/_isTypeInt64.ts +5 -5
  150. package/src/internal/_isTypeUint32.ts +5 -5
  151. package/src/internal/_isTypeUint64.ts +5 -5
  152. package/src/internal/_isUniqueItems.ts +159 -159
  153. package/src/internal/_jsonStringifyNumber.ts +12 -12
  154. package/src/internal/_jsonStringifyRest.ts +3 -3
  155. package/src/internal/_jsonStringifyString.ts +42 -42
  156. package/src/internal/_jsonStringifyTail.ts +2 -2
  157. package/src/internal/_llmApplicationFinalize.ts +20 -20
  158. package/src/internal/_miscCloneAny.ts +46 -46
  159. package/src/internal/_notationAny.ts +37 -37
  160. package/src/internal/_notationCamel.ts +13 -13
  161. package/src/internal/_notationPascal.ts +8 -8
  162. package/src/internal/_notationSnake.ts +43 -43
  163. package/src/internal/_randomArray.ts +21 -21
  164. package/src/internal/_randomBigint.ts +6 -6
  165. package/src/internal/_randomBoolean.ts +1 -1
  166. package/src/internal/_randomFormatByte.ts +3 -3
  167. package/src/internal/_randomFormatDate.ts +18 -18
  168. package/src/internal/_randomFormatDatetime.ts +16 -16
  169. package/src/internal/_randomFormatDuration.ts +27 -27
  170. package/src/internal/_randomFormatEmail.ts +11 -11
  171. package/src/internal/_randomFormatHostname.ts +6 -6
  172. package/src/internal/_randomFormatIdnEmail.ts +3 -3
  173. package/src/internal/_randomFormatIdnHostname.ts +3 -3
  174. package/src/internal/_randomFormatIpv4.ts +11 -11
  175. package/src/internal/_randomFormatIpv6.ts +11 -11
  176. package/src/internal/_randomFormatIri.ts +3 -3
  177. package/src/internal/_randomFormatIriReference.ts +3 -3
  178. package/src/internal/_randomFormatJsonPointer.ts +7 -7
  179. package/src/internal/_randomFormatPassword.ts +8 -8
  180. package/src/internal/_randomFormatRegex.ts +4 -4
  181. package/src/internal/_randomFormatRelativeJsonPointer.ts +8 -8
  182. package/src/internal/_randomFormatTime.ts +14 -14
  183. package/src/internal/_randomFormatUri.ts +3 -3
  184. package/src/internal/_randomFormatUriReference.ts +3 -3
  185. package/src/internal/_randomFormatUriTemplate.ts +3 -3
  186. package/src/internal/_randomFormatUrl.ts +11 -11
  187. package/src/internal/_randomFormatUuid.ts +6 -6
  188. package/src/internal/_randomInteger.ts +53 -53
  189. package/src/internal/_randomNumber.ts +80 -80
  190. package/src/internal/_randomPattern.ts +10 -10
  191. package/src/internal/_randomPick.ts +9 -9
  192. package/src/internal/_randomString.ts +24 -24
  193. package/src/internal/_throwTypeGuardError.ts +5 -5
  194. package/src/internal/_validateReport.ts +13 -13
  195. package/src/internal/private/__notationCapitalize.ts +2 -2
  196. package/src/internal/private/__notationUnsnake.ts +24 -24
  197. package/src/json.ts +696 -696
  198. package/src/llm.ts +358 -335
  199. package/src/misc.ts +651 -651
  200. package/src/module.ts +936 -936
  201. package/src/notations.ts +820 -820
  202. package/src/programmers/AssertProgrammer.ts +454 -454
  203. package/src/programmers/CheckerProgrammer.ts +1617 -1617
  204. package/src/programmers/FeatureProgrammer.ts +627 -627
  205. package/src/programmers/ImportProgrammer.ts +185 -185
  206. package/src/programmers/IsProgrammer.ts +273 -273
  207. package/src/programmers/RandomProgrammer.ts +1190 -1190
  208. package/src/programmers/TypiaProgrammer.ts +175 -175
  209. package/src/programmers/ValidateProgrammer.ts +448 -448
  210. package/src/programmers/functional/FunctionalAssertFunctionProgrammer.ts +153 -153
  211. package/src/programmers/functional/FunctionalAssertParametersProgrammer.ts +125 -125
  212. package/src/programmers/functional/FunctionalAssertReturnProgrammer.ts +115 -115
  213. package/src/programmers/functional/FunctionalIsFunctionProgrammer.ts +72 -72
  214. package/src/programmers/functional/FunctionalIsParametersProgrammer.ts +113 -113
  215. package/src/programmers/functional/FunctionalIsReturnProgrammer.ts +116 -116
  216. package/src/programmers/functional/FunctionalValidateFunctionProgrammer.ts +119 -119
  217. package/src/programmers/functional/FunctionalValidateParametersProgrammer.ts +274 -274
  218. package/src/programmers/functional/FunctionalValidateReturnProgrammer.ts +135 -135
  219. package/src/programmers/functional/internal/FunctionalGeneralProgrammer.ts +34 -34
  220. package/src/programmers/helpers/AtomicPredicator.ts +35 -35
  221. package/src/programmers/helpers/CloneJoiner.ts +143 -143
  222. package/src/programmers/helpers/FunctionProgrammer.ts +67 -67
  223. package/src/programmers/helpers/HttpMetadataUtil.ts +21 -21
  224. package/src/programmers/helpers/ICheckEntry.ts +13 -13
  225. package/src/programmers/helpers/IExpressionEntry.ts +12 -12
  226. package/src/programmers/helpers/NotationJoiner.ts +144 -144
  227. package/src/programmers/helpers/OptionPredicator.ts +15 -15
  228. package/src/programmers/helpers/ProtobufUtil.ts +228 -228
  229. package/src/programmers/helpers/ProtobufWire.ts +34 -34
  230. package/src/programmers/helpers/PruneJoiner.ts +148 -148
  231. package/src/programmers/helpers/RandomJoiner.ts +168 -168
  232. package/src/programmers/helpers/StringifyJoinder.ts +115 -115
  233. package/src/programmers/helpers/StringifyPredicator.ts +13 -13
  234. package/src/programmers/helpers/UnionExplorer.ts +372 -372
  235. package/src/programmers/helpers/UnionPredicator.ts +79 -79
  236. package/src/programmers/helpers/disable_function_programmer_declare.ts +32 -32
  237. package/src/programmers/http/HttpAssertFormDataProgrammer.ts +99 -99
  238. package/src/programmers/http/HttpAssertHeadersProgrammer.ts +99 -99
  239. package/src/programmers/http/HttpAssertQueryProgrammer.ts +105 -105
  240. package/src/programmers/http/HttpFormDataProgrammer.ts +308 -308
  241. package/src/programmers/http/HttpHeadersProgrammer.ts +400 -400
  242. package/src/programmers/http/HttpIsFormDataProgrammer.ts +108 -108
  243. package/src/programmers/http/HttpIsHeadersProgrammer.ts +108 -108
  244. package/src/programmers/http/HttpIsQueryProgrammer.ts +114 -114
  245. package/src/programmers/http/HttpParameterProgrammer.ts +115 -115
  246. package/src/programmers/http/HttpQueryProgrammer.ts +336 -336
  247. package/src/programmers/http/HttpValidateFormDataProgrammer.ts +92 -92
  248. package/src/programmers/http/HttpValidateHeadersProgrammer.ts +92 -92
  249. package/src/programmers/http/HttpValidateQueryProgrammer.ts +98 -98
  250. package/src/programmers/internal/check_array_length.ts +47 -47
  251. package/src/programmers/internal/check_bigint.ts +50 -50
  252. package/src/programmers/internal/check_dynamic_key.ts +201 -201
  253. package/src/programmers/internal/check_dynamic_properties.ts +208 -208
  254. package/src/programmers/internal/check_everything.ts +23 -23
  255. package/src/programmers/internal/check_native.ts +27 -27
  256. package/src/programmers/internal/check_number.ts +112 -112
  257. package/src/programmers/internal/check_object.ts +75 -75
  258. package/src/programmers/internal/check_string.ts +50 -50
  259. package/src/programmers/internal/check_template.ts +48 -48
  260. package/src/programmers/internal/check_union_array_like.ts +335 -335
  261. package/src/programmers/internal/decode_union_object.ts +116 -116
  262. package/src/programmers/internal/feature_object_entries.ts +61 -61
  263. package/src/programmers/internal/json_schema_alias.ts +47 -47
  264. package/src/programmers/internal/json_schema_array.ts +45 -45
  265. package/src/programmers/internal/json_schema_bigint.ts +15 -15
  266. package/src/programmers/internal/json_schema_boolean.ts +15 -15
  267. package/src/programmers/internal/json_schema_constant.ts +26 -26
  268. package/src/programmers/internal/json_schema_description.ts +12 -12
  269. package/src/programmers/internal/json_schema_discriminator.ts +35 -35
  270. package/src/programmers/internal/json_schema_escaped.ts +82 -82
  271. package/src/programmers/internal/json_schema_native.ts +33 -33
  272. package/src/programmers/internal/json_schema_number.ts +15 -15
  273. package/src/programmers/internal/json_schema_object.ts +158 -158
  274. package/src/programmers/internal/json_schema_plugin.ts +18 -18
  275. package/src/programmers/internal/json_schema_station.ts +185 -185
  276. package/src/programmers/internal/json_schema_string.ts +15 -15
  277. package/src/programmers/internal/json_schema_template.ts +55 -55
  278. package/src/programmers/internal/json_schema_title.ts +20 -20
  279. package/src/programmers/internal/json_schema_tuple.ts +35 -35
  280. package/src/programmers/internal/metadata_to_pattern.ts +42 -42
  281. package/src/programmers/internal/postfix_of_tuple.ts +5 -5
  282. package/src/programmers/internal/prune_object_properties.ts +71 -71
  283. package/src/programmers/internal/stringify_dynamic_properties.ts +162 -162
  284. package/src/programmers/internal/stringify_native.ts +7 -7
  285. package/src/programmers/internal/stringify_regular_properties.ts +81 -81
  286. package/src/programmers/internal/template_to_pattern.ts +23 -23
  287. package/src/programmers/internal/wrap_metadata_rest_tuple.ts +23 -23
  288. package/src/programmers/json/JsonApplicationProgrammer.ts +266 -266
  289. package/src/programmers/json/JsonAssertParseProgrammer.ts +113 -113
  290. package/src/programmers/json/JsonAssertStringifyProgrammer.ts +115 -115
  291. package/src/programmers/json/JsonIsParseProgrammer.ts +114 -114
  292. package/src/programmers/json/JsonIsStringifyProgrammer.ts +108 -108
  293. package/src/programmers/json/JsonSchemaProgrammer.ts +26 -26
  294. package/src/programmers/json/JsonSchemasProgrammer.ts +91 -91
  295. package/src/programmers/json/JsonStringifyProgrammer.ts +1124 -1124
  296. package/src/programmers/json/JsonValidateParseProgrammer.ts +105 -105
  297. package/src/programmers/json/JsonValidateStringifyProgrammer.ts +124 -124
  298. package/src/programmers/llm/LlmApplicationProgrammer.ts +401 -401
  299. package/src/programmers/llm/LlmModelPredicator.ts +127 -127
  300. package/src/programmers/llm/LlmParametersProgrammer.ts +93 -93
  301. package/src/programmers/llm/LlmSchemaProgrammer.ts +192 -192
  302. package/src/programmers/misc/MiscAssertCloneProgrammer.ts +95 -95
  303. package/src/programmers/misc/MiscAssertPruneProgrammer.ts +116 -116
  304. package/src/programmers/misc/MiscCloneProgrammer.ts +1032 -1032
  305. package/src/programmers/misc/MiscIsCloneProgrammer.ts +99 -99
  306. package/src/programmers/misc/MiscIsPruneProgrammer.ts +97 -97
  307. package/src/programmers/misc/MiscLiteralsProgrammer.ts +80 -80
  308. package/src/programmers/misc/MiscPruneProgrammer.ts +728 -728
  309. package/src/programmers/misc/MiscValidateCloneProgrammer.ts +111 -111
  310. package/src/programmers/misc/MiscValidatePruneProgrammer.ts +113 -113
  311. package/src/programmers/notations/NotationAssertGeneralProgrammer.ts +101 -101
  312. package/src/programmers/notations/NotationGeneralProgrammer.ts +984 -984
  313. package/src/programmers/notations/NotationIsGeneralProgrammer.ts +105 -105
  314. package/src/programmers/notations/NotationValidateGeneralProgrammer.ts +119 -119
  315. package/src/programmers/protobuf/ProtobufAssertDecodeProgrammer.ts +98 -98
  316. package/src/programmers/protobuf/ProtobufAssertEncodeProgrammer.ts +102 -102
  317. package/src/programmers/protobuf/ProtobufDecodeProgrammer.ts +654 -654
  318. package/src/programmers/protobuf/ProtobufEncodeProgrammer.ts +945 -945
  319. package/src/programmers/protobuf/ProtobufIsDecodeProgrammer.ts +109 -109
  320. package/src/programmers/protobuf/ProtobufIsEncodeProgrammer.ts +98 -98
  321. package/src/programmers/protobuf/ProtobufMessageProgrammer.ts +179 -179
  322. package/src/programmers/protobuf/ProtobufValidateDecodeProgrammer.ts +92 -92
  323. package/src/programmers/protobuf/ProtobufValidateEncodeProgrammer.ts +119 -119
  324. package/src/protobuf.ts +861 -861
  325. package/src/reflect.ts +50 -50
  326. package/src/schemas/json/IJsonApplication.ts +73 -73
  327. package/src/schemas/json/IJsonSchemaCollection.ts +29 -29
  328. package/src/schemas/json/IJsonSchemaUnit.ts +32 -32
  329. package/src/schemas/json/__IJsonApplication.ts +63 -63
  330. package/src/schemas/metadata/IJsDocTagInfo.ts +10 -10
  331. package/src/schemas/metadata/IMetadata.ts +35 -35
  332. package/src/schemas/metadata/IMetadataAlias.ts +6 -6
  333. package/src/schemas/metadata/IMetadataAliasType.ts +12 -12
  334. package/src/schemas/metadata/IMetadataApplication.ts +7 -7
  335. package/src/schemas/metadata/IMetadataArray.ts +6 -6
  336. package/src/schemas/metadata/IMetadataArrayType.ts +10 -10
  337. package/src/schemas/metadata/IMetadataAtomic.ts +6 -6
  338. package/src/schemas/metadata/IMetadataComponents.ts +11 -11
  339. package/src/schemas/metadata/IMetadataConstant.ts +18 -18
  340. package/src/schemas/metadata/IMetadataConstantValue.ts +11 -11
  341. package/src/schemas/metadata/IMetadataDictionary.ts +11 -11
  342. package/src/schemas/metadata/IMetadataEscaped.ts +6 -6
  343. package/src/schemas/metadata/IMetadataFunction.ts +8 -8
  344. package/src/schemas/metadata/IMetadataMap.ts +8 -8
  345. package/src/schemas/metadata/IMetadataNative.ts +6 -6
  346. package/src/schemas/metadata/IMetadataObject.ts +6 -6
  347. package/src/schemas/metadata/IMetadataObjectType.ts +13 -13
  348. package/src/schemas/metadata/IMetadataParameter.ts +9 -9
  349. package/src/schemas/metadata/IMetadataProperty.ts +9 -9
  350. package/src/schemas/metadata/IMetadataSet.ts +7 -7
  351. package/src/schemas/metadata/IMetadataTemplate.ts +7 -7
  352. package/src/schemas/metadata/IMetadataTuple.ts +6 -6
  353. package/src/schemas/metadata/IMetadataTupleType.ts +10 -10
  354. package/src/schemas/metadata/IMetadataTypeTag.ts +16 -16
  355. package/src/schemas/metadata/Metadata.ts +687 -687
  356. package/src/schemas/metadata/MetadataAlias.ts +46 -46
  357. package/src/schemas/metadata/MetadataAliasType.ts +63 -63
  358. package/src/schemas/metadata/MetadataApplication.ts +44 -44
  359. package/src/schemas/metadata/MetadataArray.ts +49 -49
  360. package/src/schemas/metadata/MetadataArrayType.ts +57 -57
  361. package/src/schemas/metadata/MetadataAtomic.ts +87 -87
  362. package/src/schemas/metadata/MetadataComponents.ts +98 -98
  363. package/src/schemas/metadata/MetadataConstant.ts +34 -34
  364. package/src/schemas/metadata/MetadataConstantValue.ts +62 -62
  365. package/src/schemas/metadata/MetadataEscaped.ts +51 -51
  366. package/src/schemas/metadata/MetadataFunction.ts +49 -49
  367. package/src/schemas/metadata/MetadataMap.ts +48 -48
  368. package/src/schemas/metadata/MetadataNative.ts +44 -44
  369. package/src/schemas/metadata/MetadataObject.ts +48 -48
  370. package/src/schemas/metadata/MetadataObjectType.ts +149 -149
  371. package/src/schemas/metadata/MetadataParameter.ts +54 -54
  372. package/src/schemas/metadata/MetadataProperty.ts +59 -59
  373. package/src/schemas/metadata/MetadataSet.ts +45 -45
  374. package/src/schemas/metadata/MetadataTemplate.ts +80 -80
  375. package/src/schemas/metadata/MetadataTuple.ts +32 -32
  376. package/src/schemas/metadata/MetadataTupleType.ts +67 -67
  377. package/src/schemas/protobuf/IProtobufProperty.ts +6 -6
  378. package/src/schemas/protobuf/IProtobufPropertyType.ts +37 -37
  379. package/src/schemas/protobuf/IProtobufSchema.ts +50 -50
  380. package/src/tags/Constant.ts +15 -15
  381. package/src/tags/ContentMediaType.ts +10 -10
  382. package/src/tags/Default.ts +22 -22
  383. package/src/tags/Example.ts +24 -24
  384. package/src/tags/Examples.ts +16 -16
  385. package/src/tags/ExclusiveMaximum.ts +23 -23
  386. package/src/tags/ExclusiveMinimum.ts +23 -23
  387. package/src/tags/Format.ts +50 -50
  388. package/src/tags/JsonSchemaPlugin.ts +8 -8
  389. package/src/tags/MaxItems.ts +12 -12
  390. package/src/tags/MaxLength.ts +12 -12
  391. package/src/tags/Maximum.ts +19 -19
  392. package/src/tags/MinItems.ts +12 -12
  393. package/src/tags/MinLength.ts +12 -12
  394. package/src/tags/Minimum.ts +19 -19
  395. package/src/tags/MultipleOf.ts +21 -21
  396. package/src/tags/Pattern.ts +31 -31
  397. package/src/tags/Sequence.ts +10 -10
  398. package/src/tags/TagBase.ts +82 -82
  399. package/src/tags/Type.ts +37 -37
  400. package/src/tags/UniqueItems.ts +14 -14
  401. package/src/tags/index.ts +21 -21
  402. package/src/tags/internal/FormatCheatSheet.ts +73 -73
  403. package/src/transform.ts +35 -35
  404. package/src/transformers/CallExpressionTransformer.ts +554 -552
  405. package/src/transformers/FileTransformer.ts +136 -136
  406. package/src/transformers/IProgrammerProps.ts +11 -11
  407. package/src/transformers/ITransformOptions.ts +62 -62
  408. package/src/transformers/ITransformProps.ts +9 -9
  409. package/src/transformers/ITypiaContext.ts +18 -18
  410. package/src/transformers/ImportTransformer.ts +81 -81
  411. package/src/transformers/NoTransformConfigurationError.ts +18 -18
  412. package/src/transformers/NodeTransformer.ts +17 -17
  413. package/src/transformers/TransformerError.ts +60 -60
  414. package/src/transformers/features/AssertTransformer.ts +24 -24
  415. package/src/transformers/features/CreateAssertTransformer.ts +24 -24
  416. package/src/transformers/features/CreateIsTransformer.ts +18 -18
  417. package/src/transformers/features/CreateRandomTransformer.ts +43 -43
  418. package/src/transformers/features/CreateValidateTransformer.ts +18 -18
  419. package/src/transformers/features/IsTransformer.ts +18 -18
  420. package/src/transformers/features/RandomTransformer.ts +41 -41
  421. package/src/transformers/features/ValidateTransformer.ts +18 -18
  422. package/src/transformers/features/functional/FunctionalGenericTransformer.ts +57 -57
  423. package/src/transformers/features/http/CreateHttpAssertFormDataTransformer.ts +13 -13
  424. package/src/transformers/features/http/CreateHttpAssertHeadersTransformer.ts +13 -13
  425. package/src/transformers/features/http/CreateHttpAssertQueryTransformer.ts +13 -13
  426. package/src/transformers/features/http/CreateHttpFormDataTransformer.ts +13 -13
  427. package/src/transformers/features/http/CreateHttpHeadersTransformer.ts +13 -13
  428. package/src/transformers/features/http/CreateHttpIsFormDataTransformer.ts +13 -13
  429. package/src/transformers/features/http/CreateHttpIsHeadersTransformer.ts +13 -13
  430. package/src/transformers/features/http/CreateHttpIsQueryTransformer.ts +13 -13
  431. package/src/transformers/features/http/CreateHttpParameterTransformer.ts +13 -13
  432. package/src/transformers/features/http/CreateHttpQueryTransformer.ts +13 -13
  433. package/src/transformers/features/http/CreateHttpValidateFormDataTransformer.ts +13 -13
  434. package/src/transformers/features/http/CreateHttpValidateHeadersTransformer.ts +13 -13
  435. package/src/transformers/features/http/CreateHttpValidateQueryTransformer.ts +13 -13
  436. package/src/transformers/features/http/HttpAssertFormDataTransformer.ts +13 -13
  437. package/src/transformers/features/http/HttpAssertHeadersTransformer.ts +13 -13
  438. package/src/transformers/features/http/HttpAssertQueryTransformer.ts +13 -13
  439. package/src/transformers/features/http/HttpFormDataTransformer.ts +13 -13
  440. package/src/transformers/features/http/HttpHeadersTransformer.ts +13 -13
  441. package/src/transformers/features/http/HttpIsFormDataTransformer.ts +13 -13
  442. package/src/transformers/features/http/HttpIsHeadersTransformer.ts +13 -13
  443. package/src/transformers/features/http/HttpIsQueryTransformer.ts +13 -13
  444. package/src/transformers/features/http/HttpParameterTransformer.ts +13 -13
  445. package/src/transformers/features/http/HttpQueryTransformer.ts +13 -13
  446. package/src/transformers/features/http/HttpValidateFormDataTransformer.ts +13 -13
  447. package/src/transformers/features/http/HttpValidateHeadersTransformer.ts +13 -13
  448. package/src/transformers/features/http/HttpValidateQueryTransformer.ts +13 -13
  449. package/src/transformers/features/json/JsonApplicationTransformer.ts +105 -105
  450. package/src/transformers/features/json/JsonAssertParseTransformer.ts +13 -13
  451. package/src/transformers/features/json/JsonAssertStringifyTransformer.ts +13 -13
  452. package/src/transformers/features/json/JsonCreateAssertParseTransformer.ts +13 -13
  453. package/src/transformers/features/json/JsonCreateAssertStringifyTransformer.ts +13 -13
  454. package/src/transformers/features/json/JsonCreateIsParseTransformer.ts +13 -13
  455. package/src/transformers/features/json/JsonCreateIsStringifyTransformer.ts +13 -13
  456. package/src/transformers/features/json/JsonCreateStringifyTransformer.ts +13 -13
  457. package/src/transformers/features/json/JsonCreateValidateParseTransformer.ts +13 -13
  458. package/src/transformers/features/json/JsonCreateValidateStringifyProgrammer.ts +13 -13
  459. package/src/transformers/features/json/JsonIsParseTransformer.ts +13 -13
  460. package/src/transformers/features/json/JsonIsStringifyTransformer.ts +13 -13
  461. package/src/transformers/features/json/JsonSchemaTransformer.ts +135 -135
  462. package/src/transformers/features/json/JsonSchemasTransformer.ts +145 -145
  463. package/src/transformers/features/json/JsonStringifyTransformer.ts +13 -13
  464. package/src/transformers/features/json/JsonValidateParseTransformer.ts +13 -13
  465. package/src/transformers/features/json/JsonValidateStringifyTransformer.ts +13 -13
  466. package/src/transformers/features/llm/LlmApplicationTransformer.ts +145 -128
  467. package/src/transformers/features/llm/LlmControllerTransformer.ts +93 -0
  468. package/src/transformers/features/llm/LlmParametersTransformer.ts +102 -102
  469. package/src/transformers/features/llm/LlmSchemaTransformer.ts +170 -170
  470. package/src/transformers/features/misc/MiscAssertCloneTransformer.ts +13 -13
  471. package/src/transformers/features/misc/MiscAssertPruneTransformer.ts +13 -13
  472. package/src/transformers/features/misc/MiscCloneTransformer.ts +13 -13
  473. package/src/transformers/features/misc/MiscCreateAssertCloneTransformer.ts +13 -13
  474. package/src/transformers/features/misc/MiscCreateAssertPruneTransformer.ts +13 -13
  475. package/src/transformers/features/misc/MiscCreateCloneTransformer.ts +13 -13
  476. package/src/transformers/features/misc/MiscCreateIsCloneTransformer.ts +13 -13
  477. package/src/transformers/features/misc/MiscCreateIsPruneTransformer.ts +13 -13
  478. package/src/transformers/features/misc/MiscCreatePruneTransformer.ts +13 -13
  479. package/src/transformers/features/misc/MiscCreateValidateCloneTransformer.ts +13 -13
  480. package/src/transformers/features/misc/MiscCreateValidatePruneTransformer.ts +13 -13
  481. package/src/transformers/features/misc/MiscIsCloneTransformer.ts +13 -13
  482. package/src/transformers/features/misc/MiscIsPruneTransformer.ts +13 -13
  483. package/src/transformers/features/misc/MiscLiteralsTransformer.ts +35 -35
  484. package/src/transformers/features/misc/MiscPruneTransformer.ts +13 -13
  485. package/src/transformers/features/misc/MiscValidateCloneTransformer.ts +13 -13
  486. package/src/transformers/features/misc/MiscValidatePruneTransformer.ts +13 -13
  487. package/src/transformers/features/notations/NotationAssertGeneralTransformer.ts +20 -20
  488. package/src/transformers/features/notations/NotationCreateAssertGeneralTransformer.ts +20 -20
  489. package/src/transformers/features/notations/NotationCreateGeneralTransformer.ts +20 -20
  490. package/src/transformers/features/notations/NotationCreateIsGeneralTransformer.ts +20 -20
  491. package/src/transformers/features/notations/NotationCreateValidateGeneralTransformer.ts +20 -20
  492. package/src/transformers/features/notations/NotationGeneralTransformer.ts +18 -18
  493. package/src/transformers/features/notations/NotationIsGeneralTransformer.ts +20 -20
  494. package/src/transformers/features/notations/NotationValidateGeneralTransformer.ts +20 -20
  495. package/src/transformers/features/protobuf/ProtobufAssertDecodeTransformer.ts +13 -13
  496. package/src/transformers/features/protobuf/ProtobufAssertEncodeTransformer.ts +13 -13
  497. package/src/transformers/features/protobuf/ProtobufCreateAssertDecodeTransformer.ts +13 -13
  498. package/src/transformers/features/protobuf/ProtobufCreateAssertEncodeTransformer.ts +13 -13
  499. package/src/transformers/features/protobuf/ProtobufCreateDecodeTransformer.ts +13 -13
  500. package/src/transformers/features/protobuf/ProtobufCreateEncodeTransformer.ts +13 -13
  501. package/src/transformers/features/protobuf/ProtobufCreateIsDecodeTransformer.ts +13 -13
  502. package/src/transformers/features/protobuf/ProtobufCreateIsEncodeTransformer.ts +13 -13
  503. package/src/transformers/features/protobuf/ProtobufCreateValidateDecodeTransformer.ts +13 -13
  504. package/src/transformers/features/protobuf/ProtobufCreateValidateEncodeTransformer.ts +13 -13
  505. package/src/transformers/features/protobuf/ProtobufDecodeTransformer.ts +13 -13
  506. package/src/transformers/features/protobuf/ProtobufEncodeTransformer.ts +13 -13
  507. package/src/transformers/features/protobuf/ProtobufIsDecodeTransformer.ts +13 -13
  508. package/src/transformers/features/protobuf/ProtobufIsEncodeTransformer.ts +13 -13
  509. package/src/transformers/features/protobuf/ProtobufMessageTransformer.ts +35 -35
  510. package/src/transformers/features/protobuf/ProtobufValidateDecodeTransformer.ts +13 -13
  511. package/src/transformers/features/protobuf/ProtobufValidateEncodeTransformer.ts +13 -13
  512. package/src/transformers/features/reflect/ReflectMetadataTransformer.ts +69 -69
  513. package/src/transformers/features/reflect/ReflectNameTransformer.ts +82 -82
  514. package/src/transformers/internal/GenericTransformer.ts +101 -101
  515. package/src/typings/Atomic.ts +13 -13
  516. package/src/typings/ClassProperties.ts +5 -5
  517. package/src/typings/Customizable.ts +5 -5
  518. package/src/typings/Equal.ts +18 -18
  519. package/src/typings/IsTuple.ts +9 -9
  520. package/src/typings/NativeClass.ts +23 -23
  521. package/src/typings/OmitNever.ts +3 -3
  522. package/src/typings/ProtobufAtomic.ts +19 -19
  523. package/src/typings/SpecialFields.ts +3 -3
  524. package/src/typings/ValidationPipe.ts +9 -9
  525. package/src/typings/ValueOf.ts +20 -20
  526. package/src/typings/Writable.ts +11 -11
  527. package/src/utils/ArrayUtil.ts +41 -41
  528. package/src/utils/Escaper.ts +50 -50
  529. package/src/utils/MapUtil.ts +14 -14
  530. package/src/utils/NamingConvention.ts +94 -94
  531. package/src/utils/PatternUtil.ts +29 -29
  532. package/src/utils/ProtobufNameEncoder.ts +32 -32
  533. package/src/utils/Singleton.ts +16 -16
  534. package/src/utils/StringUtil.ts +16 -16
package/src/llm.ts CHANGED
@@ -1,335 +1,358 @@
1
- import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
2
-
3
- import { NoTransformConfigurationError } from "./transformers/NoTransformConfigurationError";
4
-
5
- /**
6
- * > You must configure the generic argument `App`.
7
- *
8
- * TypeScript functions to LLM function calling application.
9
- *
10
- * Creates an application of LLM (Large Language Model) function calling application
11
- * from a TypeScript class or interface type containing the target functions to be
12
- * called by the LLM function calling feature.
13
- *
14
- * If you put the returned {@link ILlmApplication.functions} objects to the LLM provider
15
- * like [OpenAI (ChatGPT)](https://openai.com/), the LLM will automatically select the
16
- * proper function and fill its arguments from the conversation (maybe chatting text)
17
- * with user (human). This is the concept of the LLM function calling.
18
- *
19
- * By the way, there can be some parameters (or their nested properties) which must be
20
- * composed by human, not by LLM. File uploading feature or some sensitive information
21
- * like security keys (password) are the examples. In that case, you can separate the
22
- * function parameters to both LLM and human sides by configuring the
23
- * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
24
- * assigned to the {@link ILlmFunction.separated} property.
25
- *
26
- * For reference, the actual function call execution is not by LLM, but by you.
27
- * When the LLM selects the proper function and fills the arguments, you just call
28
- * the function with the LLM prepared arguments. And then informs the return value to
29
- * the LLM by system prompt. The LLM will continue the next conversation based on
30
- * the return value.
31
- *
32
- * Additionally, if you've configured {@link ILlmApplication.IOptions.separate},
33
- * so that the parameters are separated to human and LLM sides, you can merge these
34
- * humand and LLM sides' parameters into one through {@link HttpLlm.mergeParameters}
35
- * before the actual LLM function call execution.
36
- *
37
- * Here is the list of available `Model` types with their corresponding LLM schema.
38
- * Reading the following list, and determine the `Model` type considering the
39
- * characteristics of the target LLM provider.
40
- *
41
- * - LLM provider schemas
42
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
43
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
44
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
45
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
46
- * - Midldle layer schemas
47
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
48
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
49
- *
50
- * @template App Target class or interface type collecting the functions to call
51
- * @template Model LLM schema model
52
- * @template Config Configuration of LLM schema composition
53
- * @param options Options for the LLM application construction
54
- * @returns Application of LLM function calling schemas
55
- * @reference https://platform.openai.com/docs/guides/function-calling
56
- * @author Jeongho Nam - https://github.com/samchon
57
- */
58
- export function application(
59
- options?: Partial<Pick<ILlmApplication.IOptions<any>, "separate">>,
60
- ): never;
61
-
62
- /**
63
- * TypeScript functions to LLM function calling application.
64
- *
65
- * Creates an application of LLM (Large Language Model) function calling application
66
- * from a TypeScript class or interface type containing the target functions to be
67
- * called by the LLM function calling feature.
68
- *
69
- * If you put the returned {@link ILlmApplication.functions} objects to the LLM provider
70
- * like [OpenAI (ChatGPT)](https://openai.com/), the LLM will automatically select the
71
- * proper function and fill its arguments from the conversation (maybe chatting text)
72
- * with user (human). This is the concept of the LLM function calling.
73
- *
74
- * By the way, there can be some parameters (or their nested properties) which must be
75
- * composed by human, not by LLM. File uploading feature or some sensitive information
76
- * like security keys (password) are the examples. In that case, you can separate the
77
- * function parameters to both LLM and human sides by configuring the
78
- * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
79
- * assigned to the {@link ILlmFunction.separated} property.
80
- *
81
- * For reference, the actual function call execution is not by LLM, but by you.
82
- * When the LLM selects the proper function and fills the arguments, you just call
83
- * the function with the LLM prepared arguments. And then informs the return value to
84
- * the LLM by system prompt. The LLM will continue the next conversation based on
85
- * the return value.
86
- *
87
- * Additionally, if you've configured {@link ILlmApplication.IOptions.separate},
88
- * so that the parameters are separated to human and LLM sides, you can merge these
89
- * humand and LLM sides' parameters into one through {@link HttpLlm.mergeParameters}
90
- * before the actual LLM function call execution.
91
- *
92
- * Here is the list of available `Model` types with their corresponding LLM schema.
93
- * Reading the following list, and determine the `Model` type considering the
94
- * characteristics of the target LLM provider.
95
- *
96
- * - LLM provider schemas
97
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
98
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
99
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
100
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
101
- * - Midldle layer schemas
102
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
103
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
104
- *
105
- * @template App Target class or interface type collecting the functions to call
106
- * @template Model LLM schema model
107
- * @template Config Configuration of LLM schema composition
108
- * @param options Options for the LLM application construction
109
- * @returns Application of LLM function calling schemas
110
- * @reference https://platform.openai.com/docs/guides/function-calling
111
- * @author Jeongho Nam - https://github.com/samchon
112
- */
113
- export function application<
114
- App extends Record<string, any>,
115
- Model extends ILlmSchema.Model,
116
- Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
117
- >(
118
- options?: Partial<Pick<ILlmApplication.IOptions<Model>, "separate">>,
119
- ): ILlmApplication<Model, App>;
120
-
121
- /**
122
- * @internal
123
- */
124
- export function application(): never {
125
- NoTransformConfigurationError("llm.application");
126
- }
127
-
128
- /**
129
- * > You must configure the generic argument `Parameters`.
130
- *
131
- * TypeScript parameters to LLM parameters schema.
132
- *
133
- * Creates an LLM (Large Language Model) parameters schema, a type metadata that is used in the
134
- * [LLM function calling](https://platform.openai.com/docs/guides/function-calling)
135
- * and [LLM structured outputs](https://platform.openai.com/docs/guides/structured-outputs),
136
- * from a TypeScript parameters type.
137
- *
138
- * For references, LLM identifies only keyworded arguments, not positional arguments.
139
- * Therefore, the TypeScript parameters type must be an object type, and its properties
140
- * must be static. If dynamic properties are, it would be compilation error.
141
- *
142
- * Also, such parameters type can be utilized not only for the LLM function calling,
143
- * but also for the LLM structured outputs. The LLM structured outputs is a feature
144
- * that LLM (Large Language Model) can generate a structured output, not only a plain
145
- * text, by filling the parameters from the conversation (maybe chatting text) with user
146
- * (human).
147
- *
148
- * Here is the list of available `Model` types with their corresponding LLM schema.
149
- * Reading the following list, and determine the `Model` type considering the
150
- * characteristics of the target LLM provider.
151
- *
152
- * - LLM provider schemas
153
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
154
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
155
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
156
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
157
- * - Midldle layer schemas
158
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
159
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
160
- *
161
- * @template Parameters Target parameters type
162
- * @template Model LLM schema model
163
- * @template Config Configuration of LLM schema composition
164
- * @returns LLM parameters schema
165
- * @reference https://platform.openai.com/docs/guides/function-calling
166
- * @reference https://platform.openai.com/docs/guides/structured-outputs
167
- */
168
- export function parameters(): never;
169
-
170
- /**
171
- * TypeScript parameters to LLM parameters schema.
172
- *
173
- * Creates an LLM (Large Language Model) parameters schema, a type metadata that is used in the
174
- * [LLM function calling](https://platform.openai.com/docs/guides/function-calling)
175
- * and [LLM structured outputs](https://platform.openai.com/docs/guides/structured-outputs),
176
- * from a TypeScript parameters type.
177
- *
178
- * For references, LLM identifies only keyworded arguments, not positional arguments.
179
- * Therefore, the TypeScript parameters type must be an object type, and its properties
180
- * must be static. If dynamic properties are, it would be compilation error.
181
- *
182
- * Also, such parameters type can be utilized not only for the LLM function calling,
183
- * but also for the LLM structured outputs. The LLM structured outputs is a feature
184
- * that LLM (Large Language Model) can generate a structured output, not only a plain
185
- * text, by filling the parameters from the conversation (maybe chatting text) with user
186
- * (human).
187
- *
188
- * Here is the list of available `Model` types with their corresponding LLM schema.
189
- * Reading the following list, and determine the `Model` type considering the
190
- * characteristics of the target LLM provider.
191
- *
192
- * - LLM provider schemas
193
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
194
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
195
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
196
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
197
- * - Midldle layer schemas
198
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
199
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
200
- *
201
- * @template Parameters Target parameters type
202
- * @template Model LLM schema model
203
- * @template Config Configuration of LLM schema composition
204
- * @returns LLM parameters schema
205
- * @reference https://platform.openai.com/docs/guides/function-calling
206
- * @reference https://platform.openai.com/docs/guides/structured-outputs
207
- */
208
- export function parameters<
209
- Parameters extends Record<string, any>,
210
- Model extends ILlmSchema.Model,
211
- Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
212
- >(): ILlmSchema.ModelParameters[Model];
213
-
214
- /**
215
- * @internal
216
- */
217
- export function parameters(): never {
218
- NoTransformConfigurationError("llm.parameters");
219
- }
220
-
221
- /**
222
- * > You must configure the generic argument `T`.
223
- *
224
- * TypeScript type to LLM type schema.
225
- *
226
- * Creates an LLM (Large Language Model) type schema, a type metadata that is used in the
227
- * [LLM function calling](@reference https://platform.openai.com/docs/guides/function-calling),
228
- * from a TypeScript type.
229
- *
230
- * The returned {@link ILlmSchema} type would be specified by the `Model` argument,
231
- * and here is the list of available `Model` types with their corresponding LLM schema.
232
- * Reading the following list, and determine the `Model` type considering the
233
- * characteristics of the target LLM provider.
234
- *
235
- * - LLM provider schemas
236
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
237
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
238
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
239
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
240
- * - Midldle layer schemas
241
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
242
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
243
- *
244
- * If you actually want to perform the LLM function calling with TypeScript functions,
245
- * you can do it with the {@link application} function. Otherwise you hope to perform the
246
- * structured output, {@link parameters} function is better. Let's enjoy the LLM function calling
247
- * and structured output with the native TypeScript functions and types.
248
- *
249
- * > **What LLM function calling is?
250
- * >
251
- * > LLM (Large Language Model) selects property function and fill the arguments,
252
- * > but actual function call execution is not by LLM, but by you.
253
- * >
254
- * > In nowadays, most LLM (Large Language Model) like OpenAI are supporting
255
- * > "function calling" feature. The "function calling" means that LLM automatically selects
256
- * > a proper function and compose parameter values from the user's chatting text.
257
- * >
258
- * > When LLM selects the proper function and its arguments, you just call the function
259
- * > with the arguments. And then informs the return value to the LLM by system prompt,
260
- * > LLM will continue the next conversation based on the return value.
261
- *
262
- * @template T Target type
263
- * @template Model LLM schema model
264
- * @template Config Configuration of LLM schema composition
265
- * @returns LLM schema
266
- * @reference https://platform.openai.com/docs/guides/function-calling
267
- * @reference https://platform.openai.com/docs/guides/structured-outputs
268
- * @author Jeongho Nam - https://github.com/samchon
269
- */
270
- export function schema(): never;
271
-
272
- /**
273
- * TypeScript type to LLM type schema.
274
- *
275
- * Creates an LLM (Large Language Model) type schema, a type metadata that is used in the
276
- * [LLM function calling](@reference https://platform.openai.com/docs/guides/function-calling),
277
- * from a TypeScript type.
278
- *
279
- * The returned {@link ILlmSchema} type would be specified by the `Model` argument,
280
- * and here is the list of available `Model` types with their corresponding LLM schema:
281
- *
282
- * - LLM provider schemas
283
- * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
284
- * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
285
- * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
286
- * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
287
- * - Midldle layer schemas
288
- * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
289
- * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
290
- *
291
- * If you actually want to perform the LLM function calling with TypeScript functions,
292
- * you can do it with the {@link application} function. Otherwise you hope to perform the
293
- * structured output, {@link parameters} function is better. Let's enjoy the LLM function calling
294
- * and structured output with the native TypeScript functions and types.
295
- *
296
- * > **What LLM function calling is?
297
- * >
298
- * > LLM (Large Language Model) selects property function and fill the arguments,
299
- * > but actual function call execution is not by LLM, but by you.
300
- * >
301
- * > In nowadays, most LLM (Large Language Model) like OpenAI are supporting
302
- * > "function calling" feature. The "function calling" means that LLM automatically selects
303
- * > a proper function and compose parameter values from the user's chatting text.
304
- * >
305
- * > When LLM selects the proper function and its arguments, you just call the function
306
- * > with the arguments. And then informs the return value to the LLM by system prompt,
307
- * > LLM will continue the next conversation based on the return value.
308
- *
309
- * @template T Target type
310
- * @template Model LLM schema model
311
- * @template Config Configuration of LLM schema composition
312
- * @returns LLM schema
313
- * @reference https://platform.openai.com/docs/guides/function-calling
314
- * @reference https://platform.openai.com/docs/guides/structured-outputs
315
- * @author Jeongho Nam - https://github.com/samchon
316
- */
317
- export function schema<
318
- T,
319
- Model extends ILlmSchema.Model,
320
- Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
321
- >(
322
- ...$defs: Extract<
323
- ILlmSchema.ModelSchema[Model],
324
- { $ref: string }
325
- > extends never
326
- ? []
327
- : [Record<string, ILlmSchema.ModelSchema[Model]>]
328
- ): ILlmSchema.ModelSchema[Model];
329
-
330
- /**
331
- * @internal
332
- */
333
- export function schema(): never {
334
- NoTransformConfigurationError("llm.schema");
335
- }
1
+ import { ILlmApplication, ILlmController, ILlmSchema } from "@samchon/openapi";
2
+
3
+ import { NoTransformConfigurationError } from "./transformers/NoTransformConfigurationError";
4
+
5
+ export function controller(
6
+ name: string,
7
+ execute: object,
8
+ options?: Partial<Pick<ILlmApplication.IOptions<any>, "separate">>,
9
+ ): never;
10
+
11
+ export function controller<
12
+ Class extends Record<string, any>,
13
+ Model extends ILlmSchema.Model,
14
+ Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
15
+ >(
16
+ name: string,
17
+ execute: Class,
18
+ options?: Partial<Pick<ILlmApplication.IOptions<Model>, "separate">>,
19
+ ): ILlmController<Model>;
20
+
21
+ /**
22
+ * @internal
23
+ */
24
+ export function controller(..._args: any[]): never {
25
+ NoTransformConfigurationError("llm.controller");
26
+ }
27
+
28
+ /**
29
+ * > You must configure the generic argument `App`.
30
+ *
31
+ * TypeScript functions to LLM function calling application.
32
+ *
33
+ * Creates an application of LLM (Large Language Model) function calling application
34
+ * from a TypeScript class or interface type containing the target functions to be
35
+ * called by the LLM function calling feature.
36
+ *
37
+ * If you put the returned {@link ILlmApplication.functions} objects to the LLM provider
38
+ * like [OpenAI (ChatGPT)](https://openai.com/), the LLM will automatically select the
39
+ * proper function and fill its arguments from the conversation (maybe chatting text)
40
+ * with user (human). This is the concept of the LLM function calling.
41
+ *
42
+ * By the way, there can be some parameters (or their nested properties) which must be
43
+ * composed by human, not by LLM. File uploading feature or some sensitive information
44
+ * like security keys (password) are the examples. In that case, you can separate the
45
+ * function parameters to both LLM and human sides by configuring the
46
+ * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
47
+ * assigned to the {@link ILlmFunction.separated} property.
48
+ *
49
+ * For reference, the actual function call execution is not by LLM, but by you.
50
+ * When the LLM selects the proper function and fills the arguments, you just call
51
+ * the function with the LLM prepared arguments. And then informs the return value to
52
+ * the LLM by system prompt. The LLM will continue the next conversation based on
53
+ * the return value.
54
+ *
55
+ * Additionally, if you've configured {@link ILlmApplication.IOptions.separate},
56
+ * so that the parameters are separated to human and LLM sides, you can merge these
57
+ * humand and LLM sides' parameters into one through {@link HttpLlm.mergeParameters}
58
+ * before the actual LLM function call execution.
59
+ *
60
+ * Here is the list of available `Model` types with their corresponding LLM schema.
61
+ * Reading the following list, and determine the `Model` type considering the
62
+ * characteristics of the target LLM provider.
63
+ *
64
+ * - LLM provider schemas
65
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
66
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
67
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
68
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
69
+ * - Midldle layer schemas
70
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
71
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
72
+ *
73
+ * @template Class Target class or interface type collecting the functions to call
74
+ * @template Model LLM schema model
75
+ * @template Config Configuration of LLM schema composition
76
+ * @param options Options for the LLM application construction
77
+ * @returns Application of LLM function calling schemas
78
+ * @reference https://platform.openai.com/docs/guides/function-calling
79
+ * @author Jeongho Nam - https://github.com/samchon
80
+ */
81
+ export function application(
82
+ options?: Partial<Pick<ILlmApplication.IOptions<any>, "separate">>,
83
+ ): never;
84
+
85
+ /**
86
+ * TypeScript functions to LLM function calling application.
87
+ *
88
+ * Creates an application of LLM (Large Language Model) function calling application
89
+ * from a TypeScript class or interface type containing the target functions to be
90
+ * called by the LLM function calling feature.
91
+ *
92
+ * If you put the returned {@link ILlmApplication.functions} objects to the LLM provider
93
+ * like [OpenAI (ChatGPT)](https://openai.com/), the LLM will automatically select the
94
+ * proper function and fill its arguments from the conversation (maybe chatting text)
95
+ * with user (human). This is the concept of the LLM function calling.
96
+ *
97
+ * By the way, there can be some parameters (or their nested properties) which must be
98
+ * composed by human, not by LLM. File uploading feature or some sensitive information
99
+ * like security keys (password) are the examples. In that case, you can separate the
100
+ * function parameters to both LLM and human sides by configuring the
101
+ * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
102
+ * assigned to the {@link ILlmFunction.separated} property.
103
+ *
104
+ * For reference, the actual function call execution is not by LLM, but by you.
105
+ * When the LLM selects the proper function and fills the arguments, you just call
106
+ * the function with the LLM prepared arguments. And then informs the return value to
107
+ * the LLM by system prompt. The LLM will continue the next conversation based on
108
+ * the return value.
109
+ *
110
+ * Additionally, if you've configured {@link ILlmApplication.IOptions.separate},
111
+ * so that the parameters are separated to human and LLM sides, you can merge these
112
+ * humand and LLM sides' parameters into one through {@link HttpLlm.mergeParameters}
113
+ * before the actual LLM function call execution.
114
+ *
115
+ * Here is the list of available `Model` types with their corresponding LLM schema.
116
+ * Reading the following list, and determine the `Model` type considering the
117
+ * characteristics of the target LLM provider.
118
+ *
119
+ * - LLM provider schemas
120
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
121
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
122
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
123
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
124
+ * - Midldle layer schemas
125
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
126
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
127
+ *
128
+ * @template Class Target class or interface type collecting the functions to call
129
+ * @template Model LLM schema model
130
+ * @template Config Configuration of LLM schema composition
131
+ * @param options Options for the LLM application construction
132
+ * @returns Application of LLM function calling schemas
133
+ * @reference https://platform.openai.com/docs/guides/function-calling
134
+ * @author Jeongho Nam - https://github.com/samchon
135
+ */
136
+ export function application<
137
+ Class extends Record<string, any>,
138
+ Model extends ILlmSchema.Model,
139
+ Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
140
+ >(
141
+ options?: Partial<Pick<ILlmApplication.IOptions<Model>, "separate">>,
142
+ ): ILlmApplication<Model, Class>;
143
+
144
+ /**
145
+ * @internal
146
+ */
147
+ export function application(): never {
148
+ NoTransformConfigurationError("llm.application");
149
+ }
150
+
151
+ /**
152
+ * > You must configure the generic argument `Parameters`.
153
+ *
154
+ * TypeScript parameters to LLM parameters schema.
155
+ *
156
+ * Creates an LLM (Large Language Model) parameters schema, a type metadata that is used in the
157
+ * [LLM function calling](https://platform.openai.com/docs/guides/function-calling)
158
+ * and [LLM structured outputs](https://platform.openai.com/docs/guides/structured-outputs),
159
+ * from a TypeScript parameters type.
160
+ *
161
+ * For references, LLM identifies only keyworded arguments, not positional arguments.
162
+ * Therefore, the TypeScript parameters type must be an object type, and its properties
163
+ * must be static. If dynamic properties are, it would be compilation error.
164
+ *
165
+ * Also, such parameters type can be utilized not only for the LLM function calling,
166
+ * but also for the LLM structured outputs. The LLM structured outputs is a feature
167
+ * that LLM (Large Language Model) can generate a structured output, not only a plain
168
+ * text, by filling the parameters from the conversation (maybe chatting text) with user
169
+ * (human).
170
+ *
171
+ * Here is the list of available `Model` types with their corresponding LLM schema.
172
+ * Reading the following list, and determine the `Model` type considering the
173
+ * characteristics of the target LLM provider.
174
+ *
175
+ * - LLM provider schemas
176
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
177
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
178
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
179
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
180
+ * - Midldle layer schemas
181
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
182
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
183
+ *
184
+ * @template Parameters Target parameters type
185
+ * @template Model LLM schema model
186
+ * @template Config Configuration of LLM schema composition
187
+ * @returns LLM parameters schema
188
+ * @reference https://platform.openai.com/docs/guides/function-calling
189
+ * @reference https://platform.openai.com/docs/guides/structured-outputs
190
+ */
191
+ export function parameters(): never;
192
+
193
+ /**
194
+ * TypeScript parameters to LLM parameters schema.
195
+ *
196
+ * Creates an LLM (Large Language Model) parameters schema, a type metadata that is used in the
197
+ * [LLM function calling](https://platform.openai.com/docs/guides/function-calling)
198
+ * and [LLM structured outputs](https://platform.openai.com/docs/guides/structured-outputs),
199
+ * from a TypeScript parameters type.
200
+ *
201
+ * For references, LLM identifies only keyworded arguments, not positional arguments.
202
+ * Therefore, the TypeScript parameters type must be an object type, and its properties
203
+ * must be static. If dynamic properties are, it would be compilation error.
204
+ *
205
+ * Also, such parameters type can be utilized not only for the LLM function calling,
206
+ * but also for the LLM structured outputs. The LLM structured outputs is a feature
207
+ * that LLM (Large Language Model) can generate a structured output, not only a plain
208
+ * text, by filling the parameters from the conversation (maybe chatting text) with user
209
+ * (human).
210
+ *
211
+ * Here is the list of available `Model` types with their corresponding LLM schema.
212
+ * Reading the following list, and determine the `Model` type considering the
213
+ * characteristics of the target LLM provider.
214
+ *
215
+ * - LLM provider schemas
216
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
217
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
218
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
219
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
220
+ * - Midldle layer schemas
221
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
222
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
223
+ *
224
+ * @template Parameters Target parameters type
225
+ * @template Model LLM schema model
226
+ * @template Config Configuration of LLM schema composition
227
+ * @returns LLM parameters schema
228
+ * @reference https://platform.openai.com/docs/guides/function-calling
229
+ * @reference https://platform.openai.com/docs/guides/structured-outputs
230
+ */
231
+ export function parameters<
232
+ Parameters extends Record<string, any>,
233
+ Model extends ILlmSchema.Model,
234
+ Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
235
+ >(): ILlmSchema.ModelParameters[Model];
236
+
237
+ /**
238
+ * @internal
239
+ */
240
+ export function parameters(): never {
241
+ NoTransformConfigurationError("llm.parameters");
242
+ }
243
+
244
+ /**
245
+ * > You must configure the generic argument `T`.
246
+ *
247
+ * TypeScript type to LLM type schema.
248
+ *
249
+ * Creates an LLM (Large Language Model) type schema, a type metadata that is used in the
250
+ * [LLM function calling](@reference https://platform.openai.com/docs/guides/function-calling),
251
+ * from a TypeScript type.
252
+ *
253
+ * The returned {@link ILlmSchema} type would be specified by the `Model` argument,
254
+ * and here is the list of available `Model` types with their corresponding LLM schema.
255
+ * Reading the following list, and determine the `Model` type considering the
256
+ * characteristics of the target LLM provider.
257
+ *
258
+ * - LLM provider schemas
259
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
260
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
261
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
262
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
263
+ * - Midldle layer schemas
264
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
265
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
266
+ *
267
+ * If you actually want to perform the LLM function calling with TypeScript functions,
268
+ * you can do it with the {@link application} function. Otherwise you hope to perform the
269
+ * structured output, {@link parameters} function is better. Let's enjoy the LLM function calling
270
+ * and structured output with the native TypeScript functions and types.
271
+ *
272
+ * > **What LLM function calling is?
273
+ * >
274
+ * > LLM (Large Language Model) selects property function and fill the arguments,
275
+ * > but actual function call execution is not by LLM, but by you.
276
+ * >
277
+ * > In nowadays, most LLM (Large Language Model) like OpenAI are supporting
278
+ * > "function calling" feature. The "function calling" means that LLM automatically selects
279
+ * > a proper function and compose parameter values from the user's chatting text.
280
+ * >
281
+ * > When LLM selects the proper function and its arguments, you just call the function
282
+ * > with the arguments. And then informs the return value to the LLM by system prompt,
283
+ * > LLM will continue the next conversation based on the return value.
284
+ *
285
+ * @template T Target type
286
+ * @template Model LLM schema model
287
+ * @template Config Configuration of LLM schema composition
288
+ * @returns LLM schema
289
+ * @reference https://platform.openai.com/docs/guides/function-calling
290
+ * @reference https://platform.openai.com/docs/guides/structured-outputs
291
+ * @author Jeongho Nam - https://github.com/samchon
292
+ */
293
+ export function schema(): never;
294
+
295
+ /**
296
+ * TypeScript type to LLM type schema.
297
+ *
298
+ * Creates an LLM (Large Language Model) type schema, a type metadata that is used in the
299
+ * [LLM function calling](@reference https://platform.openai.com/docs/guides/function-calling),
300
+ * from a TypeScript type.
301
+ *
302
+ * The returned {@link ILlmSchema} type would be specified by the `Model` argument,
303
+ * and here is the list of available `Model` types with their corresponding LLM schema:
304
+ *
305
+ * - LLM provider schemas
306
+ * - `chatgpt`: [`IChatGptSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IChatGptSchema.ts)
307
+ * - `claude`: [`IClaudeSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IClaudeSchema.ts)
308
+ * - `gemini`: [`IGeminiSchema`](https://github.com/samchon/openapi/blob/master/src/structures/IGeminiSchema.ts)
309
+ * - `llama`: [`ILlamaSchema`](https://github.com/samchon/openapi/blob/master/src/structures/ILlamaSchema.ts)
310
+ * - Midldle layer schemas
311
+ * - `3.0`: [`ILlmSchemaV3`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3.ts)
312
+ * - `3.1`: [`ILlmSchemaV3_1`](https://github.com/samchon/openapi/blob/master/src/structures/ILlmSchemaV3_1.ts)
313
+ *
314
+ * If you actually want to perform the LLM function calling with TypeScript functions,
315
+ * you can do it with the {@link application} function. Otherwise you hope to perform the
316
+ * structured output, {@link parameters} function is better. Let's enjoy the LLM function calling
317
+ * and structured output with the native TypeScript functions and types.
318
+ *
319
+ * > **What LLM function calling is?
320
+ * >
321
+ * > LLM (Large Language Model) selects property function and fill the arguments,
322
+ * > but actual function call execution is not by LLM, but by you.
323
+ * >
324
+ * > In nowadays, most LLM (Large Language Model) like OpenAI are supporting
325
+ * > "function calling" feature. The "function calling" means that LLM automatically selects
326
+ * > a proper function and compose parameter values from the user's chatting text.
327
+ * >
328
+ * > When LLM selects the proper function and its arguments, you just call the function
329
+ * > with the arguments. And then informs the return value to the LLM by system prompt,
330
+ * > LLM will continue the next conversation based on the return value.
331
+ *
332
+ * @template T Target type
333
+ * @template Model LLM schema model
334
+ * @template Config Configuration of LLM schema composition
335
+ * @returns LLM schema
336
+ * @reference https://platform.openai.com/docs/guides/function-calling
337
+ * @reference https://platform.openai.com/docs/guides/structured-outputs
338
+ * @author Jeongho Nam - https://github.com/samchon
339
+ */
340
+ export function schema<
341
+ T,
342
+ Model extends ILlmSchema.Model,
343
+ Config extends Partial<ILlmSchema.ModelConfig[Model]> = {},
344
+ >(
345
+ ...$defs: Extract<
346
+ ILlmSchema.ModelSchema[Model],
347
+ { $ref: string }
348
+ > extends never
349
+ ? []
350
+ : [Record<string, ILlmSchema.ModelSchema[Model]>]
351
+ ): ILlmSchema.ModelSchema[Model];
352
+
353
+ /**
354
+ * @internal
355
+ */
356
+ export function schema(): never {
357
+ NoTransformConfigurationError("llm.schema");
358
+ }