diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index ea5da59..a59dca3 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42V0UrDMBSG36XXw6HokF06Nyg4ESfeiBchO65xaVKaU5yI725sZ9bYniS3+f7/4+SkYy9fGcIBs3l2x9SuYTsw2SSrGBb2CFRTmqkDZwWW0tK9UNtsfv09cd213oIcFLtTuvUIlWQc1oCF3g7aPg1YtBzO3B7SnYUUoPBU4pIZA2banfu984t+My/tJlZCwrDsULR/D/ih6z2hONKQ5YYZmF0uFbcbrk8aoRDqN7s0M/USvuriatZfRcFw1PALYsVFoQUHst7hmCRXVUOP0NKYYg3G2M2RkiOPaTabJamwLKEeWYhLJKhuQSILmdpATPQsjNCK1HQ4TRK5Wz+UJoy9mpcKKnVZSUDyog6nSUIX/RcKCZd1rcd/nC0JVVeMY8OkwM/R/gmnSRYF8H3E1GZCuly9Ayd37GiSgh7Ij4Rkx/+Hh3zU42iSgp7Hj4RkT/ogOPVifzBFQA/jJYKqmikjGY5/xI6mKKgH7/Gh5vUHH+T1h1cIAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42VXUvDMBSG/0uvh8OhQ3bp3KDgRJx4I17E9LjGpUlpTnEi/ndrO7PG9iS5zfO+D8lJP56/EoQDJovklqldzXZgkklSMsybJVB1YaYWnOVYyIbuhcqSxdX3xHY3OgM5KHardOsBSsk4bABznQ3aLvVYtBzuuV2kO0spQOGpxCUzBsy0W3d757N+My2aSayFhGHZomD/DvBDV3tCcaQ+yzUzML9YKd5MuDpphEKo3pqhmamTcFWzy3l/FDnDUcMvCBWXuRYcyHqHQ5JUlTW9hZaGFBswppkcKTnykGa7XZGKhkXUAwOxiQjVDUhkPlMbCImehBFakZoOx0kCZ+uH4oShW3NSXqUuSglIHtTiOInvoP9CPuGqeIUsE2o3arI0SnHDiGfBSUSp6NfNjXhlVaXHvzst8VXXjGPNpMDP0f4Jx0mWOfB9wNRmfLpUvQMnHx9LoxT0htyIT3b89d2nox5LoxT0ftyIT/aoD4JTN/YHYwT0ZpyEV1UxZSTD8ffT0hgFdeE9PtS8/AClLQRsMgkAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 8f8b83b..4a82639 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dXZPbtpL9LzOvcx0C/M7bOk5uvDdOpeJ7s7Xlcrk4GnqGGUnUktI4Tir/fQmCIButboDCzINdGrHRB8BpNIBDivjrqmu/9Ffffvjr6rHZ3119K2Rxc7WvdvXVt1ffbZt6f7y6uTp12+HPzbbq+7r/Rn/96uG42w7Xpm+H61d/3xgvqZCzl02774/daXNsO5era9sOuL25OlSdqshcowVIRDKZkZRvF4K+vng+9nf/aPp/HLrmqTrW63GqQ/Ov+qsTajYJQpNRAlh4qJwcXE8GK3vszPf799973WubUITfmr5p916Q2SwIp90dtvXRiwPNQnB+qDbHU7Vtjm7+LbMQnB/rant8+O6h3jw6gWy7EKS3+9/rjbfjoFUIyq/1YVtt6l/eOlGgVQjKv9s/mo2PG2AUhNFV+36rh7ADBFgF9Vf15U37z9o98oERkWfa48BYfXch5i9tvwJ0snox1CHBrANeDEOx02yG/r7rwKTU7I9193kIv/6b8YJzhrMmhNrv59rY0MGga7K4X7rnXXtXb/vZeb0/7fpv9JfuCmYgl3S7upe/dO1P22pXxcVr3t01aUxXeqoaiflze+q1q9GNFLELlLa+HHWp/LtmWExU23xdU6H15ahDnZ8qkeavf/zBgWZbBfRofRqqqCZKZ6OQ2eU4/9vEyWtr0XEOAm0uR3hT14e+rh+/G2y6LH/9dlr4OQAdRVbig4TTbms8oMbv1o6n/+r7IV6qPa7w4uQamtAV1LUg/f+nrzve9XT1Yq/vv/bHesf7na+v83w2tb+rjw/t3VnHWhfX9vCv1f6uPavruavr2ZCptF01EuuH6rFegTSZheN8NywG7tvu6wosYBqO967qH1dgTWYX4izs/1Tt70/V/dmImr9fPao+d81jtd+7HV1DM7rSS41onN1D1TUbD8psFIbRVbdeCGMTiLCr902192HMVmEof9bdbdX87sWBdkFIr6v+/054HCKU2SYMod5W3an39pllF4i0vx/2fj4YYxSG0fZ++hejIIwhDVVbH8ZiFIYx7Fwfah/GbBSK0bWPtSe6gFUgSrOvey+IMQrD6Nrq6KUdWIWh/Dl0twdiMgny/6baN70HYLYJQzgdfS0wJkH+v9/fb71NWIzCMPpj6x/iwCoI5Yfmdy/GbBOIsG0Ozb71YcxWgSh7f1AtRmEYg5kvrGabIIR/DjPCxssHsApDqdvu3o+yWAWidDs/xmQThtANO0IPwGQS5v/0e9UNmdQDsVgFofxYNf6UvhiFYdS3Xf3FA2FswhCGLzwdZUzC/J+G5VLn7ydgFoTzdjMs/4Z6ehbv0CwMZ9i3DisBb4MsuzCkzpsXjUmY/2H952/GbBSE8d/VofIvroBVEMq/hm1ldVe5QRajQIw/q0cPHbNNGELb1T46ZpsghJ+q45OX8cUoDKM5Ppwq//rHsgtCeldt6rsVKy3LLhBpW30VPpTJJhxBrkCQz0IY/mFxjgKZzEJxjt4BvxgFYgzz9oNn1lqMgjB+rg9eKWC2CUNouy+1fzkHzYJwfqk7/3S1GIVhtP5t1WwTiNAdT/cnb2hZdkFIv7a7FfkLWIWhnHo/K4tREMb7atf6IGabMIS6u/W2YjEKw9i2T5VnuzDbBCOsEGWhWSBO9TRMRJ4lKrAKQzmskGkWozCML9VD40uPi1EgRn3nb8dsFITx72rXbN0IxiTMf70dkpEHwNiEITxUHhomizDvp+7Ry8FiFITxn8euavyjD5qF4XR3HiYmiyDv/1Nvff1kTIL8/9bUR/XRN/9ZduuR4NM1r6u+zpLv9xt1z35GA0/HWAbO24TWA0O6gC68zu01KkK3x64v3Sb1zMPb/eF0pIDni+ufHOrabe13dT2Z0fVe6sSAbNrB8X5Fla8Xy/VQuHve1X0/RAWHNl1e30We2kN/q+pv6hfAiIXl5cQD1J6OjjiyoGbTS8AwL989tM2GbZq+up6V4Zv6jxXOro0hX/WpYgzQzh1OEGoxDQXrj9Xx1K/Bmi0vgMKMcDgXsHDn9HE9XudryIbmrXrY1+16trnc/aarK/2YpsP/YnQ5wE49/OV2b0wCaj/SygbJVPvZaBWANb9NLX8DHzF2ddEb51PGCAiF4Pv337+pt8eKAzLXXyxdWw5X5eu5is5WuLPbbPBCCc72tyLHLTVk4O48LEA4Y/sMuPt6X3cqeD4d6z9cZEHcs0LPqMC2vT907S07jBA0MH8G6OdGbVY/DcOmBz93cCPjMpfBE5HqwH2JxG/c+HK/qklQ+p8BVswADhDPJDCjrJkHHDDOqWAG8c8Grpa4J4SlJSvmBBvm0mkBd5p3ZkBwKFj1D7I863nL6GU2Pucu/Yttu65hcxOBu2aCWgXtXu0TyCvW/BwwzaN7hoQ2LzRJnrlcMU9aVQ3bEZzDrtkXrAF27w7OcVfsERhYmkE38ktMHsCTb/6YqhQ0hUCYFbOIG8ozkUCsNXOJG8w5nUAo/4ziaZV7UrFatWJeOQO7dGohutE7u5yDwrCef4nrSEzI5iUSE+XSl5hwVS8ODhLUEyIrQR1JiUT1JaWVsOy2gQR17xd4SDpg3LjPzoO2J2ceXKp0eR5EML486IVy5UGE5c2DfjBHesJgvvREgV2UnujWudMTCQqibfkBv/0bfICLTF4gOVEePbkJ15PLEpu2IzuPhDTWz4NkExON6c5LPCjNmhv3uTkCeXLlCFCli3MEhvHkCD+UI0dgLF+OWAGmiPIEgEkRk+UFUJdkCKZtzgxBg4JYm9+IwSYI2+IF8gPh0JMeUCUZQCWtVbcNN24oWLvIc8D5PEHhetIEC0ky5wR9bo6wHblSxFKfizMEAvEkCC+QIz8gJF968EOx2QEjuZMDBXRJbqDb5UwNJCSIr/ktNmxmsC1eIDMQDj2ZAVWSAdzXXz4NQ313IKOPQrVKPAeazwsUrCcvsJAkb07Q5+YF25ErLyz1uTgvIBBPXvACOfICQvLlBT8UmxcwkjsvUECX5AW6Xc68QEKC+DIvnmLTgmXwAlnh3J8nKdg1vHQvQcC5dxLr4Ng8QOG50wAHSLHkQnxuDrD8uFLAXJmLM4AN4UkAPhjH+LdxfMPfC8SOfoTjHvwEzCVjn2yTc+hTgDCmprfBMWtOcHl9ZPHDEHnzDUJQN07su6z617Z9MCyrp54BuqXUFVCOJHPWm54UQ4JRweAk7xKtmx6XliNnjpnrc3mSsUF8WcYH5EozNpI3z/igbuv++GllXE+YRJEXAv/kjXSmCp/WBb67It5EAsHX5RL+tsFSd+doq88SiX/E1aHZngwtd7qn2gnenPx2V93XP9fHL213/vpWeNE5yte+RfnM4ap3KVt1ZOhSOH40bbWg8G86XoN5az/Yz8Penj/OfzGy/4cFPP6qHxVwLcbB8kMDnoexMNWVlwuT2dv6GBmrximH1fHBBzTZrGbJhecKjgXx8shAmBeGxYK8PiY04sebaff27V9XT+q3s8O08u2VfBW/KocSn5t6ezeU/qCrMvhrdzvl4+N07bda0acstMk30dXNh+gmjV4lZfnx480HU2K8MH4xmonhL3GTyFeRzCwzYZnJ4S95k6SvYtuZtKzi4a+Ywowts6E/PiSEs8SySoe/UsIqtayy4a+MsMosq3z4KyescsuqGP4qCKvCshro+FBSjSztjlX9LCLCnUAMjBQIytDmQKjOFhQLwqZBqO4WMWVoEyFUj4uEaoywyRCq10VKWtqECNXzIiMtbVKE6n1B0SJsXkTBGtrUCEWBKEhsmx05skPSKG16pCJBkiNJojEyDhJBWtoESUWDlKSlzZBUNEhyTEmbIalokCSX0mZIKhokyaW0GZKKB0lyKW2KpCJC5qSlzZFUREiSI2lzFCsiJMlRbHMUKyJikqPY5ihWRMQkRzHKZWMyIzmKbY5iRURM5z2bo1gREZMcxTZHsSIiJjmKbY5iRURMchTbHMWKiJjkKLY5ihURMclRbHOUKCJikqPE5ihRRCQkR4nNUaKISEiOEpujRBGRkBwlaMoZ5xySo8TmKFFEJCRHic1RoohISI4Sm6NEEZGQHCU2R4kiIiE5SmyOEkVEQnKU2BylioiE5Ci1OUoVESnJUWpzlCoiUpKj1OYoVUSkJEepzVGqiEhJjlK0NBjXBiRHqc1RqohISY5Sm6NUEZGSHKU2R6kiIiU5Sm2OUkVESnKU2hxlioiU5CizOcoUERnJUWZzlCkiMpKjzOYoU0RkJEeZzZFay37ISI4ym6NMEZGRHGVoCTeu4UiOMpujTBGRkRxlNkeZIiIjOcpsjjJFREZylNkc5YqIjOQotznKFRE5yVFuc5QrInKSo9zmKFdE5CRHuc1RrojISY5ym6NcEZGTHOU2R7kiIic5ytFSe1xrkxzlNke5IiInOcptjnJFRE5ylNscFYqInOSosDkqFBEFyVFhc1QoIgqSo8LmqFBEFCRHhc1RoYgoSI4Km6NCEVGQHBU2R4UioiA5KmyOCkVEQXJUoC3RuCciOSpsjgpFREFyVNgclYqIgt5C2RyVioiS5Ki0OSoVESXJUWlzVCoiSpKj0uaoVESUJEelzVGpiChJjkqbo1IRUZIclTZHpSKiJDkqbY5KRURJclSireu4dyU5KvHuVTFRkiTpa9B23MFGJE/6IjQed7ERSZW+CI3HnWxEsqUvQuNxNxuRhOmL0Hjc0Eb03jdCW9po3NNG9PY3QrvaaNzWRvQOOEI722jc2kYkefoiNB63t1FByjURInDSH2gGzyQIrUFEpGcsQ2gdQoibuHyVComMEYNaixA0g1iO0HoE5xkxqCUJrs6IQa1K0JoIliW0LsHIIlia0NqESG/i+JVIY2SMCNT6hKD0KoEECqEVCpGTjpFGIUYlgpLUhMQakiavuImHXkuQLeJOau5K0hZRN6oRQ71IW8TcqEcMNbuJ81dphJhDYoUYJYmhamRMIL1CjKrEUDeyFoi5UZcQtGIikGghZOmITKRbiFGdELTCIpB0IWLhCCCkXohYS4B0bomxCjjSR4syAmkYItb80doZkjFErAmkcwtSMsSoV1BCrkBKhohzPjaRliHigo9NpGaIUbNgYhPpGSKJHLGJJA0xChdcbCJVQySSj02ka4hEK7j0jJpgETdxJEKkbogkdQQyEjhE4siaSOIQo5AhaGlNIJVDJK6siYQOkTiyJpI6ROrKmkjtEKOmQbpFaodIHVkT6R0idWRNpHiI1JE1U6zAu7Imkj1E6sqaSPkQqSNrIu1DjAqHoHVRgeQPkZYOmpECIjLXyEMiiMiEg2ekg4hR7RC0QiuQFCJGwYO814CkEJElfFAgMURkKR8UGb6BkvFBgQQRkeUOnpEmIrKC5xmpImLUPgStVQskjIg8cvCMtBExKiDDLEGmKySPiFw6eEYKiRh1EOoGnkAKicgd1CGNROQO6pBKInIHdTm++6UTZkZSh6QSkTuoQ2KJyDV19LyP9BJRuKhDkokoNHX0IgGpJqJwUYeEE1HojR55iw9xVzi4Q9qJKBzcIfVEFA7ukH4iChd3SEIRhYM7JKKIQnNHr6yQjiJKF3dIShGjYCLoGzACqSmidHGHBBVR6gmP4g4pKqJ0cIc0FVE6uEOqiigd3CFdRZQu7pC0IkoHd0hcEaOEIugbVwLpKzJycCeRwCIjR8qUSGCRkYM7iQQWqQUW8skOJK/IiOdOInVFRjx3EokrMuK5k0hbkZGDO4m0FRnx3EkkrUgtrSR0RyDqtLLCsIGUFamVFdoxElbk9IAHuQKSSFiRk7BC04yEFamFFWodL5GsIidZhaQZqSpyUlVImpGqIrWqQtOMRBWpRRX6dq1EoorUogp9x1bixz60qkLftJX4yQ+puaOffzh7+IPf3kn8+IcWVujbvBI/AaKVFTLY8CMg+hkQimX8CIhWVRJqsSTxQyBaVKFlR4mfA9GqCn23WeJHQbSqQvtFxGlNhb43LZGmIrWmQrcOSSpSSypM6yZJZXw276nujvXdW/2M3ocPV9Vy/OxfV5+mZ/fi+eH+v67ifPj/77+XZ/XUX8p9ZY6UBeVyUK7gyh2ax/qrVQyU4gpNh8uCQgUoVbLFdtPJBKBguRRMIq7gct71UlKC5km2eeDo2KXosGJZQAVT1DzmuRQTCWilCunB9OZKse/yUJtXlANHEai7kuTZ8uOJtKDiAlRccsXAEbOgqARFOWJvzbGxoByIhyRhyy0P78P+SmF/ceye//IBugDwKk2vc2F+uQAdJdARF6K35kxb0AGgYJIy5TbmnFpQDjQ+yfhy01ncYEjAEcj1+GZ8wzNAA2A6LpVMz5fdTK/FAj0kgA91T4Iv3Oh31MOALmFZjmlVdn5dHkSWsDQXnKp031slQRenU6tjtqt1caLhErhRWrqz/PR6XFgc9hubiVTxp+lFe0thkNqndKJ0Qp8Hog0xyAxKGvW5oGiII+iDp2E6LhkEH2iGA1v/qBICgnJKntAdUJgP5fRBrcJZn9OpyqAyILcmPBvTScmgHEjuCZcf5tdNQf5h9JpZQeh5RfFpvsnYVmyb2p7bABFsOIIXli0FQdtNL2YskbMHKp5go1K2G+GvPEBpUHaiUCbmA9u15mWoMDFAT0JOLRJzhitNZ7N52fySD/IFw9zUS8TGV2q+yQxxuflQmA+lmfsj84HPl7oGd+PvQmAtYlgLQ1Zi2pjO9BWmFuZDYT6UhamF+SC5NcFmPrQbBDzI2SkbZvoobpByQe+xqepuOrcJFANMplwt7+r60Nf147hgyvLbZooua9kH1xRcrieSNEw1MVsBfWw3qDYYBik3kPQKj1gvRiClqIcpJpJMWmOrUZuzvUFFQLik3KKg7jo0EOE6c86vXOn5sG8AC+a2lBtkn8F70ZaioO1zCHM9uHjY6LdXwEwEp9eMyx6fq0drfMH8FbOw09HjoL1wRcFF1+f5NHFQEMRXyuUC9LZ3GJ5w/RSzHW1OGAe4gGE2TX/u9LHhoBhgJ+X69H4+CRwUBBXNuKSBX+UPGwojkiXmfj4dHCyVQOLJuMRzPx35DYqBxJNxA+5eH+QNSoHwYSfQ+/lsblAQjNOMG6cP5rxtUA5Eecbx/1BX2+PD2RABlHBUPkzHbwNAEOkZF+nD8mpYKMpD12631a6Ki1uLTADM7u4WF7thD99V29zyIQE97Ow1LNbu7F6G62ZutD0sp3WDkiD+Mm68NMv526AkGDJsGmrspYaAE4A0c3tsMnFqvsnMmiM3HwrzoTQLp8h8EFx4NOqXn5/Hn/rCjS9kid2ejGX35jflsDiUWSQ3FKYX/8Cmw02VMDNAbFbFifkmNeuuPDJNNx/KyDSdC64GnF8OmAItzvmi82v64IwNJ2xTH77Rkwti0rImXjZaOpTNc4CfczmuMaedg3JgFOXcKPp9PsAcFAR5jp2dH82h5KAcSHM5l+Yep5PGQTGQ5XIujB+n48NBMRBLOZertvOBgXAZAEqyysDWHCYOEEGCybkEswWng4OicA/GDbchnT5VwyL/9uGzlQ0BHexYW06rgfMqzDSsarSrllPGQY1BWTZWd9PR4aAYGGYFN8x203ngYF0IYrzgYny3nPANSoIoL7go35lTu0E50KvsYN6Zk7hBORDkBd+lvTX04XKVXciRIhjcoYh5Z8vycaZwwqlUPfI6OTBpLDXfZCatCrYPlW87vmB4cVXaTyeNgx4EnVFwnbGvT8OyQElTaGkApV+u++ELIeGsBRN5yUXZfjm1HNQZpIyCSxn79tTrlc24MJIitqsO4FkZ1rzPCMYA3AboBKAmzXmuNN9khsvcfCjMhzI1k6b5ILhGmENgYAWgKiFmLYvzoF++AcpDdUCyUurBnOMOeh1Ef8El3EOLt8UFSLYFl2wP4LR1UBRuULmQtl5EDOd3OB7YLNYNi8jWSmFQpmW3/1315a69r1FEQ23WVfDQ9nZJuBDjxuBYsu/rs8IwKXFR0Ok3U+7q40N7Z0+/IBzY22RT8UNjRyIMRBPbXPKeXRArMTikWJ71CVAQHiaQuQJizqosBYMjqwug8CS5wB4S2Nk6ooDbOm4kdacej6QS1JzNfH21a1Ex0OElF5nnt/jgAkvkRu2NzAf2VlBfd7e44mCaZpnu53PnQUFQh5IL0n7bPlX2thnkupLjUxU7u2ldgsFYckOqP5yJoCWIhZKLBfMGQBiMcDch5wndfMhMeOZmP1mYD6U0jJgP7O21/kv10NjTdwlwSy679uZwe1AOZMeSG3L91/5YW8kRimDs3HHUJ90DMDjA2Z3icTq/Hu71rM0eN1LOFCx4e1awitJxPM8eosGEFrHF5tfDwoUdZN/wydFoPJxnQvjwgGBpOS7vj4SNhrsLE0ncmGHv5cPdzSyHC7bnrdfzQT8wpbLLq+Ope0RxqX71CUjguvD02FUNHvPqR6CgLNf2U3eHogxO3BGXLMaX3IGRABo4dZNki/b2wyVwJ8jebHtq6qMyspdE6hemoLJchvoybA5Qv8JZIOJS8NcmTm7xgwvw7jndxo83V4fmUG+b/WD04ePff/8/rfJ4PVeqAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dXXPjtpL9L/ar70QAv+dtJx83szeTSiX3ZmtramqKtjA2x5KoJalxJqn89wVIgmy0ugGK9oOrZKmB0+jTaACHFPXXVVM/tVev3/919Vgdtlevhcxvrg7lXl29vvp2V6lDd3VzdWp2+t+7Xdm2qv1mePvVQ7ff6c/Gd/XnV3/f2F4SIade7upD2zWnu65ufF1du3ag25urY9kYRyaPZiCxkfGEZPr2IQyfzz137fYfVfuPY1N9KTu1HKc8Vv9SX71Qk8kqNLmJAQsPpZeD69FgYcTO+v7tt++D3Q82axF+r9qqPgRBJrNVOPX+uFNdEAearcH5fn+rttvqcO+FgVZrUH4o77pTuas6f5Y5ZmtwflTlrnv49kHdPXqBXLs1SG8Pn9VdkB5otQblV3XclXfql7deFGi1BuXf9R/VXYgbYLQKoykP7W4oFB4QYLUqXuXTd/U/lb++ACOimtWdZkxtL8T8pW4XgI5WL4aqy9gy4NlwLXaSziWjacDSVx061XzS6dd+03/gXUedZUeF+7m2NnQyDJ7M3c/heVdv1a6dOleH0779ZnjT7+A8zDdNtb1XXf2kmp/K5l697fbvdvu33R3f67WvDT2E0VHSgx9Vs1et/KWpf9qV+zLK33igSePLMX+uT+3QVd+NFJEPlLZ+zkjfVXrTVO6yZUOF1pejap+/lCLJ3vz4gwfNtVoRUXXSLpoNgXdQyOxynP+toviNs7k6B4E2lyN8p9SxVerxW23TpNmbt+MG1wPoabIQH5S8eqfwlO7fWzqj/6ttdb6UB+zw3Mk1NKEdHLwg+/9Pqxq+6/HTi3v97WvbqT3f7/T5sp7PNhfvVPdQb88C63y4NMK/lodtfebreVfXkyHjtOsaifVD+agWII1m63G+1duR+7r5ugALmK7He1e2jwuwRrMLcWb2fyoP96fy/mxGTe8vnlWfmuqxPBz8HV1DM9rp2SMaZ/9QNhVefTHKZLQOoylvgxDWZiXCXh2q8hDCmKzWofypmtuy+hzEgXarkN6U7f+d8DxEKJPNOgS1K5tTG4yZY7cS6XCvT58hGGu0DqNuw/TPRqswdBkqdyGM2Wgdhj47P6gQxmS0FqOpH1Ugu4DVSpTqoNogiDVah9HUZRekHVitQ/lThzsAMZqs6v+78lC1AYDJZh3CqQuNwJqs6v/7w/0uOITZaB1G29XhKQ6sVqH8UH0OYkw2KxF21bE61CGMyWolyiGcVLPROgxtFkqryWYVwj/1inAX5ANYrUNRdXMfRpmtVqI0+zDGaLMOodEnwgDAaLKu/9PnstGVNAAxW61C+bGswiV9NlqHoW4b9RSAsDbrEPQbgUBZk3X9n/R2qQnHCZitwnl7p7d/2s/A5h2arcPR51a9EwgOyLFbh9QE66I1Wde/3v+FhzEZrcL47/JYhjdXwGoVyr/0sbLcln6Q2Wglxp/lY4COyWYdQt2oEB2TzSqEn8ruS5Dx2WgdRtU9nMrw/sexW4X0rrxT2wU7LcduJdKu/CpCKKPNegS5AEE+C0H/YXGOAhnN1uJ0wQk/G63E0Ov2Q2DVmo1WYfysjkEpYLJZh1A3Tyq8nYNmq3B+UU14uZqN1mHU4WPVZLMSoelO96dgajl2q5B+rfcL6hewWodyasOszEarMH4r93UIYrJZh6Ca2+AoZqN1GLv6Sxk4Lkw2qxEWiLLQbCVO+UUvRIEtKrBah3JcINPMRuswnsqHKlQeZ6OVGGobHsdktArj3+W+2vkRrMm6/tVOF6MAgLVZh/BQBmgYLdb1fmoegxzMRqsw/vPYlFV49kGzdTjNNsDEaLGq9/9Ru1CcrMmq/n+vVGdehtY/x245Ery/503ZqjT+/nBnrtlPaOD+HMfAe5nQvdWwbzA0XtbtNWpCj8f1lx6Tuefh7eF46ijg6cPl9y419U6Fu7oezWi/Z58YkLtad3xY4PL1bLkcCofnnWpbnRUc2vjx8hAFvIf9LfLf+reCEQcryEkAqD51njxyoCbTS8AwL98+1NUdO7Th0+Ws6HfUHws6u7aGvOujYwzQ3p9OEGo2XQvWdmV3apdgTZYXQGFGOJwLWNh6+7juP+c9ZFPz1txu7O96srm8+7tGlcONop7+Z6PLAfbm5i9/99Zkhfc9rWySjN5PRosAnPVtHPl38CZnX4i+897njIBQCv722/ffqV1XckD28xcr106Hi+r15KJ3FP7qNhm8UIFz+1tQ42YPGbhtgAUIZ22fAXevDqoxyfOxU3/4yIK4Z42e4cCuvj829S07jRA0MH8G6KfKHFY/6mnTgi9c+JFxm8vgiUz14L5E4bfdhGq/8WRV+Z8AFqwAHpDAIjChLFkHPDDepWACCa8GvpH4F4R5JAvWBBfm0mUBBy24MiA4lKzDF88C+3nH6GUOPuddhjfbrq/r1iYCd8kCtQjav9snkBfs+Tlgmkf/CgltXmiRPOtywTrpuLruRHAOu+RcsATYfzo4x11wRmBgaQb9yC+xeICeQuvH6NKqJQTCLFhF/FCBhQRiLVlL/GDe5QRChVeUwKj8i4ozqgXryhnYpUsLEcbg6nIOCtN6+saxpzAhm5coTFSXocKEXb04OUjQQIosBPUUJRI1VJQWwrLHBhLUf17gIemE8eM+uw66PXnr4OzS5XUQwYTqYBDKVwcRVrAOhsE85QmDhcoTBXZReaJH5y9PJCj8crJ9UgGr9rsWy7OOmzlEf/55g1zkknzP7JUoPGt8ISAZOB1/UtBwDF6gop/3FyjnroeX1nICzl/IF8HxVZzAC5TwRYDq7HkdfkwVfHIHB0smhxf1uRXc7chXwGd/Lq7fCCRQvoNAnuqNkELFOwgVTu2L0ppVNEPzfxQzS4+WSYFcsjTQofOuDCQkSOH52TLu42EAKjJ5gRpH9RiocthPrvDc1Q0ZOhLSWj8Pkq11NKa/2vGgNGt+3OeWHtSTr/YAly4uPhgmUH3CUJ7yg7FC9WcBmCEqkAB27zhaXgB1SX1gxuYtEDQoyLXpYU1sgXAtXqA+EB0GygNykgE011zK24qbNxSs2+Q54HydoHADZYKFJJnzgj63Rrgd+UrE7M/FFQKBBApEEMhTHxBSqDyEodjqgJH8xYECuqQ20OPylgYSEuTX9IA1tjK4Fi9QGYgOA5UBOckAHtTTRz3V90cy+yhUp8VzoPm6QMEG6gILSfLmBX1uXXA78tWF2Z+L6wICCdSFIJCnLiCkUF0IQ7F1ASP56wIFdEldoMflrQskJMgv+0xEtiw4Bi9QFc77CxQF18NLzxIEnP8ksQyOrQMUnr8McIAUSz7E59YApx9fCZicubgCuBCBAhCC8cx/Fyc0/YNA7OxHOP7JT8BcMvfJMXmnPgUIc2p8UCmz5wQfL88sfhqi3kKTEPjGadmXuX/t2q+GZRWsM0C/hrUAylNkzqIZKDEkGJUMXvIuuQhKz0unI2+Nmfy5vMi4IKEqEwLylRkXKVhnQlC3qu0+LszrEZNo8kLgH4OZzrjwcVni+x0JFhIIvqyW8NeTZ9+9s02dFZLwjFNrqz2ZWv5yT40T/HTAW3OB7WfVPdXN+ZPF4YfeWb70ZwTOOlz0YwKOjwxdBieMNljNKPyj/pdg3rrf+OJhb8+/53UxcvgbZzz+om+bcSPGyfJDBW6UdDDNJy+XJlNvy3Okd41TDsvuIQQ02ixmyYfnS44Z8fLMQJgXpsWMvDwnBsQPN+Pp7fVfV1/MQxX0svL6Sr6KXhW6xadK7ba69fvBFd1fvd+bPj6Mn/2uDH3GYjD5ZnN1835zk4hX8sOHm/fWvn+7f6M3Evo/cRPLV5nMHDPhmEn9n7yJ01ebwu1NOmaR/i86h4wcIx2M9zHVV+yYJfq/hDJLHLNU/5dSZqljlun/Msosc8xy/V9OhSN3zDQh7wuqt8INrom1IDgQiISeBUF1KFwehIm3IJkQLhXCBF1EpKXLhzBxFyQjwqVEmNCLhBiPy4kwsRcpYeeSIkzwRUbYuawIE32Rkx66xIiCt3S5kT03xTm2dLmRhgBJcCjRDOmniCDsXF6kCb6UhJ3LijShl8Rkki4n0oReV8VzO5cTaUIvCe6ky4k0oZcEd9LlRJrAS4I76TIiTdj1Cndu5/IRmbBLgo/I5SMyYY8IPiKXj8iEPSL4iFDJ6msWwUfk8hGZsEdUcXP5iEzYI4KPyOUjMmGPCD4il4/IhD0i+IhcPiIT9ojgI3L5iEzYI4KPyOUjNmGPCD5il4/YhD0m+IhdPmIT9pjgI3b5iE3YY4KPGK0i/TJC8BG7fMQm7DHBR+zyEZuwxwQfsctHbMIeE3zELh+xCXtM8BG7fMQm7DHBR+zykZiwxwQfictHYsKeEHwkLh+JCXtC8JG4fCQm7AnBR+LykZiwJwQfCVrW+3Wd4CNx+UhM2BOCj8TlIzFhTwg+EpePxIQ9IfhIXD4SE/aE4CNx+UhN2BOCj9TlIzVhTwk+UpeP1IQ9JfhIXT5SE/aU4CN1+TB7zvcpwUfq8pGasKcEHynaZ/UbLYKP1OUjNWFPCT5Sl4/UhD0l+EhdPlIT9pTgI3X5yEzYU4KPzOUjM2HPCD4yl4/MhD0j+MhcPjIT9ozgI3P5yEzYM4KPzOUjM2HPCD4yl4/MhD0j+MjQxrff+RJ8ZC4fmQl7RvCRuXxkJuwZwUfm8pGbsGcEH7nLR27CnhN85C4fuQl7TvCRu3zkJuw5wUfu8pGbsOcEH7nLR27CnhN85C4fuQl7TvCRu3zkJuw5wUeOTiL9UYTgI3f5yE3Yc4KP3OWjMGHPCT4Kl4/ChL0g+ChcPgoT9oLgo3D5KEzYC4KPwuWjMGEvCD4Kl4/ChL0g+ChcPgoT9oLgo3D5KEzYC4KPwuWjMGEvCD4KdDTsz4YEHwU+G5q4FwQhwyfQsj8ebshzJDoebvrz4YagZfgImvYHxA3BzPARNO1PiBuCnOEjaNofETcEP8NH0LQ/JW6o4+QGnRM3/UFxQ50oN+iouOnPihvqULlBZ8VNf1jcEFwNHwHT8SRPsXV2lh8O8xtSVMHH+eE8Lyi+8Hl+ONCbsz/VL2JsONOb4//mlRQxMkacDcd6QXGGD/bDyZ7rF7E2HO85jxFvwxlfkIqPwKf84ZhPKgzomC+Gc77IbiLtRIwlE8SdHLij9QOJpZiBu4LuGbHXn+5pjQUd/EV/wNeu3URC9yuQMeKuP+Vr12hjxF5/1Neu0caIvf68r527iZJXepYiY8Ref+jXzpF5gRQB0Z/8tXO0G4i//vgvKEFCIGVARMKTnEgeENGgpFF1IsJKWuRJISQTiGhgjyoqSCkQ0cAdVVSQWCB6UUBQsodAeoHodQFBKR8CSQailwboGYdUAxEVnqRE0oGIN56kRPqB6HUCLimRiCBi6UlKpCSIXjHgkjLGImjsSUqkKYheOxCUaiSQrCDi1FMEkbYg4syTwUhgELGvYiKVQfRqgqD0K4GEBpH4KiZSG0Tiq5hIchCJr2Ii3UH0+gKp7AskPYjEVzETrGH7KiYSIUTiq5hIiRCJr2IiOUIkvoqJNAmR+ComEiZEL0AISoIUSJsQqfBQjQQKkfrmHlIpRBp5qEZSheglCV3zSLKRXiF6XYK8lCNSfBki9eQF0i1EmnnyAokXIs09eYEUDJEWHqqRjCGyjYdqpGWIXrMQlDoskJwhetmCizHSNEQ2XDwir8wg7rKBO2q9Q8qGyBJPtiF5Q2SpJ9syfB0p82QbEjpExl7kE0jrEL2mwZgi3vKNJ9eQ5iFy4ck1JHyIXHpyDakfIo88YUMSiMgH7qgNCFJBRJ540hJJIaKXPAR1UUAgNUTkmScnkCQieulD7wlIQpAuIvLCkxNIHBG9CEJe0RVIHxGF8BCNRBJRSA/RSCkRReQhGsklohiu2kqyqCDNRBQ+9pBwIoqBPWqrgLQTUfjYQwKKKAb2qHUJaSii8HGHhBS5GfYr5N0JSEqRGw95EokpcuMhTyI5RW485EkkqMiNhzyJJBW58ZAnkagiB1GFuo4lkagiNx7yJJJV5CCrUNe9JJJV5MZDnkTCihyEFfrWEqSsSOEjDykrUvjIQ9qKFD7ykLYihY88pK1I4SMPqStyUFeoi4YSaStS+MhD2ooUnropkbYihY8+fBPFoK6Qd5lIfCOF9NF3djeFjz58S4X00Yfvq5A++vDNFdJHH77DYpBXYvIsJPFtFoO8wnCC77UY5BWuZ0TgKK+QWwCJ5BU5yCsM20hgkYPAQqpYEukrctRXaLaRwiIHhYVhGyksclRYaLaRxiIHjYW6bi6RxiIHjYW6dC6RxiIHjYW6ei6RxiJ7IUVQF9Al0lhk5DnlSaSxyEFjoS64S6SwyJi9yU8ifUXG/I1+SF2Rg7qS0NmA1BU5qCu0KC6RuiIHdYW69i+RuiIHdYXuFXE2aCvUnQISKStyUFa4oSHWBmWFG9rAWn9r5xfVdGr7drjF8/37q3L+Wfu/rj6Ot35G072mf11pyl//9fff862e5j/TfWl/qh60K+Z2mn+m3bF6VF+dZgCNazT+aP3cSG/sZyzBNtuPv3gEGgrQUHIN27Zqu9I8gXVuKcHwInZ44CfpAagEoNwg7V3CczND/9RODg1vrgz7vh6U/ekT0NEG+G6uFrHt+1+6B44DcvQUYZqBn64HTYHvespwTcefowftEtAuZdvN3/2A8QLkmiroaex8cQZ0ERewC95v+osv0JcN7IgdSN2eZWgKAsCOoam296qrn1Sjg3+vqm6/3+2rzpkkErrATZK7sit3yIMMeMAlm26n7uvGncqAO3bId/1vUAA0ADZkuLkcxbe9Gx/cCWItUpjeXMkyjavhuXqwrYBtuYpg2k4P9IWtY9iaSxfTum2dliBSyTjqiA310JwYuARMmWtG3vbjA/xhcxg3tqaZ5l/GRwHPjUHTdBxA4qNt6IEYQwRqjLkQEOqCoiGSsA+eBh1D5aY6WOs82MO3e2GZgIDFmLfm2Dy8EPaF5Iqm7rOpH5VbbUHtSXg2quHXhkEugXmesPPcPhAT8g+zV+YjjXahMZcAhhcpG5ldpdxVErjCjgA8UnVuCDI5s7AskVMPVD7BQaW8E+DrRqA1aGuX2+kFW9Hs49phYYBZbdPB3J4wznVhg81V+OkrpZAvmHXS9mUdNBeDxsBZ4nI5vijs5mFjXwj7QtoXEZurgyvb/ptK0J0EulNYd+xgE/tOtrHu2FJXJNYd+0LYF9K+YLeed01ddmjRhCt/wtbBP/X8d1qBeLLFazv+1iRoBrhNuKANTxiEeQn3YDnbTKljq9Rjv4dLs9tqTFNnXQdzRXKLBlHtc1jtWQdOHQoSmE8JNyPBgzrnlgDPJmQ2veDYnXo6DyD0P+P8n9qfL/URXO4yrlAO+2diNy42cEpPVcGWenb50HvcHc4guPxzZUU1DSpOMAA2kCxq29V4a5mAACRc4fkEHlo4NwXJa6d1wdXWuYe74dEycOGEQcy5oX8qH51SA2s6uyn/VH3G4wUTJeEmyqdqVx2rQ+00BJFOuAij3+iBiQaXEfYcotufVRYQZnbp+tToFHWapSCoKZfX5qB1hwKUAkdTrmziH2CCJQXWNJaYe1U39xgZlN6UK733qtmjZqD0plwJuG90AXVagfRhNxX3p8/mR9edw2gK5mnKJetDWeHlKIW7Y47/B1XuuofzKQJnCJcDD+q2UU8OJMj1lMt1venU22d5bOrdrtyXUX7rrCvw+Mxlw9zFvtJLU7nL3D4AQezmV29ht26cwXxjN5sPp8N92eBIgwzMuGjpLaI+4m5dCSkDcWYXgwptwCA30m50IlsRE/tOandiud36FHa92NgX0woi7Qv2ADc+IB1WGHjwy7j507f71H+VHyoTCaSImw5924N9ZgRs7jDMhnx4sBdcPqHL0sYlmg4b9p3Ubmczu1vM7YGgyGwQ7QvBTS6NWutzEsqWDGR4xkZ7fh4ndB8u/tYNfvRjF8QCCA8GBVdTqgatDBmolzzfna7xaMQAjt0zfS6PJT5UZqBmZlySGO243DrbtAxkV8YN77H8s3x0xwcqZsaR+ljrxdYdHjw2clVvN/1kNNxSgJas8rIzogNCBKWK3cTqvc/DqcTbrwzUqpxLHV2Yv5QiyW4fPjl1FUrBHB3z7xXCUgFrFqvK7cs7tT3bMOagbc7VyH25K78KpxmYLDk3zfpm0mkGcjzncrxvpv/2TkuQ5ezRSrfsUJLnIKo5F9W92RY8OOtVDpKc3cTuy9aZ+vD4wW4KSZER7vvldNpn+TjTouGibO6bHzqIrTiQTIKLfSeb1q9JJeBSvUdzMw5K6FyaH9QRCf85CE/OheegTnrLYcRAtO2AaxpHCHwWLKzIKfSXKwWHunlSeBebgyKS8y1P7bBr6jddUkSu6yDrWeHbPsoMkgpXJKuaiNguo4l9J7Xs5jZzCmnXL/tC2BfSvohYT8ZfCIT5CXWg6WDKXjkYHsADdxSQAFYQO5rn0aDwQ4WBS9BjjU/fOTzMcgl6rJvudH9CBaMABbHgJqDzMHKYaFCZLLjwNHqnWjvVDSrkrG7TlE/b+l65zEBiuPLWNzzWrdsSSiXcfOpbtq06a+xsTrnGw9Np96p7qLfuygwmBJuGY/Nj5c4JOCVsbnMMT10QmzRYTjbs+Gu0s3bwrcAqxFRwfR05IYBSHVt5dSU722IUoCgU3MrbnFo8kwrgecHFvC33NWoGMrPgMvP8Oi28CC/y3BJlX0guZ1rV3GLHwZwquBRv9Z5K722c418BkpSdi+2u/lI6qVGAzGB376bZ2Z0HBZhSBTvC45naXIBcKLhcsE8BhckItRk5rfX2RWrTM5vWh0nYK+z6YF8I+4K9SNg+lQ+Vu6AX0AH2qNQ+qS0asfmeMWjJldn2a9spt1CCvGIP0125r9zt0Qam44Ztp3Z6PXAbwvm+4abNmWoGL5OL1GoG7Hm0eyjdKreB27kNN+266cHREBqeBex046ixPRD1EV6BYNeHbn6yLGwLL9XatOI4Zm/TgAXSXgmT7MUQ98GdcIF0Nl9s81PzeJajcBwbrvKcHpuywpXAfOEctOXCd2q2KN3gorzhSkj/+EuwlIABjmFi73s6te59Q/DoyFL0pVKdMXI3SuY77cBZrm496bMDiivcPLC78a9VFN/iO0ng7Qz0GvLh5upYHdWuOmij9x/+/vv/Ac3bODJytQAA"; \ No newline at end of file diff --git a/docs/classes/Client.html b/docs/classes/Client.html index dd41e23..5fda044 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -6,6 +6,7 @@ ChatSSE ChatVision Completion +Embedding Factuality HealthCheck Injection @@ -28,7 +29,7 @@
  • temperature: number

    temperature represents the parameter for controlling randomness in generated chat.

    • Returns Promise<[Chat, null | Error]>

    Example

    import * as pg from 'predictionguard';

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

    async function Chat() {
        const model = pg.chat.Model.NeuralChat7B;
        const input = [
            {
                role: pg.Roles.User,
                content: 'How do you feel about the world in general',
            },
        ];
        const maxTokens = 1000;
        const temperature = 1.1;

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

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

    Chat();
@@ -46,7 +47,7 @@
  • onMessage: ((event, err) => void)

    onMessage represents a function that will receive the stream of chat results.

    • Returns Promise<null | Error>

    Example

    import * as pg from '../dist/index.js';

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

    async function ChatSSE() {
        const model = pg.Models.NeuralChat7B;
        const input = [
            {
                role: pg.Roles.User,
                content: 'How do you feel about the world in general',
            },
        ];
        const maxTokens = 1000;
        const temperature = 1.1;

        const 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(model, input, maxTokens, temperature, onMessage);
        if (err != null) {
            console.log('ERROR:' + err.error);
            return;
        }
    }

    ChatSSE();
@@ -63,7 +64,7 @@
  • temperature: number

    temperature represents the parameter for controlling randomness in the generated chat.

    • Returns Promise<[ChatVision, null | Error]>

    Example

    import * as pg from 'predictionguard';

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

    async function ChatVision() {
        const role = pg.Roles.User;
        const question = 'is there a deer in this picture';

        const image = new pg.ImageNetwork('https://pbs.twimg.com/profile_images/1571574401107169282/ylAgz_f5_400x400.jpg');
        // const file = new pg.ImageFile('/Users/bill/Documents/images/pGwOq5tz_400x400.jpg');

        const maxTokens = 300;
        const temperature = 0.1;

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

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

    ChatVision();
@@ -76,46 +77,55 @@
  • temperature: number

    temperature represents the parameter for controlling randomness in generated chat.

  • prompt: string

    • Returns Promise<[Completion, null | Error]>

    Example

    import * as pg from 'predictionguard';

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

    async function Completions() {
        const model = pg.Models.NeuralChat7B;
        const maxTokens = 1000;
        const temperature = 1.1;
        const prompt = 'Will I lose my hair';

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

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

    Completions();
    -

    Factuality

    • Factuality(reference, text): Promise<[Factuality, null | Error]>

    • Factuality checks the factuality of a given text compared to a reference.

      +

    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]>

        +
      • A Promise with a Embedding object and 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 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.

      Parameters

      • reference: string

        reference represents the reference text for comparison.

      • text: string

        text represents the text to be checked for factuality.

      Returns Promise<[Factuality, null | Error]>

        -
      • A Promise with a Factuality object and a client.Error +
      • A Promise with a Factuality 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 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 a client.Error object if +
      • 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]>

        -
      • A Promise with a Injection object and a client.Error +
      • A Promise with a Injection 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 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.

        @@ -123,7 +133,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.

        @@ -132,37 +142,37 @@
          • (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.
      -

    ReplacePI

    • ReplacePI(replaceMethod, prompt): Promise<[ReplacePI, null | Error]>

    • ReplacePI replaces personal information such as names, SSNs, and +

    ReplacePI

    • ReplacePI(replaceMethod, prompt): Promise<[ReplacePI, null | Error]>

    • ReplacePI 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.

      • prompt: string

        prompt represents the text to detect injection attacks against.

      Returns Promise<[ReplacePI, null | Error]>

        -
      • A Promise with a ReplacePI object and a client.Error +
      • A Promise with a ReplacePI 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 ReplacePI() {
          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.ReplacePI(replaceMethod, prompt);
          if (err != null) {
              console.log('ERROR:' + err.error);
              return;
          }

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

      ReplacePI();
      -

    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]>

        -
      • A Promise with a Toxicity object and a client.Error +
      • A Promise with a Toxicity 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 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.

      • targetLang: Languages

        targetLang represents the target language of the text.

      Returns Promise<[Translate, null | Error]>

        -
      • A Promise with a Translate object and a client.Error +
      • A Promise with a Translate 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 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

    constructorapiKeyurlChatChatSSEChatVisionCompletionFactualityHealthCheckInjectionRawDoGetRawDoPostRawDoSSEPostReplacePIToxicityTranslate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyurlChatChatSSEChatVisionCompletionEmbeddingFactualityHealthCheckInjectionRawDoGetRawDoPostRawDoSSEPostReplacePIToxicityTranslate
    \ No newline at end of file diff --git a/docs/enums/Languages.html b/docs/enums/Languages.html index ff55dba..fe8a881 100644 --- a/docs/enums/Languages.html +++ b/docs/enums/Languages.html @@ -1,5 +1,5 @@ Languages | predictionguard

    Enumeration Languages

    Languages represents the set of languages that can be used.

    -

    Enumeration Members

    Afrikanns +

    Enumeration Members

    Afrikanns Amharic Arabic Armenian @@ -70,4 +70,4 @@ Urdu Vietnamese Welsh -

    Enumeration Members

    Afrikanns

    Afrikanns: "afr"

    Amharic

    Amharic: "amh"

    Arabic

    Arabic: "ara"

    Armenian

    Armenian: "hye"

    Azerbaijan

    Azerbaijan: "aze"

    Basque

    Basque: "eus"

    Belarusian

    Belarusian: "bel"

    Bengali

    Bengali: "ben"

    Bosnian

    Bosnian: "bos"

    Catalan

    Catalan: "cat"

    Chechen

    Chechen: "che"

    Cherokee

    Cherokee: "chr"

    Chinese

    Chinese: "zho"

    Croatian

    Croatian: "hrv"

    Czech

    Czech: "ces"

    Danish

    Danish: "dan"

    Dutch

    Dutch: "nld"

    English

    English: "eng"

    Estonian

    Estonian: "est"

    Fijian

    Fijian: "fij"

    Filipino

    Filipino: "fil"

    Finnish

    Finnish: "fin"

    French

    French: "fra"

    Galician

    Galician: "glg"

    Georgian

    Georgian: "kat"

    German

    German: "deu"

    Greek

    Greek: "ell"

    Gujarati

    Gujarati: "guj"

    Haitian

    Haitian: "hat"

    Hebrew

    Hebrew: "heb"

    Hindi

    Hindi: "hin"

    Hungarian

    Hungarian: "hun"

    Icelandic

    Icelandic: "isl"

    Indonesian

    Indonesian: "ind"

    Irish

    Irish: "gle"

    Italian

    Italian: "ita"

    Japanese

    Japanese: "jpn"

    Kannada

    Kannada: "kan"

    Kazakh

    Kazakh: "kaz"

    Korean

    Korean: "kor"

    Latvian

    Latvian: "lav"

    Lithuanian

    Lithuanian: "lit"

    Macedonian

    Macedonian: "mkd"

    Malay1

    Malay1: "msa"

    Malay2

    Malay2: "zlm"

    Malayalam

    Malayalam: "mal"

    Maltese

    Maltese: "mlt"

    Marathi

    Marathi: "mar"

    Nepali

    Nepali: "nep"

    Norwegian

    Norwegian: "nor"

    Persian

    Persian: "fas"

    Polish

    Polish: "pol"

    Portuguese

    Portuguese: "por"

    Romanian

    Romanian: "ron"

    Russian

    Russian: "rus"

    Samoan

    Samoan: "smo"

    Serbian

    Serbian: "srp"

    Slavonic

    Slavonic: "chu"

    Slovak

    Slovak: "slk"

    Slovenian

    Slovenian: "slv"

    Spanish

    Spanish: "spa"

    Swahili

    Swahili: "swh"

    Swedish

    Swedish: "swe"

    Tamil

    Tamil: "tam"

    Telugu

    Telugu: "tel"

    Thai

    Thai: "tha"

    Turkish

    Turkish: "tur"

    Ukrainian

    Ukrainian: "ukr"

    Urdu

    Urdu: "urd"

    Vietnamese

    Vietnamese: "vie"

    Welsh

    Welsh: "cym"

    Settings

    Member Visibility

    Theme

    On This Page

    AfrikannsAmharicArabicArmenianAzerbaijanBasqueBelarusianBengaliBosnianCatalanChechenCherokeeChineseCroatianCzechDanishDutchEnglishEstonianFijianFilipinoFinnishFrenchGalicianGeorgianGermanGreekGujaratiHaitianHebrewHindiHungarianIcelandicIndonesianIrishItalianJapaneseKannadaKazakhKoreanLatvianLithuanianMacedonianMalay1Malay2MalayalamMalteseMarathiNepaliNorwegianPersianPolishPortugueseRomanianRussianSamoanSerbianSlavonicSlovakSlovenianSpanishSwahiliSwedishTamilTeluguThaiTurkishUkrainianUrduVietnameseWelsh
    \ No newline at end of file +

    Enumeration Members

    Afrikanns

    Afrikanns: "afr"

    Amharic

    Amharic: "amh"

    Arabic

    Arabic: "ara"

    Armenian

    Armenian: "hye"

    Azerbaijan

    Azerbaijan: "aze"

    Basque

    Basque: "eus"

    Belarusian

    Belarusian: "bel"

    Bengali

    Bengali: "ben"

    Bosnian

    Bosnian: "bos"

    Catalan

    Catalan: "cat"

    Chechen

    Chechen: "che"

    Cherokee

    Cherokee: "chr"

    Chinese

    Chinese: "zho"

    Croatian

    Croatian: "hrv"

    Czech

    Czech: "ces"

    Danish

    Danish: "dan"

    Dutch

    Dutch: "nld"

    English

    English: "eng"

    Estonian

    Estonian: "est"

    Fijian

    Fijian: "fij"

    Filipino

    Filipino: "fil"

    Finnish

    Finnish: "fin"

    French

    French: "fra"

    Galician

    Galician: "glg"

    Georgian

    Georgian: "kat"

    German

    German: "deu"

    Greek

    Greek: "ell"

    Gujarati

    Gujarati: "guj"

    Haitian

    Haitian: "hat"

    Hebrew

    Hebrew: "heb"

    Hindi

    Hindi: "hin"

    Hungarian

    Hungarian: "hun"

    Icelandic

    Icelandic: "isl"

    Indonesian

    Indonesian: "ind"

    Irish

    Irish: "gle"

    Italian

    Italian: "ita"

    Japanese

    Japanese: "jpn"

    Kannada

    Kannada: "kan"

    Kazakh

    Kazakh: "kaz"

    Korean

    Korean: "kor"

    Latvian

    Latvian: "lav"

    Lithuanian

    Lithuanian: "lit"

    Macedonian

    Macedonian: "mkd"

    Malay1

    Malay1: "msa"

    Malay2

    Malay2: "zlm"

    Malayalam

    Malayalam: "mal"

    Maltese

    Maltese: "mlt"

    Marathi

    Marathi: "mar"

    Nepali

    Nepali: "nep"

    Norwegian

    Norwegian: "nor"

    Persian

    Persian: "fas"

    Polish

    Polish: "pol"

    Portuguese

    Portuguese: "por"

    Romanian

    Romanian: "ron"

    Russian

    Russian: "rus"

    Samoan

    Samoan: "smo"

    Serbian

    Serbian: "srp"

    Slavonic

    Slavonic: "chu"

    Slovak

    Slovak: "slk"

    Slovenian

    Slovenian: "slv"

    Spanish

    Spanish: "spa"

    Swahili

    Swahili: "swh"

    Swedish

    Swedish: "swe"

    Tamil

    Tamil: "tam"

    Telugu

    Telugu: "tel"

    Thai

    Thai: "tha"

    Turkish

    Turkish: "tur"

    Ukrainian

    Ukrainian: "ukr"

    Urdu

    Urdu: "urd"

    Vietnamese

    Vietnamese: "vie"

    Welsh

    Welsh: "cym"

    Settings

    Member Visibility

    Theme

    On This Page

    AfrikannsAmharicArabicArmenianAzerbaijanBasqueBelarusianBengaliBosnianCatalanChechenCherokeeChineseCroatianCzechDanishDutchEnglishEstonianFijianFilipinoFinnishFrenchGalicianGeorgianGermanGreekGujaratiHaitianHebrewHindiHungarianIcelandicIndonesianIrishItalianJapaneseKannadaKazakhKoreanLatvianLithuanianMacedonianMalay1Malay2MalayalamMalteseMarathiNepaliNorwegianPersianPolishPortugueseRomanianRussianSamoanSerbianSlavonicSlovakSlovenianSpanishSwahiliSwedishTamilTeluguThaiTurkishUkrainianUrduVietnameseWelsh
    \ No newline at end of file diff --git a/docs/enums/Models.html b/docs/enums/Models.html index 1f5d7c5..9fee716 100644 --- a/docs/enums/Models.html +++ b/docs/enums/Models.html @@ -1,9 +1,10 @@ Models | predictionguard

    Enumeration Models

    Models represents the set of models that can be used.

    -

    Enumeration Members

    DeepseekCoder67BInstruct +

    Enumeration Members

    BridgetowerLargeItmMlmItc +DeepseekCoder67BInstruct Hermes2ProLlama38B Hermes2ProMistral7B Llava157BHF NeuralChat7B NousHermesLlama213B Yi34BChat -

    Enumeration Members

    DeepseekCoder67BInstruct

    DeepseekCoder67BInstruct: "deepseek-coder-6.7b-instruct"

    Hermes2ProLlama38B

    Hermes2ProLlama38B: "Hermes-2-Pro-Llama-3-8B"

    Hermes2ProMistral7B

    Hermes2ProMistral7B: "Hermes-2-Pro-Mistral-7B"

    Llava157BHF

    Llava157BHF: "llava-1.5-7b-hf"

    NeuralChat7B

    NeuralChat7B: "Neural-Chat-7B"

    NousHermesLlama213B

    NousHermesLlama213B: "Nous-Hermes-Llama-213B"

    Yi34BChat

    Yi34BChat: "Yi-34B-Chat"

    Settings

    Member Visibility

    Theme

    On This Page

    DeepseekCoder67BInstructHermes2ProLlama38BHermes2ProMistral7BLlava157BHFNeuralChat7BNousHermesLlama213BYi34BChat
    \ No newline at end of file +

    Enumeration Members

    BridgetowerLargeItmMlmItc

    BridgetowerLargeItmMlmItc: "bridgetower-large-itm-mlm-itc"

    DeepseekCoder67BInstruct

    DeepseekCoder67BInstruct: "deepseek-coder-6.7b-instruct"

    Hermes2ProLlama38B

    Hermes2ProLlama38B: "Hermes-2-Pro-Llama-3-8B"

    Hermes2ProMistral7B

    Hermes2ProMistral7B: "Hermes-2-Pro-Mistral-7B"

    Llava157BHF

    Llava157BHF: "llava-1.5-7b-hf"

    NeuralChat7B

    NeuralChat7B: "Neural-Chat-7B"

    NousHermesLlama213B

    NousHermesLlama213B: "Nous-Hermes-Llama-213B"

    Yi34BChat

    Yi34BChat: "Yi-34B-Chat"

    Settings

    Member Visibility

    Theme

    On This Page

    BridgetowerLargeItmMlmItcDeepseekCoder67BInstructHermes2ProLlama38BHermes2ProMistral7BLlava157BHFNeuralChat7BNousHermesLlama213BYi34BChat
    \ No newline at end of file diff --git a/docs/enums/ReplaceMethods.html b/docs/enums/ReplaceMethods.html index ea3f882..6d35da0 100644 --- a/docs/enums/ReplaceMethods.html +++ b/docs/enums/ReplaceMethods.html @@ -1,6 +1,6 @@ ReplaceMethods | predictionguard

    Enumeration ReplaceMethods

    ReplaceMethods represents the set of replace methods that can be used.

    -

    Enumeration Members

    Category +

    Enumeration Members

    Category Fake Mask Random -

    Enumeration Members

    Category

    Category: "category"

    Fake

    Fake: "fake"

    Mask

    Mask: "mask"

    Random

    Random: "random"

    Settings

    Member Visibility

    Theme

    On This Page

    CategoryFakeMaskRandom
    \ No newline at end of file +

    Enumeration Members

    Category

    Category: "category"

    Fake

    Fake: "fake"

    Mask

    Mask: "mask"

    Random

    Random: "random"

    Settings

    Member Visibility

    Theme

    On This Page

    CategoryFakeMaskRandom
    \ No newline at end of file diff --git a/docs/enums/Roles.html b/docs/enums/Roles.html index 3b3fcea..5cc393a 100644 --- a/docs/enums/Roles.html +++ b/docs/enums/Roles.html @@ -1,6 +1,6 @@ Roles | predictionguard

    Enumeration Roles

    Roles represents the set of roles that a sender can represent themselves as.

    -

    Enumeration Members

    Assistant +

    Enumeration Members

    Assistant System User -

    Enumeration Members

    Assistant

    Assistant: "assistant"

    System

    System: "system"

    User

    User: "user"

    Settings

    Member Visibility

    Theme

    On This Page

    AssistantSystemUser
    \ No newline at end of file +

    Enumeration Members

    Assistant

    Assistant: "assistant"

    System

    System: "system"

    User

    User: "user"

    Settings

    Member Visibility

    Theme

    On This Page

    AssistantSystemUser
    \ No newline at end of file diff --git a/docs/interfaces/Base64Encoder.html b/docs/interfaces/Base64Encoder.html index 4fc2294..4ac5114 100644 --- a/docs/interfaces/Base64Encoder.html +++ b/docs/interfaces/Base64Encoder.html @@ -1,4 +1,4 @@ Base64Encoder | predictionguard

    Interface Base64Encoder

    Base64Encoder defines a method that can read a data source and returns a base64 encoded string.

    -
    interface Base64Encoder {
        EncodeBase64(): Promise<[string, null | Error]>;
    }

    Methods

    EncodeBase64 -

    Methods

    EncodeBase64

    Settings

    Member Visibility

    Theme

    On This Page

    EncodeBase64
    \ No newline at end of file +
    interface Base64Encoder {
        EncodeBase64(): Promise<[string, null | Error]>;
    }

    Methods

    EncodeBase64 +

    Methods

    EncodeBase64

    Settings

    Member Visibility

    Theme

    On This Page

    EncodeBase64
    \ No newline at end of file diff --git a/docs/interfaces/Chat.html b/docs/interfaces/Chat.html index 3de0eba..5236ce7 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 804ee2d..fda66a9 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 74be272..92278df 100644 --- a/docs/interfaces/ChatInput.html +++ b/docs/interfaces/ChatInput.html @@ -1,4 +1,4 @@ ChatInput | predictionguard

    Interface ChatInput

    ChatInput represents a role and content related to a chat.

    -
    interface ChatInput {
        content: string;
        role: Roles;
    }

    Properties

    content +
    interface ChatInput {
        content: string;
        role: Roles;
    }

    Properties

    content role -

    Properties

    content

    content: string

    role

    role: Roles

    Settings

    Member Visibility

    Theme

    On This Page

    contentrole
    \ No newline at end of file +

    Properties

    content

    content: string

    role

    role: Roles

    Settings

    Member Visibility

    Theme

    On This Page

    contentrole
    \ No newline at end of file diff --git a/docs/interfaces/ChatMessage.html b/docs/interfaces/ChatMessage.html index 79021d4..5b02a7f 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 25ba6fe..a348187 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 8508a9b..dd9e46b 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 b39b5de..9331749 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/ChatVision.html b/docs/interfaces/ChatVision.html index c31b3c9..5bb9c9f 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 a075009..2d9954c 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/ChatVisionMessage.html b/docs/interfaces/ChatVisionMessage.html index a9b1b18..4f94508 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 9e88d8a..a00fd81 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 8239faf..2515e7b 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/Embedding.html b/docs/interfaces/Embedding.html new file mode 100644 index 0000000..171be34 --- /dev/null +++ b/docs/interfaces/Embedding.html @@ -0,0 +1,15 @@ +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 +data +id +model +object +

    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 diff --git a/docs/interfaces/EmbeddingData.html b/docs/interfaces/EmbeddingData.html new file mode 100644 index 0000000..f9ecf90 --- /dev/null +++ b/docs/interfaces/EmbeddingData.html @@ -0,0 +1,12 @@ +EmbeddingData | predictionguard

    Interface EmbeddingData

    EmbeddingData represents the vector data points.

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

    Properties

    embedding +index +model +status +

    Properties

    embedding

    embedding: number[]

    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 +this choice.

    +

    status

    status: string

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    embeddingindexmodelstatus
    \ No newline at end of file diff --git a/docs/interfaces/EmbeddingInput.html b/docs/interfaces/EmbeddingInput.html new file mode 100644 index 0000000..c6c49de --- /dev/null +++ b/docs/interfaces/EmbeddingInput.html @@ -0,0 +1,6 @@ +EmbeddingInput | predictionguard

    Interface EmbeddingInput

    EmbeddingInput represents the input to generate embeddings.

    +
    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 diff --git a/docs/interfaces/Factuality.html b/docs/interfaces/Factuality.html index 9266f26..433ee68 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 0e02c0c..97d80fa 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 a2d7a38..4c4c6ee 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 60e73cd..87d4b8a 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/ReplacePI.html b/docs/interfaces/ReplacePI.html index 95d2cb5..7d7fe25 100644 --- a/docs/interfaces/ReplacePI.html +++ b/docs/interfaces/ReplacePI.html @@ -1,14 +1,14 @@ ReplacePI | predictionguard

    Interface ReplacePI

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

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

    Properties

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

    Properties

    checks created id object

    Methods

    createdDate

    Properties

    checks

    checks: ReplacePICheck[]

    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/ReplacePICheck.html b/docs/interfaces/ReplacePICheck.html index 4994836..ecbb037 100644 --- a/docs/interfaces/ReplacePICheck.html +++ b/docs/interfaces/ReplacePICheck.html @@ -1,9 +1,9 @@ ReplacePICheck | predictionguard

    Interface ReplacePICheck

    ReplacePICheck represents an object that contains a check choice.

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

    Properties

    index +
    interface ReplacePICheck {
        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 af3f662..10eb549 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 4858145..0c1d838 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 d7eca63..72a7cbd 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 2d8a6f0..571135f 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/docs/modules.html b/docs/modules.html index 39453c7..f28e84a 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -18,6 +18,9 @@ ChatVisionMessage Completion CompletionChoice +Embedding +EmbeddingData +EmbeddingInput Error Factuality FactualityCheck