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

Files::AiAssistantPersonality.list

Return Object

List<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

begin
  ai_assistant_personalities = Files::AiAssistantPersonality.list
  ai_assistant_personalities.auto_paging_each do |ai_assistant_personality|
    # Operate on ai_assistant_personality
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Ai Assistant Personality

SDK Method

Files::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

begin
  ai_assistant_personality = Files::AiAssistantPersonality.find(id)
  # Operate on ai_assistant_personality
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Ai Assistant Personality

SDK Method

Files::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

begin
  ai_assistant_personality = Files::AiAssistantPersonality.create(
    name: "Concise Assistant",
    system_prompt: "Respond as a concise operations assistant."
  )
  # Operate on ai_assistant_personality
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Ai Assistant Personality

SDK Method

ai_assistant_personality.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

begin
  # Find the ai_assistant_personality object by its id.
  ai_assistant_personality = Files::AiAssistantPersonality.find(id)
  ai_assistant_personality.update(
    apply_to_all_workspaces: false
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Ai Assistant Personality

SDK Method

ai_assistant_personality.delete

Return Object

nil

Authorization Requirement

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

Example Request

begin
  # Find the ai_assistant_personality object by its id.
  ai_assistant_personality = Files::AiAssistantPersonality.find(id)
  ai_assistant_personality.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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.