Ai Assistant Personalities

An AI Assistant Personality defines a system prompt used to customize the in-app AI Assistant.

List Ai Assistant Personalities

SDK Method

AiAssistantPersonality.list()

Return Object

AiAssistantPersonality[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import AiAssistantPersonality from 'files.com/lib/models/AiAssistantPersonality';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const aiAssistantPersonalities = await AiAssistantPersonality.list();
  for (const aiAssistantPersonality of aiAssistantPersonalities) {
    // Operate on aiAssistantPersonality
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Ai Assistant Personality

SDK Method

AiAssistantPersonality.find()

Return Object

AiAssistantPersonality

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Ai Assistant Personality ID.

Example Request

import AiAssistantPersonality from 'files.com/lib/models/AiAssistantPersonality';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const aiAssistantPersonality = await AiAssistantPersonality.find(id);
  // Operate on aiAssistantPersonality
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create Ai Assistant Personality

SDK Method

AiAssistantPersonality.create()

Return Object

AiAssistantPersonality

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
apply_to_all_workspaces
boolean		falseIf true, this default-workspace personality can apply to users in all workspaces.
name
string
Required		AI Assistant Personality name.
system_prompt
string
Required		System prompt injected into the in-app AI Assistant.
use_by_default
boolean		falseWhether this personality is the default personality for the Workspace.
workspace_id
int64		0Workspace ID. 0 means the default workspace.

Example Request

import AiAssistantPersonality from 'files.com/lib/models/AiAssistantPersonality';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const aiAssistantPersonality = await AiAssistantPersonality.create({
    name: "Concise Assistant",
    system_prompt: "Respond as a concise operations assistant.",
  });
  // Operate on aiAssistantPersonality
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update Ai Assistant Personality

SDK Method

aiAssistantPersonality.update()

Return Object

AiAssistantPersonality

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
apply_to_all_workspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
name
string		AI Assistant Personality name.
system_prompt
string		System prompt injected into the in-app AI Assistant.
use_by_default
boolean		Whether this personality is the default personality for the Workspace.
workspace_id
int64		Workspace ID. 0 means the default workspace.

Example Request

import AiAssistantPersonality from 'files.com/lib/models/AiAssistantPersonality';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the aiAssistantPersonality object by its id.
  const aiAssistantPersonality = await AiAssistantPersonality.find(id);
  await aiAssistantPersonality.update({
    apply_to_all_workspaces: false,
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Ai Assistant Personality

SDK Method

aiAssistantPersonality.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import AiAssistantPersonality from 'files.com/lib/models/AiAssistantPersonality';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the aiAssistantPersonality object by its id.
  const aiAssistantPersonality = await AiAssistantPersonality.find(id);
  await aiAssistantPersonality.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The AiAssistantPersonality Object

Some of the methods above return a AiAssistantPersonality object. The attributes of this object are listed below.

AttributeDescription
id
int64		AI Assistant Personality ID.
workspace_id
int64		Workspace ID. 0 means the default workspace.
name
string		AI Assistant Personality name.
system_prompt
string		System prompt injected into the in-app AI Assistant.
use_by_default
boolean		Whether this personality is the default personality for the Workspace.
apply_to_all_workspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.