diff --git a/docs/assets/search.js b/docs/assets/search.js index 68b33d3..bb60f89 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dXXPjNrL9L/ardyKA33m7k4/N3M3sTSW7e+vWVGqKtmCbY0lUSGqcSSr//QIkQTZa3QBF+2GqNFYDB+jTaDQOKfLPq6Z+bq++/vDn1VN12F59LWR+c3Uo9+rq66tvdpU6dFc3V6dmp/97tyvbVrVfDX9+89jtd/q78a/6+6u/bmwviZBTL3f1oe2a011XN76url070O3N1bFszECmEc1AYiPjCcn07UMYvp977trt36r2b8em+lx2ajlOeaz+ob54oSaTVWhyEwMWHksvB9ejwUKPnfX9yy/fBbsfbNYi/Kdqq/oQBJnMVuHU++NOdUEcaLYG57v9rdpuq8ODFwZarUH5vrzrTuWu6vxR5pitwflBlbvu8ZtHdffkBXLt1iC9O3xSd0F6oNUalJ/VcVfeqZ/evfPCOGZrcP5V/17dhdgBRqswmvLQ7oZU4QEBVqs8Vj5/W/9d+TMMMCLyWd1pztT2Qsyf6nYB6Gj1aqg6kS0Dng3XYifpnDSaBmx+1aFTzb2Ov/ar/gvvTupsPCrcz7W1oYNhGMnc/eye9/VW7dqpc3U47duvhj/6BzhP821TbR9UVz+r5seyeVDvuv373f5dd8f3eu1rQ09hHCg5gh9Us1et/Kmpf9yV+zLK33qgSePLMf9Zn9qhq74bKSIfKG39kpm+r3TZVO6yZVOF1pej6jF/LkWSvf3hew+aa7XCo+qkh2hKAu+kkNnlOP9XRfFbp7w6B4E2lyN8q9SxVerpG23TpNnbd2OJ6wH0NFmID1JevVN4Sfd/W7qi/6ttdbyUBzzguZNraEIPcBgF2f+/W9XwXY/fXtzrL1/aTu35fqfvl/U8+1MXDNid5k+L8+OuBnUWan9tv6UH1UOTvY7FDNvv/P2ins+Kqfeqe6y3Z2HkfLnUAz+Xh219xsx5V9eTIUOROzQS6/vyCTuFQhrN1uN8o4uvh7r5sgALmK7He1+2OIgorNHsQpyZ/R/Lw8OpfDjLH9PfF+eQ+6Z6Kg8Hf0fX0Iwe9DwiGmf/WDYVrjUwymS0DqMpb4MQ1mYlwl4dqvIQwpis1qH8oZrbsvoUxIF2q5Delu1vJ7wOEcpksw5B7crm1AZ95titRDo86NN2CMYarcOo2zD9s9EqDJ2Gyl0IYzZah/Go7h5VCGMyWovR1E8qEF3AaiVKdVBtEMQarcNo6rIL0g6s1qH8od0dgBhNVvX/bXmo2gDAZLMO4dSFZmBNVvX/3eFhF5zCbLQOo+3q8BIHVqtQvq8+BTEmm5UIu+pYHeoQxmS1EuUQDqrZaB2GNguF1WSzCuHveke4C/IBrNahqLp5CKPMVitRmn0YY7RZh9Do828AYDRZ1//pU9noTBqAmK1WofxQVuGUPhutw1C3jXoOQFibdQj6DwFHWZN1/Z90udSE/QTMVuG8u9Plnx5noHiHZutw9LlVVwLBCTl265CaYF60Juv61/VfeBqT0SqM/y6PZbi4AlarUP6hj5XltvSDzEYrMf4onwJ0TDbrEOpGheiYbFYh/Fh2n4OMz0brMKru8VSG6x/HbhXS+/JObRdUWo7dSqRd+UWEUEab9QhyAYJ8EYL+h8U5CmQ0W4vTBRf8bLQSQ+/bj4FdazZahfFPdQxKAZPNOoS6eVbhcg6arcL5STXh7Wo2WodRh49Vk81KhKY7PZyCoeXYrUL6ud4vyF/Aah3KqQ2zMhutwvil3NchiMlmHYJqboOzmI3WYezqz2XguDDZrEZYIMpCs5U45We9EQVKVGC1DuW4QKaZjdZhPJePVSg9zkYrMdQ2PI/JaBXGv8p9tfMjWJN1/audTkYBAGuzDuGxDNAwWqzr/dQ8BTmYjVZh/PupKavw6oNm63CabYCJ0WJV7/+rdiE/WZNV/f+nUp35GNr/HLvlSPBuprdlq9L4u8OduUNhQgN3IzkG3suE7q2VfYOh8bJur1ETej7ueOk5mTs83h2Op+69als9dwof2yy/b6upd8t7vB6t6cmcDZSBvKs1DLhvI4g6N7gYmHTk/xzNfZytdwCjzXJH3p/fFxvq9/p+wU2yeNAMfIdv+wyCd8F7QBdC35q7Q35q6v2xO7+VNjgMpvXLhnSsquUjGIxfDOjcuHAROm558VDIKPcOYXlc7809XOG+rq1dYPAszLB0/YtyRJpN14KVv/+rflKBFDCiAduVcJ3aH5U+0p8af6od16VjvRayPv60BGswWwlSL8ijA85suRwKB3Vg+7t45wtsQxfvQIFdz7fRXrbHBoDqU+dZ/Q7UZHoJGOblm8e6umOnNny7nBX9F/X7gs6urSE/9HFg/oSzBGo2XQvWdno9swsFYk2WF0BhRjicC1hgN7DR+f5tig3NW7PB+7uebC7v/q5R5fDbB0//s9HlAN69cOk2yI6+p5UNknH0k9EiAOcQM878W/i7HZ+LvvX+dAcBoRD85ZfvvEWI/f6V6hCnuwUcTMNbWY0gvCUFSRAyVJMgzEVlSQh0QWXiwi4tToLAnvoEIYZKlBBUfQhUDi4eNL8INE2SaF4EHz92X46XQr6ZWoWR38wD9S7Db9WuKz3j6L9/tarJ6XBR2TQN0TsLf5ExGbxSneH2t6DUmEfIwG0DLEA4a/sCuAd1MKtUbT926ncfWRD3rNELBrCrH45NfetLZhAamL8A9L4yFwY+6t2r5RUIhIzbXAZPRKoH9zXqL9tNqAQzI1lVhU0ACwoxD0igFptQlpRjHphQVXBBQbCyLptnsqA0c2Eurc6w04IFGoJDwTo81MBbpgGT15GUcYfh0y4cJQP420m1PtHxDBQ0eBFwtfeUFWeo1vpFkMEy8Qx2WaW4AHpBsXgGvrReXALvKRnPcUNVIw1IL5FA/egYveYyuUwWcse6rnwjcJfUcIug/boUgbxAneKAaR79RSS0eaU68qzLBaWkM9R12tU57BIFawmwX8c6x12gZjGwNIN+5Neor0BPoRJrHNKqKgvCLCi0/FCBWgtiLSm3/GDeigtChYuuwKz8dZczqwWl1xnYpdUX4cZgAXYOCsN6euATX4O5Jq+hlhE9hqhC4+QugfbXcBdjTuYvAvWXQ+Rcw+XQMuhQOUSBLyqHFsJz5RCJ6y2HWEA6Wj3bKLJ5jW2U6jK0jeKhrl8kzia6cJWs3kJJ1NAWuhCW1YFIUL8AxEPSAePHffGu7fbk3bXnIV2+ayOY0K4dhPLt2ggruGuHwTybKQYLbaYU2EWbKT07/2ZKgsLnmNnHGrJ7qWuxPOq4lUP05183aIiXagoUnl9SYAFJx2n/kwq1Y/AKGf28v0A6d0d4cVol8AI5dRGgOnvaph9TBZ+7ycGSbHlRX5pS3Y58GXUez8UJFYEE8mkQyJNOEVIomwah2LoBAfkLhiDMNrQgx8tFpedqEQVySa6mXedN1SQkCOH5ybDuw10BKjJ5haRD9RhIO3icXOK5q+kDAAlprV8GyeY6GtOf7XhQmjU/7ktTD+rJl3vAkC5OPhgmkH3CUJ70g7FC+WcBmCEqEAC2mBstL4C6JD8wc/MmCBoUxNp0HzibIFyLV8gPRIeB9IAGyYsit+Vtxa0bCtZt8hJwPk9QuIE0wUKSzHlBX5oj3I58KWIez8UZAoEEEkQQyJMfEFIoPYSh2OyAkfzJgQK6JDfQ8/KmBhISxNf8dHQ2NSCTV8gNVI+B5IDHyUAe1PNHXjYlcZ0mLwLnswMJHEgPPCjNnx/3pRkC9eRLEWBIF+cIDBNIEmEoT5bAWKE0sQCMzRNnWP5EQUJdkimYuXlTBQ0KYs2+44DNFI7BK+SJ8/4CWcId4aXnCwLOf7pYBsdmBQrPnxM4QIolH+JLs4HTjy8XTIO5OBO4EIE8EILxZAEXJ5QDgkBsBkA4/vVPwFyy+sk5edc+BQhjanzxCFOHgq+XRxa/DFFvoUUIxsYJzpcN/9q1Xw3LqlpngH5dawGUJ8mceTOQYkgwKhi85F1ypZJel05H3hwzjefyJOOChLJMCMiXZlykYJ4JQd2qtvu4MK5HTKLJK4F/DEY6M4SPywLfP5BgIoHgy3IJf9F3Hrt3tamzRBJecWpttidDy5/uqXmClwG+M1fB/qm657o5f1cY/NK7ype+GPCsw0WvB3TGyNBlcMJog9WMwr+8bwnmrftMEx729vxJJhcjh5+pwuMvep4KN2McLN9X4N5bB9N883phMvW2PEb6oXFqYtk9hoBGm8Us+fB8wTEjXh4ZCPPCsJiRl8fEgPjrzXh6+/rPq8/msYF6W/n6Sr6J3hS6xX2ldlvd+sMwFN1fvd+bPn4dv/uPMvQZi8Hkq83VzYfNTSLfJPGvv958sA36v/d/6K2E/p+4ieM3mzRzzIRjJvX/5E2cvYkj6ZhJxyzS/4sIzMix0u74EFOdxY5Zov+XUGaJY5bq/6WUWeqYZfp/GWWWOWa5/l9O+SN3zDQlHwrKrHC9a5wtKBYEoqHnQVDjEy4TwnhckFwIlwxhvC4iklyXEGEcL0hKhMuJML4XCTUhlxVhvC9SytDlRRj/i4wydJkRhgGRk4N0yREFb+nyI3t+CgJcuvxIQ4KkiJRoofQrRVCGLjvSUCAlZeiSIw0DklpV0uVGGgZ0giQMXW6kYUBSJEqXG2kYkBSJ0uVGGgIkRaJ0qZHG/3rDIwxdZiLjf0kxE7nMRMb/EcVM5DITGf9HFDMRSmJ9FqOYiVxmIuP/iMx3LjOR8X9EMRO5zETG/xHFTOQyExn/RxQzkctMZPwfUcxELjOR8X9EMRO5zMTG/xHFTOwyExv/xxQzsctMbPwfU8zELjOx8X9MMROjHabfYihmYpeZ2Pg/ppiJXWZi4/+YYiZ2mYmN/2OKmdhlJjb+jylmYpeZ2Pg/ppiJXWYS4/+YYiZxmUmM/xOKmcRlJjH+TyhmEpeZxPg/oZhJXGYS4/+EYiZBu3+//VPMJC4zifF/QjGTuMwkxv8JxUziMpMY/ycUM4nLTGL8n1DMJC4zqfF/QjGTusykxv8pxUzqMpMa/6cUM6nLTGr8n1LMpC4zpkr9kFLMpC4zqfF/SjGTosqsL80oZlKXmdT4P6WYSV1mUuP/lGImdZlJjf9TipnUZSYz/k8pZjKXmcz4P6OYyVxmMuP/jGImc5nJjP8zipnMZSYz/s8oZjKXmcz4P6OYyVxmMuP/jGImQ1VzXzZTzGQuM5nxf0Yxk7nMZMb/GcVM5jKTG/9nFDO5y0xu/J9TzOQuM7nxf04xk7vM5Mb/OcVM7jKTG//nFDO5y0xu/J9TzOQuM7nxf04xk7vM5Mb/OcVMjk40/ZGGYiZ3mcmN/3OKmdxlpjD+zylmCpeZwvi/oJgpXGYK4/+CYqZwmSmM/wuKmcJlpjD+LyhmCpeZwvi/oJgpXGYK4/+CYqZwmSmM/wuKmcJlpjD+LyhmCnTa7I+bFDMFPm8aAgqKmuEraNofOTf04RSdOTf9oXNDETR8B237Y+eG4mj4Dtr2B88NRdPwHbTtj54biqnhO2jbnz435Dl1g86fm/4AuiGPqht0BN30Z9ANeVrdoEPopj+FbijWhu+A7agTkLydKQWDVEDyhrWCQSwQJG9YLRjkAkHyhvWCQTBgtAUsGQyagSCJw6rBIBuI5CYWb5IzY8TcIB2IlDZG1A3yAS00YP1AsPKOQAKCGBQE2hFIQxByYI6MCIlVnoE5MiKQkiB6wUCQ6oRAYoLoNQNBChQC6Qmilw002k2kJ5djrQkx10sHGo4WphBzvXyg8UjmkLYgeglB49HGiLpeRtB4tDEir5cSBKlbCCQziF5NEKR0IZDSICLpCcwIq3SRJ+SR4iCigb6C9DJSHUQvLghSGxFIeBC9vqAnQnKNxAfRawx6IvQoEH29zqAnQveM6Ou1BlqIRDKEiIeVF99Eke5XuMZIihC94qAnTRsj+nrVQU+aNkb0xZFnkcRYZ+3pizKSayRNiHigL6eHgfiLB/7IfIEUChFnviEj+uLcs66RUiHiwrOukVohko1nXSPFQiTCs66RaiF6cUKQ0pNAwoXo9QlBqk8CaRciGXRycotMsFCeeHIAkjBEr1QIUrASSMUQSeZZqUjJEL1gIUiBSyAxQ/SahSA1LoH0DNHLFoKUuQSSNESvXAhS6RJI1RC9eEFe9BFI1xBp5Fn/SNsQaexZ/0jfEGniWf8pvs6RehYT0jlEmnnWP9I6RJp71j/SO0Q6kEduT0jyEL2ywe04SPYQ2cAemViQ8iF6gUMvXZI/pH6ILPLkCqSAiCz25Aqkgogs8eQKpISIXvAQpMYpMnypKvM5DtGX5Z4EgEQRkRWefR0JI6LXPwSptgqkjYhceLIF0kdELj37OtJIRB559nWkk4heDiGv0gqklIg88axrpJaIPPWsa6SYiDzzrGukmog896xrpJyIXiDh1jVST0Sx8axrpKCIXigRpGAukIgiCukZMhJSRK+XCFJgF0hLEUXsWapITxFF4lmqSFMRRepZqkhXEb18IkipXyBpRRS5J+6RvCKKwuc4fMl4w8e9RCKLHESWhIx8iVQW2Ssp5D0KEokscuPZ/CRSWeTGs/lJJLPIjWfzk0hnkYPOQse9REKLHIQWOu4lUlrkoLSQF2EkUlrkoLRwTkb0DVILvUdJpLXIQWshr/BIpLXIQWuhI04isUUKT/KUSG2RvaBC3pQikdYiez2FMUXcDVILE0JIapGD1MKEEJJa5CC1MCGEtBYpPGtP4ts1BrWFvJAm8R0bg9rChNvZXRs9eeSFN4lv3BjkFoZofPPGoLek5C1WEt/AMQguTFTgmzh6TYUUqSS+jWOQWxiq8a0cg9zCUI1v5xjkFoZqJLfIQW5JJZktkN4iIx99SHCRg+BCXryUSG+RkY8+pLfIQW8hL3ZKJLfIyMce0lvkoLeQN3xJJLfIyEcfkltk5KMPyS0y8tGHBBcZ++hDgouMffQhwUUOggt5pVgivUXGPvqQ3iIHvYW8siyR3CJjH31IbpGD3ELfEYnkFhn76ENyi4x99CG5RcY++pDcIhMffUhukYmPPiS3yEFuIS/LSyS3yMRHH9JbZOJLnkhwkYmPPyS4yEFwIWV7iQQXmfj4Q4KLTHz8IcVFJj7+kOQiUx9/SHORqY8/JLrIdOCPvGFSItlFDrILwwmSXeQgu3A9IwJTz+UGiWQXOcguDNtIdpGD7ELKyhKpLnJUXWi2keoiB9WFYRvJLnKQXRi2kewiB9mFvDFFItlFDrILeW+KRKqLHFQX8vYUiUQXOYgu5B0qEmkuMvOI1RJpLnLQXMg7WiTSXOSguZDRhhQX2YsqdE5Geosc9JaMDgmkt8hBb2GyBRJc5CC4kPfWSKS3yEFvobtFvA1qC3knjkRii8xjz+SQ3CIHuYWb3EBc/9OEz6rp1Pbd8BOFDx+mlwj9efVx/N2CUdH7Xs1PGIx4/vWff/01/1LB/M/0Xt431VN5MD/jmtvCpnrLZ1ruH8vGvMEdtJOgHYt4rJ7UF9gsmluxjZryFmGBVrp64Jrtx5fZg4YxaJhwDdu2arvSPM1+bikLMNAN1/IP1dyW1ScEmgDQlGlqfx4DSMzAYM1S0KY3VyZsfD0o+1Zr0JEA1Jg7CNj2v52cMIpTMPCMa6Z2ZXNqsaMz0DRnmx4eyl3ltMtBu4JtN//oEfpLQH+x0zz7xSjoIi1gF2JhF/YXn3AsG9gRt4z6txo7qwEuB5Zo02p4uks1P0kJ8g2caO5nYLqp27PlAaafcEF+21TbB9XVz6rRzD+oqtvvd/uqc1aohPPnRnBXduXOHUEC2iWeduqhbtw8AuYccYFz17/2EswXBNuwvIS37d34TGvg6wgM2FzL5xtXwyNnQVsJs7Tk6J7aTq9ngFTHcGkH4ac37MIuMtgFt1ZNF9QAJIy1iGVMt25bpyVIisno+5RbJ2Nzwv1wJzAXaL3tx1emweYwMyY+BnTzcwIjsF4Em9pN88/jiynmxiC3puP82dQ+90C4IIFzyLlVO3dxPg2YdM01ylAPVBwkMJYz3hWaROWueNAw4QNgeLQITNVg2nLYkfXuGNsPif2Q8h5RTf2k3KAEnbJl091jdVAomEEYesJofGQ2jCC4+GKbhNLMRoTd9TesR3eVcisVkJDYqYOHrs8NwVAyC8sSMvVARSRY2+Z6UKiL84iE/jRX17gewK+lQWvQdpxHZieU8xMaX2AEM2MKM6PlJJLjh8TmrYxNmvaJGJBx2Gls+0ptX/nk+vEvckjJ+oO0wRDZD7H9kNgPGUv5MJRt/0NrOBy49uMpE4+Y5iroOBw7Lml9GtkPsf2Q2A/p5Hd2R2pqvSWhvR/sZQnb8A+dQZxWcCPhVsm2NO9vdJoBGhIuRIeHJsO4hPWh5Hy9VerYKvXUV+JpdluNYeoUSGC1SS5+iA0L7vcJ2+7UIScBNLYVePb43BKEh41DEdsPHElTT+cOBP2ZC3eB9kRmgH7bsFPpT0HEmUrAxDJNJLdRnrMzOjzscASBqSTcpqmaBiUnuN6mVca1brsa1+gwBNm97R48h3luClqO+UIImzgkt3Tmru6GR+TBPRhW+ZJLrfflk5Nz4J4XcQzeV5/QxCFYykXOfbWrjtWhdhqCDYEtMdEbXuGSg1u0B/iAUwysUFKumLhvdKy6zUCIplwtYc7Nd9hBIDekXCDj1/fCicJtm43oB1U3DxgZtEy5QHpQzR41gzUwl4MfGp1JnVaAj5QLn4fTp1JP09EWUrD02Cr3sazwvgRFAXZ/fVTlrns8XyLweMi3vW3Us1OKgWasDKHrV12Jy2NT73blvozyW2eDgWoIF/VzF/tK71HlLnP7AKHInk91Nbx1/Ax1GFb6eDwdHsoGeToDK4YVcHS1uSs1pKM3ZGCkGTfSClVicC+1BwcxrFRTidkCbBPZ/S61ydIWQ5H9ENsPif3Ahub4Nha4p8EgyaRF48Kl7+C+fzYRVJzAGjT6tqftwT4ECzaHVLPnt/FJpdCJsNqO7Ek2mQ4wwm5xU/Vg5yetWyP7IbYf2KOXRq312QuHDSCSrTgZqQyWA3Y8/OzHLoidELov4oK+atAWAUnjnd7pZI9mDDJnxmXOT+WxxAfVDB7yuAg11wTKrVO4ZSB3ZlzufCr/KJ/c+YHUyUoTT7XedZ3p5WBBsKGsk8DDSUeze/UCtIz5lt1n5NAcBAJ7RtRF0OOpxAVZDpJWzgWuztCfS70sbh/vnQQLJX4ucufX3sPNGh4j2TpwX96p7VkJmYNgZTWnfbkrvwinGRgsWyj3zaTTDMR4zsV430z/2zstwRxzLsp1yw4FeQ6CPOeCfG/qg0dn48rhYYcL8n3ZupI9CPGY5+H3bnydJNRO4QZk9xRhD/UisztRwXJECHERlAOjKQ9zMT12gQYGT0nSJnX2Os755Q8JByGtqmDzu7C7pUgn6XM6CllFpLAnk+mIwta0Pb47A3hO50g5qCO6+pTDExLf7KQLJaOGomIJbsBcnMMH88PtA0S6ZK9oHurmWeHauwAZj1XKDvWpHWq9vlSUInKH7mipTB/2QbIw1uCJwcpAIrUyZm7rpc2kGEwqki0HIvshth8S+4Gt0WkFGqZ+wSrJ1BUQqMUI9uKufdE4bAj1/8hOm90fh4cuwqIL0s7uHUfzDEJEOtiuCm6qx8oJbgEXhWCPBLpVMzw0f6+6x9otmeFlPcFGiu7CcTBMSRHbqMYCSwGaFXyzpjs9nNAOUIAExmZP5xU6cDHCTZm9CkusYihgCnbEv+nBntWh8MqrYE98jT731M4WCdXkiNsim/J5Wz8oNFi4WnwNj3WLkhWsPHwt21adNYZLjR3vEH/OPIFr2ausTty6EQhmy5b3Y3O8bJytzCarcB/EGQFuEOytNfo0jy7xQqbsEVTYQ5PI7MGVPQeYHh1vwGu2kktWOrzPSt0CsFCwLJzas3QFplBwrmvLfY2agUhjLyOd3weSOsqH3XoS+4GV4lrV3OKBg3AtuPKn1bW9rrEdPcI8zgUIP9yCbnf159KJkgJwU3DcmGZn9zYVMIVsuF2sPZ5dCjGPkwEtucC0z9iH+z+sE+1OLnJ7jN9YWV3Yv9hSUEb2g73kJO3VNMkKiO1z+Vi5BZt5ug0YOsvss9qeTRqOfcNl+fZL2yk34wJnsQf9rtxXbkW8gXvDhls7ndrpzcxtCJc/exnYeWU8TF6wtS26RDLlDFuzsKv5TCWGF87kxmomGy5Uu8cSMQa3jw23qrv6eHQnApvZK6HCXnEUmT1jsOmlm14hAwMYxu/Yg5xuIQh1RaR4eHWKrUG7+WUTsASAtbRdC6x/uBvYYGpP7XbFXkZwn+UPt2l4ImAFVR1uT2frCu7w7AW601NTVjiDmWc0gbZcSJ2aLVoiMPOxsmn/RHywCYIJjm5iBbFT695RCW/6Yu95+lypzhi1aDt3JEcuRJ71gdb1q3Mlgb1y+qWK4lt8mxtcO5KMqF9vdNF+VLvqoI0+/PrXX/8PznqhH1fRAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dXXPjNrL9L/ardyKA33m7k4/N3GT2pja7e+vWVGqKtmCbY0lUSGqcSSr//QIkQTZa3QBF+2GqNFY3DoDTaDQOKfLPq6Z+bq++/vDn1VN12F59LWR+c3Uo9+rq66tvdpU6dFc3V6dmp/97tyvbVrVfDX9+89jtd/q78a/6+6u/bmwriZBTK3f1oe2a011XN76mrl070OzN1bFsTEemHs1AYiPjCcm07UMYvp9b7trt36r2b8em+lx2ajlOeax+VF+8UJPJKjS5iQELj6WXg+vRYOGMnbX9yy/fBZsfbNYi/Kdqq/oQBJnMVuHU++NOdUEcaLYG57v9rdpuq8ODFwZarUH5vrzrTuWu6vxR5pitwflBlbvu8ZtHdffkBXLt1iC9O3xSd0F6oNUalH+q4668Uz+/e+eFcczW4Pyr/r26C7EDjFZhNOWh3Q2pwgMCrFbNWPn8bf135c8wwIjIZ3WnOVPbCzF/rtsFoKPVq6HqRLYMeDZci52kc9JoGrD5VYdONfc6/tqv+i+8O6mz8ahwO9fWhg6GoSdz8/P0vK+3atdOjavDad9+NfzR38F5mG+bavuguvpZNT+VzYN61+3f7/bvuju+1WufDz2EsaNkD35QzV618uem/mlX7ssof+uBJo0vx/xHfWqHpvpmpIh8oLT1S0b6vtJlU7nLlg0VWl+Oqvv8uRRJ9vaH7z1ortWKGVUn3UVTEngHhcwux/m/KorfOuXVOQi0uRzhW6WOrVJP32ibJs3evhtLXA+gx2UhPkh59U7hJd3/bemK/q+21fFSHnCH50auoQndwaEXZPv/blXDNz1+e3Grv3xpO7Xn252+X9byPJ+6YMDTaf60OD/ualBnIf9r+y3dqR6abHUsZth25+8XtXxWTL1X3WO9PQsj58ulM/DP8rCtz5g5b+p6MmQocrtGYn1fPuFJoZBGs/U43+ji66FuvizAAqbr8d6XLQ4iCms0uxBnZv+n8vBwKh/O8sf098U55L6pnsrDwd/QNTSjOz33iMbZP5ZNhWsNjDIZrcNoytsghLVZibBXh6o8hDAmq3Uof6jmtqw+BXGg3Sqkt2X72wmvQ4Qy2axDULuyObXBOXPsViIdHvRpOwRjjdZh1G2Y/tloFYZOQ+UuhDEbrcN4VHePKoQxGa3FaOonFYguYLUSpTqoNghijdZhNHXZBWkHVutQ/tDTHYAYTVa1/215qNoAwGSzDuHUhUZgTVa1/93hYRccwmy0DqPt6vASB1arUL6vPgUxJpuVCLvqWB3qEMZktRLlEA6q2WgdhjYLhdVkswrh73pHuAvyAazWoai6eQijzFYrUZp9GGO0WYfQ6PNvAGA0Wdf+6VPZ6EwagJitVqH8UFbhlD4brcNQt416DkBYm3UI+g+BibIm69o/6XKpCc8TMFuF8+5Ol3+6n4HiHZqtw9HnVl0JBAfk2K1DaoJ50Zqsa1/Xf+FhTEarMP67PJbh4gpYrUL5UR8ry23pB5mNVmL8UT4F6Jhs1iHUjQrRMdmsQvip7D4HGZ+N1mFU3eOpDNc/jt0qpPflndouqLQcu5VIu/KLCKGMNusR5AIE+SIE/Q+LcxTIaLYWpwsu+NloJYbetx8Du9ZstArjH+oYlAImm3UIdfOswuUcNFuF87NqwtvVbLQOow4fqyablQhNd3o4BUPLsVuF9M96vyB/Aat1KKc2zMpstArjl3JfhyAmm3UIqrkNjmI2Woexqz+XgePCZLMaYYEoC81W4pSf9UYUKFGB1TqU4wKZZjZah/FcPlah9DgbrcRQ2/A4JqNVGP8q99XOj2BN1rWvdjoZBQCszTqExzJAw2ixrvVT8xTkYDZahfHvp6aswqsPmq3DabYBJkaLVa3/r9qF5smarGr/P5XqzMfQ/ufYLUeCdzO9LVuVxt8d7swdChMauBvJMfBeJnRvrewdBudlzV4jF3o8bn/pMZk7PN4djqfuvWpbPXYKH9ssv2+rqXfLW7werenBnHWUgbyrNQy4byOIOjtcDExO5P8czX2crbcDo83yibw/vy821O71/YKbZHGnGfgO3/YZBO+C94AuhL41d4f83NT7Y3d+K22wG4z3y7p0rKrlPRiMXwzo3LhwETr2vLgrZJR7u7A8rvfmHq5wW9fWLtB5FmZYuv5FOSLNpmvByt//VT+pQAoY0YDtSrhO7Y9KH+lPjT/VjuvSsV4LWR9/XoI1mK0H+XEZyI/rQeoFyXrAmS2XQ+GVE9hjL95eA3vdxdtcYGv17eaXbeQBoPrUeVKMAzWZXgKGefnmsa7u2KEN3y5nRf9F/b6gsWtryHd97Jg/qy2Bmk3XgrWdThrsQoFYk+UFUJgRDucCFthdcpx8/17IhuatqSL8TU82lzd/16hy+IGFp/3Z6HIA74a7dK9le9/TygbJ2PvJaBGAc1IaR/4t/HGQb4q+9f4+CAGhEPzll++8lY79/pWKHae5BRxM3VtZ8iC8JVVPEDJU+CDMRbVPCHRB+ePCLq2AgsCeIgghhuqgBVBsKXQG5a+GQlD1IVCkuHjQ/CLQNEmieb19/Nh9OV4K+WbyCiO/mTvqXfHfql1XevrRf/9qBZrT4KIKbeqidxT+emYyeKWSxm1vQVUz95CB2wZYgHDW9gVwD+pgEoLafuzU7z6yIO6Z0ws6sKsfjk1968ubEBqYvwD0vjIXOj7qjbLlFRWEjH0ugyci1YP7GqWebSZU7ZmerCr4JoAFNZ8HJFD2TShLKj8PTKgAuaD2WFkCziNZUAW6MJcWgnjSgrUggkPBOjykwVsRApPXkchxg+GDNewlA/jbSbU+EfUMFDi8CLjae8qKM1Rr/SLIYEV6BrusKF0AvaAuPQNfWpougfdUp+e4oQJ1GSBbo1KA/jKVBqTXZKBgdYxec11eJnm5fV1XLxK4S4rGRdB+zY1AXqC8ccA0j/6qFdq8UuF61uSC2tXp6jpd7hx2iTq3BNiv0Z3jLlDqGFiaQT/yaxR0oKVQTTd2aVVZB2EWVHZ+qEBxB7GW1Hd+MG+JB6HCVV5gVP5CzxnVglrvDOzSco+YxmDFdw4Kw3p6YhZf9Lkmr6EEEi2GqEL95K4h9xfBF2NO5i8C9ddf5FjD9dcy6FD9RYEvqr8WwnP1F4nrrb8WA9L1FwPoqb9YQHp5ePZtZPMa+zbVZGjfxl1dvyqdXXvhsly9Z5OooT17ISyrdJGgfomLh6QDxo/74jLBbclbJsxdurxMQDChMiEI5SsTEFawTAiDeXZvDBbavSmwi3ZvenT+3ZsEhU+esw+iZDdv12J51HErh2jPv25QFy9VTSg8v2jCApITp+ef1OAdg1fI6OftBdK528OL0yqBF8ipiwDV2fNR/Zgq+KRUDpZky4v60pTqNuTLqHN/Lk6oCCSQT4NAnnSKkELZNAjF1g0IyF8wBGG2oQU5XhArPdfDKJBLcjU9dd5UTUKCEJ6f5es+jhegIpNXSDpUi4G0g/vJJZ67mj5xkJDW+mWQbK6jMf3ZjgelWfPjvjT1oJZ8uQd06eLkg2EC2ScM5Uk/GCuUfxaAGaICAWCLudHyAqhL8gMzNm+CoEFBrE137rMJwrV4hfxANBhID6iTvApzW95W3LqhYF2Xl4DzeYLCDaQJFpJkzgv60hzhNuRLEXN/Ls4QCCSQIIJAnvyAkELpIQzFZgeM5E8OFNAluYEelzc1kJAgvubn2bOpAZm8Qm6gWgwkB9xPBvKgnj/yOi2J67i8CJzPDiRwID3woDR/ftyXZgjUki9FgC5dnCMwTCBJhKE8WQJjhdLEAjA2T5xh+RMFCXVJpmDG5k0VNCiINftWCjZTOAavkCfO2wtkCbeHl54vCDj/6WIZHJsVKDx/TuAAKZZ8iC/NBk47vlwwdebiTOBCBPJACMaTBVycUA4IArEZAOH41z8Bc8nqJ8fkXfsUIIyp8VUxTB0Kvl4eWfwyRK2FFiHoGyc4X9b9a9d+NSyrap0B+nWtBVCeJHM2m4EUQ4JRweAl75IrlfS6dBry5pipP5cnGRcklGVCQL404yIF80wI6la13ceFcT1iEi6vBP4xGOlMFz4uC3x/R4KJBIIvyyX8Rd+5797Vps4SSXjFqbXZngwtf7qnxgle3/jOXAX7h+qe6+b87W7wS+8qX/oqx7MGF73Q0ekjQ5fBCaMNVjMK/7rFJZi37lNoeNjb82fPXIwcfgoOj7/oCTjciHGwfF+Bm30dTPPN64XJ1NryGOm7xqmJZfcYAhptFrPkw/MFx4x4eWQgzAvDYkZeHhMD4q834+nt6z+vPpsHPept5esr+SZ6U2iP+0rtttr7w9AV3V6935s2fh2/+48y9BmLweSrzdXNh81NIt+kWfHrrzcfrEf/Rf+H3kzo/4mbOH4jN6ljJhwzqf8nb+LsTZI5VtKxivT/Igozcsz0fHyIicZixyrR/0sIq8SxSvX/UsIqdawy/b+MsMocq1z/L6fmInfMNB8fCsqscGfWTLQgKRCIg54EQfRPuCwIM92C4kG4RAgz4SIieXW5EGbSBcWGcOkQZt5FQg7HpUSYuRcpaenSIsz8i4y0dKkRhgKRU910yREFa+jSI3t6CgpbuvRIQ4IkiZRolfTLRJCWLkHSsCAlaekSJA0NklxV0mVIGhp0hqQsXYakoUGSXEqXIWlokCSX0mVIGh4kyaV0KZKGCL3rUZYuR5EhQpIcRS5HkSEiIjmKXI4iQ0REchShbNanM5KjyOUoMkREdOZzOYoMERHJUeRyFBkiIpKjyOUoMkREJEeRy1FkiIhIjiKXo8gQEZEcRS5HsSEiIjmKXY5iQ0RMchS7HMWGiJjkKHY5ig0RMclRjDadftchOYpdjmJDRExyFLscxYaImOQodjmKDRExyVHschQbImKSo9jlKDZExCRHsctRYoiISY4Sl6PEEJGQHCUuR4khIiE5SlyOEkNEQnKUuBwlhoiE5ChBxUFfHZAcJS5HiSEiITlKXI4SQ0RCcpS4HCWGiITkKHE5SgwRCclR4nKUGiISkqPU5Sg1RKQkR6nLUWqISEmOUpej1BCRkhylLkemmv2QkhylLkepISIlOUpREddXcSRHqctRaohISY5Sl6PUEJGSHKUuR6khIiU5Sl2OMkNESnKUuRxlhoiM5ChzOcoMERnJUeZylBkiMpKjzOUoM0RkJEeZy1FmiMhIjjKXo8wQkZEcZajY7qttkqPM5SgzRGQkR5nLUWaIyEiOMpej3BCRkRzlLke5ISInOcpdjnJDRE5ylLsc5YaInOQodznKDRE5yVHucpQbInKSo9zlKDdE5CRHuctRbojISY5ydCjqT0UkR7nLUW6IyEmOcpejwhCRkxwVLkeFIaIgOSpcjgpDREFyVLgcFYaIguSocDkqDBEFyVHhclQYIgqSo8LlqDBEFCRHhctRYYgoSI4Kl6PCEFGQHBXo7NofXkmOCnx8NUwUJEnDd9C2P8FumMMuOsRu+lPshqRq+BIa9yfZDcnW8CU07g+zG5Kw4Uto3B9oNyRnw5fQuD/Tbujj7wadajf9sXZDn4A36GC76U+2G/oQvEGH201/ut2Q/A1fAuNRgKAZPJMgBg2CZhDLEIMOIWgGsRQxaBGCZhCrEYMcwSgXWJEYJAlBM4hFiUGVEMlNLN6khUTGiMFBmBApbYwYHLQJRsbA8oRg1SOBBAoxKBT0VCCJQsiBPjowJFaRBvrowEBChejlCEHLHwJpFaJXJAStgAgkV4helNB4N5EeIJpjJFiIXpbQcKT0hcjrhQmNRpKHVAvRaxMajjZG5PXyhMajjRF9vUKh8UhjJF+IXqQQtCgikIIhokEGpPmLsBIYeUIZ6Rgiij2LBEkZohcs9EgoTpCYIXrJQtCyi0B6huhVCz0QKjCQoiF63UKPg+wEoq9XLvQwyHYRe712QcuiiLpeu9ADvomiN1KgoSFhQ/TyhR4wbYyoiwcVN6ONsY4b86sJCRwiHpjLSZqRxiHigbqC7gWirhczBC3yCKR0iDj3dBlxFxd8AkBqh0g2ngSABA+RCE8CQJqHSKQnASDZQySRJwEg5UMkgw5PL5AES/E9f7TsJZD+IXqVQ9DKl0ASiEh8Gx9SQUSvdQhaKRNICBFJwS9qJIWIXvAQtLAmkBoies1D0NqaQIKI6GUPQctrAmkiolc+BK2wCSSLiF78oK5XCSSLiDTxJIwUX0tJPQkDiSMizTwJA+kjIvWsPqSQiLTwJAwkkohs40kYSCcR2cAevZchqURk0rM9IbVE9JqIoLVMgQQT0csierlT/CHJRGSJJ70g1URkqSe9ZPhyWOZJL0g7EVnuSS9IPhG9SCJoEVYgBUX0Ogk3zUhEEbnwZAyko4hc8iUDUlJEPvBH5y0kpoheMmGyC5JTRJ7wJQMSVESe8iUDklREL5xQ16IFklREnnsyAFJVRF54MgASVkSx8WQApK2IQvAZAKkropCeDIAEFlFEngyANBZRDEuP3kWQzCIKz5kBCS2il1MELf0LpLWIwndoQHKLKHyHBqS4iMJ3aECii9x4Dg0SqS5yUF3oKxYSqS5yUF3IFSKR6CIH0YWcZYk0FzloLuQKkUhykYPkklB3YkikuMheVKEt0SXqQW6hV5NEcosc5BZ6NUkkt8hBbqFXk0RyixzkFnqFSCS3yEFuoVeIRHKLHOQW+iqSRHKLHOQWeo6R2iIFv+tJJLbI8f4P+oYJJLbIQWyhgw1pLXLQWugAQlKLFOwtOhIJLbJXUxhTxNwotNABhG8GGZQWJoDO7geRngDCt4RIz6rDN4UMQgt9EVDi+0IGoYUJNnxryKC00BcNJb47RPIndYnvDxmUllSSlOBbRCR/VJdIaJG9lkJKahLJLDLynNUlkllk5DmrSySzyMhzVpdIZpGDzJJGZKpAMouMfOwhnUUOOgt90VUinUV6dBaJdBY56Cz0NVqJhBbpEVokElpkPBSbVApCSov0KS0SKS3Sp7RIpLRIn9IikdIiYx97SGqRsY89JLXIQWqhL29LJLXI2MMeUlrkoLTQV8Mlklpk7GEPSS1ylFoo9pDQIhMfe0hokYmPPSS0yMTHHhJaZOJjDwktMvGxh4QWOQgt9I0EEgktMvGwh3QWmfgyJ9JZZOJhD+ksMuWvMEgks8jURx+SWWTqow/JLDL10YdkFpn66ENKi0x99CGlRQ5KS1pQsYyEFjkILQwjSGiRg9DCNIzYG4QWugZAOoscdRaSaSSzyFFmobqARBY5iCwM0UhkkYPIwhCNRBY5iCwM0UhlkYPKQt9CI5HKIgeVhb6LRiKVRQ4qC30jjUQqixxUFvpeGolUFjmoLEy8IZVFDioLfe+NRCqLzNn79CXSWGTO3quPFBY5KCwZJVpKJLDI3HNhViKFRQ4KC30LkEQSixwkFrpdxFw+MMfcZIzvR849o0PEDRoLN7qBuP4HGp9V06ntu+GHGh8+TC+L+vPq4/jrDSPL962aH3IYMf7rP//6a/69hvmfab28b6qn8mB+zDb7xmJ21SUK47l/LJvqzvEDkLpaYfyO1ZP6At2i2Yt1aspbhAW8dLHDuen/9q+BB44xcGSnpW2rtivNSwRmT1mAjm44zz9Uc1tWnxBoAkBTxtX+SAiQmAE/sxa06c2VCRtfC8q+jR00JGA0CG6atf9vJyeM4hR0POPc1K5sTi2e6Ay4sj1Wh4dyVzl+OfArWL/5p59wvsAwTQ71ODu/m4VNbGATXIBwv3uFDQnYEEu6eRu3sxrgcuACu/cannFTzc+TgnyDSTQ3XjDN1O3Z8gBBnnBBfttU2wfV1c+q0cw/qKrb73f7qnNWqIQTyfXgruzKnduDBPglHj/1UDduHgFjjrjAuevfpArGC4JtWF7myjrvezc+2RvMdQSINjcR8M7V8OBd4Cuhr+Tonnynt2JAqmO4tLmAnZqYXtoMm8hgE9xaNU1QHYB50dz3wXu3reMJklsyzn3qmwLtTkw/TOjmcq/Xf3w1HnSPoLuPPe1+TmAMolWwGdK4fx7fBzI7g9yajuPPwy0QU5DAMeRcdp+bIIYBOczYVTe1QMVBAveYjF+AmkTlrniwCBI+foYHrADAFAxbRuPylbH9kNgPnqBSTf2k3KAEo0j4qawOCgUz6EzCA44PDofpA6bqeFoIxfihkOMoBJuWdpVyKxUQk6wTePT87AjyQDbCbtglMbVARSSIbXMNKNTEeUQmcFkX7ITC34wDb+Bri6bpAz+g8b1RMDOmMDOOc2LuVxs+JPYvOTtE+1wQyDhMt7FtK7VtFRs79WMMGIl++GCBpfWSif2Q2g8ZO1dDV7b9z81hd+Daj20myja2O7ZhYWdQJrY79oMNW5nYD6n9wCeCptZbEtr7AensmeXuD51BHC+4kXDsbkvznk7HDXCbcHl3eHQ0TDqwrGF37K1Sx1app74ST7PbagxTp0ACYSC5fYvYsMBozV1IjN+pQ5ME0NhdEjyBffYE+Sm3oTB94NidWjqbwASEm2TrlcmfyAw5bIDbL4ZTEHGmEnCzFHaPyKcP7IgODzscQaAnCevXNCg5wYSf21XGebddjWt0OINsANyDp1HPrsDTbjDCZhn2TDs3dTc8KBAuB3jKkdziuy+fnJwDM2DEBeN99QkNHK69lMu499WuOlaH2nEEvUy5iEFv8oVLDjKWckWB9scpJgXFBO/X6Fh13UCIssWLOTff4QkC+TPllhZ+TTMcKNzu2Bl+UHXzgJFBVkq5MHhQzR65wRqYy8EPjc6kjhcIn5QLn4fTp1IP09EWUkBkyi25x7LC+1IK1k3GLZNHVe66x/MlAk8IvO9to56dUgy4sQW5rl91JS6PTb3blfsyym+dDcZZm8Em9pXeo8pd5rYBa2wuFHU1vHXmGWofGYt8OjyUDZppqOBk3IrR1eau1JCO3pCBnrI1UIUqMbiXxmN9I2ztInK7zW1sNSxtbRbZYsh6ycR+SO0HduTjO2ngngYr1szuRYIdhmngvn9CE1ScYNGdc8u/9z3YR4FB9xi6c5E6Pq8VTiI890W2ik3s/jLtrJvpJJPa2bTTar1kbD+wBZlGrfXZC4cN6Dsr2jFSGSwHbDf40Y9NEDshnD5WBqoatEVAiZdVCatOJ3s0YkA2q3R+Ko8lPqhm8JDHJU9zTaDcOoVbBnInW9Q/lX+UT+74QOpkg+qp1ruuM7wcpD/2cKWTwMNJR7N79QJ4xrxn9xlNaA4CIedWri6CHk8lLshysAJY+UVn6M+lPjHePt47CRaGDRe5u/rBvPPAFQ6gwC7YqmZf3qntWQmZg2SZc1lmX+7KL8JxA51lE0zvJh03EOPs8bt30//2jieIclYb054dCvIczA17uWRv6oNHZ+PK4WGHC/J92bqSPQhxNnPsy9+78S2eUDuFKoeccqc9e2d2JyrYsRNCHLyEICJ7wuD5GppAHYNtSCsKsNdjzi9/SLgrWMVAWHFOxLZb6XQCsttvYaWDjVUe5CRyePHdEcBjJkfKQR3R1accnpB4t5MulIwaiooleLmOi3P4egK4fUA1gL1edqibZ4Vr7wJkvILLeIf61A61Xl8qShG5XYdXzrgUZh+nC2MNnhhiaUmd9Gx7uNzYUkraPTay5YD1kon9kNoPbAVIK9DwwrVgRVjqCoiEJ7yIm0P7fnc4fljdR1PhyGXj4dGTsOhyRCBulR/NkxgR6WCsBQtXOcEt4KIQ7JFAezXDqwP2qnus3ZIZXtYTbKToJpwJhjVixDrVWGApgFvBuzXd6eGEdoACJDBWPnZeJAQXI1zIrEBBrGIoRZofd9COv+nOntWh8LqnYAO/0eee2tki4QqMuABqyudt/aBQZ+Fq8Tke6xYlK1h5+DzbVp05w7KF7e8Qf844wVYZsd2FcetGIBgtW52P7njZOFuZTVbc5jC3QZwR4AmNvRFEn+bRJV7IlD09CXvFS2Q27bL1tWnRmQ2Y7yS3qerwPit1C8BCwbJwas/SFRgCuy7acl8jNzBhbA10fh8I1N2ktFtPYj+wSlOrmlvccRCuBZcJWl3b6xrb0SPMc2iA8MPtKe2u/lw6UVIAbgqOG+N2dm9TAdP7hguG9nh2KcQ8Bgd4chuDfdMA3P9gARtNZ357wt9MUsakoExys/0Q2w9WMpCsxNY+l4+VW7CZh/KArnN5s31W27NBwxp3w+0R7Ze2U27GBZPF3u/QlfvKrYg3cKo23Nrp1E5vZq4jXP7s9VjdyaPRdU9oLcCiVNi1IKxaJTKbTtjgPlOJ4aUkubHVOntXWfdYIsbg9rHh1mJXH93kCa+XicgekewFUJFNYh0XPbrFo9si7IgNTGHLUJFNV2S5VdhNr+aBSwJ2c2xh0g3Z6zW2KWLTgLmavb7ZzS/xgBUxrM7t6uJSEXdLHFS/pS3tJSu8u+9IgBs/1JJZ6UkH8NPZSoXUbzjP01NTVjgnmsdUAV+OyVOzRYsO5lJWt+/fNAC2VTDAcZrYo8Cpde/RhCcJ9gTyuVKdMWpRgeCImBzisz4iu/PqXJsQHOiXKopv8Y1zcO1Icg3/eqOPAUe1qw7a6MOvf/31/9Qgr+1h1AAA"; \ No newline at end of file diff --git a/docs/classes/Client.html b/docs/classes/Client.html index 7f7ae26..e928417 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -26,9 +26,9 @@
  • A Promise with a Chat object and an Error object if the error is not null.
    • -

    Example

    import * as pg from 'predictionguard';

    const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

    async function Chat() {
        const input = {
            model: pg.Models.NeuralChat7B,
            messages: [
                {
                    role: pg.Roles.User,
                    content: 'How do you feel about the world in general',
                },
            ],
            maxTokens: 1000,
            temperature: 0.1,
            topP: 0.1,
            options: {
                factuality: true,
                toxicity: true,
                pii: pg.PIIs.Replace,
                piiReplaceMethod: pg.ReplaceMethods.Random,
            },
        };

        var [result, err] = await client.Chat(input);
        if (err != null) {
            console.log('ERROR:' + err.error);
            return;
        }

        console.log('RESULT:' + result.createdDate() + ': ' + result.model + ': ' + result.choices[0].message.content);
    }

    Chat();
