utils.hpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899
  1. #pragma once
  2. #include "common.h"
  3. #include "log.h"
  4. #include "llama.h"
  5. #ifndef NDEBUG
  6. // crash the server in debug mode, otherwise send an http 500 error
  7. #define CPPHTTPLIB_NO_EXCEPTIONS 1
  8. #endif
  9. // increase max payload length to allow use of larger context size
  10. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 1048576
  11. #include "httplib.h"
  12. // Change JSON_ASSERT from assert() to GGML_ASSERT:
  13. #define JSON_ASSERT GGML_ASSERT
  14. #include "json.hpp"
  15. #include <random>
  16. #include <sstream>
  17. #include <string>
  18. #include <vector>
  19. #define DEFAULT_OAICOMPAT_MODEL "gpt-3.5-turbo-0613"
  20. using json = nlohmann::ordered_json;
  21. using llama_tokens = std::vector<llama_token>;
  22. #define SLT_INF(slot, fmt, ...) LOG_INF("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  23. #define SLT_WRN(slot, fmt, ...) LOG_WRN("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  24. #define SLT_ERR(slot, fmt, ...) LOG_ERR("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  25. #define SLT_DBG(slot, fmt, ...) LOG_DBG("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  26. #define SRV_INF(fmt, ...) LOG_INF("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  27. #define SRV_WRN(fmt, ...) LOG_WRN("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  28. #define SRV_ERR(fmt, ...) LOG_ERR("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  29. #define SRV_DBG(fmt, ...) LOG_DBG("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  30. #define QUE_INF(fmt, ...) LOG_INF("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  31. #define QUE_WRN(fmt, ...) LOG_WRN("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  32. #define QUE_ERR(fmt, ...) LOG_ERR("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  33. #define QUE_DBG(fmt, ...) LOG_DBG("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  34. // https://community.openai.com/t/openai-chat-list-of-error-codes-and-types/357791/11
  35. enum error_type {
  36. ERROR_TYPE_INVALID_REQUEST,
  37. ERROR_TYPE_AUTHENTICATION,
  38. ERROR_TYPE_SERVER,
  39. ERROR_TYPE_NOT_FOUND,
  40. ERROR_TYPE_PERMISSION,
  41. ERROR_TYPE_UNAVAILABLE, // custom error
  42. ERROR_TYPE_NOT_SUPPORTED, // custom error
  43. };
  44. template <typename T>
  45. static T json_value(const json & body, const std::string & key, const T & default_value) {
  46. // Fallback null to default value
  47. if (body.contains(key) && !body.at(key).is_null()) {
  48. try {
  49. return body.at(key);
  50. } catch (NLOHMANN_JSON_NAMESPACE::detail::type_error const &) {
  51. LOG_WRN("Wrong type supplied for parameter '%s'. Expected '%s', using default value\n", key.c_str(), json(default_value).type_name());
  52. return default_value;
  53. }
  54. } else {
  55. return default_value;
  56. }
  57. }
  58. //
  59. // tokenizer and input processing utils
  60. //
  61. static bool json_is_array_of_numbers(const json & data) {
  62. if (data.is_array()) {
  63. for (const auto & e : data) {
  64. if (!e.is_number_integer()) {
  65. return false;
  66. }
  67. }
  68. return true;
  69. }
  70. return false;
  71. }
  72. // is array having BOTH numbers & strings?
  73. static bool json_is_array_of_mixed_numbers_strings(const json & data) {
  74. bool seen_string = false;
  75. bool seen_number = false;
  76. if (data.is_array()) {
  77. for (const auto & e : data) {
  78. seen_string |= e.is_string();
  79. seen_number |= e.is_number_integer();
  80. if (seen_number && seen_string) {
  81. return true;
  82. }
  83. }
  84. }
  85. return false;
  86. }
  87. /**
  88. * this handles 2 cases:
  89. * - only string, example: "string"
  90. * - mixed string and tokens, example: [12, 34, "string", 56, 78]
  91. */
  92. static llama_tokens tokenize_mixed(const llama_context * ctx, const json & json_prompt, bool add_special, bool parse_special) {
  93. // If `add_bos` is true, we only add BOS, when json_prompt is a string,
  94. // or the first element of the json_prompt array is a string.
  95. llama_tokens prompt_tokens;
  96. if (json_prompt.is_array()) {
  97. bool first = true;
  98. for (const auto & p : json_prompt) {
  99. if (p.is_string()) {
  100. auto s = p.template get<std::string>();
  101. llama_tokens p;
  102. if (first) {
  103. p = common_tokenize(ctx, s, add_special, parse_special);
  104. first = false;
  105. } else {
  106. p = common_tokenize(ctx, s, false, parse_special);
  107. }
  108. prompt_tokens.insert(prompt_tokens.end(), p.begin(), p.end());
  109. } else {
  110. if (first) {
  111. first = false;
  112. }
  113. prompt_tokens.push_back(p.template get<llama_token>());
  114. }
  115. }
  116. } else {
  117. auto s = json_prompt.template get<std::string>();
  118. prompt_tokens = common_tokenize(ctx, s, add_special, parse_special);
  119. }
  120. return prompt_tokens;
  121. }
  122. /**
  123. * break the input "prompt" object into multiple prompt if needed, then tokenize them
  124. * this supports these cases:
  125. * - "prompt": "string"
  126. * - "prompt": [12, 34, 56]
  127. * - "prompt": [12, 34, "string", 56, 78]
  128. * and multiple prompts (multi-tasks):
  129. * - "prompt": ["string1", "string2"]
  130. * - "prompt": ["string1", [12, 34, 56]]
  131. * - "prompt": [[12, 34, "string", 56, 78], [12, 34, 56]]
  132. */
  133. static std::vector<llama_tokens> tokenize_input_prompts(llama_context * ctx, const json & json_prompt, bool add_special, bool parse_special) {
  134. std::vector<llama_tokens> result;
  135. if (json_prompt.is_string() || json_is_array_of_mixed_numbers_strings(json_prompt)) {
  136. // string or mixed
  137. result.push_back(tokenize_mixed(ctx, json_prompt, add_special, parse_special));
  138. } else if (json_is_array_of_numbers(json_prompt)) {
  139. // array of tokens
  140. result.push_back(json_prompt.get<llama_tokens>());
  141. } else if (json_prompt.is_array()) {
  142. // array of prompts
  143. result.reserve(json_prompt.size());
  144. for (const auto & p : json_prompt) {
  145. if (p.is_string() || json_is_array_of_mixed_numbers_strings(p)) {
  146. result.push_back(tokenize_mixed(ctx, p, add_special, parse_special));
  147. } else if (json_is_array_of_numbers(p)) {
  148. // array of tokens
  149. result.push_back(p.get<llama_tokens>());
  150. } else {
  151. throw std::runtime_error("element of \"prompt\" must be a string, an list of tokens, or a list of mixed strings & tokens");
  152. }
  153. }
  154. } else {
  155. throw std::runtime_error("\"prompt\" must be a string, an list of tokens, a list of mixed strings & tokens, or a list of prompts");
  156. }
  157. return result;
  158. }
  159. //
  160. // template utils
  161. //
  162. // format rerank task: [BOS]query[EOS][SEP]doc[EOS]
  163. static llama_tokens format_rerank(const struct llama_model * model, const llama_tokens & query, const llama_tokens & doc) {
  164. llama_tokens result;
  165. result.reserve(doc.size() + query.size() + 4);
  166. result.push_back(llama_token_bos(model));
  167. result.insert(result.end(), query.begin(), query.end());
  168. result.push_back(llama_token_eos(model));
  169. result.push_back(llama_token_sep(model));
  170. result.insert(result.end(), doc.begin(), doc.end());
  171. result.push_back(llama_token_eos(model));
  172. return result;
  173. }
  174. // format infill task
  175. static llama_tokens format_infill(
  176. const llama_context * ctx,
  177. const json & input_prefix,
  178. const json & input_suffix,
  179. const json & input_extra,
  180. const int n_batch,
  181. const int n_predict,
  182. const int n_ctx,
  183. const bool spm_infill,
  184. const llama_tokens & tokens_prompt
  185. ) {
  186. // TODO: optimize this block by reducing memory allocations and movement
  187. // use FIM repo-level pattern:
  188. // ref: https://arxiv.org/pdf/2409.12186
  189. //
  190. // [FIM_REP]myproject
  191. // [FIM_SEP]filename0
  192. // extra chunk 0
  193. // [FIM_SEP]filename1
  194. // extra chunk 1
  195. // ...
  196. // [FIM_SEP]filename
  197. // [FIM_PRE]prefix[FIM_SUF]suffix[FIM_MID]prompt
  198. //
  199. llama_tokens extra_tokens;
  200. extra_tokens.reserve(n_ctx);
  201. auto model = llama_get_model(ctx);
  202. auto tokens_prefix = tokenize_mixed(ctx, input_prefix, false, false);
  203. auto tokens_suffix = tokenize_mixed(ctx, input_suffix, false, false);
  204. if (llama_token_fim_rep(model) != LLAMA_TOKEN_NULL) {
  205. // TODO: make project name an input
  206. static const auto k_fim_repo = common_tokenize(ctx, "myproject\n", false, false);
  207. extra_tokens.push_back(llama_token_fim_rep(model));
  208. extra_tokens.insert(extra_tokens.end(), k_fim_repo.begin(), k_fim_repo.end());
  209. }
  210. for (const auto & chunk : input_extra) {
  211. // { "text": string, "filename": string }
  212. const std::string text = json_value(chunk, "text", std::string());
  213. const std::string filename = json_value(chunk, "filename", std::string("tmp"));
  214. if (llama_token_fim_sep(model) != LLAMA_TOKEN_NULL) {
  215. const auto k_fim_file = common_tokenize(ctx, filename + "\n", false, false);
  216. extra_tokens.insert(extra_tokens.end(), llama_token_fim_sep(model));
  217. extra_tokens.insert(extra_tokens.end(), k_fim_file.begin(), k_fim_file.end());
  218. } else {
  219. // chunk separator in binary form to avoid confusing the AI
  220. static const char k_chunk_prefix_str[] = {0x0a, 0x0a, 0x2d, 0x2d, 0x2d, 0x20, 0x73, 0x6e, 0x69, 0x70, 0x70, 0x65, 0x74, 0x20, 0x2d, 0x2d, 0x2d, 0x0a, 0x0a, 0x00};
  221. static const auto k_chunk_prefix_tokens = common_tokenize(ctx, k_chunk_prefix_str, false, false);
  222. extra_tokens.insert(extra_tokens.end(), k_chunk_prefix_tokens.begin(), k_chunk_prefix_tokens.end());
  223. }
  224. const auto chunk_tokens = common_tokenize(ctx, text, false, false);
  225. extra_tokens.insert(extra_tokens.end(), chunk_tokens.begin(), chunk_tokens.end());
  226. }
  227. if (llama_token_fim_sep(model) != LLAMA_TOKEN_NULL) {
  228. // TODO: current filename
  229. static const auto k_fim_file = common_tokenize(ctx, "filename\n", false, false);
  230. extra_tokens.insert(extra_tokens.end(), llama_token_fim_sep(model));
  231. extra_tokens.insert(extra_tokens.end(), k_fim_file.begin(), k_fim_file.end());
  232. }
  233. // for now pick FIM context to fit in a batch (ratio prefix:suffix = 3:1, TODO: configurable?)
  234. const int n_suffix_take = std::min<int>(tokens_suffix.size(), (n_batch/4));
  235. const int n_prefix_take = std::min<int>(tokens_prefix.size(), 3*(n_batch/4) - 3);
  236. // fill the rest of the context with extra chunks
  237. const int n_extra_take = std::min<int>(std::max<int>(0, n_ctx - (n_batch) - 2*n_predict), extra_tokens.size());
  238. tokens_prefix.erase(tokens_prefix.begin(), tokens_prefix.begin() + tokens_prefix.size() - n_prefix_take);
  239. tokens_suffix.resize(n_suffix_take);
  240. tokens_prefix.insert(tokens_prefix.begin(), llama_token_fim_pre(model));
  241. tokens_prefix.insert(tokens_prefix.end(), tokens_prompt.begin(), tokens_prompt.end());
  242. tokens_suffix.insert(tokens_suffix.begin(), llama_token_fim_suf(model));
  243. auto embd_inp = spm_infill ? tokens_suffix : tokens_prefix;
  244. auto embd_end = spm_infill ? tokens_prefix : tokens_suffix;
  245. if (llama_add_bos_token(model)) {
  246. embd_inp.insert(embd_inp.begin(), llama_token_bos(model));
  247. }
  248. SRV_DBG("extra: n_ctx = %d, n_extra_take = %d, n_extra = %d\n", n_ctx, n_extra_take, (int) extra_tokens.size());
  249. // put the extra context before the FIM prefix
  250. embd_inp.insert(embd_inp.begin(), extra_tokens.end() - n_extra_take, extra_tokens.end());
  251. embd_inp.insert(embd_inp.end(), embd_end.begin(), embd_end.end());
  252. embd_inp.push_back(llama_token_fim_mid(model));
  253. return embd_inp;
  254. }
  255. // Format given chat. If tmpl is empty, we take the template from model metadata
  256. inline std::string format_chat(const struct llama_model * model, const std::string & tmpl, const std::vector<json> & messages) {
  257. std::vector<common_chat_msg> chat;
  258. for (size_t i = 0; i < messages.size(); ++i) {
  259. const auto & curr_msg = messages[i];
  260. std::string role = json_value(curr_msg, "role", std::string(""));
  261. std::string content;
  262. if (curr_msg.contains("content")) {
  263. if (curr_msg["content"].is_string()) {
  264. content = curr_msg["content"].get<std::string>();
  265. } else if (curr_msg["content"].is_array()) {
  266. for (const auto & part : curr_msg["content"]) {
  267. if (part.contains("text")) {
  268. content += "\n" + part["text"].get<std::string>();
  269. }
  270. }
  271. } else {
  272. throw std::runtime_error("Invalid 'content' type (ref: https://github.com/ggerganov/llama.cpp/issues/8367)");
  273. }
  274. } else {
  275. throw std::runtime_error("Missing 'content' (ref: https://github.com/ggerganov/llama.cpp/issues/8367)");
  276. }
  277. chat.push_back({role, content});
  278. }
  279. const auto formatted_chat = common_chat_apply_template(model, tmpl, chat, true);
  280. LOG_DBG("formatted_chat: '%s'\n", formatted_chat.c_str());
  281. return formatted_chat;
  282. }
  283. static std::string llama_get_chat_template(const struct llama_model * model) {
  284. std::string template_key = "tokenizer.chat_template";
  285. // call with NULL buffer to get the total size of the string
  286. int32_t res = llama_model_meta_val_str(model, template_key.c_str(), NULL, 0);
  287. if (res < 0) {
  288. return "";
  289. } else {
  290. std::vector<char> model_template(res, 0);
  291. llama_model_meta_val_str(model, template_key.c_str(), model_template.data(), model_template.size());
  292. return std::string(model_template.data(), model_template.size());
  293. }
  294. }
  295. //
  296. // base64 utils (TODO: move to common in the future)
  297. //
  298. static const std::string base64_chars =
  299. "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  300. "abcdefghijklmnopqrstuvwxyz"
  301. "0123456789+/";
  302. static inline bool is_base64(uint8_t c) {
  303. return (isalnum(c) || (c == '+') || (c == '/'));
  304. }
  305. static inline std::vector<uint8_t> base64_decode(const std::string & encoded_string) {
  306. int i = 0;
  307. int j = 0;
  308. int in_ = 0;
  309. int in_len = encoded_string.size();
  310. uint8_t char_array_4[4];
  311. uint8_t char_array_3[3];
  312. std::vector<uint8_t> ret;
  313. while (in_len-- && (encoded_string[in_] != '=') && is_base64(encoded_string[in_])) {
  314. char_array_4[i++] = encoded_string[in_]; in_++;
  315. if (i == 4) {
  316. for (i = 0; i < 4; i++) {
  317. char_array_4[i] = base64_chars.find(char_array_4[i]);
  318. }
  319. char_array_3[0] = ((char_array_4[0] ) << 2) + ((char_array_4[1] & 0x30) >> 4);
  320. char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2);
  321. char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3];
  322. for (i = 0; (i < 3); i++) {
  323. ret.push_back(char_array_3[i]);
  324. }
  325. i = 0;
  326. }
  327. }
  328. if (i) {
  329. for (j = i; j < 4; j++) {
  330. char_array_4[j] = 0;
  331. }
  332. for (j = 0; j < 4; j++) {
  333. char_array_4[j] = base64_chars.find(char_array_4[j]);
  334. }
  335. char_array_3[0] = ((char_array_4[0] ) << 2) + ((char_array_4[1] & 0x30) >> 4);
  336. char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2);
  337. char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3];
  338. for (j = 0; j < i - 1; j++) {
  339. ret.push_back(char_array_3[j]);
  340. }
  341. }
  342. return ret;
  343. }
  344. //
  345. // random string / id
  346. //
  347. static std::string random_string() {
  348. static const std::string str("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz");
  349. std::random_device rd;
  350. std::mt19937 generator(rd());
  351. std::string result(32, ' ');
  352. for (int i = 0; i < 32; ++i) {
  353. result[i] = str[generator() % str.size()];
  354. }
  355. return result;
  356. }
  357. static std::string gen_chatcmplid() {
  358. return "chatcmpl-" + random_string();
  359. }
  360. //
  361. // other common utils
  362. //
  363. static size_t longest_common_prefix(const std::vector<llama_token> & a, const std::vector<llama_token> & b) {
  364. size_t i;
  365. for (i = 0; i < a.size() && i < b.size() && a[i] == b[i]; i++) {}
  366. return i;
  367. }
  368. static size_t longest_common_prefix(const std::string & a, const std::string & b) {
  369. size_t i;
  370. for (i = 0; i < a.size() && i < b.size() && a[i] == b[i]; i++) {}
  371. return i;
  372. }
  373. static bool ends_with(const std::string & str, const std::string & suffix) {
  374. return str.size() >= suffix.size() && 0 == str.compare(str.size() - suffix.size(), suffix.size(), suffix);
  375. }
  376. static size_t find_partial_stop_string(const std::string &stop, const std::string &text) {
  377. if (!text.empty() && !stop.empty()) {
  378. const char text_last_char = text.back();
  379. for (int64_t char_index = stop.size() - 1; char_index >= 0; char_index--) {
  380. if (stop[char_index] == text_last_char) {
  381. const std::string current_partial = stop.substr(0, char_index + 1);
  382. if (ends_with(text, current_partial)) {
  383. return text.size() - char_index - 1;
  384. }
  385. }
  386. }
  387. }
  388. return std::string::npos;
  389. }
  390. // TODO: reuse llama_detokenize
  391. template <class Iter>
  392. static std::string tokens_to_str(llama_context * ctx, Iter begin, Iter end) {
  393. std::string ret;
  394. for (; begin != end; ++begin) {
  395. ret += common_token_to_piece(ctx, *begin);
  396. }
  397. return ret;
  398. }
  399. // format incomplete utf-8 multibyte character for output
  400. static std::string tokens_to_output_formatted_string(const llama_context * ctx, const llama_token token) {
  401. std::string out = token == -1 ? "" : common_token_to_piece(ctx, token);
  402. // if the size is 1 and first bit is 1, meaning it's a partial character
  403. // (size > 1 meaning it's already a known token)
  404. if (out.size() == 1 && (out[0] & 0x80) == 0x80) {
  405. std::stringstream ss;
  406. ss << std::hex << (out[0] & 0xff);
  407. std::string res(ss.str());
  408. out = "byte: \\x" + res;
  409. }
  410. return out;
  411. }
  412. struct completion_token_output {
  413. llama_token tok;
  414. std::string text_to_send;
  415. struct token_prob {
  416. llama_token tok;
  417. float prob;
  418. };
  419. std::vector<token_prob> probs;
  420. };
  421. // convert a vector of completion_token_output to json
  422. static json probs_vector_to_json(const llama_context * ctx, const std::vector<completion_token_output> & probs) {
  423. json out = json::array();
  424. for (const auto & prob : probs) {
  425. json probs_for_token = json::array();
  426. for (const auto & p : prob.probs) {
  427. const std::string tok_str = tokens_to_output_formatted_string(ctx, p.tok);
  428. probs_for_token.push_back(json {
  429. {"tok_str", tok_str},
  430. {"prob", p.prob},
  431. });
  432. }
  433. const std::string tok_str = tokens_to_output_formatted_string(ctx, prob.tok);
  434. out.push_back(json {
  435. {"content", tok_str},
  436. {"probs", probs_for_token},
  437. });
  438. }
  439. return out;
  440. }
  441. static bool server_sent_event(httplib::DataSink & sink, const char * event, const json & data) {
  442. const std::string str =
  443. std::string(event) + ": " +
  444. data.dump(-1, ' ', false, json::error_handler_t::replace) +
  445. "\n\n"; // note: these newlines are important (not sure why though, if you know, add a comment to explain)
  446. LOG_DBG("data stream, to_send: %s", str.c_str());
  447. return sink.write(str.c_str(), str.size());
  448. }
  449. //
  450. // OAI utils
  451. //
  452. static json oaicompat_completion_params_parse(
  453. const struct llama_model * model,
  454. const json & body, /* openai api json semantics */
  455. const std::string & chat_template) {
  456. json llama_params;
  457. llama_params["__oaicompat"] = true;
  458. // Apply chat template to the list of messages
  459. llama_params["prompt"] = format_chat(model, chat_template, body.at("messages"));
  460. // Handle "stop" field
  461. if (body.contains("stop") && body.at("stop").is_string()) {
  462. llama_params["stop"] = json::array({body.at("stop").get<std::string>()});
  463. } else {
  464. llama_params["stop"] = json_value(body, "stop", json::array());
  465. }
  466. // Handle "response_format" field
  467. if (body.contains("response_format")) {
  468. json response_format = json_value(body, "response_format", json::object());
  469. std::string response_type = json_value(response_format, "type", std::string());
  470. if (response_type == "json_object") {
  471. llama_params["json_schema"] = json_value(response_format, "schema", json::object());
  472. } else if (response_type == "json_schema") {
  473. json json_schema = json_value(response_format, "json_schema", json::object());
  474. llama_params["json_schema"] = json_value(json_schema, "schema", json::object());
  475. } else if (!response_type.empty() && response_type != "text") {
  476. throw std::runtime_error("response_format type must be one of \"text\" or \"json_object\", but got: " + response_type);
  477. }
  478. }
  479. // Handle "n" field
  480. int n_choices = json_value(body, "n", 1);
  481. if (n_choices != 1) {
  482. throw std::runtime_error("Only one completion choice is allowed");
  483. }
  484. // Handle "logprobs" field
  485. // TODO: The response format of this option is not yet OAI-compatible, but seems like no one really using it; We may need to fix it in the future
  486. if (json_value(body, "logprobs", false)) {
  487. llama_params["n_probs"] = json_value(body, "top_logprobs", 20);
  488. } else if (body.contains("top_logprobs") && !body.at("top_logprobs").is_null()) {
  489. throw std::runtime_error("top_logprobs requires logprobs to be set to true");
  490. }
  491. // Params supported by OAI but unsupported by llama.cpp
  492. static const std::vector<std::string> unsupported_params { "tools", "tool_choice" };
  493. for (const auto & param : unsupported_params) {
  494. if (body.contains(param)) {
  495. throw std::runtime_error("Unsupported param: " + param);
  496. }
  497. }
  498. // Copy remaining properties to llama_params
  499. // This allows user to use llama.cpp-specific params like "mirostat", "tfs_z",... via OAI endpoint.
  500. // See "launch_slot_with_task()" for a complete list of params supported by llama.cpp
  501. for (const auto & item : body.items()) {
  502. // Exception: if "n_predict" is present, we overwrite the value specified earlier by "max_tokens"
  503. if (!llama_params.contains(item.key()) || item.key() == "n_predict") {
  504. llama_params[item.key()] = item.value();
  505. }
  506. }
  507. return llama_params;
  508. }
  509. static json format_final_response_oaicompat(const json & request, const json & result, const std::string & completion_id, bool streaming = false, bool verbose = false) {
  510. bool stopped_word = result.count("stopped_word") != 0;
  511. bool stopped_eos = json_value(result, "stopped_eos", false);
  512. int num_tokens_predicted = json_value(result, "tokens_predicted", 0);
  513. int num_prompt_tokens = json_value(result, "tokens_evaluated", 0);
  514. std::string content = json_value(result, "content", std::string(""));
  515. std::string finish_reason = "length";
  516. if (stopped_word || stopped_eos) {
  517. finish_reason = "stop";
  518. }
  519. json choices =
  520. streaming ? json::array({json{{"finish_reason", finish_reason},
  521. {"index", 0},
  522. {"delta", json::object()}}})
  523. : json::array({json{{"finish_reason", finish_reason},
  524. {"index", 0},
  525. {"message", json{{"content", content},
  526. {"role", "assistant"}}}}});
  527. std::time_t t = std::time(0);
  528. json res = json {
  529. {"choices", choices},
  530. {"created", t},
  531. {"model",
  532. json_value(request, "model", std::string(DEFAULT_OAICOMPAT_MODEL))},
  533. {"object", streaming ? "chat.completion.chunk" : "chat.completion"},
  534. {"usage", json {
  535. {"completion_tokens", num_tokens_predicted},
  536. {"prompt_tokens", num_prompt_tokens},
  537. {"total_tokens", num_tokens_predicted + num_prompt_tokens}
  538. }},
  539. {"id", completion_id}
  540. };
  541. // extra fields for debugging purposes
  542. if (verbose) {
  543. res["__verbose"] = result;
  544. }
  545. if (result.contains("completion_probabilities")) {
  546. res["completion_probabilities"] = json_value(result, "completion_probabilities", json::array());
  547. }
  548. return res;
  549. }
  550. // return value is vector as there is one case where we might need to generate two responses
  551. static std::vector<json> format_partial_response_oaicompat(const json & result, const std::string & completion_id) {
  552. if (!result.contains("model") || !result.contains("oaicompat_token_ctr")) {
  553. return std::vector<json>({result});
  554. }
  555. bool first = json_value(result, "oaicompat_token_ctr", 0) == 0;
  556. std::string modelname = json_value(result, "model", std::string(DEFAULT_OAICOMPAT_MODEL));
  557. bool stopped_word = json_value(result, "stopped_word", false);
  558. bool stopped_eos = json_value(result, "stopped_eos", false);
  559. bool stopped_limit = json_value(result, "stopped_limit", false);
  560. std::string content = json_value(result, "content", std::string(""));
  561. std::string finish_reason;
  562. if (stopped_word || stopped_eos) {
  563. finish_reason = "stop";
  564. }
  565. if (stopped_limit) {
  566. finish_reason = "length";
  567. }
  568. std::time_t t = std::time(0);
  569. json choices;
  570. if (!finish_reason.empty()) {
  571. choices = json::array({json{{"finish_reason", finish_reason},
  572. {"index", 0},
  573. {"delta", json::object()}}});
  574. } else {
  575. if (first) {
  576. if (content.empty()) {
  577. choices = json::array({json{{"finish_reason", nullptr},
  578. {"index", 0},
  579. {"delta", json{{"role", "assistant"}}}}});
  580. } else {
  581. // We have to send this as two updates to conform to openai behavior
  582. json initial_ret = json{{"choices", json::array({json{
  583. {"finish_reason", nullptr},
  584. {"index", 0},
  585. {"delta", json{
  586. {"role", "assistant"}
  587. }}}})},
  588. {"created", t},
  589. {"id", completion_id},
  590. {"model", modelname},
  591. {"object", "chat.completion.chunk"}};
  592. json second_ret = json{
  593. {"choices", json::array({json{{"finish_reason", nullptr},
  594. {"index", 0},
  595. {"delta", json{
  596. {"content", content}}}
  597. }})},
  598. {"created", t},
  599. {"id", completion_id},
  600. {"model", modelname},
  601. {"object", "chat.completion.chunk"}};
  602. return std::vector<json>({initial_ret, second_ret});
  603. }
  604. } else {
  605. // Some idiosyncrasy in task processing logic makes several trailing calls
  606. // with empty content, we ignore these at the calee site.
  607. if (content.empty()) {
  608. return std::vector<json>({json::object()});
  609. }
  610. choices = json::array({json{
  611. {"finish_reason", nullptr},
  612. {"index", 0},
  613. {"delta",
  614. json{
  615. {"content", content},
  616. }},
  617. }});
  618. }
  619. }
  620. json ret = json {
  621. {"choices", choices},
  622. {"created", t},
  623. {"id", completion_id},
  624. {"model", modelname},
  625. {"object", "chat.completion.chunk"}
  626. };
  627. if (!finish_reason.empty()) {
  628. int num_tokens_predicted = json_value(result, "tokens_predicted", 0);
  629. int num_prompt_tokens = json_value(result, "tokens_evaluated", 0);
  630. ret.push_back({"usage", json {
  631. {"completion_tokens", num_tokens_predicted},
  632. {"prompt_tokens", num_prompt_tokens},
  633. {"total_tokens", num_tokens_predicted + num_prompt_tokens}
  634. }});
  635. }
  636. return std::vector<json>({ret});
  637. }
  638. static json format_embeddings_response_oaicompat(const json & request, const json & embeddings) {
  639. json data = json::array();
  640. int i = 0;
  641. for (const auto & elem : embeddings) {
  642. data.push_back(json{
  643. {"embedding", json_value(elem, "embedding", json::array())},
  644. {"index", i++},
  645. {"object", "embedding"}
  646. });
  647. }
  648. json res = json {
  649. {"model", json_value(request, "model", std::string(DEFAULT_OAICOMPAT_MODEL))},
  650. {"object", "list"},
  651. {"usage", json { // TODO: fill
  652. {"prompt_tokens", 0},
  653. {"total_tokens", 0}
  654. }},
  655. {"data", data}
  656. };
  657. return res;
  658. }
  659. static json format_response_rerank(const json & request, const json & ranks) {
  660. json data = json::array();
  661. int i = 0;
  662. for (const auto & rank : ranks) {
  663. data.push_back(json{
  664. {"index", i++},
  665. {"relevance_score", json_value(rank, "score", 0.0)},
  666. });
  667. }
  668. json res = json {
  669. {"model", json_value(request, "model", std::string(DEFAULT_OAICOMPAT_MODEL))},
  670. {"object", "list"},
  671. {"usage", json { // TODO: fill
  672. {"prompt_tokens", 0},
  673. {"total_tokens", 0}
  674. }},
  675. {"results", data}
  676. };
  677. return res;
  678. }
  679. static bool is_valid_utf8(const std::string & str) {
  680. const unsigned char* bytes = reinterpret_cast<const unsigned char*>(str.data());
  681. const unsigned char* end = bytes + str.length();
  682. while (bytes < end) {
  683. if (*bytes <= 0x7F) {
  684. // 1-byte sequence (0xxxxxxx)
  685. bytes++;
  686. } else if ((*bytes & 0xE0) == 0xC0) {
  687. // 2-byte sequence (110xxxxx 10xxxxxx)
  688. if (end - bytes < 2 || (bytes[1] & 0xC0) != 0x80)
  689. return false;
  690. bytes += 2;
  691. } else if ((*bytes & 0xF0) == 0xE0) {
  692. // 3-byte sequence (1110xxxx 10xxxxxx 10xxxxxx)
  693. if (end - bytes < 3 || (bytes[1] & 0xC0) != 0x80 || (bytes[2] & 0xC0) != 0x80)
  694. return false;
  695. bytes += 3;
  696. } else if ((*bytes & 0xF8) == 0xF0) {
  697. // 4-byte sequence (11110xxx 10xxxxxx 10xxxxxx 10xxxxxx)
  698. if (end - bytes < 4 || (bytes[1] & 0xC0) != 0x80 ||
  699. (bytes[2] & 0xC0) != 0x80 || (bytes[3] & 0xC0) != 0x80)
  700. return false;
  701. bytes += 4;
  702. } else {
  703. // Invalid UTF-8 lead byte
  704. return false;
  705. }
  706. }
  707. return true;
  708. }
  709. static json format_tokenizer_response(const json & tokens) {
  710. return json {
  711. {"tokens", tokens}
  712. };
  713. }
  714. static json format_detokenized_response(const std::string & content) {
  715. return json {
  716. {"content", content}
  717. };
  718. }
  719. static json format_error_response(const std::string & message, const enum error_type type) {
  720. std::string type_str;
  721. int code = 500;
  722. switch (type) {
  723. case ERROR_TYPE_INVALID_REQUEST:
  724. type_str = "invalid_request_error";
  725. code = 400;
  726. break;
  727. case ERROR_TYPE_AUTHENTICATION:
  728. type_str = "authentication_error";
  729. code = 401;
  730. break;
  731. case ERROR_TYPE_NOT_FOUND:
  732. type_str = "not_found_error";
  733. code = 404;
  734. break;
  735. case ERROR_TYPE_SERVER:
  736. type_str = "server_error";
  737. code = 500;
  738. break;
  739. case ERROR_TYPE_PERMISSION:
  740. type_str = "permission_error";
  741. code = 403;
  742. break;
  743. case ERROR_TYPE_NOT_SUPPORTED:
  744. type_str = "not_supported_error";
  745. code = 501;
  746. break;
  747. case ERROR_TYPE_UNAVAILABLE:
  748. type_str = "unavailable_error";
  749. code = 503;
  750. break;
  751. }
  752. return json {
  753. {"code", code},
  754. {"message", message},
  755. {"type", type_str},
  756. };
  757. }