search

protectai / rebuff

LLM Prompt Injection Detector
https://playground.rebuff.ai
Apache License 2.0
1.06k stars 73 forks source link

Improve documentation #17

Closed woop closed 11 months ago

woop commented 1 year ago

Our documentation is quite limited today. Minimally we should have API docs for Python and JavaScript, a getting started guide that walks users through setting up their infrastructure (Pinecone and Supabase), examples in how to use Rebuff both locally and as part of an application, and a contributor guide.

shachar-ug commented 1 year ago

if you're on it, what your_billing_rate_int_10k refer to? it's not the master api key

woop commented 1 year ago

your_billing_rate_int_10k is the amount of credits that should be deducted for every request. The value is an integer, and 10k refers to a single dollar amount. So if you set the value to 10000 then it will deduct 1 dollar per request. If you set it to 1 then it will deduct 0.1 cents per request.

woop commented 1 year ago

Also, please not that there is a large scale refactor happening on https://github.com/woop/rebuff/tree/monorepo

seanpmorgan commented 11 months ago

We'll certainly be working on documentation improvements. I'm going to close this issue and make a new one that is scoped to the new documentation changes we'll need after #54 and #52