+
    Example
    import * as pg from 'predictionguard';

    const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

    async function Chat() {
        const input = {
            model: pg.Models.NeuralChat7B,
            messages: [
                {
                    role: pg.Roles.User,
                    content: 'How do you feel about the world in general',
                },
            ],
            maxTokens: 1000,
            temperature: 0.1,
            topP: 0.1,
            topK: 50.0,
            options: {
                factuality: true,
                toxicity: true,
                pii: pg.PIIs.Replace,
                piiReplaceMethod: pg.ReplaceMethods.Random,
            },
        };

        var [result, err] = await client.Chat(input);
        if (err != null) {
            console.log('ERROR:' + err.error);
            return;
        }

        console.log('RESULT:' + result.createdDate() + ': ' + result.model + ': ' + result.choices[0].message.content);
    }

    Chat();
 
    
-
    ChatSSE
    • ChatSSE(input): Promise<null | Error>
    • ChatSSE generates a stream of chat completions based on a
+
    ChatSSE
    • ChatSSE(input): Promise<null | Error>
    • ChatSSE generates a stream of chat completions based on a
 conversation history.
      
 
      Parameters
      • input: ChatSSEInput
        input represents the entire set of
 possible input for the SSE Chat call.
        
@@ -36,27 +36,27 @@
 
      • A Promise with an Error object if the error is not
 null.
        • 
 
      
