Update Character | Machani Robotics SDK

curl -X PATCH https://api.machanirobotics.com/v1/conversation/characters/character \
     -H "Content-Type: application/json" \
     -d '{
  "displayName": "Ava the Assistant"
}'

{
  "displayName": "Ava the Assistant",
  "name": "characters/ava-assistant",
  "description": "Ava is a friendly and knowledgeable virtual assistant designed to help users with a wide range of tasks.",
  "versions": [
    {
      "defaultModel": "gpt-4-ava-v1",
      "changeNote": "Updated personality traits and expanded language support.",
      "id": "01F8MECHZX3TBDSZ7XRADM79XE",
      "version": 3,
      "versionCreateTime": "2024-01-15T09:30:00Z",
      "personalityTraits": [
        "helpful",
        "empathetic",
        "patient"
      ],
      "interests": [
        "technology",
        "education",
        "customer service"
      ],
      "goals": [
        "assist users efficiently",
        "provide accurate information",
        "maintain friendly interactions"
      ],
      "systemInstructions": [
        "Always prioritize user privacy.",
        "Respond in a clear and concise manner."
      ],
      "scenarioContext": [
        "Customer support chatbot",
        "Virtual personal assistant"
      ],
      "location": {},
      "metadata": {},
      "localeTime": "2024-01-15T09:30:00Z",
      "weather": "clear skies",
      "supportedLanguages": [
        "en-US",
        "es-ES",
        "fr-FR"
      ],
      "styleSettings": {
        "formality": 70,
        "humor": 40,
        "empathy": 85,
        "professionalism": 80,
        "enthusiasm": 60,
        "conciseness": 75
      },
      "signature": {
        "username": "jdoe",
        "email": "jdoe@machanirobotics.com",
        "company": "Machani Robotics"
      },
      "favorite": true
    }
  ]
}

Update updates an existing Character resource.

This RPC accepts an UpdateCharacterRequest containing the updated character data and an update mask to specify which fields should be modified. The updated Character is then returned.

HTTP Mapping: PATCH “/v1/conversation/characters/{character.name=characters/*}”

Path parameters

characterstringRequired

The character id.

Query parameters

updateMaskstringOptionalformat: "field-mask"

update_mask specifies the fields to update in the Character.

Request

This endpoint expects an object.

displayNamestringRequired

display_name is the human-readable name for the Character.

namestringOptional

name is the unique resource identifier for the Character. It follows the format “characters/{character}”.

descriptionstringOptional

description provides a brief overview of the Character's purpose.

Response

displayNamestring

display_name is the human-readable name for the Character.

namestring

name is the unique resource identifier for the Character. It follows the format “characters/{character}”.

descriptionstring

description provides a brief overview of the Character's purpose.

versionslist of objectsRead-only

version is the current version of the Character.

Errors

400

Bad Request Error