Character

A character is a set of models (typically large language models) from a particular AI platform (OpenAI, Google AI, etc.) working together towards a common goal, using the custom data and functions available to them. For instance, an OpenAI character may use gpt-4-1106-preview for chat completion and whisper-1 for audio transcriptions.

  {
      "id": "659a21168ad10b77542a3587",
      "createdAt": "2024-01-07T03:57:10.830Z",
      "description": "AI character for ABC Inventory",
      "image": "https://proteusai-dev.s3.amazonaws.com/6509bbf39a93db7d92f77320/characters/659a2114eb362b863bf25d55",
      "isExistingAssistant": false,
      "modelFamily": "OPENAI",
      "name": "ABC Inventory Bot",
      "openai": {
          "assistantId": "asst_VqKlnnooXtk2WXeH38iwt19e"
      },
      "orgId": "6509bbf39a93db7d92f77320",
      "sendWelcomeMessage": false,
      "updatedAt": "2024-01-07T04:17:10.274Z",
      "welcomeMessage": "### Hello!\n\nWelcome to ABC Inventory"
  }

Properties

id ^string

The unique ID of the character. You can find your character's ID by visiting the character page on ProteusAI. The character ID is located in the URL by reading the characterId query parameter.

E.g. the character ID for http://localhost:4000/6509bbf39a93db7d92f77320?characterId=659a21168ad10b77542a3587 is 659a21168ad10b77542a3587

name ^string

The name of the character.