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

ai_assistant_personality.List()

Return Values

Returns a *ai_assistant_personality.Iter and an error. Range over All() to receive files_sdk.AiAssistantPersonality values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    ai_assistant_personality "github.com/Files-com/files-sdk-go/v3/aiassistantpersonality"
)

aiAssistantPersonalityIterator, err := ai_assistant_personality.List(files_sdk.AiAssistantPersonalityListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for aiAssistantPersonality, err := range aiAssistantPersonalityIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(aiAssistantPersonality)
}

Show Ai Assistant Personality

SDK Method

ai_assistant_personality.Find()

Return Values

Returns a files_sdk.AiAssistantPersonality value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

AiAssistantPersonalityFindParams Fields

FieldDescription
Id
int64
Required		Ai Assistant Personality ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    ai_assistant_personality "github.com/Files-com/files-sdk-go/v3/aiassistantpersonality"
)

aiAssistantPersonality, err := ai_assistant_personality.Find(files_sdk.AiAssistantPersonalityFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(aiAssistantPersonality)

Create Ai Assistant Personality

SDK Method

ai_assistant_personality.Create()

Return Values

Returns a files_sdk.AiAssistantPersonality value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

AiAssistantPersonalityCreateParams Fields

FieldDefaultDescription
ApplyToAllWorkspaces
boolean		falseIf true, this default-workspace personality can apply to users in all workspaces.
Name
string
Required		AI Assistant Personality name.
SystemPrompt
string
Required		System prompt injected into the in-app AI Assistant.
UseByDefault
boolean		falseWhether this personality is the default personality for the Workspace.
WorkspaceId
int64		0Workspace ID. 0 means the default workspace.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    ai_assistant_personality "github.com/Files-com/files-sdk-go/v3/aiassistantpersonality"
)

aiAssistantPersonality, err := ai_assistant_personality.Create(files_sdk.AiAssistantPersonalityCreateParams{
  Name: "Concise Assistant",
  SystemPrompt: "Respond as a concise operations assistant.",
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(aiAssistantPersonality)

Update Ai Assistant Personality

SDK Method

ai_assistant_personality.Update()

Return Values

Returns a files_sdk.AiAssistantPersonality value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

AiAssistantPersonalityUpdateParams Fields

FieldDescription
Id
int64
Required		Ai Assistant Personality ID.
ApplyToAllWorkspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
Name
string		AI Assistant Personality name.
SystemPrompt
string		System prompt injected into the in-app AI Assistant.
UseByDefault
boolean		Whether this personality is the default personality for the Workspace.
WorkspaceId
int64		Workspace ID. 0 means the default workspace.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    ai_assistant_personality "github.com/Files-com/files-sdk-go/v3/aiassistantpersonality"
    "github.com/Files-com/files-sdk-go/v3/lib"
)

aiAssistantPersonality, err := ai_assistant_personality.Update(files_sdk.AiAssistantPersonalityUpdateParams{
  Id: 1,
  ApplyToAllWorkspaces: lib.Bool(false),
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(aiAssistantPersonality)

Delete Ai Assistant Personality

SDK Method

ai_assistant_personality.Delete()

Return Values

Returns an error, or nil on success.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

AiAssistantPersonalityDeleteParams Fields

FieldDescription
Id
int64
Required		Ai Assistant Personality ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    ai_assistant_personality "github.com/Files-com/files-sdk-go/v3/aiassistantpersonality"
)

err := ai_assistant_personality.Delete(files_sdk.AiAssistantPersonalityDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

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.
WorkspaceId
int64		Workspace ID. 0 means the default workspace.
Name
string		AI Assistant Personality name.
SystemPrompt
string		System prompt injected into the in-app AI Assistant.
UseByDefault
boolean		Whether this personality is the default personality for the Workspace.
ApplyToAllWorkspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
CreatedAt
date-time		Creation time.
UpdatedAt
date-time		Last update time.