-
      Example
      import * as pg from 'predictiongaurd';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function ChatSSE() {
          const input = {
              model: pg.Models.NeuralChat7B,
              messages: [
                  {
                      role: pg.Roles.User,
                      content: 'How do you feel about the world in general',
                  },
              ],
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
              onMessage: function (event, err) {
                  if (err != null) {
                      if (err.error == 'EOF') {
                          return;
                      }
                      console.log(err);
                  }

                  for (const choice of event.choices) {
                      if (choice.delta.hasOwnProperty('content')) {
                          process.stdout.write(choice.delta.content);
                      }
                  }
              },
          };

          var err = await client.ChatSSE(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }
      }

      ChatSSE();
+
      Example
      import * as pg from 'predictiongaurd';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function ChatSSE() {
          const input = {
              model: pg.Models.NeuralChat7B,
              messages: [
                  {
                      role: pg.Roles.User,
                      content: 'How do you feel about the world in general',
                  },
              ],
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
              topK: 50.0,
              onMessage: function (event, err) {
                  if (err != null) {
                      if (err.error == 'EOF') {
                          return;
                      }
                      console.log(err);
                  }

                  for (const choice of event.choices) {
                      if (choice.delta.hasOwnProperty('content')) {
                          process.stdout.write(choice.delta.content);
                      }
                  }
              },
          };

          var err = await client.ChatSSE(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }
      }

      ChatSSE();
 
      
