json-gpt

<!doctype html> <html lang="en"> <head> <title>Code coverage report for solve-json.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="index.html">All files</a> solve-json.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 83.87% Statements 26/31 </div> <div class='fl pad1y space-right2'> 70.58% Branches 12/17 </div> <div class='fl pad1y space-right2'> 100% Functions 6/6 </div> <div class='fl pad1y space-right2'> 95.83% Lines 23/24 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. <template id="filterTemplate"> <div class="quiet"> Filter: <input oninput="onInput()" type="search" id="fileSearch"> </div> </template> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a></td><td class="line-coverage quiet">                                    2x                                                                                                                                 2x   2x   2x                     2x   1x 1x 1x                     2x 2x 2x 2x 2x         1x           4x 4x             5x 5x 3x   2x         3x 3x       1x  </td><td class="text"><pre class="prettyprint lang-js">/** * Module for solving requests using the OpenAI GPT-3 API. * @module solveJson */   import { SolveRequestOptions, solve } from "./solve" import { z } from "zod"; import { getJsonSchema } from "./utils"     /** * Function for solving a parse error that occurs while trying to parse JSON from text. * @function * @async * @param {string} text - The text that contains the JSON string. * @param {string} error - The error message that describes the parse error. * @returns {Promise<SolveResponse>} - A promise that resolves to the corrected JSON string, or a JSON object with a "message" property containing the original text if the text does not contain a valid JSON string. */ async function solveParseError(text: string, error: string, textKey: string = 'text') { return solve( ` ###INSTRUCTIONS: Catched error while trying to parse JSON from text. The text may contain a json string, read the error and correct it without modifing the content. If the text do not contain a json string please return it like this "{"${textKey}":"text..."}" Make sure to scape all line breaks and bad characters!.   ###ERROR: ${error}   ###TEXT: ${text} `)}   /** * Interface for a JSON solving request. * @interface * @template Output - The expected output type of the solved JSON. * @property {string} instructions - Instructions for solving the JSON. * @property {object} target - The target object to solve within the JSON. * @property {string} target.key - The key of the target object. * @property {string} target.value - The value of the target object. * @property {string} safeKey? - The key name of the return strinc content in case of json parse fail. * @property {z.ZodType<Output>} zodSchema - The Zod schema for indicating the model the output format and validating it. * @property {object} data - Additional data to be passed to the solving function. */ export interface SolveJsonRequest<Output extends object> { instructions: string; target: { key: string; value: string; }; safeKey?: string; zodSchema: z.ZodType<Output>; data: { [key: string]: any } }   /** * Type for the response of a JSON solving request. * @typedef {Object} SolveJsonResponse * @property {number} status - The status code of the response. * @property {Output} data - The data returned by the solving function, if successful. * @property {Object} data.error - The error object returned by the solving function, if unsuccessful. * @property {string} data.text - The original text input to the solving function. */ export type SolveJsonResponse<Output extends object> = { status: number; data: Output; } | { status: number; data: { error: any; text: string; } }   /** * Function for solving a request from a JSON object using the OpenAI GPT-3.5-turbo API. Solves the target based on the provided instructions and schema. * @function * @async * @template Output - The expected output type of the solved JSON. * @param {SolveJsonRequest<T>} json - The JSON request object containing instructions, target, schema, and data. * @param {SolveRequestOptions} options - Optional options for the solving process. * @returns {Promise<SolveJsonResponse<T>>} - A promise that resolves to the solved JSON response. */ export async function solveJson<Output extends object>(json: SolveJsonRequest<Output>, options?: SolveRequestOptions): Promise<SolveJsonResponse<Output>> {   const verbose = options?.verbose || false   const jsonSchema = getJsonSchema(json.zodSchema, 'Output')   const solved = await solve([{ role: 'system', content: JSON.stringify({ instructions: `Read the data, the ${json.target.key} and use your knowledge to respond to it following this instructions and the outputSchema. ${json.instructions} \n\n Your output must be a json following the exact outputSchema. IMPORTANT: Your output will de parsed to JSON so do not output plain text!`, outputSchema: jsonSchema, [json.target.key]: json.target.value, data: json.data }) } ], options)   if (solved.status === 200) return fullParse(solved.data, json.zodSchema,verbose,json.safeKey)   const data = JSON.parse(solved.data) Iif (verbose) console.log('SOLVE ERROR', data) return handleError(solved.status, data.error, data.text, verbose) }   /** * Handles an error response from the OpenAI API. * @param {SolveApiResponse} solved - The response from the OpenAI API. * @param {SolveJsonRequest<Output>} json - The JSON request object. * @param {boolean} verbose - Whether to log verbose output or not. * @returns {SolveJsonResponse<Output>} - The solved JSON response. */ async function handleParseError<Output extends object>(text: string, error: string, z: z.ZodType<Output>, verbose: boolean, safeKey?: string): Promise<SolveJsonResponse<Output>> { Iif (verbose) console.log('PARSE ERROR', text, error) const solved = await solveParseError(text,error,safeKey) Iif (verbose) console.log('SOLVED?', solved) Eif (solved.status === 200) try { return { status: solved.status, data: JSON.parse(solved.data) } } catch(error: any) { return handleError(1,'ERROR PARSING HANDLED PARSE ERROR', error.message, verbose) } return handleError(solved.status,'ERROR SOLVING HANDLED PARSE ERROR', solved.data, verbose) }   export function handleError<Output extends object>(status: number, error: string, message: string, verbose: boolean): SolveJsonResponse<Output> { Iif (verbose) console.error(`STATUS: ${status}`,`ERROR: ${error}: ${message}`) return { status, data: { error, text: message } } }   export function fullParse<Output extends object>(text: string, z: z.ZodType<Output>, verbose: boolean, safeKey?: string) { try { const obj = JSON.parse(text) return zodParse(obj,z,verbose) } catch (error: any) { return handleParseError(text,error.message,z,verbose,safeKey) } }   function zodParse<Output extends object>(obj: Output, z: z.ZodType<Output>, verbose: boolean): SolveJsonResponse<Output> { const zParse = z.safeParse(obj) if (zParse.success) return { status: 200, data: obj } return handleError(2,'ZOD PARSE ERROR',zParse.error.message,verbose) }</pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a> at 2023-04-20T20:51:27.664Z </div> <script src="prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="sorter.js"></script> <script src="block-navigation.js"></script> </body> </html>