Set-FilesAiAssistantPersonality

Update Ai Assistant Personality.

Syntax

Id (Default)

Set-FilesAiAssistantPersonality [-Id] <System.Int64> [-ApplyToAllWorkspaces <System.Boolean>] [-Name <System.String>] [-SystemPrompt <System.String>] [-UseByDefault <System.Boolean>] [-WorkspaceId <System.Int64>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-FilesAiAssistantPersonality [-ApplyToAllWorkspaces <System.Boolean>] [-Name <System.String>] [-SystemPrompt <System.String>] [-UseByDefault <System.Boolean>] [-WorkspaceId <System.Int64>] -InputObject <FilesCom.PowerShell.Models.AiAssistantPersonality> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update Ai Assistant Personality.

The command accepts ai assistant personalities from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.

When given -InputObject, the command updates that object with the values Files.com returns and writes it.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Update Ai Assistant Personality

Set-FilesAiAssistantPersonality -Id 1 -Name 'Concise Assistant' -SystemPrompt 'Respond as a concise operations assistant.'

Writes the ai assistant personality as Files.com returns it.

Example 2: Act on ai assistant personalities from the pipeline

Get-FilesAiAssistantPersonality -Id 1 | Set-FilesAiAssistantPersonality -Name 'Concise Assistant' -SystemPrompt 'Respond as a concise operations assistant.'

Takes the ai assistant personality from the pipeline and uses its Id and connection.

Example 3: Preview the change

Set-FilesAiAssistantPersonality -Id 1 -Name 'Concise Assistant' -SystemPrompt 'Respond as a concise operations assistant.' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Ai Assistant Personality ID.

  • Type: System.Int64
  • Parameter sets: Id (required, position 0)

-ApplyToAllWorkspaces

If true, this default-workspace personality can apply to users in all workspaces.

  • Type: System.Boolean
  • Parameter sets: Id, InputObject

-Name

AI Assistant Personality name.

  • Type: System.String
  • Parameter sets: Id, InputObject

-SystemPrompt

System prompt injected into the in-app AI Assistant.

  • Type: System.String
  • Parameter sets: Id, InputObject

-UseByDefault

Whether this personality is the default personality for the Workspace.

  • Type: System.Boolean
  • Parameter sets: Id, InputObject

-WorkspaceId

Workspace ID. 0 means the default workspace.

  • Type: System.Int64
  • Parameter sets: Id, InputObject

-InputObject

The ai assistant personality to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.

  • Type: FilesCom.PowerShell.Models.AiAssistantPersonality
  • Parameter sets: InputObject (required)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

  • FilesCom.PowerShell.Models.AiAssistantPersonality: a ai assistant personality from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.AiAssistantPersonality: the ai assistant personality as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.