-
    ChatVision
    ChatVision
    • ChatVision(input): Promise<[ChatVision, null | Error]>
    • ChatVision generates answers a question about an image.
      
 
      Parameters
      • input: ChatVisionInput
        input represents the entire set of
 possible input for the Vision Chat call.
        
 
      Returns Promise<[ChatVision, null | Error]>
        
 
      • A Promise with a ChatVision object and a Error
 object if the error is not null.
        • 
 
      
-
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function ChatVision() {
          const image = new pg.ImageNetwork('https://pbs.twimg.com/profile_images/1571574401107169282/ylAgz_f5_400x400.jpg');

          const input = {
              role: pg.Roles.User,
              question: 'is there a deer in this picture',
              image: image,
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
          };

          var [result, err] = await client.ChatVision(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.createdDate() + ': ' + result.model + ': ' + result.choices[0].message.content);
      }

      ChatVision();
+
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function ChatVision() {
          const image = new pg.ImageNetwork('https://pbs.twimg.com/profile_images/1571574401107169282/ylAgz_f5_400x400.jpg');

          const input = {
              role: pg.Roles.User,
              question: 'is there a deer in this picture',
              image: image,
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
              topK: 50.0,
          };

          var [result, err] = await client.ChatVision(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.createdDate() + ': ' + result.model + ': ' + result.choices[0].message.content);
      }

      ChatVision();
 
      
