revanced-bots/server/PROTOCOL.md

Server Protocol

The server uses TCP for connection and BSON for messages, so you need to serialize and deserialize the messages.

AI

Sending the server this JSON (BSON) will send you back the AI predictions.

{
  "op": 1,
  "id": "String",
  "text": "How do i download ReVanced?"
}

And the server would return something like this:

{
  "op": 2,
  "id": "String",
  "response": [
    {
      "confidence": 0.99,
      "id": "String",
      "name": "revanced_download"
    }
  ]

Training the AI

To train the AI, send the server a JSON (BSON) like this:

{
  "op": 3,
  "label": "revanced_download",
  "text": "how to download revanced"
}

OCR

Sending the server this JSON (BSON) will send you back the read text.

{
  "op": 5,
  "id": "String",
  "url": "https://cdn.discordapp.com/attachments/1033338556493606963/1033338557231796224/Screenshot_20221022-121318.jpg"
}

And the server would return something like this:

{
  "op": 6,
  "id": "String",
  "ocrText": "..."
}