-
    Completion
    Completion
    • Completion(input): Promise<[Completion, null | Error]>
    • Completion generates text completions based on the provided input.
      
 
      Parameters
      • input: CompletionInput
        input represents the entire set of
 possible input for the Completion call.
        
 
      Returns Promise<[Completion, null | Error]>
        
 
      • A Promise with a Completion object and a Error
 object if the error is not null.
        • 
 
      
-
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Completions() {
          const input = {
              model: pg.Models.NeuralChat7B,
              prompt: 'Will I lose my hair',
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
          };

          var [result, err] = await client.Completion(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.choices[0].text);
      }

      Completions();
+
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Completions() {
          const input = {
              model: pg.Models.NeuralChat7B,
              prompt: 'Will I lose my hair',
              maxTokens: 1000,
              temperature: 0.1,
              topP: 0.1,
              topK: 50.0,
          };

          var [result, err] = await client.Completion(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.choices[0].text);
      }

      Completions();
 
      
-
    Embedding
    Embedding
    • Embedding(input): Promise<[Embedding, null | Error]>
    • Embedding generates chat completions based on a conversation history.
      
 
      Parameters
      • input: EmbeddingInput[]
        input represents a collection of
 text and images to vectorize.
        
 
      Returns Promise<[Embedding, null | Error]>
        
@@ -65,7 +65,7 @@
 
      
 
      Example
      import * as pg from 'predictiongaurd';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Embedding() {
          const image = new pg.ImageNetwork('https://pbs.twimg.com/profile_images/1571574401107169282/ylAgz_f5_400x400.jpg');

          const input = [
              {
                  text: 'This is Bill Kennedy, a decent Go developer.',
                  image: image,
              },
          ];

          var [result, err] = await client.Embedding(input);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          for (const dt of result.data) {
              process.stdout.write(dt.embedding.toString());
          }
      }

      Embedding();
 
      
-
    Factuality
    • Factuality(reference, text): Promise<[Factuality, null | Error]>
    • Factuality checks the factuality of a given text compared to a reference.
      
+
    Factuality
    • Factuality(reference, text): Promise<[Factuality, null | Error]>
    • Factuality checks the factuality of a given text compared to a reference.
      
 
      Parameters
      • reference: string
        reference represents the reference text
 for comparison.
        
 
      • text: string
        text represents the text to be checked
@@ -76,14 +76,14 @@
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Factuality() {
          const fact = `The President shall receive in full for his services during
          the term for which he shall have been elected compensation in the aggregate
          amount of 400,000 a year, to be paid monthly, and in addition an expense
          allowance of 50,000 to assist in defraying expenses relating to or resulting
          from the discharge of his official duties. Any unused amount of such expense
          allowance shall revert to the Treasury pursuant to section 1552 of title 31,
          United States Code. No amount of such expense allowance shall be included in
          the gross income of the President. He shall be entitled also to the use of
          the furniture and other effects belonging to the United States and kept in
          the Executive Residence at the White House.`;

          const text = `The president of the united states can take a salary of one
          million dollars`;

          var [result, err] = await client.Factuality(fact, text);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + JSON.stringify(result.checks[0]));
      }

      Factuality();
 
      
-
    HealthCheck
    • HealthCheck(): Promise<[string, null | Error]>
    • HealthCheck validates the PG API Service is available.
      
+
    HealthCheck
    • HealthCheck(): Promise<[string, null | Error]>
    • HealthCheck validates the PG API Service is available.
      
 
      Returns Promise<[string, null | Error]>
        
 
      • A Promise with a string and an Error object if
 the error is not null.
        • 
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function HealthCheck() {
          var [result, err] = await client.HealthCheck();
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log(result);
      }

      HealthCheck();
 
      
-
    Injection
    Injection
    • Injection(prompt): Promise<[Injection, null | Error]>
    • Injection detects potential prompt injection attacks in a given prompt.
      
 
      Parameters
      • prompt: string
        prompt represents the text to detect
 injection attacks against.
        
 
      Returns Promise<[Injection, null | Error]>
        
@@ -92,14 +92,14 @@
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Injection() {
          const prompt = `A short poem may be a stylistic choice or it may be that you
          have said what you intended to say in a more concise way.`;

          var [result, err] = await client.Injection(prompt);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.checks[0].probability);
      }

      Injection();
 
      
-
    Protected RawDoGet
    • RawDoGet(endpoint): Promise<[any, null | Error]>
    • RawDoGet performs a raw GET call.
      
+
    Protected RawDoGet
    • RawDoGet(endpoint): Promise<[any, null | Error]>
    • RawDoGet performs a raw GET call.
      
 
      Parameters
      • endpoint: string
        endpoint represents endpoint to call and
 does not include the transport or domain.
        
 
      Returns Promise<[any, null | Error]>
        
 
      • A Promise with a respose object and an error object if
 the error is not null.
        • 
 
      
-
    Protected RawDoPost
    • RawDoPost(endpoint, body): Promise<[any, null | Error]>
    • RawDoPost performs a raw POST call.
      
+
    Protected RawDoPost
    • RawDoPost(endpoint, body): Promise<[any, null | Error]>
    • RawDoPost performs a raw POST call.
      
 
      Parameters
      • endpoint: string
        endpoint represents endpoint to call and
 does not include the transport or domain.
        
 
      • body: any
        body represents an input object.
        
@@ -107,7 +107,7 @@
 
      • A Promise with a respose object and an error object if
 the error is not null.
        • 
 
      
-
    Protected RawDoSSEPost
    • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>
    • RawDoSSEPost performs a raw POST call with SSE support.
      
+
    Protected RawDoSSEPost
    • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>
    • RawDoSSEPost performs a raw POST call with SSE support.
      
 
      Parameters
      • endpoint: string
        endpoint represents endpoint to call and
 does not include the transport or domain.
        
 
      • body: any
        body represents an input object.
        
@@ -116,7 +116,7 @@
 
          • (event, err): void
          • Parameters
            • event: null | ServerSentEvent
            • err: null | Error
            Returns void
      Returns Promise<null | Error>
        
 
      • A Promise with an error object if the error is not null.
        • 
 
      
-
    ReplacePII
    • ReplacePII(replaceMethod, prompt): Promise<[ReplacePII, null | Error]>
    • ReplacePII replaces personal information such as names, SSNs, and
+
    ReplacePII
    • ReplacePII(replaceMethod, prompt): Promise<[ReplacePII, null | Error]>
    • ReplacePII replaces personal information such as names, SSNs, and
 emails in a given text.
      
 
      Parameters
      • replaceMethod: ReplaceMethods
        replaceMethod represents the
 method to use for replacing personal information.
        
@@ -128,7 +128,7 @@
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function ReplacePII() {
          const replaceMethod = pg.ReplaceMethods.Mask;
          const prompt = `My email is bill@ardanlabs.com and my number is 954-123-4567.`;

          var [result, err] = await client.ReplacePII(replaceMethod, prompt);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.checks[0].new_prompt);
      }

      ReplacePII();
 
      
-
    Toxicity
    Toxicity
    • Toxicity(text): Promise<[Toxicity, null | Error]>
    • Toxicity checks the toxicity of a given text.
      
 
      Parameters
      • text: string
        text represents the text to be scored
 for toxicity.
        
 
      Returns Promise<[Toxicity, null | Error]>
        
@@ -137,7 +137,7 @@
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Toxicity() {
          const text = `Every flight I have is late and I am very angry. I want to
          hurt someone.`;

          var [result, err] = await client.Toxicity(text);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.checks[0].score);
      }

      Toxicity();
 
      
-
    Translate
    • Translate(text, sourceLang, targetLang): Promise<[Translate, null | Error]>
    • Translate converts text from one language to another.
      
+
    Translate
    • Translate(text, sourceLang, targetLang): Promise<[Translate, null | Error]>
    • Translate converts text from one language to another.
      
 
      Parameters
      • text: string
        text represents the text to be translated.
        
 
      • sourceLang: Languages
        sourceLang represents the source
 language of the text.
        
@@ -149,4 +149,4 @@
 
      
 
      Example
      import * as pg from 'predictionguard';

      const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

      async function Translate() {
          const sourceLang = pg.Languages.English;
          const targetLang = pg.Languages.Spanish;
          const text = `The rain in Spain stays mainly in the plain`;

          var [result, err] = await client.Translate(text, sourceLang, targetLang);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

          console.log('RESULT:' + result.best_translation);
      }

      Translate();
 
      
-

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyurlChatChatSSEChatVisionCompletionEmbeddingFactualityHealthCheckInjectionRawDoGetRawDoPostRawDoSSEPostReplacePIIToxicityTranslate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyurlChatChatSSEChatVisionCompletionEmbeddingFactualityHealthCheckInjectionRawDoGetRawDoPostRawDoSSEPostReplacePIIToxicityTranslate
    \ No newline at end of file diff --git a/docs/interfaces/Chat.html b/docs/interfaces/Chat.html index fa66662..8987d3c 100644 --- a/docs/interfaces/Chat.html +++ b/docs/interfaces/Chat.html @@ -1,15 +1,15 @@ Chat | predictionguard

    Interface Chat

    Chat represents an object that contains the result for the chat call.

    -
    interface Chat {
        choices: ChatChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices +
    interface Chat {
        choices: ChatChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices created id model object

    Methods

    createdDate

    Properties

    choices

    choices: ChatChoice[]

    choices represents the collection of choices to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    model

    model: Models

    model represents the model used for generating the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    model

    model: Models

    model represents the model used for generating the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/ChatChoice.html b/docs/interfaces/ChatChoice.html index 1ad0982..30d3942 100644 --- a/docs/interfaces/ChatChoice.html +++ b/docs/interfaces/ChatChoice.html @@ -1,10 +1,10 @@ ChatChoice | predictionguard

    Interface ChatChoice

    ChatChoice represents an object that contains a result choice.

    -
    interface ChatChoice {
        index: number;
        message: ChatMessage;
        status: string;
    }

    Properties

    index +
    interface ChatChoice {
        index: number;
        message: ChatMessage;
        status: string;
    }

    Properties

    index message status

    Properties

    index

    index: number

    index represents the index position in the collection for this choice.

    -

    message

    message: ChatMessage

    message represents the message response for this choice.

    -

    status

    status: string

    status represents if the response for this choice was successful +

    message

    message: ChatMessage

    message represents the message response for this choice.

    +

    status

    status: string

    status represents if the response for this choice was successful or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexmessagestatus
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    indexmessagestatus
    \ No newline at end of file diff --git a/docs/interfaces/ChatInput.html b/docs/interfaces/ChatInput.html index 1d7d8d5..463e9cc 100644 --- a/docs/interfaces/ChatInput.html +++ b/docs/interfaces/ChatInput.html @@ -1,14 +1,16 @@ ChatInput | predictionguard

    Interface ChatInput

    ChatInput represents the full potential input options for chat.

    -
    interface ChatInput {
        maxTokens: number;
        messages: ChatInputMessage[];
        model: Models;
        options: ChatInputOptions;
        temperature: number;
        topP: number;
    }

    Properties

    maxTokens +
    interface ChatInput {
        maxTokens: number;
        messages: ChatInputMessage[];
        model: Models;
        options: ChatInputOptions;
        temperature: number;
        topK: number;
        topP: number;
    }

    Properties

    maxTokens messages model options temperature +topK topP

    Properties

    maxTokens

    maxTokens: number

    maxTokens represents the max number of tokens to return.

    messages

    messages: ChatInputMessage[]

    messages represents the set of messages to process.

    model

    model: Models

    model represents the model to use.

    options

    options: ChatInputOptions

    options represents a set of optional parameters.

    -

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    -

    topP

    topP: number

    topP represents the diversity of the generated text.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmessagesmodeloptionstemperaturetopP
    \ No newline at end of file +

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    +

    topK

    topK: number

    topK represents the variability of the generated text.

    +

    topP

    topP: number

    topP represents the diversity of the generated text.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmessagesmodeloptionstemperaturetopKtopP
    \ No newline at end of file diff --git a/docs/interfaces/ChatMessage.html b/docs/interfaces/ChatMessage.html index 8df9420..dc08433 100644 --- a/docs/interfaces/ChatMessage.html +++ b/docs/interfaces/ChatMessage.html @@ -1,9 +1,9 @@ ChatMessage | predictionguard

    Interface ChatMessage

    ChatMessage represents an object that contains the content and a role. It can be used for input and returned as part of the response.

    -
    interface ChatMessage {
        content: string;
        output: string;
        role: Roles;
    }

    Properties

    content +
    interface ChatMessage {
        content: string;
        output: string;
        role: Roles;
    }

    Properties

    content output role

    Properties

    content

    content: string

    content represents the content of the message.

    -

    output

    output: string

    output represents the output for this message.

    -

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    contentoutputrole
    \ No newline at end of file +

    output

    output: string

    output represents the output for this message.

    +

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    +

    Settings

    Member Visibility

    Theme

    On This Page

    contentoutputrole
    \ No newline at end of file diff --git a/docs/interfaces/ChatSSE.html b/docs/interfaces/ChatSSE.html index 5277bdf..1bfd9ac 100644 --- a/docs/interfaces/ChatSSE.html +++ b/docs/interfaces/ChatSSE.html @@ -1,16 +1,16 @@ ChatSSE | predictionguard

    Interface ChatSSE

    ChatSSE represents an object that contains the result for the chatSSE call.

    -
    interface ChatSSE {
        choices: ChatSSEChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices +
    interface ChatSSE {
        choices: ChatSSEChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices created id model object

    Methods

    createdDate

    Properties

    choices

    choices: ChatSSEChoice[]

    choices represents the collection of choices to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    model

    model: Models

    model represents the model used for generating the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    model

    model: Models

    model represents the model used for generating the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/ChatSSEChoice.html b/docs/interfaces/ChatSSEChoice.html index bf3ed44..5ec16ce 100644 --- a/docs/interfaces/ChatSSEChoice.html +++ b/docs/interfaces/ChatSSEChoice.html @@ -1,15 +1,15 @@ ChatSSEChoice | predictionguard

    Interface ChatSSEChoice

    ChatSSEChoice represents an object that contains a result choice.

    -
    interface ChatSSEChoice {
        delta: ChatSSEDelta;
        finish_reason: string;
        generated_text: string;
        index: number;
        logprobs: number;
    }

    Properties

    delta +
    interface ChatSSEChoice {
        delta: ChatSSEDelta;
        finish_reason: string;
        generated_text: string;
        index: number;
        logprobs: number;
    }

    Properties

    delta finish_reason generated_text index logprobs

    Properties

    delta

    delta: ChatSSEDelta

    delta represents the partial content for this choice.

    -

    finish_reason

    finish_reason: string

    finish_reason represents the reason the response has finished +

    finish_reason

    finish_reason: string

    finish_reason represents the reason the response has finished which is provided when this is the last choice.

    -

    generated_text

    generated_text: string

    generated_text represents the final completed chat response which +

    generated_text

    generated_text: string

    generated_text represents the final completed chat response which is provided when this is the last choice.

    -

    index

    index: number

    index represents the index position in the collection for +

    index

    index: number

    index represents the index position in the collection for this choice.

    -

    logprobs

    logprobs: number

    logprobs represents the log probabilty of accuracy for this choice.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    deltafinish_reasongenerated_textindexlogprobs
    \ No newline at end of file +

    logprobs

    logprobs: number

    logprobs represents the log probabilty of accuracy for this choice.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    deltafinish_reasongenerated_textindexlogprobs
    \ No newline at end of file diff --git a/docs/interfaces/ChatSSEDelta.html b/docs/interfaces/ChatSSEDelta.html index 19a5e92..cfdb7d9 100644 --- a/docs/interfaces/ChatSSEDelta.html +++ b/docs/interfaces/ChatSSEDelta.html @@ -1,4 +1,4 @@ ChatSSEDelta | predictionguard

    Interface ChatSSEDelta

    ChatSSEDelta represents an object that contains the content.

    -
    interface ChatSSEDelta {
        content: string;
    }

    Properties

    content +
    interface ChatSSEDelta {
        content: string;
    }

    Properties

    content

    Properties

    content

    content: string

    content represents the partial content response for a choice.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    content
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    content
    \ No newline at end of file diff --git a/docs/interfaces/ChatSSEInput.html b/docs/interfaces/ChatSSEInput.html index 431ea99..f6fd7c2 100644 --- a/docs/interfaces/ChatSSEInput.html +++ b/docs/interfaces/ChatSSEInput.html @@ -1,14 +1,16 @@ ChatSSEInput | predictionguard

    Interface ChatSSEInput

    ChatSSEInput represents the full potential input options for SSE chat.

    -
    interface ChatSSEInput {
        maxTokens: number;
        messages: ChatInputMessage[];
        model: Models;
        onMessage: ((event, err) => void);
        temperature: number;
        topP: number;
    }

    Properties

    maxTokens +
    interface ChatSSEInput {
        maxTokens: number;
        messages: ChatInputMessage[];
        model: Models;
        onMessage: ((event, err) => void);
        temperature: number;
        topK: number;
        topP: number;
    }

    Properties

    maxTokens messages model onMessage temperature +topK topP

    Properties

    maxTokens

    maxTokens: number

    maxTokens represents the max number of tokens to return.

    -

    messages

    messages: ChatInputMessage[]

    messages represents the set of messages to process.

    -

    model

    model: Models

    model represents the model to use.

    -

    onMessage

    onMessage: ((event, err) => void)

    onMessage represents a function that will receive the messages.

    -

    Type declaration

      • (event, err): void

      • Parameters

        Returns void

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    -

    topP

    topP: number

    topP represents the diversity of the generated text.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmessagesmodelonMessagetemperaturetopP
    \ No newline at end of file +

    messages

    messages: ChatInputMessage[]

    messages represents the set of messages to process.

    +

    model

    model: Models

    model represents the model to use.

    +

    onMessage

    onMessage: ((event, err) => void)

    onMessage represents a function that will receive the messages.

    +

    Type declaration

      • (event, err): void

      • Parameters

        Returns void

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    +

    topK

    topK: number

    topK represents the variability of the generated text.

    +

    topP

    topP: number

    topP represents the diversity of the generated text.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmessagesmodelonMessagetemperaturetopKtopP
    \ No newline at end of file diff --git a/docs/interfaces/ChatVision.html b/docs/interfaces/ChatVision.html index c74dc15..8a8f2e5 100644 --- a/docs/interfaces/ChatVision.html +++ b/docs/interfaces/ChatVision.html @@ -1,15 +1,15 @@ ChatVision | predictionguard

    Interface ChatVision

    ChatVision represents the result for the vision call.

    -
    interface ChatVision {
        choices: ChatVisionChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices +
    interface ChatVision {
        choices: ChatVisionChoice[];
        created: number;
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices created id model object

    Methods

    createdDate

    Properties

    choices

    choices: ChatVisionChoice[]

    choices represents the collection of choices to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    model

    model: Models

    model represents the model used for generating the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    model

    model: Models

    model represents the model used for generating the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidmodelobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/ChatVisionChoice.html b/docs/interfaces/ChatVisionChoice.html index 696a680..f890802 100644 --- a/docs/interfaces/ChatVisionChoice.html +++ b/docs/interfaces/ChatVisionChoice.html @@ -1,10 +1,10 @@ ChatVisionChoice | predictionguard

    Interface ChatVisionChoice

    ChatVisionChoice represents a choice for the vision call.

    -
    interface ChatVisionChoice {
        index: number;
        message: ChatVisionMessage;
        status: string;
    }

    Properties

    index +
    interface ChatVisionChoice {
        index: number;
        message: ChatVisionMessage;
        status: string;
    }

    Properties

    index message status

    Properties

    index

    index: number

    index represents the index position in the collection for this choice.

    -

    message

    message: ChatVisionMessage

    message represents a response for this choice.

    -

    status

    status: string

    status represents if the response for this choice was successful +

    message

    message: ChatVisionMessage

    message represents a response for this choice.

    +

    status

    status: string

    status represents if the response for this choice was successful or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexmessagestatus
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    indexmessagestatus
    \ No newline at end of file diff --git a/docs/interfaces/ChatVisionInput.html b/docs/interfaces/ChatVisionInput.html index afdc6e1..9803d1c 100644 --- a/docs/interfaces/ChatVisionInput.html +++ b/docs/interfaces/ChatVisionInput.html @@ -1,14 +1,16 @@ ChatVisionInput | predictionguard

    Interface ChatVisionInput

    ChatVisionInput represents the full potential input options for Vision chat.

    -
    interface ChatVisionInput {
        image: Base64Encoder;
        maxTokens: number;
        question: string;
        role: Roles;
        temperature: number;
        topP: number;
    }

    Properties

    image +
    interface ChatVisionInput {
        image: Base64Encoder;
        maxTokens: number;
        question: string;
        role: Roles;
        temperature: number;
        topK: number;
        topP: number;
    }

    Properties

    image maxTokens question role temperature +topK topP

    Properties

    image

    image: Base64Encoder

    image represents an object that knows how to retrieve an image.

    -

    maxTokens

    maxTokens: number

    maxTokens represents the max number of tokens to return.

    -

    question

    question: string

    question represents the question about the image.

    -

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    -

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    -

    topP

    topP: number

    topP represents the diversity of the generated text.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    imagemaxTokensquestionroletemperaturetopP
    \ No newline at end of file +

    maxTokens

    maxTokens: number

    maxTokens represents the max number of tokens to return.

    +

    question

    question: string

    question represents the question about the image.

    +

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    +

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    +

    topK

    topK: number

    topK represents the variability of the generated text.

    +

    topP

    topP: number

    topP represents the diversity of the generated text.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    imagemaxTokensquestionroletemperaturetopKtopP
    \ No newline at end of file diff --git a/docs/interfaces/ChatVisionMessage.html b/docs/interfaces/ChatVisionMessage.html index b0ee79e..5e91777 100644 --- a/docs/interfaces/ChatVisionMessage.html +++ b/docs/interfaces/ChatVisionMessage.html @@ -1,8 +1,8 @@ ChatVisionMessage | predictionguard

    Interface ChatVisionMessage

    ChatVisionMessage represents content for the vision call.

    -
    interface ChatVisionMessage {
        content: string;
        output: string;
        role: Roles;
    }

    Properties

    content +
    interface ChatVisionMessage {
        content: string;
        output: string;
        role: Roles;
    }

    Properties

    content output role

    Properties

    content

    content: string

    content represents the response for this message.

    -

    output

    output: string

    output represents the output for this message.

    -

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    -

    Settings

    Member Visibility

    Theme

    On This Page

    contentoutputrole
    \ No newline at end of file +

    output

    output: string

    output represents the output for this message.

    +

    role

    role: Roles

    role represents the role of the sender (user or assistant).

    +

    Settings

    Member Visibility

    Theme

    On This Page

    contentoutputrole
    \ No newline at end of file diff --git a/docs/interfaces/Completion.html b/docs/interfaces/Completion.html index e41d6af..f68dbf3 100644 --- a/docs/interfaces/Completion.html +++ b/docs/interfaces/Completion.html @@ -1,14 +1,14 @@ Completion | predictionguard

    Interface Completion

    Completion represents an object that contains the result for the completion call.

    -
    interface Completion {
        choices: CompletionChoice[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices +
    interface Completion {
        choices: CompletionChoice[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    choices created id object

    Methods

    createdDate

    Properties

    choices

    choices: CompletionChoice[]

    choices represents the collection of choices to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    choicescreatedidobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/CompletionChoice.html b/docs/interfaces/CompletionChoice.html index 88f0a82..1a788ad 100644 --- a/docs/interfaces/CompletionChoice.html +++ b/docs/interfaces/CompletionChoice.html @@ -1,13 +1,13 @@ CompletionChoice | predictionguard

    Interface CompletionChoice

    Choice represents an object that contains a result choice.

    -
    interface CompletionChoice {
        index: number;
        model: Models;
        status: string;
        text: string;
    }

    Properties

    index +
    interface CompletionChoice {
        index: number;
        model: Models;
        status: string;
        text: string;
    }

    Properties

    index model status text

    Properties

    index

    index: number

    index represents the index position in the collection for this choice.

    -

    model

    model: Models

    model represents the model used for generating the result for +

    model

    model: Models

    model represents the model used for generating the result for this choice.

    -

    status

    status: string

    status represents if the response for this choice was successful +

    status

    status: string

    status represents if the response for this choice was successful or not.

    -

    text

    text: string

    text represents the generated text for this choice.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexmodelstatustext
    \ No newline at end of file +

    text

    text: string

    text represents the generated text for this choice.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    indexmodelstatustext
    \ No newline at end of file diff --git a/docs/interfaces/CompletionInput.html b/docs/interfaces/CompletionInput.html index bf01d29..54bf96c 100644 --- a/docs/interfaces/CompletionInput.html +++ b/docs/interfaces/CompletionInput.html @@ -1,12 +1,14 @@ CompletionInput | predictionguard

    Interface CompletionInput

    CompletionInput represents the full potential input options for completion.

    -
    interface CompletionInput {
        maxTokens: number;
        model: Models;
        prompt: string;
        temperature: number;
        topP: number;
    }

    Properties

    maxTokens +
    interface CompletionInput {
        maxTokens: number;
        model: Models;
        prompt: string;
        temperature: number;
        topK: number;
        topP: number;
    }

    Properties

    maxTokens model prompt temperature +topK topP

    Properties

    maxTokens

    maxTokens: number

    maxTokens represents the max number of tokens to return.

    -

    model

    model: Models

    model represents the model to use.

    -

    prompt

    prompt: string

    prompt represents the prompt to process.

    -

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    -

    topP

    topP: number

    topP represents the diversity of the generated text.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmodelprompttemperaturetopP
    \ No newline at end of file +

    model

    model: Models

    model represents the model to use.

    +

    prompt

    prompt: string

    prompt represents the prompt to process.

    +

    temperature

    temperature: number

    temperature represents the randomness in GPT's output.

    +

    topK

    topK: number

    topK represents the variability of the generated text.

    +

    topP

    topP: number

    topP represents the diversity of the generated text.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxTokensmodelprompttemperaturetopKtopP
    \ No newline at end of file diff --git a/docs/interfaces/Embedding.html b/docs/interfaces/Embedding.html index 2ad9932..ffadbce 100644 --- a/docs/interfaces/Embedding.html +++ b/docs/interfaces/Embedding.html @@ -1,5 +1,5 @@ Embedding | predictionguard

    Interface Embedding

    Embedding represents the result for the embedding call.

    -
    interface Embedding {
        created: number;
        data: EmbeddingData[];
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    created +
    interface Embedding {
        created: number;
        data: EmbeddingData[];
        id: string;
        model: Models;
        object: string;
        createdDate(): Date;
    }

    Properties

    created data id model @@ -7,9 +7,9 @@

    Methods

    createdDate

    Properties

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    data

    data: EmbeddingData[]

    EmbeddingData represents the collection of vector points.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    model

    model: Models

    model represents the model used for generating the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    createddataidmodelobjectcreatedDate
    \ No newline at end of file +

    data

    data: EmbeddingData[]

    EmbeddingData represents the collection of vector points.

    +

    id

    id: string

    id represents a unique identifier for the result.

    +

    model

    model: Models

    model represents the model used for generating the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    createddataidmodelobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/EmbeddingData.html b/docs/interfaces/EmbeddingData.html index 1dcb8ba..7e8d83b 100644 --- a/docs/interfaces/EmbeddingData.html +++ b/docs/interfaces/EmbeddingData.html @@ -1,9 +1,9 @@ EmbeddingData | predictionguard

    Interface EmbeddingData

    EmbeddingData represents the vector data points.

    -
    interface EmbeddingData {
        embedding: number[];
        index: number;
        status: string;
    }

    Properties

    embedding +
    interface EmbeddingData {
        embedding: number[];
        index: number;
        status: string;
    }

    Properties

    embedding index status -

    Properties

    embedding

    embedding: number[]

    index

    index: number

    index represents the index position in the collection for +

    Properties

    embedding

    embedding: number[]

    index

    index: number

    index represents the index position in the collection for this choice.

    -

    status

    status: string

    status represents if the response for this choice was successful +

    status

    status: string

    status represents if the response for this choice was successful or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    embeddingindexstatus
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    embeddingindexstatus
    \ No newline at end of file diff --git a/docs/interfaces/EmbeddingInput.html b/docs/interfaces/EmbeddingInput.html index 96eda25..3e21bc8 100644 --- a/docs/interfaces/EmbeddingInput.html +++ b/docs/interfaces/EmbeddingInput.html @@ -1,6 +1,6 @@ EmbeddingInput | predictionguard

    Interface EmbeddingInput

    EmbeddingInput represents the input to generate embeddings.

    -
    interface EmbeddingInput {
        image: Base64Encoder;
        text: string;
    }

    Properties

    image +
    interface EmbeddingInput {
        image: Base64Encoder;
        text: string;
    }

    Properties

    image text

    Properties

    image

    image: Base64Encoder

    image represents an image to vectorize.

    -

    text

    text: string

    text represents text to vectorize.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    imagetext
    \ No newline at end of file +

    text

    text: string

    text represents text to vectorize.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    imagetext
    \ No newline at end of file diff --git a/docs/interfaces/Factuality.html b/docs/interfaces/Factuality.html index 3162a4d..08208c6 100644 --- a/docs/interfaces/Factuality.html +++ b/docs/interfaces/Factuality.html @@ -1,14 +1,14 @@ Factuality | predictionguard

    Interface Factuality

    Factuality represents an object that contains the result for the factuality call.

    -
    interface Factuality {
        checks: FactualityCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks +
    interface Factuality {
        checks: FactualityCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks created id object

    Methods

    createdDate

    Properties

    checks

    checks: FactualityCheck[]

    checks represents the collection of checks to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/FactualityCheck.html b/docs/interfaces/FactualityCheck.html index 1ecaa5b..65b337f 100644 --- a/docs/interfaces/FactualityCheck.html +++ b/docs/interfaces/FactualityCheck.html @@ -1,9 +1,9 @@ FactualityCheck | predictionguard

    Interface FactualityCheck

    FactualityCheck represents an object that contains a check choice.

    -
    interface FactualityCheck {
        index: number;
        score: number;
        status: string;
    }

    Properties

    index +
    interface FactualityCheck {
        index: number;
        score: number;
        status: string;
    }

    Properties

    index score status

    Properties

    index

    index: number

    index represents the index position in the collection for this checks.

    -

    score

    score: number

    score represents the score for this check.

    -

    status

    status: string

    status represents the status for this check.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexscorestatus
    \ No newline at end of file +

    score

    score: number

    score represents the score for this check.

    +

    status

    status: string

    status represents the status for this check.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    indexscorestatus
    \ No newline at end of file diff --git a/docs/interfaces/Injection.html b/docs/interfaces/Injection.html index e0b225a..033b404 100644 --- a/docs/interfaces/Injection.html +++ b/docs/interfaces/Injection.html @@ -1,14 +1,14 @@ Injection | predictionguard

    Interface Injection

    Injection represents an object that contains the result for the injection call.

    -
    interface Injection {
        checks: InjectionCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks +
    interface Injection {
        checks: InjectionCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks created id object

    Methods

    createdDate

    Properties

    checks

    checks: InjectionCheck[]

    checks represents the collection of checks to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the result was +

    created

    created: number

    created represents the unix timestamp for when the result was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/InjectionCheck.html b/docs/interfaces/InjectionCheck.html index 61c30d7..6972c36 100644 --- a/docs/interfaces/InjectionCheck.html +++ b/docs/interfaces/InjectionCheck.html @@ -1,10 +1,10 @@ InjectionCheck | predictionguard

    Interface InjectionCheck

    InjectionCheck represents an object that contains a check choice.

    -
    interface InjectionCheck {
        index: number;
        probability: number;
        status: string;
    }

    Properties

    index +
    interface InjectionCheck {
        index: number;
        probability: number;
        status: string;
    }

    Properties

    index probability status

    Properties

    index

    index: number

    index represents the index position in the collection for this checks.

    -

    probability

    probability: number

    probability represents the probability of a potential injection +

    probability

    probability: number

    probability represents the probability of a potential injection attack.

    -

    status

    status: string

    status represents the status for this check.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexprobabilitystatus
    \ No newline at end of file +

    status

    status: string

    status represents the status for this check.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    indexprobabilitystatus
    \ No newline at end of file diff --git a/docs/interfaces/ReplacePII.html b/docs/interfaces/ReplacePII.html index bd19a33..9260140 100644 --- a/docs/interfaces/ReplacePII.html +++ b/docs/interfaces/ReplacePII.html @@ -1,14 +1,14 @@ ReplacePII | predictionguard

    Interface ReplacePII

    ReplacePII represents an object that contains the result for the replacepi call.

    -
    interface ReplacePII {
        checks: ReplacePIICheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks +
    interface ReplacePII {
        checks: ReplacePIICheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks created id object

    Methods

    createdDate

    Properties

    checks

    checks: ReplacePIICheck[]

    checks represents the collection of checks to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/ReplacePIICheck.html b/docs/interfaces/ReplacePIICheck.html index ba48a7f..46e8291 100644 --- a/docs/interfaces/ReplacePIICheck.html +++ b/docs/interfaces/ReplacePIICheck.html @@ -1,9 +1,9 @@ ReplacePIICheck | predictionguard

    Interface ReplacePIICheck

    ReplacePIICheck represents an object that contains a check choice.

    -
    interface ReplacePIICheck {
        index: number;
        new_prompt: string;
        status: string;
    }

    Properties

    index +
    interface ReplacePIICheck {
        index: number;
        new_prompt: string;
        status: string;
    }

    Properties

    index new_prompt status

    Properties

    index

    index: number

    index represents the index position in the collection for this checks.

    -

    new_prompt

    new_prompt: string

    new_prompt represents the text with replaced personal information.

    -

    status

    status: string

    status represents the status for this check.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexnew_promptstatus
    \ No newline at end of file +

    new_prompt

    new_prompt: string

    new_prompt represents the text with replaced personal information.

    +

    status

    status: string

    status represents the status for this check.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    indexnew_promptstatus
    \ No newline at end of file diff --git a/docs/interfaces/Toxicity.html b/docs/interfaces/Toxicity.html index ebf9fd8..5829ef2 100644 --- a/docs/interfaces/Toxicity.html +++ b/docs/interfaces/Toxicity.html @@ -1,14 +1,14 @@ Toxicity | predictionguard

    Interface Toxicity

    Toxicity represents an object that contains the result for the toxicity call.

    -
    interface Toxicity {
        checks: ToxicityCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks +
    interface Toxicity {
        checks: ToxicityCheck[];
        created: number;
        id: string;
        object: string;
        createdDate(): Date;
    }

    Properties

    checks created id object

    Methods

    createdDate

    Properties

    checks

    checks: ToxicityCheck[]

    checks represents the collection of checks to choose from.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    checkscreatedidobjectcreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/ToxicityCheck.html b/docs/interfaces/ToxicityCheck.html index 1a11546..004bfb8 100644 --- a/docs/interfaces/ToxicityCheck.html +++ b/docs/interfaces/ToxicityCheck.html @@ -1,9 +1,9 @@ ToxicityCheck | predictionguard

    Interface ToxicityCheck

    ToxicityCheck represents an object that contains a check choice.

    -
    interface ToxicityCheck {
        index: number;
        score: number;
        status: string;
    }

    Properties

    index +
    interface ToxicityCheck {
        index: number;
        score: number;
        status: string;
    }

    Properties

    index score status

    Properties

    index

    index: number

    index represents the index position in the collection for this checks.

    -

    score

    score: number

    score represents the score for the provided text.

    -

    status

    status: string

    status represents the status for this check.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    indexscorestatus
    \ No newline at end of file +

    score

    score: number

    score represents the score for the provided text.

    +

    status

    status: string

    status represents the status for this check.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    indexscorestatus
    \ No newline at end of file diff --git a/docs/interfaces/Translate.html b/docs/interfaces/Translate.html index b96a6fd..b70c1d2 100644 --- a/docs/interfaces/Translate.html +++ b/docs/interfaces/Translate.html @@ -1,6 +1,6 @@ Translate | predictionguard

    Interface Translate

    Translate represents an object that contains the result for the translate call.

    -
    interface Translate {
        best_score: number;
        best_translation: string;
        best_translation_model: string;
        created: number;
        id: string;
        object: string;
        translations: Translation[];
        createdDate(): Date;
    }

    Properties

    best_score +
    interface Translate {
        best_score: number;
        best_translation: string;
        best_translation_model: string;
        created: number;
        id: string;
        object: string;
        translations: Translation[];
        createdDate(): Date;
    }

    Properties

    best_score best_translation best_translation_model created @@ -9,13 +9,13 @@ translations

    Methods

    createdDate

    Properties

    best_score

    best_score: number

    best_score represents the best score for the best translation.

    -

    best_translation

    best_translation: string

    best_translation represents the best translation of the input text.

    -

    best_translation_model

    best_translation_model: string

    best_translation_model represents the model used for the best +

    best_translation

    best_translation: string

    best_translation represents the best translation of the input text.

    +

    best_translation_model

    best_translation_model: string

    best_translation_model represents the model used for the best translation.

    -

    created

    created: number

    created represents the unix timestamp for when the request was +

    created

    created: number

    created represents the unix timestamp for when the request was received.

    -

    id

    id: string

    id represents a unique identifier for the result.

    -

    object

    object: string

    object represent the type of the result document.

    -

    translations

    translations: Translation[]

    translations represents the collection of translations to choose from.

    -

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      -

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    best_scorebest_translationbest_translation_modelcreatedidobjecttranslationscreatedDate
    \ No newline at end of file +

    id

    id: string

    id represents a unique identifier for the result.

    +

    object

    object: string

    object represent the type of the result document.

    +

    translations

    translations: Translation[]

    translations represents the collection of translations to choose from.

    +

    Methods

    createdDate

    • createdDate(): Date

    • createdDate converts the created unix timestamp into a JS Date.

      +

      Returns Date

    Settings

    Member Visibility

    Theme

    On This Page

    best_scorebest_translationbest_translation_modelcreatedidobjecttranslationscreatedDate
    \ No newline at end of file diff --git a/docs/interfaces/Translation.html b/docs/interfaces/Translation.html index 85eba35..f98824b 100644 --- a/docs/interfaces/Translation.html +++ b/docs/interfaces/Translation.html @@ -1,10 +1,10 @@ Translation | predictionguard

    Interface Translation

    Translation represents an object that contains a translation choice.

    -
    interface Translation {
        model: string;
        score: number;
        status: string;
        translation: string;
    }

    Properties

    model +
    interface Translation {
        model: string;
        score: number;
        status: string;
        translation: string;
    }

    Properties

    model score status translation

    Properties

    model

    model: string

    model represents the model that was used for this translation.

    -

    score

    score: number

    score represents the quality score for this translation.

    -

    status

    status: string

    status represents the status of using the model for this translation.

    -

    translation

    translation: string

    translation represents the translation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    modelscorestatustranslation
    \ No newline at end of file +

    score

    score: number

    score represents the quality score for this translation.

    +

    status

    status: string

    status represents the status of using the model for this translation.

    +

    translation

    translation: string

    translation represents the translation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    modelscorestatustranslation
    \ No newline at end of file diff --git a/examples/chat.js b/examples/chat.js index 200ab00..d6e21cc 100644 --- a/examples/chat.js +++ b/examples/chat.js @@ -14,6 +14,7 @@ async function Chat() { maxTokens: 1000, temperature: 0.1, topP: 0.1, + topK: 50.0, options: { factuality: true, toxicity: true, diff --git a/examples/chat_sse.js b/examples/chat_sse.js index e394ef5..2b6ebe7 100644 --- a/examples/chat_sse.js +++ b/examples/chat_sse.js @@ -14,6 +14,7 @@ async function ChatSSE() { maxTokens: 1000, temperature: 0.1, topP: 0.1, + topK: 50.0, onMessage: function (event, err) { if (err != null) { if (err.error == 'EOF') { diff --git a/examples/chat_vision.js b/examples/chat_vision.js index d901d6c..7dbed45 100644 --- a/examples/chat_vision.js +++ b/examples/chat_vision.js @@ -12,6 +12,7 @@ async function ChatVision() { maxTokens: 1000, temperature: 0.1, topP: 0.1, + topK: 50.0, }; var [result, err] = await client.ChatVision(input); diff --git a/examples/completion.js b/examples/completion.js index 9df05b3..ae93646 100644 --- a/examples/completion.js +++ b/examples/completion.js @@ -9,6 +9,7 @@ async function Completions() { maxTokens: 1000, temperature: 0.1, topP: 0.1, + topK: 50.0, }; var [result, err] = await client.Completion(input); diff --git a/makefile b/makefile index 60006a5..dbcfd73 100644 --- a/makefile +++ b/makefile @@ -46,6 +46,7 @@ curl-chat: "max_tokens": 1000, \ "temperature": 1.1, \ "top_p": 0.1, \ + "top_k": 50.0, \ "output": { \ "factuality": true, \ "toxicity": true \ @@ -71,15 +72,19 @@ curl-chat-sse: "content": "How do you feel about the world in general" \ } \ ], \ - "stream": true \ + "stream": true, \ + "max_tokens": 300, \ + "temperature": 0.1, \ + "top_p": 0.1, \ + "top_k": 50.0 \ }' js-chat-sse: compile-ts node --env-file=.env examples/chat_sse.js curl-chat-vision: - curl -i -X POST https://staging.predictionguard.com/chat/completions \ - -H "x-api-key: ${PGKEYSTAGE}" \ + curl -i -X POST https://api.predictionguard.com/chat/completions \ + -H "x-api-key: ${PGKEY}" \ -H "Content-Type: application/json" \ -d '{ \ "model": "llava-1.5-7b-hf", \ @@ -101,7 +106,9 @@ curl-chat-vision: } \ ], \ "max_tokens": 300, \ - "temperature": 0.1 \ + "temperature": 0.1, \ + "top_p": 0.1, \ + "top_k": 50.0 \ }' js-chat-vision: compile-ts @@ -117,6 +124,7 @@ curl-comp: "max_tokens": 1000, \ "temperature": 1.1, \ "top_p": 0.1 \ + "top_k": 50.0 \ }' js-comp: compile-ts diff --git a/src/api_client.ts b/src/api_client.ts index 668c538..dee7f52 100644 --- a/src/api_client.ts +++ b/src/api_client.ts @@ -44,6 +44,7 @@ export class Client { * maxTokens: 1000, * temperature: 0.1, * topP: 0.1, + * topK: 50.0, * options: { * factuality: true, * toxicity: true, @@ -106,12 +107,18 @@ export class Client { topP = input.topP; } + let topK = 0; + if (input.hasOwnProperty('topK')) { + topK = input.topK; + } + const m = new Map(); m.set('model', input.model); m.set('messages', input.messages); m.set('max_tokens', maxTokens); m.set('temperature', temperature); m.set('top_p', topP); + m.set('top_k', topK); if (input.hasOwnProperty('options')) { if (input.options.hasOwnProperty('factuality') || input.options.hasOwnProperty('toxicity')) { @@ -198,6 +205,7 @@ export class Client { * maxTokens: 1000, * temperature: 0.1, * topP: 0.1, + * topK: 50.0, * onMessage: function (event, err) { * if (err != null) { * if (err.error == 'EOF') { @@ -259,12 +267,18 @@ export class Client { topP = input.topP; } + let topK = 0; + if (input.hasOwnProperty('topK')) { + topK = input.topK; + } + const body = { model: input.model, messages: input.messages, max_tokens: maxTokens, temperature: temperature, top_p: topP, + top_k: topK, stream: true, }; @@ -310,6 +324,7 @@ export class Client { * maxTokens: 1000, * temperature: 0.1, * topP: 0.1, + * topK: 50.0, * }; * * var [result, err] = await client.ChatVision(input); @@ -370,6 +385,11 @@ export class Client { topP = input.topP; } + let topK = 0; + if (input.hasOwnProperty('topK')) { + topK = input.topK; + } + const [b64, err1] = await input.image.EncodeBase64(); if (err1 != null) { return [zero, err1]; @@ -397,6 +417,7 @@ export class Client { max_tokens: maxTokens, temperature: temperature, top_p: topP, + top_k: topK, }; const [result, err2] = await this.RawDoPost('chat/completions', body); @@ -433,6 +454,7 @@ export class Client { * maxTokens: 1000, * temperature: 0.1, * topP: 0.1, + * topK: 50.0, * }; * * var [result, err] = await client.Completion(input); @@ -488,12 +510,18 @@ export class Client { topP = input.topP; } + let topK = 0; + if (input.hasOwnProperty('topK')) { + topK = input.topK; + } + const body = { model: input.model, prompt: input.prompt, max_tokens: maxTokens, temperature: temperature, top_p: topP, + top_k: topK, }; const [result, err] = await this.RawDoPost('completions', body); diff --git a/src/api_model.ts b/src/api_model.ts index e8dc507..17f5f5a 100644 --- a/src/api_model.ts +++ b/src/api_model.ts @@ -171,6 +171,9 @@ export interface ChatInput { /** topP represents the diversity of the generated text. */ topP: number; + /** topK represents the variability of the generated text. */ + topK: number; + /** options represents a set of optional parameters. */ options: ChatInputOptions; } @@ -243,6 +246,9 @@ export interface ChatSSEInput { /** topP represents the diversity of the generated text. */ topP: number; + /** topK represents the variability of the generated text. */ + topK: number; + /** onMessage represents a function that will receive the messages. */ onMessage: (event: ChatSSE | null, err: Error | null) => void; } @@ -318,6 +324,9 @@ export interface ChatVisionInput { /** topP represents the diversity of the generated text. */ topP: number; + + /** topK represents the variability of the generated text. */ + topK: number; } /** ChatVisionMessage represents content for the vision call. */ @@ -386,6 +395,9 @@ export interface CompletionInput { /** topP represents the diversity of the generated text. */ topP: number; + + /** topK represents the variability of the generated text. */ + topK: number; } /** Choice represents an object that contains a result choice. */